Test Your Tier Structures Profile

Test using /getTierByKey

Go to the Agilit-e API Reference page.

1. Navigate to the Tier Structures Execution APIs category under the Agilit-e Tier Structures section, followed by clicking on the /getTierByKey menu item.

2. Click on the user icon on the top right of the API logic and populate your generated Agilit-e token into the api-key field.

🚧

Regarding API Keys

Note: You will need to create an API Key, as mentioned earlier in the API Keys Module section of the documentation. Once the API Key is provided for one API, it will exist for the rest of the APIs.

3. Under the Headers section, provide the tier-keys that you would like included.

• Under tier-keys you can add multiple tiers or only one. you can do this by separating the values with commas. For example country,states or states or country will all return results.
• The include-values , include-meta-data, include-tier-entries, sort-values, and values-output-format are all fields that you can specify, all giving more or less information depending on if they are on or not.

4. Click on the Try It button to execute the API.

• The API response will contain the country tiers that were configured in the Tier Structures profile.

{
    "values": [{
        "label": "United States of America",
        "value": "USA"
    }],
    "tierEntries": [{
        "_id": "1304c810-7e2d-11ea-b5d9-274a913ea02c",
        "isActive": true,
        "key": "states",
        "description": "",
        "notes": "",
        "values": [{
                "label": "Montana",
                "value": "MT"
            },
            {
                "label": "New York",
                "value": "NY"
            },
            {
                "label": "Washington",
                "value": "WA"
            }
        ],
        "tierEntries": []
    }],
    "isActive": true,
    "key": "country",
    "description": "",
    "notes": ""
}