Create a Cart Percent Discount Promotion

POST Create a Cart Percent Discount Promotion

https://api.moltin.com/v2/promotions/

Parameters

Headers

Name	Required	Type	Description
Authorization	Required	string	The Bearer token required to get access to the API.

Body

Name	Required	Type	Description
type	Required	string	Specifies the type of the resource. The type of resource for promotions is, promotion.
name	Required	string	Specifies a name for the promotion.
description	Required	string	Specifies a description for the promotion.
enabled	Required	boolean	Specifies whether the promotion is enabled. The options are true or false, and the default setting is false.
automatic	Required	boolean	Specifies whether the promotion is applied automatically to the cart or a code is required to apply the promotion. The default setting is false. When this value is set to true, a code is autogenerated. If this value is set to false, you must create the code manually. For more information about creating codes, see the Create Promotion Codes section.
promotion_type	Required	string	Specifies the type of the promotion. Use percent_discount for percentage discount for cart promotions.
max_discount_value	Optional	array	Specifies an array of currency-value objects, max_discount_value[].currency and max_discount_value[].amount, that provides the maximum possible discount for the cart.
min_cart_value	Optional	array	Specifies an array of currency-value objects, min_cart_value[].currency and min_cart_value[].amount, that provides the minimum cart value required for the promotion to apply. You can add one or several value specifications in different currencies.
schema	Required	object	Specifies the promotion value, currency, and the products to be excluded from the promotion, if any.
start	Required	string	Specifies the start date and time of the promotion or the start date of the promotion. You can provide a specific time in the HH:MM format. For example, "start": "2000-01-01 12:00". If no time is specified, the default start and end time is set to 00:00.
end	Required	string	Specifies the end date and time of the promotion or the end date of the promotion.

The schema object

Name	Required	Type	Description
schema.currencies[].currency	Required	string	Specifies a three-letter currency code. For example, USD.
schema.currencies[].percentage	Required	number	Specifies the discount percentage of the cart total value. For example, 10 represents 10% discount of the cart value of $100.
schema.exclude.targets	Optional	array [string]	Specifies the the SKUs of the products to be excluded from the promotion.
schema.exclude.nodes	Optional	array [string]	Specifies the unique identifiers of the nodes to be excluded from the promotion.
schema.exclude.attributes[].template	Optional	string	Specifies the name of the template slug to be excluded from a promotion.
schema.exclude.attributes[].field	Optional	string	Specifies the unique slug identifier for the field to be excluded from a promotion.
schema.exclude.attributes[].type	Optional	string	Specifies the type of the field, such as string, integer, boolean, float, or date.
schema.exclude.attributes[].value	Optional	Depending on the type of the field, value can be string, integer, boolean, float, or date.	Specifies the value of the field that was specified in the attributes.type. For example, you can specify any color in the value if you indicate color in the attributes.field.
schema.target_catalogs	Optional	array [string]	Specifies the unique identifiers of the catalogs to be applied for the promotion. If you do not set this parameter, promotion will be applied to all catalogs.

Request Example

curl -X POST 'https://api.moltin.com/v2/promotions' \
     -H "Authorization: Bearer 68302a5f3742875fbc647a20186a1b8932cad231' \
     -H 'accept: application/json' \
     -H 'content-type: application/json' \
   --data-raw '{
      "data": {
        "type": "promotion",
        "name": "10% off",
        "description": "10% off your order!",
        "enabled": true,
        "automatic": false,
        "promotion_type": "percent_discount",
        "max_discount_value": [
         {
          "amount": 1000,
          "currency": "USD"
         }
        ],
        "min_cart_value": [
         {
           "amount": 10000,
           "currency": "USD"
         }
       ],
        "schema": {
          "currencies": [
           {
             "currency": "USD",
             "percentage": 10
           }
           ],
          "exclude": {
            "targets": [
              "sku1",
              "sku2"
           ],
            "nodes": ['{{nodeId}}'],
            "attributes": [
              {
              "template": "products(test_template)",
              "field": "a-color",
              "type": "string",
              "value": "black"
          }
        ]
      },
        "target_catalogs": [
          "{{catalogId}}"
        ]
    },
    "start": "2000-01-01",
    "end": "2100-01-01"
  }
}'

Response Example

201 Created

{
    "data": {
        "type": "promotion",
        "id": "c5e13d6c-c3ad-47c0-bf35-e59d83cbe4dc",
        "parent_id": "c5e13d6c-c3ad-47c0-bf35-e59d83cbe4dc",
        "name": "10% off",
        "description": "10% off your order!",
        "enabled": true,
        "current": true,
        "promotion_type": "percent_discount",
        "min_cart_value": [
            {
                "currency": "USD",
                "amount": 10000
            }
        ],
        "max_discount_value": [
            {
                "currency": "USD",
                "amount": 1000
            }
        ],
        "schema": {
            "currencies": [
                {
                    "currency": "USD",
                    "percentage": 10
                }
            ],
            "exclude": {
                "targets": [
                    "sku1",
                    "sku2"
                ],
                "nodes": [
                    "node1"
                ],
                "attributes": [
                    {
                        "template": "products(test_template)",
                        "field": "a-color",
                        "type": "string",
                        "value": "black"
                    }
                ]
            },
            "target_catalogs": [
                "{{catalogId}}"
            ]
        },
        "start": "2000-01-01T00:00:00Z",
        "end": "2100-01-01T00:00:00Z",
        "created_by": "seller@elasticpath.com",
        "updated_by": "another_seller@elasticpath.com",
        "meta": {
            "timestamps": {
                "created_at": "2022-09-27T18:53:47.877Z",
                "updated_at": "2022-09-27T18:53:47.877Z"
            }
        }
    }
}