Developers

Coupons

Markdown

List coupons

Discount coupons with their type, value and usage.

GET/stores/{storeId}/v1/coupons

Query parameters

limitinteger = 25
cursorstring

Response

dataarray<object>required
idinteger
codestring
typeobject
percent fixed
valuestring
Discount percentage or amount.
usageinteger
Number of uses.
expirystring | null (date)
activeboolean
executionobject
Who executed the request: the app, version, installation and store. Field names here are camelCase.
appIdstring (uuid)
versionIdstring (uuid)
installationIdstring (uuid)
storeIdstring (uuid)
requestIdstring (uuid)
generationinteger
routeEpochinteger
appAuthEpochinteger
grantRevisioninteger
metaobjectrequired
next_cursorstring | null
Cursor for the next page, or null on the last page.
request_idstring (uuid)

Errors

HTTPCodeMeaning
503APPS_SCOPE_RUNTIME_NOT_READYThe resource is not enabled on this merchant's store yet.

Shared codes are listed in Errors.

    ↑↓ moveEnter openEsc close