Skip to main content
POST
/
api-offers
/
coupon
/
search
Search for coupons
curl --request POST \
  --url https://live.copilot.fabric.inc/api-offers/coupon/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '{
  "offset": 0,
  "limit": 10,
  "sort": "+updatedAt",
  "filters": [
    {
      "field": "title",
      "value": "Black Friday",
      "operator": "EQUAL"
    }
  ]
}'
{
  "query": {
    "limit": 10,
    "offset": 0,
    "count": 50
  },
  "data": [
    {
      "_id": "abcdefg1ee7ce20123456789",
      "promoId": 100013,
      "promoCodes": [
        "SUMMER100",
        "SUMMER20"
      ],
      "promoCount": 0,
      "state": "SCHEDULED",
      "isImplicit": true,
      "title": "CREATE PROMO",
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-25T14:15:22Z",
      "isExclusive": true,
      "eligiblePriceList": [
        10000056
      ],
      "level": 1,
      "stackingType": "STACKABLE",
      "updatedAt": "2019-08-20T14:15:22Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Headers

​
x-site-context
string
required
Example:

Body

application/json
​
offset
number
Required range: x >= 0
Example:
​
limit
number
default:10
Required range: 1 <= x <= 100
Example:
​
sort
enum<string>
Available options:
+updatedAt,
+title,
+startDate,
+endDate,
+level,
-updatedAt,
-title,
-startDate,
-endDate,
-level
​
filters
object[]

Response

​
query
object
​
data
object[]