GET /v1/commerce/promotions

GET/v1/commerce/promotions

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Query parameters

limitinteger<int32>

min 1 · max 100 · default: 20

offsetinteger<int32>

min 0 · default: 0

Responses

200OK

itemsPromotionOutput[] | nullrequired

Show properties

Array of PromotionOutput

auto_applyboolean

bundle_product_idsstring[] | null

category_idsstring[] | null

codestring

collection_idsstring[] | null

discount_typestringrequired

discount_valueinteger<int64>required

ends_atstring<date-time>

idstringrequired

max_usesinteger<int64>

min_subtotal_amountinteger<int64>

namestring

product_idsstring[] | null

starts_atstring<date-time>

defaultError

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X GET "/v1/commerce/promotions"

const response = await fetch("/v1/commerce/promotions", {
  method: "GET"
});

import requests

response = requests.get(
    "/v1/commerce/promotions",
)

Response

{
  "items": [
    {
      "auto_apply": true,
      "bundle_product_ids": [
        "string"
      ],
      "category_ids": [
        "string"
      ],
      "code": "string",
      "collection_ids": [
        "string"
      ],
      "discount_type": "string",
      "discount_value": 0,
      "ends_at": "2024-01-01T00:00:00Z",
      "id": "string",
      "max_uses": 0,
      "min_subtotal_amount": 0,
      "name": "string",
      "product_ids": [
        "string"
      ],
      "starts_at": "2024-01-01T00:00:00Z"
    }
  ]
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}