Active Offers

QUERYactiveOffers: [ActiveOfferResponse!]!

Returns

activeOffers

id*String!

title*String!

type*DiscountType!

Value inPRODUCT_AMOUNTORDER_AMOUNTBUY_X_GET_YFREE_SHIPPING

badgeLabel*String!

Short label for badges, e.g. "Buy 1 Get 1" or "20% off".

value?

appliesTo?

buyXGetY?

freeShipping?

minimumRequirement?

endsAt?DateTime

A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.

Example Request

query ActiveOffers {
  activeOffers {
    id
    title
    type
    badgeLabel
    value {
      type
      amount
      maxAmount
    }
    appliesTo {
      scope
      productIds
      collectionIds
    }
    endsAt
  }
}

query ActiveOffers {  activeOffers {    id    title    type    badgeLabel    value {      type      amount      maxAmount    }    appliesTo {      scope      productIds      collectionIds    }    endsAt  }}

Example Response

{
  "data": {
    "activeOffers": [
      {
        "id": "string",
        "title": "string",
        "type": "PRODUCT_AMOUNT",
        "badgeLabel": "string",
        "value": {
          "type": "PERCENTAGE",
          "amount": 10.5,
          "maxAmount": 10.5
        },
        "appliesTo": {
          "scope": "ALL",
          "productIds": [
            "string"
          ],
          "collectionIds": [
            "string"
          ]
        },
        "endsAt": "<DateTime>"
      }
    ]
  }
}

Example Response

{  "data": {    "activeOffers": [      {        "id": "string",        "title": "string",        "type": "PRODUCT_AMOUNT",        "badgeLabel": "string",        "value": {          "type": "PERCENTAGE",          "amount": 10.5,          "maxAmount": 10.5        },        "appliesTo": {          "scope": "ALL",          "productIds": [            "string"          ],          "collectionIds": [            "string"          ]        },        "endsAt": "<DateTime>"      }    ]  }}

ReturnsCopy Anchor Link

Returns