GET
List discount campaigns
Company space For: Manager · Permission: discount_campaigns.list Part of Run discount campaigns.

Authorizations

Authorization
string
header
required

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

Query Parameters

per_page
integer | null

Number of items per page.

Required range: 1 <= x <= 100
cursor
string | null

Position in the list. Pass the meta.next_cursor or meta.prev_cursor value of the previous page; leave it out to get the first page.

sort_by
enum<string> | null

Field the list is sorted by.

Available options:
id,
name,
status,
activation_mode,
discount_type,
application_scope,
access_mode,
starts_at
sort_order
enum<string> | null

asc for ascending order, desc for descending order.

Available options:
asc,
desc
name
string | null

Only the campaigns whose name is exactly this value.

Maximum string length: 255
code
string | null

Only the campaign with this code. The comparison ignores capitals and surrounding spaces.

Maximum string length: 255
status
enum<string> | null

Only the campaigns in this status: draft, active, paused or archived.

Available options:
draft,
active,
paused,
archived
activation_mode
enum<string> | null

Only the campaigns with this activation mode: automatic (applies by itself) or code (the customer gives a code).

Available options:
automatic,
code
discount_type
enum<string> | null

Only the campaigns of this type: percentage or fixed.

Available options:
percentage,
fixed
application_scope
enum<string> | null

Only the campaigns with this scope: order (the whole order) or stockables (chosen product units).

Available options:
order,
stockables
access_mode
enum<string> | null

Only the campaigns with this access mode: public (everyone) or restricted (only customers given access).

Available options:
public,
restricted
combination_policy
enum<string> | null

Only the campaigns with this combination policy: exclusive or stackable.

Available options:
exclusive,
stackable
response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, name, description, activation_mode, code, status, discount_type, tier_basis, currency_code, currency_exponent, application_scope, access_mode, combination_policy, usage_limit, usage_pool_limit, usage_limit_per_customer, starts_at, ends_at, metadata, created_at, updated_at, stockable_units.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: conditions, tiers.

Response

Resource.

data
DiscountCampaignResource · object[]
required

Items of this page.

meta
object
required

Pagination details.