Developers

Coupons

Markdown

Get a coupon

A coupon by its ID.

GET/stores/{storeId}/v1/coupons/{id}

Path parameters

idstringrequired

Response

dataobjectrequired
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
request_idstring (uuid)
The request ID; include it in any support request.

Errors

HTTPCodeMeaning
404RESOURCE_NOT_FOUNDThe ID does not exist in this store.
503APPS_SCOPE_RUNTIME_NOT_READYThe resource is not enabled on this merchant's store yet.

Shared codes are listed in Errors.

    ↑↓ moveEnter openEsc close