Skip to main content
POST
Track order transaction

Authorizations

x-api-key
string
header
required

Unified API key for server-side SDK and API integrations

Body

application/json

One order-transaction.v2 Order Transaction: a paid order with its products, or a refund of one.

One order-transaction.v2 Order Transaction: a paid order with its products, or a refund of one.

type
enum<string>
required
Available options:
order
source
string
required

The store this order comes from, named by the caller, for example my-shop or salla:4821. Case-sensitive. Together with orderId it identifies the order, and it names the store for Personal Picks and diagnostics.

Required string length: 1 - 100
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]*$
orderId
string
required

Your order ID. Sending the same source and orderId again updates the order.

Required string length: 1 - 255
occurredAt
string<date-time>
required

When the order was paid.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
currency
string
required

ISO 4217 currency code, for example EUR.

Pattern: ^[A-Z]{3}$
totals
object
required

Order totals in the order currency.

customer
object
required

The customer who placed the order.

lineItems
object[]

Products in the order. Orders without line items still count for revenue.

Maximum array length: 500
historical
boolean
default:false

Past order or refund imported as history. It counts like any other but never starts a Journey, also not through Segment entry.

Response

Default Response

eventId
string<uuid>
required

The stored Order Transaction.

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)$
profileId
string<uuid>
required

Resolved Profile id.

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)$
outcome
enum<string>
required

created: first time this order or refund was sent. updated: it was stored before and its details changed. unchanged: a retry with the same details.

Available options:
created,
updated,
unchanged
matchedJourneys
integer
required

Active Journeys whose entry event matched.

Required range: 0 <= x <= 9007199254740991
enrolledJourneys
integer
required

Journey enrollments this order started.

Required range: 0 <= x <= 9007199254740991
skippedJourneys
integer
required

Matched Journeys skipped by filters or eligibility.

Required range: 0 <= x <= 9007199254740991