v1

latestOpenAPI 3.0.22026-07-24800528.1 KB

Tiers

Patch V2

Update a tier collection for a company. Any parameters not passed will not be updated.

patch/v2/tiers/collection/{collection_key}

Path parameters

collection_keystring required

The collection key

Request body

created_atinteger nullable

Unix timestamp in milliseconds when the tier collection was created

is_activeboolean

keystring nullable

A unique identifier to identify the tier

namestring nullable

Specifies name of the Tier

Example request

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

Response

Update a tier collection for a company. Any parameters not passed will not be updated.

messagestring required

statusinteger required