Skip to main content
GET
List Campaign Offers

Authorizations

Authorization
string
header
required

Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.

Path Parameters

campaignId
string<uuid>
required

Query Parameters

kind
enum<string>
default:all
Available options:
all,
product_discount,
flash_sale,
voucher,
gift_with_purchase,
buy_x_get_y,
bundle_deal,
free_shipping,
early_bird_price
window
string
default:all
Maximum string length: 160
review
enum<string>
default:all
Available options:
all,
attention,
excluded
offset
integer
default:0
Required range: 0 <= x <= 100000
limit
integer
default:20
Required range: 1 <= x <= 50
organizationId
string

Required for session auth. Optional for an API key, which already identifies the organization.

Required string length: 1 - 120

Response

Canonical operation result. Inspect aggregate and per-target success and marketplace delivery evidence.

revision
number
required
offers
object[]
required
total
integer
required
Required range: 0 <= x <= 9007199254740991
hasMore
boolean
required
nextOffset
integer
required
Required range: 0 <= x <= 9007199254740991