Coupons

Fetches all coupons for a store id

get

Authorizations

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

Query parameters

limitinteger · int32 · min: 1 · max: 100Optional

The maximum number of items to return in a single request.

afterinteger · int64Optional

Returns items after the specified ID. Used for forward pagination through results.

beforeinteger · int64Optional

Returns items before the specified ID. Used for backward pagination through results.

ascbooleanOptional

Determines the sort order of returned items. When true, items are returned in ascending order. When false, items are returned in descending order.

Responses

200

OK

application/json

default

Error response

application/json

get

HTTPcURLJavaScriptPython

GET /v1/stores/{storeId}/coupons HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "enabled": true,
    "code": "text",
    "note": "text",
    "duration": "once",
    "duration_in_months": 1,
    "discount_type": "unspecified",
    "discount_amount": 1,
    "discount_apply_individually": true,
    "discount_apply_before_sales": true,
    "apply_to_products": [
      "411486491630370816"
    ],
    "apply_to_tags": [
      "411486491630370816"
    ],
    "usable_by_customer_id": "411486491630370816",
    "minimum_order_value": 1,
    "redeem_limit_store_enabled": true,
    "redeem_limit_store_amount": 1,
    "redeem_limit_customer_enabled": true,
    "redeem_limit_customer_amount": 1,
    "usable_on_one_time_purchase": true,
    "usable_on_subscription": true,
    "usable_at": "2025-08-21T19:37:56.888Z",
    "expires_at": "2025-08-21T19:37:56.888Z",
    "created_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "created_at": "2025-08-21T19:37:56.888Z",
    "updated_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "updated_at": "2025-08-21T19:37:56.888Z"
  }
]

post

Authorizations

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

Body

application/jsontext/jsonapplication/*+json

enabledbooleanRequired

codestringRequired

notestringOptional

durationstring · enumRequired

Defines the duration for which a coupon remains valid.

Possible values:

duration_in_monthsinteger · int32Optional

discount_typestring · enumRequired

Specifies the type of discount applied by a coupon.

Possible values:

discount_amountinteger · int64Required

discount_apply_individuallybooleanRequired

discount_apply_before_salesbooleanRequired

apply_to_productsstring · flake-id[]OptionalExample: 411486491630370816

apply_to_tagsstring · flake-id[]OptionalExample: 411486491630370816

usable_by_customer_idstring · flake-idOptionalExample: 411486491630370816

minimum_order_valueinteger · int64Required

redeem_limit_store_enabledbooleanRequired

redeem_limit_store_amountinteger · int64Required

redeem_limit_customer_enabledbooleanRequired

redeem_limit_customer_amountinteger · int64Required

usable_on_one_time_purchasebooleanRequired

usable_on_subscriptionbooleanRequired

usable_atstring · date-timeOptional

expires_atstring · date-timeOptional

Responses

200

OK

application/json

default

Error response

application/json

post

HTTPcURLJavaScriptPython

POST /v1/stores/{storeId}/coupons HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 634

{
  "enabled": true,
  "code": "text",
  "note": "text",
  "duration": "once",
  "duration_in_months": 1,
  "discount_type": "unspecified",
  "discount_amount": 1,
  "discount_apply_individually": true,
  "discount_apply_before_sales": true,
  "apply_to_products": [
    "411486491630370816"
  ],
  "apply_to_tags": [
    "411486491630370816"
  ],
  "usable_by_customer_id": "411486491630370816",
  "minimum_order_value": 1,
  "redeem_limit_store_enabled": true,
  "redeem_limit_store_amount": 1,
  "redeem_limit_customer_enabled": true,
  "redeem_limit_customer_amount": 1,
  "usable_on_one_time_purchase": true,
  "usable_on_subscription": true,
  "usable_at": "2025-08-21T19:37:56.888Z",
  "expires_at": "2025-08-21T19:37:56.888Z"
}

application/jsontext/jsonapplication/*+json

{
  "id": "411486491630370816",
  "store_id": "411486491630370816",
  "enabled": true,
  "code": "text",
  "note": "text",
  "duration": "once",
  "duration_in_months": 1,
  "discount_type": "unspecified",
  "discount_amount": 1,
  "discount_apply_individually": true,
  "discount_apply_before_sales": true,
  "apply_to_products": [
    "411486491630370816"
  ],
  "apply_to_tags": [
    "411486491630370816"
  ],
  "usable_by_customer_id": "411486491630370816",
  "minimum_order_value": 1,
  "redeem_limit_store_enabled": true,
  "redeem_limit_store_amount": 1,
  "redeem_limit_customer_enabled": true,
  "redeem_limit_customer_amount": 1,
  "usable_on_one_time_purchase": true,
  "usable_on_subscription": true,
  "usable_at": "2025-08-21T19:37:56.888Z",
  "expires_at": "2025-08-21T19:37:56.888Z",
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "created_at": "2025-08-21T19:37:56.888Z",
  "updated_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "updated_at": "2025-08-21T19:37:56.888Z"
}

Retrieves a coupon by ID

get

Authorizations

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

couponIdstring · flake-idRequiredExample: 411486491630370816

Responses

200

OK

application/json

404

Not Found

application/json

default

Error response

application/json

get

HTTPcURLJavaScriptPython

GET /v1/stores/{storeId}/coupons/{couponId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "411486491630370816",
  "store_id": "411486491630370816",
  "enabled": true,
  "code": "text",
  "note": "text",
  "duration": "once",
  "duration_in_months": 1,
  "discount_type": "unspecified",
  "discount_amount": 1,
  "discount_apply_individually": true,
  "discount_apply_before_sales": true,
  "apply_to_products": [
    "411486491630370816"
  ],
  "apply_to_tags": [
    "411486491630370816"
  ],
  "usable_by_customer_id": "411486491630370816",
  "minimum_order_value": 1,
  "redeem_limit_store_enabled": true,
  "redeem_limit_store_amount": 1,
  "redeem_limit_customer_enabled": true,
  "redeem_limit_customer_amount": 1,
  "usable_on_one_time_purchase": true,
  "usable_on_subscription": true,
  "usable_at": "2025-08-21T19:37:56.888Z",
  "expires_at": "2025-08-21T19:37:56.888Z",
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "created_at": "2025-08-21T19:37:56.888Z",
  "updated_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "updated_at": "2025-08-21T19:37:56.888Z"
}

Deletes a coupon

delete

Authorizations

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

couponIdstring · flake-idRequiredExample: 411486491630370816

Responses

204

No Content

default

Error response

application/json

delete

HTTPcURLJavaScriptPython

DELETE /v1/stores/{storeId}/coupons/{couponId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

Performs a Delta Update of a Coupon

patch

Authorizations

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

couponIdstring · flake-idRequiredExample: 411486491630370816

Body

application/jsontext/jsonapplication/*+json

enabledbooleanOptional

codestringOptional

notestringOptional

durationstring · enumOptional

Defines the duration for which a coupon remains valid.

Possible values:

duration_in_monthsinteger · int32Optional

discount_typestring · enumOptional

Specifies the type of discount applied by a coupon.

Possible values:

discount_amountinteger · int64Optional

discount_apply_individuallybooleanOptional

discount_apply_before_salesbooleanOptional

apply_to_productsstring · flake-id[]OptionalExample: 411486491630370816

apply_to_tagsstring · flake-id[]OptionalExample: 411486491630370816

usable_by_customer_idstring · flake-idOptionalExample: 411486491630370816

minimum_order_valueinteger · int64Optional

redeem_limit_store_enabledbooleanOptional

redeem_limit_store_amountinteger · int64Optional

redeem_limit_customer_enabledbooleanOptional

redeem_limit_customer_amountinteger · int64Optional

usable_on_one_time_purchasebooleanOptional

usable_on_subscriptionbooleanOptional

usable_atstring · date-timeOptional

expires_atstring · date-timeOptional

Responses

200

OK

application/json

default

Error response

application/json

patch

HTTPcURLJavaScriptPython

PATCH /v1/stores/{storeId}/coupons/{couponId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 634

{
  "enabled": true,
  "code": "text",
  "note": "text",
  "duration": "once",
  "duration_in_months": 1,
  "discount_type": "unspecified",
  "discount_amount": 1,
  "discount_apply_individually": true,
  "discount_apply_before_sales": true,
  "apply_to_products": [
    "411486491630370816"
  ],
  "apply_to_tags": [
    "411486491630370816"
  ],
  "usable_by_customer_id": "411486491630370816",
  "minimum_order_value": 1,
  "redeem_limit_store_enabled": true,
  "redeem_limit_store_amount": 1,
  "redeem_limit_customer_enabled": true,
  "redeem_limit_customer_amount": 1,
  "usable_on_one_time_purchase": true,
  "usable_on_subscription": true,
  "usable_at": "2025-08-21T19:37:56.888Z",
  "expires_at": "2025-08-21T19:37:56.888Z"
}

application/jsontext/jsonapplication/*+json

{
  "id": "411486491630370816",
  "store_id": "411486491630370816",
  "enabled": true,
  "code": "text",
  "note": "text",
  "duration": "once",
  "duration_in_months": 1,
  "discount_type": "unspecified",
  "discount_amount": 1,
  "discount_apply_individually": true,
  "discount_apply_before_sales": true,
  "apply_to_products": [
    "411486491630370816"
  ],
  "apply_to_tags": [
    "411486491630370816"
  ],
  "usable_by_customer_id": "411486491630370816",
  "minimum_order_value": 1,
  "redeem_limit_store_enabled": true,
  "redeem_limit_store_amount": 1,
  "redeem_limit_customer_enabled": true,
  "redeem_limit_customer_amount": 1,
  "usable_on_one_time_purchase": true,
  "usable_on_subscription": true,
  "usable_at": "2025-08-21T19:37:56.888Z",
  "expires_at": "2025-08-21T19:37:56.888Z",
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "created_at": "2025-08-21T19:37:56.888Z",
  "updated_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "updated_at": "2025-08-21T19:37:56.888Z"
}