v1

latestOpenAPI 3.0.22026-07-24800528.1 KB

Tiers

List all tiers

Returns a list of all tiers.

get/v2/tiers

Query parameters

tier_collection_keystring

The key of the tier collection you'd like to retrieve tiers for

Response

Returns a list of all tiers.

messagestring required

statusinteger required

Example response

{
  "data": [
    {
      "created_at": 1574181282399,
      "key": "co_a80cb515fe",
      "updated_at": 1574181282399,
      "benefits": [
        {
          "description": "Free shipping on all orders over $100",
          "name": "Free shipping",
          "order": 1
        }
      ],
      "img": "file_fdmni0f3420fnw",
      "name": "Tier 1",
      "threshold_type": "net_sales",
      "tier_collection_key": "tiercol_a80cb515fe"
    }
  ]
}