POST /v1/public/storefronts/{slug}/promotions/validate

POST/v1/public/storefronts/{slug}/promotions/validate

Path parameters

slugstringrequired

Request body

requiredapplication/json

codestringrequired

itemsStorefrontCheckoutItemInput[] | nullrequired

Show properties

Array of StorefrontCheckoutItemInput

product_slugstringrequired

quantityinteger<int32>required

selected_optionsobject

variant_idstring

Responses

200OK

codestringrequired

discount_amountinteger<int64>required

discount_typestringrequired

discount_valueinteger<int64>required

min_subtotal_amountinteger<int64>

namestringrequired

subtotal_amountinteger<int64>required

defaultError

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X POST "/v1/public/storefronts/string/promotions/validate" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "string",
  "items": [
    {
      "product_slug": "string",
      "quantity": 0,
      "selected_options": {},
      "variant_id": "string"
    }
  ]
}'

const response = await fetch("/v1/public/storefronts/string/promotions/validate", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "code": "string",
  "items": [
    {
      "product_slug": "string",
      "quantity": 0,
      "selected_options": {},
      "variant_id": "string"
    }
  ]
})
});

import requests

response = requests.post(
    "/v1/public/storefronts/string/promotions/validate",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "code": "string",
  "items": [
    {
      "product_slug": "string",
      "quantity": 0,
      "selected_options": {},
      "variant_id": "string"
    }
  ]
},
)

Response

{
  "code": "string",
  "discount_amount": 0,
  "discount_type": "string",
  "discount_value": 0,
  "min_subtotal_amount": 0,
  "name": "string",
  "subtotal_amount": 0
}

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