Tier Groups

List all tier groups for a store

get

Authorizations

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

Responses

200

OK

application/json

idstring · flake-idRequiredExample: 411486491630370816

store_idstring · flake-idRequiredExample: 411486491630370816

namestringRequired

The name of the tier group.

created_atstring · date-timeRequired

When the tier group was created.

updated_atstring · nullableOptional

When was the tier group last updated.

default

Error response

application/json

get/v1/stores/{storeId}/tier-groups

GET /v1/stores/{storeId}/tier-groups HTTP/1.1
Authorization: APIKey TOKEN_HERE
Accept: */*

[
  {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "name": "text",
    "created_at": "2026-01-01T00:00:00.000Z",
    "created_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "updated_at": null,
    "updated_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    }
  }
]

Create a new tier group

post

Authorizations

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

Body

namestringRequired

The name of the tier group.

Responses

200

OK

application/json

idstring · flake-idRequiredExample: 411486491630370816

store_idstring · flake-idRequiredExample: 411486491630370816

namestringRequired

The name of the tier group.

created_atstring · date-timeRequired

When the tier group was created.

updated_atstring · nullableOptional

When was the tier group last updated.

default

Error response

application/json

post/v1/stores/{storeId}/tier-groups

POST /v1/stores/{storeId}/tier-groups HTTP/1.1
Authorization: APIKey TOKEN_HERE
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

{
  "id": "411486491630370816",
  "store_id": "411486491630370816",
  "name": "text",
  "created_at": "2026-01-01T00:00:00.000Z",
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "updated_at": null,
  "updated_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  }
}

Get a tier group by ID

get

Authorizations

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

tierGroupIdstring · flake-idRequiredExample: 411486491630370816

Responses

200

OK

application/json

idstring · flake-idRequiredExample: 411486491630370816

store_idstring · flake-idRequiredExample: 411486491630370816

namestringRequired

The name of the tier group.

created_atstring · date-timeRequired

When the tier group was created.

updated_atstring · nullableOptional

When was the tier group last updated.

default

Error response

application/json

get/v1/stores/{storeId}/tier-groups/{tierGroupId}

GET /v1/stores/{storeId}/tier-groups/{tierGroupId} HTTP/1.1
Authorization: APIKey TOKEN_HERE
Accept: */*

{
  "id": "411486491630370816",
  "store_id": "411486491630370816",
  "name": "text",
  "created_at": "2026-01-01T00:00:00.000Z",
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "updated_at": null,
  "updated_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  }
}

Delete a tier group by ID

delete

Authorizations

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

tierGroupIdstring · flake-idRequiredExample: 411486491630370816

Responses

204

No Content

No content

default

Error response

application/json

delete/v1/stores/{storeId}/tier-groups/{tierGroupId}

DELETE /v1/stores/{storeId}/tier-groups/{tierGroupId} HTTP/1.1
Authorization: APIKey TOKEN_HERE
Accept: */*

No content

Update a tier group by ID

patch

Authorizations

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

tierGroupIdstring · flake-idRequiredExample: 411486491630370816

Body

namestringRequired

The name of the tier group.

Responses

200

OK

application/json

idstring · flake-idRequiredExample: 411486491630370816

store_idstring · flake-idRequiredExample: 411486491630370816

namestringRequired

The name of the tier group.

created_atstring · date-timeRequired

When the tier group was created.

updated_atstring · nullableOptional

When was the tier group last updated.

default

Error response

application/json

patch/v1/stores/{storeId}/tier-groups/{tierGroupId}

PATCH /v1/stores/{storeId}/tier-groups/{tierGroupId} HTTP/1.1
Authorization: APIKey TOKEN_HERE
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

{
  "id": "411486491630370816",
  "store_id": "411486491630370816",
  "name": "text",
  "created_at": "2026-01-01T00:00:00.000Z",
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "updated_at": null,
  "updated_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  }
}