List Promotions

GET

/admin/promotions

Promotions

Retrieve a list of promotions. The promotions can be filtered by fields such as id. The promotions can also be sorted or paginated.

Response Example

200 - Example 1

{
    "limit": 0,
    "offset": 0,
    "count": 0,
    "promotions": [
        {
            "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.

offset

number

offset

optional

The number of items to skip when retrieving a list.

limit

number

limit

optional

Limit the number of items returned in the list.

order

string

order

optional

The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.

string

optional

Search term to filter the promotion's searchable attributes.

code

optional

One of

code

array[string]

Filter by a promotion code.

campaign_id

optional

One of

campaign_id

array[string]

Filter by a campaign's ID to retrieve its associated promotions.

currency_code

optional

One of

currency_code

array[string]

Filter by a currency code.

$ne

array[string]

optional

Filter by values not equal to this parameter.

Example:

["","",""]

$gt

array[string]

optional

Filter by values greater than this parameter. Useful for numbers and dates only.

Example:

["","",""]

$gte

array[string]

optional

Filter by values greater than or equal to this parameter. Useful for numbers and dates only.

Example:

["","",""]

$lt

array[string]

optional

Filter by values less than this parameter. Useful for numbers and dates only.

Example:

["","",""]

$lte

array[string]

optional

Filter by values less than or equal to this parameter. Useful for numbers and dates only.

Example:

["","",""]

$like

array[string]

optional

Apply a like filter. Useful for strings only.

Example:

["","",""]

$re

array[string]

optional

Apply a regex filter. Useful for strings only.

Example:

["","",""]

$ilike

array[string]

optional

Apply a case-insensitive like filter. Useful for strings only.

Example:

["","",""]

$fulltext

array[string]

optional

Filter to apply on full-text properties.

Example:

["","",""]

$exists

array[string]

optional

Filter by whether a value for this parameter exists (not null).

Example:

["","",""]

$and

array [object]

$and

optional

Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.

Example:

["","",""]

$or

array [object]

$or

optional

Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.

Example:

["","",""]

$in

array[string]

optional

Filter by values in this array.

Example:

["","",""]

$nin

array[string]

optional

Filter by values not in this array.

Example:

["","",""]

$overlap

array[string]

optional

Filter arrays that have overlapping values with this parameter.

Example:

["","",""]

$contains

array[string]

optional

Filter arrays that contain some of the values of this parameter.

Example:

["","",""]

$contained

array[string]

optional

Filter arrays that contain all values of this parameter.

Example:

["","",""]

$eq

array[string]

optional

Example:

["","",""]

$not

array[string]

optional

Example:

["","",""]

application_method_type

optional

One of

application_method_type

array[string]

Filter by an application method type. The promotions are filtered based on their application method's type.

Responses

🟢200OK

application/json

Body

The paginated list of promotions.

limit

number

limit

required

The maximum number of items returned.

offset

number

offset

required

The number of items skipped before retrieving the returned items.

count

number

count

required

The total number of items.

promotions

array[object (AdminPromotion) {12}]

required

The list of promotions.

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

Modified at 2025-06-17 04:10:32

Update a Promotion

Create Promotion