Sign in

v1

latestOpenAPI 3.0.22026-07-24800528.1 KB
Tiers

Update a tier

Updates an existing tier with the data provided. Any parameters not passed will not be updated.

patch/v2/tiers/{tier_key}

Path parameters

tier_keystring required

The key of the tier you'd like to update

Request body

criteriastring[] nullable

Partner criteria for this tier

namestring nullable

Specifies name of the Tier

Example request

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

Response

Updates an existing tier with the data provided. Any parameters not passed will not be updated.

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