Skip to main content
GET
/
open-api
/
v1.0
/
promotions
Get all promotions
curl --request GET \
  --url https://api.fourthwall.com/open-api/v1.0/promotions \
  --header 'Authorization: Bearer <token>'
{
  "results": [
    {
      "id": "<string>",
      "code": "<string>",
      "discount": {
        "percentage": 123,
        "type": "<string>",
        "money": {
          "value": 10,
          "currency": "USD"
        },
        "freeShipping": true,
        "shippingOption": "Included"
      },
      "status": "Live",
      "requirements": {
        "minimumOrderValue": {
          "value": 10,
          "currency": "USD"
        }
      },
      "usageCount": 123,
      "limits": {
        "maximumUsesNumber": 123,
        "oneUsePerCustomer": true
      },
      "appliesTo": {
        "type": "<string>"
      },
      "type": "<string>",
      "title": "<string>"
    }
  ],
  "total": 123,
  "page": 123,
  "size": 123,
  "totalPages": 123
}
OAuth scope: promotions_readAPI keys have full access to this endpoint.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

page
integer<int32>
default:0
size
integer<int32>
default:20

Response

200 - application/json

OK

results
Auto Applying Shop Promotion · object · Auto Applying Shop Promotion · object · Auto Applying Shop Promotion · object · Auto Applying Shop Promotion · object · Auto Applying Shop Promotion · object · Multi Memberships Promotion · object · Multi Shop Promotion · object · Single Memberships Promotion · object · Single Shop Promotion · object[]
required
total
integer<int32>
page
integer<int32>
size
integer<int32>
totalPages
integer<int32>