Skip to main content
GET
/
api-offers
/
coupon
/
{couponId}
Get a specific coupon
curl --request GET \
  --url https://live.copilot.fabric.inc/api-offers/coupon/{couponId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-site-context: <x-site-context>'
{
  "_id": "abcdefg1ee7ce20123456789",
  "promoId": 100013,
  "promoCodes": {
    "0": "SUMMER100",
    "1": "SUMMER20"
  },
  "state": "SCHEDULED",
  "isImplicit": false,
  "title": "CREATE PROMO",
  "buyOperator": "OR",
  "promo": [
    {
      "discount": [
        {
          "unit": "%OFF",
          "value": 10,
          "discountId": 1,
          "autoAdd": false,
          "ON": {
            "kind": "SKU",
            "value": "*",
            "quantity": 2,
            "includeOperator": "OR",
            "excludeOperator": "AND"
          },
          "set": [
            "A"
          ]
        }
      ],
      "targetProducts": [
        {
          "kind": "SKU",
          "value": "*",
          "operator": "IN",
          "discountId": 1
        }
      ],
      "condition": [
        {
          "operator": "AND",
          "includeOperator": "OR",
          "excludeOperator": "AND",
          "conditions": [
            {
              "key": "SKU",
              "value": "*",
              "operator": "IN"
            }
          ],
          "set": "A"
        }
      ]
    }
  ],
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-25T14:15:22Z",
  "isExclusive": true,
  "type": "PRODUCT",
  "stackingType": "STACKABLE",
  "level": 1,
  "termsAndConditions": [
    {
      "title": "Terms Applied",
      "description": "Items cannot be exchanged"
    }
  ],
  "promotionMessages": [
    {
      "title": "Buy 1 get 1 free",
      "message": "Offer valid at participating stores through September 5, 2023.",
      "pages": [
        "PDP",
        "Cart"
      ],
      "locales": [
        "en-CA",
        "fr-CA"
      ]
    }
  ],
  "proximityMessages": [
    {
      "threshold": 1,
      "localizedMessages": [
        {
          "locales": [
            "<string>"
          ],
          "message": "<string>"
        }
      ]
    }
  ],
  "shipmentMethodIds": [
    1000001
  ],
  "eligiblePriceList": [
    10000056
  ],
  "limits": [],
  "note": "Independence day sale!",
  "createdAt": "2019-08-20T14:15:22Z",
  "updatedAt": "2019-08-20T14:15:22Z"
}

Authorizations

​
Authorization
string
header
required

Headers

​
x-site-context
string
required
Example:

Path Parameters

​
couponId
string
required

Response

​
_id
string
Example:
​
promoId
number
Example:
​
promoCodes
string[]
Example:
​
state
enum<string>
Available options:
ACTIVE,
SCHEDULED,
DISABLED,
EXPIRED
Example:
​
isImplicit
boolean
Example:
​
title
string
Example:
​
buyOperator
enum<string>
default:OR
Available options:
AND,
OR
Example:
​
promo
object[]
​
startDate
string<date-time>
Example:
​
endDate
string<date-time>
Example:
​
isExclusive
boolean
Example:
​
type
enum<string>
Available options:
PRODUCT,
CART,
QUANTITY,
BOGO,
SHIPPING,
BUYGET,
SPEND_GET
Example:
​
stackingType
enum<string>
Available options:
STACKABLE,
EXCLUSIVE,
TYPE_EXCLUSIVE,
UNIVERSAL
Example:
​
level
integer
Example:
​
termsAndConditions
object[]
​
promotionMessages
object[]
​
proximityMessages
object[]
​
shipmentMethodIds
string[]
​
eligiblePriceList
number[]
​
limits
object[]
Example:
​
note
string
Example:
​
createdAt
string<date-time>
Example:
​
updatedAt
string<date-time>
Example: