Skip to main content
POST
Verify Commerce State

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
correlations
object[]

Order, return or price-book sync correlations. May accompany product targets.

Required array length: 1 - 50000 elements
productIds
string[]

Product or variant ids to verify together. Use every distinct productId returned by the completed commerce jobs (max 50000, bounded concurrency).

Required array length: 1 - 50000 elements
Minimum string length: 1
expected
object

Expected commerce state after a write (price, quantity, listingStatus, etc).

targets
object[]

Per-product expected states for a mixed-value batch. Use every successful item's productId and commerceReceipt.expected together. Do not combine with productIds or shared expected. Identical duplicates are deduplicated; conflicting expectations are rejected.

Required array length: 1 - 50000 elements
action
enum<string>

Lifecycle action being verified. Use delete for Omni-only delete checks.

Available options:
price,
inventory,
publish,
update,
delist,
delete
platforms
string[]

Optional marketplace filter: shopee, lazada, tiktok, shopify, whatsapp, zalora, amazon, ebay.

Minimum string length: 1
includeOmni
boolean

Also assert Omni DB fields (default true).

organizationId
string
Required string length: 1 - 120

Response

Request completed. Inspect data.success, per-target results and pendingCount for processing progress.

ok
boolean
required
apiVersion
string
required
operationId
string<uuid>
required
status
enum<string>
required
Available options:
completed
data
object
required
warnings
string[]
required
recommendations
string[]
required