Skip to main content
POST
Submit or update a verified order

Authorizations

Authorization
string
header
required

Store-specific secret generated in Website & sales. Never expose in browser code.

Body

application/json
orderId
string
required

Stable identifier, trimmed before validation.

Required string length: 1 - 200
visitorId
string
required

SideShift visitor ID captured at checkout. Required for this custom-store endpoint.

Pattern: ^[a-zA-Z0-9_-]{16,128}$
totalCents
integer
required

Amount in the currency minor unit, despite the Cents suffix.

Required range: 0 <= x <= 100000000000
currency
string
required

Supported uppercase ISO 4217 currency code.

Example:

"USD"

occurredAt
string<date-time>
required

Original payment time in UTC. Cannot exceed current time by more than five minutes. Keep unchanged on refunds and retries.

refundedCents
integer
default:0

Cumulative refunded amount, at most totalCents. Never decreases on replay.

Required range: 0 <= x <= 100000000000
status
enum<string>
default:paid

A refunded order requires refundedCents equal to totalCents. Cancellation cannot be undone by replay.

Available options:
paid,
partially_refunded,
refunded,
cancelled
isSample
boolean
default:false

Sample orders do not earn commissions or send managed advertising purchases. Once true, cannot be undone by replay.

checkoutToken
string

Optional stable checkout correlation token.

Required string length: 16 - 200
items
object[]

Order line items.

Maximum array length: 500
advertising
object

Optional context returned by getAdvertisingContextAsync(). This identity differs from the top-level SideShift visitor ID.

Response

Accepted. duplicate is true for both replays and updates to existing orders. Acceptance does not guarantee creator attribution, payout, or advertising delivery.

accepted
enum<boolean>
required
Available options:
true
duplicate
boolean
required
orderId
string | null
required

Internal SideShift order ID, or null when privacy-redacted data is suppressed.