Coupons
411486491630370816
The maximum number of items to return in a single request.
Returns items after the specified ID. Used for forward pagination through results.
411486491630370816
Returns items before the specified ID. Used for backward pagination through results.
411486491630370816
Determines the sort order of returned items. When true, items are returned in ascending order. When false, items are returned in descending order.
Will filter by coupon status.
Will filter by coupon creation type.
OK
Error response
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-10-08T15:51:07.322Z",
"expires_at": "2025-10-08T15:51:07.322Z",
"created_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"created_at": "2025-10-08T15:51:07.322Z",
"updated_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"updated_at": "2025-10-08T15:51:07.322Z"
}
]
411486491630370816
Defines the duration for which a coupon remains valid.
Specifies the type of discount applied by a coupon.
411486491630370816
411486491630370816
411486491630370816
OK
Error response
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-10-08T15:51:07.322Z",
"expires_at": "2025-10-08T15:51:07.322Z"
}
{
"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-10-08T15:51:07.322Z",
"expires_at": "2025-10-08T15:51:07.322Z",
"created_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"created_at": "2025-10-08T15:51:07.322Z",
"updated_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"updated_at": "2025-10-08T15:51:07.322Z"
}
411486491630370816
411486491630370816
OK
Not Found
Error response
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-10-08T15:51:07.322Z",
"expires_at": "2025-10-08T15:51:07.322Z",
"created_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"created_at": "2025-10-08T15:51:07.322Z",
"updated_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"updated_at": "2025-10-08T15:51:07.322Z"
}
411486491630370816
411486491630370816
No Content
No content
Error response
DELETE /v1/stores/{storeId}/coupons/{couponId} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
No content
411486491630370816
411486491630370816
Defines the duration for which a coupon remains valid.
Specifies the type of discount applied by a coupon.
411486491630370816
411486491630370816
411486491630370816
OK
Error response
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-10-08T15:51:07.322Z",
"expires_at": "2025-10-08T15:51:07.322Z"
}
{
"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-10-08T15:51:07.322Z",
"expires_at": "2025-10-08T15:51:07.322Z",
"created_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"created_at": "2025-10-08T15:51:07.322Z",
"updated_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"updated_at": "2025-10-08T15:51:07.322Z"
}
Was this helpful?