GET
/
vendor
/
promotions
{
  "promotions": [
    {
      "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>"
            }
          ]
        }
      ]
    }
  ],
  "count": 123,
  "offset": 123,
  "limit": 123
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
offset
number

The number of items to skip before starting to collect the result set.

​
limit
number

The number of items to return.

​
fields
string

Comma-separated fields to include in the response.

Response

200 - application/json

OK

The response is of type object.