Promotions

Get all promotions

Changed on

Rate limit: 100 requests / 10 seconds per shop. See Rate limiting.

Returns all promotions. The maximum page size is 100 - larger values are capped at 100.

get/open-api/v1.0/promotions

Request

  • Base URL
    https://api.fourthwall.com
  • URL
    https://api.fourthwall.com/open-api/v1.0/promotions
  • Auth
    • OAuth 2
      Implicit: https://auth.staging.fourthwall.com/auth/realms/Fourthwall/protocol/openid-connect/auth
      Scopes: promotions_read
    • or HTTP basic

Query parameters

pageinteger
sizeinteger

Number of elements per page. The maximum page size is 100 - larger values are capped at 100.

codesstring[]

Filter by promotion code(s)

Response

OK

totalinteger
pageinteger
sizeinteger
totalPagesinteger

Example response

{
  "results": [
    {
      "discount": {
        "money": {
          "value": 10,
          "currency": "USD"
        }
      },
      "requirements": {
        "minimumOrderValue": {
          "value": 10,
          "currency": "USD"
        }
      }
    }
  ]
}

Changes