Create Promotion

Create a promotion.

curl --location -g --request POST '{{BASE_URL}}/admin/promotions' \ --header 'Content-Type: application/json' \ --data-raw '{ "code": "string", "is_automatic": true, "campaign_id": "string", "type": "standard", "campaign": { "name": "string", "campaign_identifier": "string", "description": "string", "starts_at": "2019-08-24T14:15:22Z", "ends_at": "2019-08-24T14:15:22Z", "budget": { "limit": 0, "currency_code": "string", "type": "spend" } }, "rules": [ { "description": "string", "attribute": "items.product.id", "operator": "gte", "values": "prod_123" } ], "application_method": { "description": "string", "value": 0, "currency_code": "string", "max_quantity": 0, "apply_to_quantity": 0, "buy_rules_min_quantity": 0, "type": "fixed", "target_type": "order", "allocation": "each", "target_rules": [ { "description": "string", "attribute": "items.product.id", "operator": "gte", "values": "prod_123" } ], "buy_rules": [ { "description": "string", "attribute": "items.product.id", "operator": "gte", "values": "prod_123" } ] }, "additional_data": {} }'

{ "promotion": { "application_method": { "promotion": {}, "target_rules": [ { "id": "string", "description": "string", "attribute": "customer_group_id", "operator": "gt", "values": [ "cusgroup_123" ] } ], "buy_rules": [ { "id": "string", "description": "string", "attribute": "customer_group_id", "operator": "gt", "values": [ "cusgroup_123" ] } ], "id": "string", "value": 0, "currency_code": "usd", "max_quantity": 0, "buy_rules_min_quantity": 0, "apply_to_quantity": 0, "type": "fixed", "target_type": "items", "allocation": "each" }, "campaign": { "id": "string", "name": "string", "description": "string", "currency": "string", "campaign_identifier": "string", "starts_at": "string", "ends_at": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "budget": { "id": "string", "currency_code": "string", "limit": 0, "used": 0, "type": "spend" } }, "rules": [ { "id": "string", "description": "string", "attribute": "customer_group_id", "operator": "gt", "values": [ "cusgroup_123" ] } ], "id": "string", "code": "OFF50", "is_automatic": true, "campaign_id": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "type": "standard", "status": "draft" } }

Request

Authorization

Query Params

fields

string

fields

optional

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

Body Params application/json

The promotion's details.

code

string

code

required

The promotion's code.

is_automatic

boolean

is_automatic

optional

Whether the promotion is applied automatically.

campaign_id

string

campaign_id

required

The ID of the campaign that the promotion belongs to.

type

enum<string>

required

The promotion's type.

Allowed values:

standardbuyget

campaign

object

optional

The details of a campaign to create and add the promotion to it.

name

string

name

required

The campaign's name.

campaign_identifier

string

campaign_identifier

required

The campaign's identifier.

description

string

description

required

The campaign's description.

starts_at

string <date-time>

starts_at

required

The campaign's start date.

ends_at

string <date-time>

ends_at

required

The campaign's end date.

budget

object

required

The campaign's budget which, when crossed, ends the campaign.

rules

array [object {4}]

optional

The promotion's rules.

description

string

description

required

The rule's description.

attribute

string

attribute

required

The attribute to compare against when checking whether a promotion can be applied on a cart.

Example:

items.product.id

operator

enum<string>

required

The operator used to check whether the buy rule applies on a cart. For example, eq means that the cart's value for the specified attribute must match the specified value.

Allowed values:

gteltegtlteqnein

values

required

application_method

object

required

The promotion's application method.

description

string

description

required

The application method's description.

value

number

value

required

The discounted amount applied by the associated promotion based on the type.

currency_code

string

currency_code

required

The application method's currency code.

max_quantity

number

max_quantity

required

The max quantity allowed in the cart for the associated promotion to be applied.

apply_to_quantity

number

apply_to_quantity

required

The quantity that results from matching the buyget promotion's condition. For example, if the promotion is a "Buy 2 shirts get 1 free", the value f this attribute is 1.

buy_rules_min_quantity

number

buy_rules_min_quantity

required

The minimum quantity required for a buyget promotion to be applied. For example, if the promotion is a "Buy 2 shirts get 1 free", the value of this attribute is 2.

type

enum<string>

required

The type of the application method indicating how the associated promotion is applied.

Allowed values:

fixedpercentage

target_type

enum<string>

required

The target type of the application method indicating whether the associated promotion is applied to the cart's items, shipping methods, or the whole order.

Allowed values:

ordershipping_methodsitems

allocation

enum<string>

optional

The allocation value that indicates whether the associated promotion is applied on each item in a cart or split between the items in the cart.

Allowed values:

eachacross

target_rules

array [object {4}]

optional

The application method's target rules.

buy_rules

array [object {4}]

optional

The application method's buy rules.

additional_data

object

optional

Pass additional custom data to the API route. This data is passed to the underlying workflow under the additional_data parameter.

Examples

Responses

🟢200OK

application/json

Body

The promotion's details.

promotion

object (AdminPromotion)

required

The promotion's details.

application_method

object (AdminApplicationMethod)

optional

The application method's details.

campaign

object (AdminCampaign)

optional

The campaign's details.

rules

array[object (AdminPromotionRule) {5}]

optional

The promotion's rules.

string

required

The promotion's ID.

code

string

code

optional

The promotion's code.

Example:

OFF50

is_automatic

boolean

is_automatic

optional

Whether the promotion is applied on a cart automatically if it matches the promotion's rules.

campaign_id

string

campaign_id

optional

The ID of the campaign this promotion belongs to.

created_at

string <date-time>

created_at

required

The date the promotion was created.

updated_at

string <date-time>

updated_at

required

The date the promotion was updated.

deleted_at

string <date-time>

deleted_at

required

The date the promotion was deleted.

type

enum<string>

optional

The promotion's type.

Allowed values:

standardbuyget

status

enum<string>

optional

The promotion's status.

Allowed values:

draftactiveinactive

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠409409

🟠422Parameter Error

🔴500Server Error