Skip to main content
POST
/
open-api
/
v1.0
/
promotions
Create a promotion
curl --request POST \
  --url https://api.fourthwall.com/open-api/v1.0/promotions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "<string>",
  "discount": {
    "percentage": 123,
    "shipping": "Excluded",
    "type": "<string>",
    "money": {
      "value": 10,
      "currency": "USD"
    },
    "freeShipping": true
  },
  "type": "<string>",
  "codes": [
    "<string>"
  ],
  "requirements": {
    "newMembersOnly": true,
    "minimumOrderValue": {
      "value": 10,
      "currency": "USD"
    }
  },
  "appliesToProducts": {
    "productIds": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "oncePerOrder": true
  },
  "limits": {
    "oneUsePerCustomer": true,
    "maximumUse": 123
  },
  "subscriptionType": {
    "type": "<string>"
  },
  "tiers": {
    "type": "<string>"
  }
}
'
{
  "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>"
}
OAuth scope: promotions_writeAPI 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.

Body

application/json
​
code
string
required
​
discount
Percentage · object
required
​
type
string
required
Allowed value: "MEMBERSHIPS_MULTI"
​
codes
string[]
required
​
requirements
Memberships · object
​
appliesToProducts
Open Api Promotion Selected Products · object
​
limits
Open Api Promotion Limits · object
​
subscriptionType
All Members · object
​
tiers
All Tiers · object

Response

OK

​
id
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
​
type
string
required
Allowed value: "SHOP_AUTO_APPLYING"
​
title
string
required