Skip to main content
GET
/
open-api
/
v1.0
/
promotions
/
{promotionId}
Get a promotion by id
curl --request GET \
  --url https://api.fourthwall.com/open-api/v1.0/promotions/{promotionId} \
  --header 'Authorization: Bearer <token>'
{
  "type": "<string>",
  "id": "<string>",
  "title": "<string>",
  "code": "<string>",
  "discount": {
    "type": "<string>",
    "money": {
      "value": 10,
      "currency": "USD"
    },
    "freeShipping": true
  },
  "status": "Live",
  "requirements": {
    "minimumOrderValue": {
      "value": 10,
      "currency": "USD"
    }
  },
  "usageCount": 123,
  "limits": {
    "maximumUsesNumber": 123,
    "oneUsePerCustomer": true
  },
  "appliesTo": {
    "type": "<string>"
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

promotionId
string
required

Response

OK

type
string
required
Allowed value: "SHOP_AUTO_APPLYING"
id
string
required
title
string
required
code
string
required
discount
Fixed Amount · object
required
status
enum<string>
required
Available options:
Live,
Ended,
Archived,
AllUsed
requirements
Shop · object
required
usageCount
integer<int32>
required
limits
Promotion Limits · object
required
appliesTo
Entire Order · object
required