v1

latestOpenAPI 3.0.22026-07-24800528.1 KB

Tiers

Get V2

Get a tier collection by key

get/v2/tiers/collection/{collection_key}

Path parameters

collection_keystring required

The unique identifier of the tier collection

Response

Get a tier collection by key

messagestring required

statusinteger required

Example response

{
  "data": {
    "tier_collection": {
      "cycle": {
        "delay_unit": "months",
        "key": "cyc_a80cb515fe",
        "length": 3,
        "unit": "months"
      },
      "key": "tag_a80cb515fe",
      "name": "Tier 1",
      "tiers": [
        {
          "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"
        }
      ]
    }
  }
}