Basic information
POST /{shopId}/coupon-campaigns
Creates a coupon campaign for a shop. Coupon campaign types can be FIX (absolute value), PERCENT (percentage value), and SHIPPING (waive delivery costs).
Authorisation
OAuth 2.0 Token required with scopes:
coupons_write
URI parameters
| Name | Type | Description |
|---|---|---|
shopId |
string |
The unique identifier of the shop. Required:
true
Example:
DemoShop
|
Query parameters
| Name | Type | Description |
|---|---|---|
locale |
string |
Represents the language code according to ISO 639-1 and the country code according to ISO 3166-1. If not provided, the shop’s default language is used. We recommend to always send this parameter with your request. If the default language had been changed in the administration, it might take up to 1 day until this change affects the shop. Required:
false
Example:
en_US
|
Request attributes
| Name | Type | Description |
|---|---|---|
|
object of couponCampaign (create request) |
Request body
Media type application/json
{
"identifier": "summer_sale_2019",
"name": "Summer Sale 2019",
"currency": "EUR",
"minimumOrderValue": 100,
"type": {
"name": "FIX",
"waiveShippingCosts": false
}
}
Response attributes
| Name | Type | Description |
|---|---|---|
|
object of couponCampaign |
Response
HTTP 201
Media type application/json
{
"campaignId": "5774E27E-0AD5-A8F6-7395-AC1532116DFC",
"identifier": "summer_sale_2019",
"name": "Summer Sale 2019",
"currency": "EUR",
"type": {
"name": "FIX",
"waiveShippingCosts": false
},
"minimumOrderValue": {
"taxType": "NONE",
"formatted": "100.00 €",
"amount": 100,
"currency": "EUR"
},
"links": [
{
"rel": "self",
"href": "https://pm.epages.com/rs/shops/apidocu/coupon-campaigns/5774E27E-0AD5-A8F6-7395-AC1532116DFC"
}
]
}