Skip to main content
GET
/
stores
/
{storeId}
/
coupons
/
{couponId}
Get coupon
curl --request GET \
  --url https://api.komerza.com/stores/{storeId}/coupons/{couponId} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "<string>",
  "code": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "dateCreated": "2023-11-07T05:31:56Z",
    "code": "<string>",
    "uses": 123,
    "maximumUses": 49999999,
    "isEnabled": true,
    "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "percentageDecrease": 50,
    "amountDecrease": 50000,
    "variantIds": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "expirationDate": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Your API key goes here

Path Parameters

​
storeId
string<uuid>
required

The ID of the store to get the coupons in

​
couponId
string<uuid>
required

The ID of the coupon to get

Response

The object was successfully returned.

Represents a default generic response for API endpoints.

​
success
boolean
required

Indicates whether the operation or response was successful.

​
message
string | null

A descriptive message providing additional context or information about the response.

​
code
string | null

The error code (if there was an error) to use when referencing the error

​
data
object

A coupon code can be used to reduce the cost of an order with a store for a specified percentage