Configuration

The Configuration API allows you to retrieve system settings and configuration values at different organizational levels. This hierarchical approach provides precise control over configuration data access based on your operational needs.

diagram_config_1

1 - Retrieve Configuration by Level and Name

Retrieve specific configuration values by specifying the organizational level and configuration key name.

Request

Definitions Example 

{
    "requestType": String,
    "actionType": String,
    "configList": [{
        "level": String,
        "name": String
    }]
}
            

{
    "requestType": "config",
    "actionType": "getList",
    "configList": [{
        "level": "STORE",
        "name": "NAME"
    }]
}

See definitions

Response

Definitions Example 

{
    "status": String,
    "configList": [{
        "level": String,
        "name": String,
        "value": String
    }]
}
            

{
    "status": "OK",
    "configList": [{
        "level": "STORE",
        "name": "NAME",
        "value": "TOM'S STORE"
     }]
}

See definitions

2 - Retrieve Multiple Configuration Values

Request multiple configuration values in a single API call, including values from different organizational levels.

Request

Definitions Example 

{
    "requestType": String,
    "actionType": String,
    "configList": [
    {
        "level": String,
        "name": String
    },
    {
        "level": String,
        "name": String
    },
    {
        "level": String,
        "name": String
    },
    {
        "level": String,
        "name": String
    }
    ]
}
            

{
    "requestType": "config",
    "actionType": "getList",
    "configList": [
    {
        "level": "STORE",
        "name": "NAME"
    },
    {
        "level": "STORE",
        "name": "PHONE"
    },
    {
        "level": "STORE",
        "name": "STREET"
    },
    {
        "level": "STORE",
        "name": "CITY"
    },
    {
        "level": "STORE",
        "name": "STATE"
    },
    {
        "level": "STORE",
        "name": "ZIPCODE"
    }
    ]
}

See definitions

Response

Definitions Example 

{
    "status": String,
    "configList": [
    {
        "level": String,
        "name": String,
        "value": String
    },
    {
        "level": String,
        "name": String,
        "value": String
    },
    {
        "level": String,
        "name": String,
        "value": String
    },
    {
        "level": String,
        "name": String,
        "value": String
    },
    ]
}
            

{
    "status": "OK",
    "configList": [
     {
        "level": "STORE",
        "name": "NAME",
        "value": "MASTER #2 FULL"
     },
     {
        "level": "STORE",
        "name": "STREET",
        "value": "13425 1/2 PUMICE ST"
     },
     {
        "level": "STORE",
        "name": "CITY",
        "value": "NORWALK"
     },
     {
        "level": "STORE",
        "name": "STATE",
        "value": "CA"
     }
     ]
}

See definitions

Definitions

Request definitions

Definition Type Description
actionType String (["getList"]) Unique action identifier for your request.
configList Object[] The structure and data fields that you want to receive.

Response Definitions

Definition Type Description
status String The Request status.
configList Object[] Config List with the data you requested.