v1

latestOpenAPI 3.0.22026-07-24800528.1 KB

Tiers

Create a tier

Creates a new tier for the given tier collection

post/v2/tiers

Request body

criteriastring[] required

Partner criteria for this tier

namestring required

Specifies name of the Tier

tier_collection_keystring required

A unique identifier for the parent collection

Example request

{
  "benefits": [
    {
      "description": "Free shipping on all orders over $100",
      "name": "Free shipping",
      "order": 1
    }
  ],
  "name": "Tier 1",
  "tier_collection_key": "tiercol_a80cb515fe"
}

Response

Creates a new tier for the given tier collection

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"
  }
}