POST
/
vendor
/
promotions
{
  "promotion": {
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "code": "<string>",
    "is_automatic": true,
    "type": "<string>",
    "application_method": {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "value": 123,
      "max_quantity": "<string>",
      "apply_to_quantity": "<string>",
      "buy_rules_min_quantity": "<string>",
      "type": "<string>",
      "target_type": "<string>",
      "allocation": "<string>",
      "target_rules": [
        {
          "id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "description": "<string>",
          "attribute": "<string>",
          "operator": "<string>",
          "values": [
            {
              "value": "<string>"
            }
          ]
        }
      ]
    },
    "rules": [
      {
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "attribute": "<string>",
        "operator": "<string>",
        "values": [
          {
            "value": "<string>"
          }
        ]
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
code
string

The code of the promotion.

is_automatic
boolean
default:false

Whether the promotion is applied automatically.

status
enum<string>

The status of the promotion.

Available options:
draft,
active,
inactive
campaign_id
string

The campaign id.

campaign
object
type
enum<string>

The type of the promotion.

Available options:
standard
application_method
object
rules
object[]

Promotion rules.

Response

201 - application/json

Created

promotion
object

Promotion object