Skip to content

order.created

POST

Order created (order.created). Sent to an installation granted read_orders.

webhook-id
required
string
/^msg_[0-9a-z]{26}$/

The message id, the same on every attempt: deduplicate on it.

webhook-timestamp
required
integer

Seconds since the epoch at this attempt; refuse one too far from now.

webhook-signature
required
string

v1, + base64 HMAC-SHA256 of {webhook-id}.{webhook-timestamp}.{body} with the signing secret (Standard Webhooks).

Media typeapplication/json
object
type
required

The webhook type.

string
Allowed value: order.created
timestamp
required

When the event happened, UTC with six fractional digits (2026-11-13T09:30:00.123456Z).

string format: date-time
organization
required

The organization it happened in (org_...).

string
/^org_[0-9a-z]{26}$/
data
required
OrderResource
object
id
required

The order’s public id (ord_...).

string
/^ord_[0-9a-z]{26}$/
number
required

The number the merchant and the buyer know, as the store shows it; null when the store gives none.

string | null
external_id
required

The store’s own id of the order.

string
integration_id
required

The store integration (int_..., see /integrations) it came from; null once that integration was removed.

string | null
/^int_[0-9a-z]{26}$/
vendor
required

The store’s vendor code: shopify, woocommerce, trendyol, test_store; app for a partner’s app that is a store (which one: integration_id). New values may appear: treat one you do not know as such.

string
status
required

Derived from the facts, never set by hand or by the store: checking, needs_attention, to_process, processed, cancelled, closed. New values may appear: treat one you do not know as such.

string
fulfillment_status
required

The store’s own fulfillment state (filter[fulfillment_status]): unfulfilled, partial, fulfilled, shipped, delivered, returned, restocked, on_hold; null when the store gives none. New values may appear: treat one you do not know as such.

string | null
returns
required

How the order came back (filter[returns]): in_store (marked returned in the store), by_courier (the parcel brought back, until the store restocks, cancels or closes the order). Empty when neither.

Array<string>
printed_at
required

When its AWB and invoice were last printed from the app; null while never printed (filter[printed]=printed or not_printed). An AWB undone clears it.

string | null format: date-time
issues
required

The open issues, blocking first; at most 250. Codes only: the app words them.

Array<object>
object
code
required

The exact problem, a stable snake_case code (phone_invalid). Order: address_missing, field_missing, field_too_long, phone_invalid, postal_code_invalid, region_not_found, locality_not_found, locality_sector_missing, payment_method_missing, payment_method_unmapped, pickup_point_missing, pickup_point_unidentified, correction_conflict, correction_conflict_emptied, delivery_service_released. AWB: route_unavailable, route_ (route_no_service_for_address, route_account_paused…), sender_address_unconfigured, weight_unconfigured, product_weight_missing, pickup_point_unknown, pickup_point_unplaced, pickup_point_closed, pickup_point_full, pickup_point_too_heavy, pickup_point_too_large, pickup_point_no_cod, pickup_point_email_missing, handover_point_full. Invoice: invoicer_unchosen, invoicing_settings_incomplete, invoice_data_invalid, billing_sector_missing. New codes may appear.

string
step
required

The step it holds: awb or invoice. New values may appear: treat one you do not know as such.

string
field
required

The field path (shipping.phone, order.total_weight); null for the order as a whole.

string | null
kind
required

Missing, invalid, not_found, mismatch, unconfigured, conflict, suspicious. New values may appear: treat one you do not know as such.

string
severity
required

Blocking (stops its step) or warning. New values may appear: treat one you do not know as such.

string
detected_at
required
string format: date-time
customer
required

Who placed it: the billing contact, else the shipping one.

object
name
required
string | null
email
required
string | null
phone
required
string | null
billing_address
required

The address the invoice is made out to; null when the store sent none.

object
name
required
string | null
first_name
required
string | null
last_name
required
string | null
company
required
string | null
email
required
string | null
phone
required
string | null
address_line_1
required
string | null
address_line_2
required
string | null
city
required
string | null
region
required
string | null
region_code
required
string | null
postal_code
required
string | null
country_code
required
string | null
locality_code
required
string | null
tax_id
required

The fiscal code (CUI, VAT number), for a company.

string | null
shipping_address
required

Where the parcel goes (for a pickup point, only the contact counts); null when the store sent none.

object
name
required
string | null
first_name
required
string | null
last_name
required
string | null
company
required
string | null
email
required
string | null
phone
required
string | null
address_line_1
required
string | null
address_line_2
required
string | null
city
required
string | null
region
required
string | null
region_code
required
string | null
postal_code
required
string | null
country_code
required
string | null
locality_code
required
string | null
tax_id
required

The fiscal code (CUI, VAT number), for a company.

string | null
line_items
required

In the store’s order; at most 250 (see line_items_count).

Array<object>
object
sku
required
string | null
name
required

The product’s name, as sold.

string | null
quantity
required

A decimal string, trailing zeros trimmed (2).

string
unit_price
required

One unit before discounts, in the store’s price convention (prices_include_tax).

object
amount
required
string
currency
required
string
discount
required

The line’s discount, its share of order discounts included.

object
amount
required
string
currency
required
string
tax_rate
required

A percentage (19.0000).

string | null
tax
required
object
amount
required
string
currency
required
string
total
required

The line after every discount, tax included.

object
amount
required
string
currency
required
string
line_items_count
required

Every line of the order, also those past the list’s bound.

integer
shipping_lines
required
Array<object>
object
code
required

The store’s own id of the shipping method.

string | null
title
required

The method’s name, as the buyer saw it.

string | null
price
required

Before discounts, in the store’s price convention.

object
amount
required
string
currency
required
string
discount
required
object
amount
required
string
currency
required
string
tax_rate
required
string | null
tax
required
object
amount
required
string
currency
required
string
total
required

After discounts, tax included.

object
amount
required
string
currency
required
string
fees
required
Array<object>
object
name
required
string | null
tax_rate
required
string | null
tax
required
object
amount
required
string
currency
required
string
total
required

Signed: a surcharge positive, an adjustment negative; tax included.

object
amount
required
string
currency
required
string
currency
required

ISO 4217; every amount of the order is in it.

string
prices_include_tax
required

Whether the store’s prices (unit prices, subtotal, shipping prices) include tax.

boolean
totals
required
object
subtotal
required
object
amount
required
string
currency
required
string
discount
required
object
amount
required
string
currency
required
string
shipping
required
object
amount
required
string
currency
required
string
tax
required
object
amount
required
string
currency
required
string
total
required
object
amount
required
string
currency
required
string
payment
required
object
method
required

Cod, card, bank_transfer, cash, gift_card, store_credit, other; null while the store’s gateway is not mapped. New values may appear: treat one you do not know as such.

string | null
status
required

Pending, authorized, partially_paid, paid, partially_refunded, refunded, voided, failed, not_applicable; null when the store gives none. New values may appear: treat one you do not know as such.

string | null
cod
required

Cash on delivery: what is left to collect from the buyer; null without.

object
amount
required
string
currency
required
string
delivery
required
object
method
required

What the buyer asked: address, pickup_point, store_pickup, mixed (a shipment’s delivery_method takes the first two). New values may appear: treat one you do not know as such.

string
carrier
required

The carrier the buyer picked at checkout for a delivery to the door; null for any or another type.

string | null
pickup_point
required

The point the buyer picked; null unless type is pickup_point.

object
external_id
required

The point’s id in its provider’s ids; null while the store named none.

string | null
provider
required

Whose ids the point’s id is in.

string | null
name
required
string | null
address
required
string | null
service
required

The courier service the AWB ships with; null until one is picked.

object
integration_id
required

The courier connection (int_...).

string | null
/^int_[0-9a-z]{26}$/
code
required

In that connection’s service codes.

string
selected_by
required

Manual (the merchant), rule (a delivery rule), fallback (the organization’s default). New values may appear: treat one you do not know as such.

string | null
selected_at
required
string | null format: date-time
total_weight_kg
required

The parcel’s weight in kilograms (the store’s, or the merchant’s correction).

string | null
placed_at
required

When the buyer placed it, as the store says.

string | null format: date-time
source_updated_at
required

When it last changed at its store, as the store says (a store app’s updated_at, to the microsecond): the version held, which a store app compares with its own.

string | null format: date-time
created_at
required
string format: date-time
updated_at
required
string format: date-time

Gone: no more webhooks are sent to this URL until its partner turns them back on.

Received. Any other answer is retried on the schedule.