Coupons
Get yourself more purchases with a coupon, but maybe not more profit...
Gets the coupons in the store. Requires the Scopes.ViewCoupons API key scope
The ID of the store to get the coupons in
The page to select when viewing the coupons
The amount of coupons to display in one page
The object was successfully returned.
You are not authorized, check your API key and try again.
You are not authorized to access this endpoint, you may be missing an API key scope or be requesting a privileged endpoint.
One of the objects referenced by the ID given in the URL or form was not found, check the ID and try again.
GET /stores/{storeId}/coupons/{page} HTTP/1.1
Host: api.sellsn.io
Authorization: Bearer JWT
Accept: */*
{
"success": true,
"pages": 1,
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"dateCreated": "2025-08-31T06:24:52.848Z",
"name": "text",
"uses": 1,
"maximumUses": 1,
"percentageDecrease": 1,
"isEnabled": true
}
]
}Creates a new coupon in the store. Requires the Scopes.CreateCoupons API key scope
The ID of the store to create the coupon in
The data-transfer object for a coupon, can be used for creating or updating a coupon and returned by the API when getting coupons
The case-sensitive name the customer will enter to redeem the coupon
The maximum amount of usages the coupon code has, -1 = infinite
The percentage that should be subtracted from the total order cost when used
Whether the coupon code is enabled and can be used in checkout
The object was successfully created.
The provided form information is not valid, check that the provided data is valid. You can use the 'invalidFields' field to get the list of invalid fields or just use the 'message' field.
You are not authorized, check your API key and try again.
You are not authorized to access this endpoint, you may be missing an API key scope or be requesting a privileged endpoint.
One of the objects referenced by the ID given in the URL or form was not found, check the ID and try again.
POST /stores/{storeId}/coupons HTTP/1.1
Host: api.sellsn.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 73
{
"name": "text",
"maximumUsages": 1,
"percentageDecrease": 1,
"isEnabled": true
}{
"success": true,
"message": "text",
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"dateCreated": "2025-08-31T06:24:52.848Z",
"name": "text",
"uses": 1,
"maximumUses": 1,
"percentageDecrease": 1,
"isEnabled": true
}
}The ID of the store that the coupon belongs to
The ID of the coupon to update
The data-transfer object for a coupon, can be used for creating or updating a coupon and returned by the API when getting coupons
The case-sensitive name the customer will enter to redeem the coupon
The maximum amount of usages the coupon code has, -1 = infinite
The percentage that should be subtracted from the total order cost when used
Whether the coupon code is enabled and can be used in checkout
The object was successfully updated.
The provided form information is not valid, check that the provided data is valid. You can use the 'invalidFields' field to get the list of invalid fields or just use the 'message' field.
You are not authorized, check your API key and try again.
You are not authorized to access this endpoint, you may be missing an API key scope or be requesting a privileged endpoint.
One of the objects referenced by the ID given in the URL or form was not found, check the ID and try again.
PUT /stores/{storeId}/coupons/{couponId} HTTP/1.1
Host: api.sellsn.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 73
{
"name": "text",
"maximumUsages": 1,
"percentageDecrease": 1,
"isEnabled": true
}{
"success": true,
"message": "text",
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"dateCreated": "2025-08-31T06:24:52.848Z",
"name": "text",
"uses": 1,
"maximumUses": 1,
"percentageDecrease": 1,
"isEnabled": true
}
}Deletes an existing coupon from the store. Requires the Scopes.DeleteCoupons permission
The ID of the store the coupon belongs to
The ID of the coupon to delete
The object was successfully deleted.
The provided form information is not valid, check that the provided data is valid. You can use the 'invalidFields' field to get the list of invalid fields or just use the 'message' field.
You are not authorized, check your API key and try again.
You are not authorized to access this endpoint, you may be missing an API key scope or be requesting a privileged endpoint.
One of the objects referenced by the ID given in the URL or form was not found, check the ID and try again.
DELETE /stores/{storeId}/coupons/{couponId} HTTP/1.1
Host: api.sellsn.io
Authorization: Bearer JWT
Accept: */*
{
"success": true,
"message": "text",
"data": null
}Last updated
Was this helpful?