Coupons

Get yourself more purchases with a coupon, but maybe not more profit...

PreviousTickets NextMiscellaneous objects

Last updated 1 year ago

Was this helpful?

Delete coupon

delete

Deletes an existing coupon from the store. Requires the Scopes.DeleteCoupons permission

Authorizations

Path parameters

storeIdstring · uuidrequired

The ID of the store the coupon belongs to

couponIdstring · uuidrequired

The ID of the coupon to delete

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.sellsn.io/stores/{storeId}/coupons/{couponId}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

text/plain

application/json

text/json

{
  "success": true,
  "message": "text",
  "data": null
}

The object was successfully deleted.

Get coupons

get

Gets the coupons in the store. Requires the Scopes.ViewCoupons API key scope

Authorizations

Path parameters

storeIdstring · uuidrequired

The ID of the store to get the coupons in

pageinteger · int32required

The page to select when viewing the coupons

Query parameters

countinteger · int32optional

The amount of coupons to display in one page

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.sellsn.io/stores/{storeId}/coupons/{page}' \
  --header 'Authorization: Bearer JWT'

200

401

403

404

text/plain

application/json

text/json

{
  "success": true,
  "pages": 1,
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "dateCreated": "2025-04-03T08:10:28.032Z",
      "name": "text",
      "uses": 1,
      "maximumUses": 1,
      "percentageDecrease": 1,
      "isEnabled": true
    }
  ]
}

The object was successfully returned.

Create coupon

post

Creates a new coupon in the store. Requires the Scopes.CreateCoupons API key scope

Authorizations

Path parameters

storeIdstring · uuidrequired

The ID of the store to create the coupon in

Body

namestring · min: 3 · max: 25required

The case-sensitive name the customer will enter to redeem the coupon

maximumUsagesinteger · int32optional

The maximum amount of usages the coupon code has, -1 = infinite

percentageDecreasenumber · doubleoptional

The percentage that should be subtracted from the total order cost when used

isEnabledbooleanoptional

Whether the coupon code is enabled and can be used in checkout

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.sellsn.io/stores/{storeId}/coupons' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "maximumUsages": 1,
    "percentageDecrease": 1,
    "isEnabled": true
  }'

200

400

401

403

404

text/plain

application/json

text/json

{
  "success": true,
  "message": "text",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "dateCreated": "2025-04-03T08:10:28.032Z",
    "name": "text",
    "uses": 1,
    "maximumUses": 1,
    "percentageDecrease": 1,
    "isEnabled": true
  }
}

The object was successfully created.

Update coupon

put

Authorizations

Path parameters

storeIdstring · uuidrequired

The ID of the store that the coupon belongs to

couponIdstring · uuidrequired

The ID of the coupon to update

Body

namestring · min: 3 · max: 25required

The case-sensitive name the customer will enter to redeem the coupon

maximumUsagesinteger · int32optional

The maximum amount of usages the coupon code has, -1 = infinite

percentageDecreasenumber · doubleoptional

The percentage that should be subtracted from the total order cost when used

isEnabledbooleanoptional

Whether the coupon code is enabled and can be used in checkout

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://api.sellsn.io/stores/{storeId}/coupons/{couponId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "maximumUsages": 1,
    "percentageDecrease": 1,
    "isEnabled": true
  }'

200

400

401

403

404

text/plain

application/json

text/json

{
  "success": true,
  "message": "text",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "dateCreated": "2025-04-03T08:10:28.032Z",
    "name": "text",
    "uses": 1,
    "maximumUses": 1,
    "percentageDecrease": 1,
    "isEnabled": true
  }
}

The object was successfully updated.