Skip to main content
POST
Find Eligible Promotion Products

Authorizations

Authorization
string
header
required

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

Body

application/json
targetStores
object[]
required
Required array length: 1 - 100 elements
organizationId
string

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

Required string length: 1 - 120
productIds
string<uuid>[]
Maximum array length: 50
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
q
string
default:""
Maximum string length: 500
limit
integer
default:20
Required range: 1 <= x <= 50

Response

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

{key}
any