Coupons

Activate or deactivate a coupon

Does not create coupons or change their value; it only activates and deactivates them.

PATCH/stores/{storeId}/v1/coupons/{id}/status

Scopecoupons.status:writeActivate and deactivate coupons

Path parameters

idstringrequired

Headers

If-Matchstringrequired: ETag from a GET of this same resource projection.

Request body

activebooleanrequired

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

HTTP	Code	Meaning
503	`APPS_SCOPE_RUNTIME_NOT_READY`	The resource is not enabled on this merchant's store yet.

Shared codes are listed in Errors.

curl -X PATCH "https://larm.sa/stores/$STORE_ID/v1/coupons/9/status" \ -H "Authorization: Bearer $ACCESS_TOKEN" \ -H "If-Match: $ETAG" \ -H "Content-Type: application/json" \ -d '{ "active": false }'

{ "data": { "id": 9, "code": "WELCOME10", "type": "percent", "value": "10.00", "usage": 41, "expiry": "2026-12-31", "active": false }, "execution": { "appId": "1f2e3d4c-5b6a-4978-8695-a4b3c2d1e0f9", "versionId": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d", "installationId": "c7e4a1f2-6b3d-4e8a-9c05-1d2f3a4b5c6d", "storeId": "5b1d7a62-0c4e-4f38-9a51-2e7b3c9d8f10", "requestId": "3f0c2b8e-7a51-4c1e-9d0a-5b6f1e2d4c3a", "generation": 1, "routeEpoch": 4, "appAuthEpoch": 1, "grantRevision": 2 }, "meta": { "request_id": "3f0c2b8e-7a51-4c1e-9d0a-5b6f1e2d4c3a" } }