Skip to content

Send an order

POST
/orders
curl --request POST \
--url https://api.connectato.com/v1/orders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "external_id": "example", "number": "example", "source_state": "example", "source_status": "example", "fulfillment_status": "example", "test": true, "currency": "example", "prices_include_tax": true, "totals": { "subtotal": "example", "discount": "example", "shipping": "example", "tax": "example", "total": "example" }, "payment": { "method": "example", "status": "example", "gateway": "example", "gateway_label": "example", "cod": "example" }, "billing_address": { "first_name": "example", "last_name": "example", "company": "example", "email": "example", "phone": "example", "address_line_1": "example", "address_line_2": "example", "city": "example", "region": "example", "region_code": "example", "postal_code": "example", "country_code": "example", "tax_id": "example" }, "shipping_address": { "first_name": "example", "last_name": "example", "company": "example", "email": "example", "phone": "example", "address_line_1": "example", "address_line_2": "example", "city": "example", "region": "example", "region_code": "example", "postal_code": "example", "country_code": "example", "tax_id": "example" }, "line_items": [ { "external_id": "example", "sku": "example", "name": "example", "quantity": 1, "unit_price": "example", "discount": "example", "tax_rate": "example", "tax": "example", "total": "example", "weight_kg": "example" } ], "shipping_lines": [ { "external_id": "example", "code": "example", "title": "example", "price": "example", "discount": "example", "tax_rate": "example", "tax": "example", "total": "example" } ], "fees": [ { "external_id": "example", "name": "example", "tax_rate": "example", "tax": "example", "total": "example" } ], "delivery": { "method": "example", "carrier": "example", "pickup_point": { "external_id": "example", "provider": "example", "name": "example", "address": "example" } }, "total_weight_kg": "example", "placed_at": "2026-04-15T12:00:00Z", "updated_at": "2026-04-15T12:00:00Z" }'

Scope: write_orders.

A store app’s order, the whole order every time (a full replace), named by its own external_id: created the first time, replaced after. Idempotency-Key honoured when sent. 201 created the first time; 200 updated after; 200 stale when updated_at is older than the version held or the same again (nothing written, order is the version held); 202 refused when the store’s import rules leave it out (reason, nothing stored). An updated_at more than 5 minutes ahead of the current time is a 422.

Refusals (code, the reason in detail): not_a_store (403, the caller is no store of the organization), integration_paused (409, the store is paused or on hold: send again once it resumes), order_in_progress (409, another send of the same order is still being taken in: send it again).

Idempotency-Key

1 to 255 visible ASCII characters

string

A unique value per operation, sent again on a retry: a success or a definitive refusal is replayed for 24 hours; a validation failure, a 429 or a refusal whose code may pass later is not kept, so a retry with the same key runs again.

Media typeapplication/json
SendOrderRequest

One order a store app sends, whole every time (a full replace), named by the app’s own external_id: created the first time, replaced after. Money is a decimal string in the order’s currency, at most four decimals; a line’s total is after every discount, tax included, and its tax the tax in it. Text a buyer typed is kept as sent, whatever its length.

object
external_id
required

The app’s own id of the order: one order per id in its store, matched exactly (case-sensitive), no comma.

string
<= 255 characters
number

The number the merchant and the buyer know; null when the app has none.

string | null
<= 255 characters
source_state
required
SourceState

What the order’s status means: active, cancelled, or closed (done in the store, nothing left to do).

string
source_status

The app’s own status, as its platform names it: shown on the order, and what the merchant’s import rules leave out by.

string | null
<= 255 characters
fulfillment_status
Any of:
FulfillmentStatus

How far the store got with sending it.

string
test

A test order: left out unless the merchant takes test orders in.

boolean
currency
required

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

string
/^[A-Za-z]{3}$/
prices_include_tax
required

Whether the prices (unit prices, shipping prices) include tax.

boolean
totals
required

The order’s totals; lines, shipping lines and fees add up to total.

object
subtotal

Before discounts, shipping and fees.

string | null
/^\d{1,11}(\.\d{1,4})?$/
discount

Every discount of the order.

string | null
/^\d{1,11}(\.\d{1,4})?$/
shipping

Every shipping line.

string | null
/^\d{1,11}(\.\d{1,4})?$/
tax

The tax in the order.

string | null
/^\d{1,11}(\.\d{1,4})?$/
total
required

What the buyer pays.

string
/^\d{1,11}(\.\d{1,4})?$/
payment
required
object
method
required
PaymentMethod

Our payment method code; other when none fits.

string
status
Any of:
PaymentStatus

Whether it is paid.

string
gateway

The app’s own gateway, kept for display.

string | null
gateway_label

The gateway’s name as the buyer saw it.

string | null
cod

Cash on delivery (cod): what is left to collect from the buyer.

string | null
/^\d{1,11}(\.\d{1,4})?$/
billing_address

Who pays; null when the app has none.

object
first_name
string | null
last_name
string | null
company
string | null
email
string | null
phone

As typed; stored in E.164 when it reads as a number of the address’s country.

string | null
address_line_1
string | null
address_line_2
string | null
city
string | null
region

As written; resolved to region_code where the country’s regions are known.

string | null
region_code

ISO 3166-2 without its country (CJ), when the app knows it.

string | null
<= 10 characters
postal_code
string | null
country_code

ISO 3166-1 alpha-2.

string | null
/^[A-Za-z]{2}$/
tax_id

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

string | null
shipping_address

Where it goes; null when the app has none.

object
first_name
string | null
last_name
string | null
company
string | null
email
string | null
phone

As typed; stored in E.164 when it reads as a number of the address’s country.

string | null
address_line_1
string | null
address_line_2
string | null
city
string | null
region

As written; resolved to region_code where the country’s regions are known.

string | null
region_code

ISO 3166-2 without its country (CJ), when the app knows it.

string | null
<= 10 characters
postal_code
string | null
country_code

ISO 3166-1 alpha-2.

string | null
/^[A-Za-z]{2}$/
tax_id

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

string | null
line_items
required

What was bought; may be empty.

Array<object>
object
external_id

The app’s own id of the line.

string | null
<= 255 characters
sku
string | null
name
string | null
quantity
required
integer
>= 1 <= 1000000
unit_price

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

string | null
/^\d{1,11}(\.\d{1,4})?$/
discount

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

string | null
/^\d{1,11}(\.\d{1,4})?$/
tax_rate

A percentage (19).

string | null
/^\d{1,3}(\.\d{1,4})?$/
tax
required

The tax in the line’s total.

string
/^\d{1,11}(\.\d{1,4})?$/
total
required

After every discount, tax included.

string
/^\d{1,11}(\.\d{1,4})?$/
weight_kg

One unit’s weight in kilograms.

string | null
/^\d{1,7}(\.\d{1,3})?$/
shipping_lines
Array<object>
object
external_id

The app’s own id of the line.

string | null
<= 255 characters
code

The app’s own id of the method.

string | null
title

The method’s name, as the buyer saw it: shown only, it decides nothing.

string | null
price

Before discounts, in the store’s convention (prices_include_tax).

string | null
/^\d{1,11}(\.\d{1,4})?$/
discount
string | null
/^\d{1,11}(\.\d{1,4})?$/
tax_rate

A percentage (19).

string | null
/^\d{1,3}(\.\d{1,4})?$/
tax
required

The tax in the line’s total.

string
/^\d{1,11}(\.\d{1,4})?$/
total
required

After every discount, tax included.

string
/^\d{1,11}(\.\d{1,4})?$/
fees

Anything else the buyer pays (or is given back: a fee may be negative).

Array<object>
object
external_id

The app’s own id of the fee.

string | null
<= 255 characters
name
string | null
tax_rate

A percentage (19).

string | null
/^\d{1,3}(\.\d{1,4})?$/
tax
required

The tax in the fee’s total.

string
/^-?\d{1,11}(\.\d{1,4})?$/
total
required

Tax included.

string
/^-?\d{1,11}(\.\d{1,4})?$/
delivery
required

What the buyer asked: to the address, to a pickup point, picked up at the store (mixed for lines asking different things).

object
method
required
DeliveryType

Where the buyer asked to receive the order, as the store told us: never guessed from the method’s name. A pickup point is a courier’s locker, office or partner shop; a store pickup is the merchant’s own location, no courier.

address
pickup_point
store_pickup
mixed
The order’s delivery groups asked for different deliveries (several Woo packages).
string
carrier

The carrier the buyer picked at checkout, by our carrier code; null for any.

string | null
<= 64 characters
pickup_point

For a pickup point: the point the buyer picked. Without its id the order’s AWB waits for the merchant to pick one.

object
external_id

The point’s id at its provider.

string | null
<= 255 characters
provider

Who runs the point, by our provider code (sameday).

string | null
<= 255 characters
name
string | null
address
string | null
total_weight_kg

The parcel’s weight in kilograms.

string | null
/^\d{1,7}(\.\d{1,3})?$/
placed_at
required

When the buyer placed it (RFC 3339).

string format: date-time
/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,9})?(Z|[+-]\d{2}:\d{2})$/
updated_at
required

When the app last changed it: RFC 3339 with at least milliseconds, at most 5 minutes ahead. Older than, or the same as, the version held: nothing written.

string format: date-time
/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3,9}(Z|[+-]\d{2}:\d{2})$/

Example generated

{
"external_id": "example",
"number": "example",
"source_state": "example",
"source_status": "example",
"fulfillment_status": "example",
"test": true,
"currency": "example",
"prices_include_tax": true,
"totals": {
"subtotal": "example",
"discount": "example",
"shipping": "example",
"tax": "example",
"total": "example"
},
"payment": {
"method": "example",
"status": "example",
"gateway": "example",
"gateway_label": "example",
"cod": "example"
},
"billing_address": {
"first_name": "example",
"last_name": "example",
"company": "example",
"email": "example",
"phone": "example",
"address_line_1": "example",
"address_line_2": "example",
"city": "example",
"region": "example",
"region_code": "example",
"postal_code": "example",
"country_code": "example",
"tax_id": "example"
},
"shipping_address": {
"first_name": "example",
"last_name": "example",
"company": "example",
"email": "example",
"phone": "example",
"address_line_1": "example",
"address_line_2": "example",
"city": "example",
"region": "example",
"region_code": "example",
"postal_code": "example",
"country_code": "example",
"tax_id": "example"
},
"line_items": [
{
"external_id": "example",
"sku": "example",
"name": "example",
"quantity": 1,
"unit_price": "example",
"discount": "example",
"tax_rate": "example",
"tax": "example",
"total": "example",
"weight_kg": "example"
}
],
"shipping_lines": [
{
"external_id": "example",
"code": "example",
"title": "example",
"price": "example",
"discount": "example",
"tax_rate": "example",
"tax": "example",
"total": "example"
}
],
"fees": [
{
"external_id": "example",
"name": "example",
"tax_rate": "example",
"tax": "example",
"total": "example"
}
],
"delivery": {
"method": "example",
"carrier": "example",
"pickup_point": {
"external_id": "example",
"provider": "example",
"name": "example",
"address": "example"
}
},
"total_weight_kg": "example",
"placed_at": "2026-04-15T12:00:00Z",
"updated_at": "2026-04-15T12:00:00Z"
}

PushedOrderResource

Media typeapplication/json
PushedOrderResource
object
external_id
required

The app’s own id of the order, as sent.

string
result
required

Created (first seen); updated (stored as sent); stale (the version held is newer, or has the same updated_at: nothing written, order is the version held); refused (left out by the store’s import rules: nothing stored). New values may appear: treat one you do not know as such.

string
reason
required

Why it was refused: before_cutoff (placed before the store’s import cut-off day), excluded_status (its source_status is one the merchant leaves out), test_order (test orders are left out); null otherwise.

string | null
order
required
Any of:
OrderResource

The order as held, as GET /orders/{id} shows it; null when refused.

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

Example generated

{
"external_id": "example",
"result": "example",
"reason": "example",
"order": {
"id": "example",
"number": "example",
"external_id": "example",
"integration_id": "example",
"vendor": "example",
"status": "example",
"fulfillment_status": "example",
"returns": [
"example"
],
"printed_at": "2026-04-15T12:00:00Z",
"issues": [
{
"code": "example",
"step": "example",
"field": "example",
"kind": "example",
"severity": "example",
"detected_at": "2026-04-15T12:00:00Z"
}
],
"customer": {
"name": "example",
"email": "example",
"phone": "example"
},
"billing_address": {
"name": "example",
"first_name": "example",
"last_name": "example",
"company": "example",
"email": "example",
"phone": "example",
"address_line_1": "example",
"address_line_2": "example",
"city": "example",
"region": "example",
"region_code": "example",
"postal_code": "example",
"country_code": "example",
"locality_code": "example",
"tax_id": "example"
},
"shipping_address": {
"name": "example",
"first_name": "example",
"last_name": "example",
"company": "example",
"email": "example",
"phone": "example",
"address_line_1": "example",
"address_line_2": "example",
"city": "example",
"region": "example",
"region_code": "example",
"postal_code": "example",
"country_code": "example",
"locality_code": "example",
"tax_id": "example"
},
"line_items": [
{
"sku": "example",
"name": "example",
"quantity": "example",
"unit_price": {
"amount": "example",
"currency": "example"
},
"discount": {
"amount": "example",
"currency": "example"
},
"tax_rate": "example",
"tax": {
"amount": "example",
"currency": "example"
},
"total": {
"amount": "example",
"currency": "example"
}
}
],
"line_items_count": 1,
"shipping_lines": [
{
"code": "example",
"title": "example",
"price": {
"amount": "example",
"currency": "example"
},
"discount": {
"amount": "example",
"currency": "example"
},
"tax_rate": "example",
"tax": {
"amount": "example",
"currency": "example"
},
"total": {
"amount": "example",
"currency": "example"
}
}
],
"fees": [
{
"name": "example",
"tax_rate": "example",
"tax": {
"amount": "example",
"currency": "example"
},
"total": {
"amount": "example",
"currency": "example"
}
}
],
"currency": "example",
"prices_include_tax": true,
"totals": {
"subtotal": {
"amount": "example",
"currency": "example"
},
"discount": {
"amount": "example",
"currency": "example"
},
"shipping": {
"amount": "example",
"currency": "example"
},
"tax": {
"amount": "example",
"currency": "example"
},
"total": {
"amount": "example",
"currency": "example"
}
},
"payment": {
"method": "example",
"status": "example",
"cod": {
"amount": "example",
"currency": "example"
}
},
"delivery": {
"method": "example",
"carrier": "example",
"pickup_point": {
"external_id": "example",
"provider": "example",
"name": "example",
"address": "example"
},
"service": {
"integration_id": "example",
"code": "example",
"selected_by": "example",
"selected_at": "2026-04-15T12:00:00Z"
}
},
"total_weight_kg": "example",
"placed_at": "2026-04-15T12:00:00Z",
"source_updated_at": "2026-04-15T12:00:00Z",
"created_at": "2026-04-15T12:00:00Z",
"updated_at": "2026-04-15T12:00:00Z"
}
}
X-RateLimit-Limit
integer

Requests allowed per minute (per caller; before authentication, failed attempts per address).

X-RateLimit-Remaining
integer

Requests left in the current minute.

Idempotent-Replayed
string
Allowed values: true

true when this is the stored answer of an earlier request with the same Idempotency-Key.

PushedOrderResource

Media typeapplication/json
PushedOrderResource
object
external_id
required

The app’s own id of the order, as sent.

string
result
required

Created (first seen); updated (stored as sent); stale (the version held is newer, or has the same updated_at: nothing written, order is the version held); refused (left out by the store’s import rules: nothing stored). New values may appear: treat one you do not know as such.

string
reason
required

Why it was refused: before_cutoff (placed before the store’s import cut-off day), excluded_status (its source_status is one the merchant leaves out), test_order (test orders are left out); null otherwise.

string | null
order
required
Any of:
OrderResource

The order as held, as GET /orders/{id} shows it; null when refused.

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

Example generated

{
"external_id": "example",
"result": "example",
"reason": "example",
"order": {
"id": "example",
"number": "example",
"external_id": "example",
"integration_id": "example",
"vendor": "example",
"status": "example",
"fulfillment_status": "example",
"returns": [
"example"
],
"printed_at": "2026-04-15T12:00:00Z",
"issues": [
{
"code": "example",
"step": "example",
"field": "example",
"kind": "example",
"severity": "example",
"detected_at": "2026-04-15T12:00:00Z"
}
],
"customer": {
"name": "example",
"email": "example",
"phone": "example"
},
"billing_address": {
"name": "example",
"first_name": "example",
"last_name": "example",
"company": "example",
"email": "example",
"phone": "example",
"address_line_1": "example",
"address_line_2": "example",
"city": "example",
"region": "example",
"region_code": "example",
"postal_code": "example",
"country_code": "example",
"locality_code": "example",
"tax_id": "example"
},
"shipping_address": {
"name": "example",
"first_name": "example",
"last_name": "example",
"company": "example",
"email": "example",
"phone": "example",
"address_line_1": "example",
"address_line_2": "example",
"city": "example",
"region": "example",
"region_code": "example",
"postal_code": "example",
"country_code": "example",
"locality_code": "example",
"tax_id": "example"
},
"line_items": [
{
"sku": "example",
"name": "example",
"quantity": "example",
"unit_price": {
"amount": "example",
"currency": "example"
},
"discount": {
"amount": "example",
"currency": "example"
},
"tax_rate": "example",
"tax": {
"amount": "example",
"currency": "example"
},
"total": {
"amount": "example",
"currency": "example"
}
}
],
"line_items_count": 1,
"shipping_lines": [
{
"code": "example",
"title": "example",
"price": {
"amount": "example",
"currency": "example"
},
"discount": {
"amount": "example",
"currency": "example"
},
"tax_rate": "example",
"tax": {
"amount": "example",
"currency": "example"
},
"total": {
"amount": "example",
"currency": "example"
}
}
],
"fees": [
{
"name": "example",
"tax_rate": "example",
"tax": {
"amount": "example",
"currency": "example"
},
"total": {
"amount": "example",
"currency": "example"
}
}
],
"currency": "example",
"prices_include_tax": true,
"totals": {
"subtotal": {
"amount": "example",
"currency": "example"
},
"discount": {
"amount": "example",
"currency": "example"
},
"shipping": {
"amount": "example",
"currency": "example"
},
"tax": {
"amount": "example",
"currency": "example"
},
"total": {
"amount": "example",
"currency": "example"
}
},
"payment": {
"method": "example",
"status": "example",
"cod": {
"amount": "example",
"currency": "example"
}
},
"delivery": {
"method": "example",
"carrier": "example",
"pickup_point": {
"external_id": "example",
"provider": "example",
"name": "example",
"address": "example"
},
"service": {
"integration_id": "example",
"code": "example",
"selected_by": "example",
"selected_at": "2026-04-15T12:00:00Z"
}
},
"total_weight_kg": "example",
"placed_at": "2026-04-15T12:00:00Z",
"source_updated_at": "2026-04-15T12:00:00Z",
"created_at": "2026-04-15T12:00:00Z",
"updated_at": "2026-04-15T12:00:00Z"
}
}
X-RateLimit-Limit
integer

Requests allowed per minute (per caller; before authentication, failed attempts per address).

X-RateLimit-Remaining
integer

Requests left in the current minute.

Idempotent-Replayed
string
Allowed values: true

true when this is the stored answer of an earlier request with the same Idempotency-Key.

PushedOrderResource

Media typeapplication/json
PushedOrderResource
object
external_id
required

The app’s own id of the order, as sent.

string
result
required

Created (first seen); updated (stored as sent); stale (the version held is newer, or has the same updated_at: nothing written, order is the version held); refused (left out by the store’s import rules: nothing stored). New values may appear: treat one you do not know as such.

string
reason
required

Why it was refused: before_cutoff (placed before the store’s import cut-off day), excluded_status (its source_status is one the merchant leaves out), test_order (test orders are left out); null otherwise.

string | null
order
required
Any of:
OrderResource

The order as held, as GET /orders/{id} shows it; null when refused.

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

Example generated

{
"external_id": "example",
"result": "example",
"reason": "example",
"order": {
"id": "example",
"number": "example",
"external_id": "example",
"integration_id": "example",
"vendor": "example",
"status": "example",
"fulfillment_status": "example",
"returns": [
"example"
],
"printed_at": "2026-04-15T12:00:00Z",
"issues": [
{
"code": "example",
"step": "example",
"field": "example",
"kind": "example",
"severity": "example",
"detected_at": "2026-04-15T12:00:00Z"
}
],
"customer": {
"name": "example",
"email": "example",
"phone": "example"
},
"billing_address": {
"name": "example",
"first_name": "example",
"last_name": "example",
"company": "example",
"email": "example",
"phone": "example",
"address_line_1": "example",
"address_line_2": "example",
"city": "example",
"region": "example",
"region_code": "example",
"postal_code": "example",
"country_code": "example",
"locality_code": "example",
"tax_id": "example"
},
"shipping_address": {
"name": "example",
"first_name": "example",
"last_name": "example",
"company": "example",
"email": "example",
"phone": "example",
"address_line_1": "example",
"address_line_2": "example",
"city": "example",
"region": "example",
"region_code": "example",
"postal_code": "example",
"country_code": "example",
"locality_code": "example",
"tax_id": "example"
},
"line_items": [
{
"sku": "example",
"name": "example",
"quantity": "example",
"unit_price": {
"amount": "example",
"currency": "example"
},
"discount": {
"amount": "example",
"currency": "example"
},
"tax_rate": "example",
"tax": {
"amount": "example",
"currency": "example"
},
"total": {
"amount": "example",
"currency": "example"
}
}
],
"line_items_count": 1,
"shipping_lines": [
{
"code": "example",
"title": "example",
"price": {
"amount": "example",
"currency": "example"
},
"discount": {
"amount": "example",
"currency": "example"
},
"tax_rate": "example",
"tax": {
"amount": "example",
"currency": "example"
},
"total": {
"amount": "example",
"currency": "example"
}
}
],
"fees": [
{
"name": "example",
"tax_rate": "example",
"tax": {
"amount": "example",
"currency": "example"
},
"total": {
"amount": "example",
"currency": "example"
}
}
],
"currency": "example",
"prices_include_tax": true,
"totals": {
"subtotal": {
"amount": "example",
"currency": "example"
},
"discount": {
"amount": "example",
"currency": "example"
},
"shipping": {
"amount": "example",
"currency": "example"
},
"tax": {
"amount": "example",
"currency": "example"
},
"total": {
"amount": "example",
"currency": "example"
}
},
"payment": {
"method": "example",
"status": "example",
"cod": {
"amount": "example",
"currency": "example"
}
},
"delivery": {
"method": "example",
"carrier": "example",
"pickup_point": {
"external_id": "example",
"provider": "example",
"name": "example",
"address": "example"
},
"service": {
"integration_id": "example",
"code": "example",
"selected_by": "example",
"selected_at": "2026-04-15T12:00:00Z"
}
},
"total_weight_kg": "example",
"placed_at": "2026-04-15T12:00:00Z",
"source_updated_at": "2026-04-15T12:00:00Z",
"created_at": "2026-04-15T12:00:00Z",
"updated_at": "2026-04-15T12:00:00Z"
}
}
X-RateLimit-Limit
integer

Requests allowed per minute (per caller; before authentication, failed attempts per address).

X-RateLimit-Remaining
integer

Requests left in the current minute.

Idempotent-Replayed
string
Allowed values: true

true when this is the stored answer of an earlier request with the same Idempotency-Key.

Missing or malformed Idempotency-Key (idempotency_key_required, idempotency_key_invalid).

Media typeapplication/problem+json
Problem
object
type
required

The documentation URL of the code.

string format: uri
title
required

A short summary of the error, in English.

string
status
required

The HTTP status, repeated.

integer
code
required

The stable code: one of bad_request, unauthenticated, insufficient_scope, forbidden, not_found, method_not_allowed, payload_too_large, validation_failed, idempotency_key_required, idempotency_key_invalid, idempotency_key_reused, idempotency_in_progress, conflict, rate_limited, server_error, unavailable, or the code an endpoint declares for a refused action.

string
detail

The explanation for this case, in English.

string
errors

Validation only: the messages per field.

object
key
additional properties
Array<string>

Example generated

{
"type": "https://example.com",
"title": "example",
"status": 1,
"code": "example",
"detail": "example",
"errors": {
"additionalProperty": [
"example"
]
}
}
X-RateLimit-Limit
integer

Requests allowed per minute (per caller; before authentication, failed attempts per address).

X-RateLimit-Remaining
integer

Requests left in the current minute.

No valid access token.

Media typeapplication/problem+json
Problem
object
type
required

The documentation URL of the code.

string format: uri
title
required

A short summary of the error, in English.

string
status
required

The HTTP status, repeated.

integer
code
required

The stable code: one of bad_request, unauthenticated, insufficient_scope, forbidden, not_found, method_not_allowed, payload_too_large, validation_failed, idempotency_key_required, idempotency_key_invalid, idempotency_key_reused, idempotency_in_progress, conflict, rate_limited, server_error, unavailable, or the code an endpoint declares for a refused action.

string
detail

The explanation for this case, in English.

string
errors

Validation only: the messages per field.

object
key
additional properties
Array<string>

Example generated

{
"type": "https://example.com",
"title": "example",
"status": 1,
"code": "example",
"detail": "example",
"errors": {
"additionalProperty": [
"example"
]
}
}
X-RateLimit-Limit
integer

Requests allowed per minute (per caller; before authentication, failed attempts per address).

X-RateLimit-Remaining
integer

Requests left in the current minute.

WWW-Authenticate
string

Bearer: send an access token as a Bearer token.

The app was not granted the scope (insufficient_scope).

Media typeapplication/problem+json
Problem
object
type
required

The documentation URL of the code.

string format: uri
title
required

A short summary of the error, in English.

string
status
required

The HTTP status, repeated.

integer
code
required

The stable code: one of bad_request, unauthenticated, insufficient_scope, forbidden, not_found, method_not_allowed, payload_too_large, validation_failed, idempotency_key_required, idempotency_key_invalid, idempotency_key_reused, idempotency_in_progress, conflict, rate_limited, server_error, unavailable, or the code an endpoint declares for a refused action.

string
detail

The explanation for this case, in English.

string
errors

Validation only: the messages per field.

object
key
additional properties
Array<string>

Example generated

{
"type": "https://example.com",
"title": "example",
"status": 1,
"code": "example",
"detail": "example",
"errors": {
"additionalProperty": [
"example"
]
}
}
X-RateLimit-Limit
integer

Requests allowed per minute (per caller; before authentication, failed attempts per address).

X-RateLimit-Remaining
integer

Requests left in the current minute.

A request with this Idempotency-Key is still running, or the action is refused by the record’s state.

Media typeapplication/problem+json
Problem
object
type
required

The documentation URL of the code.

string format: uri
title
required

A short summary of the error, in English.

string
status
required

The HTTP status, repeated.

integer
code
required

The stable code: one of bad_request, unauthenticated, insufficient_scope, forbidden, not_found, method_not_allowed, payload_too_large, validation_failed, idempotency_key_required, idempotency_key_invalid, idempotency_key_reused, idempotency_in_progress, conflict, rate_limited, server_error, unavailable, or the code an endpoint declares for a refused action.

string
detail

The explanation for this case, in English.

string
errors

Validation only: the messages per field.

object
key
additional properties
Array<string>

Example generated

{
"type": "https://example.com",
"title": "example",
"status": 1,
"code": "example",
"detail": "example",
"errors": {
"additionalProperty": [
"example"
]
}
}
X-RateLimit-Limit
integer

Requests allowed per minute (per caller; before authentication, failed attempts per address).

X-RateLimit-Remaining
integer

Requests left in the current minute.

Idempotent-Replayed
string
Allowed values: true

true when this is the stored answer of an earlier request with the same Idempotency-Key.

Validation failed (validation_failed, errors per field), the action’s rules refuse it, or an Idempotency-Key was reused for another request (idempotency_key_reused).

Media typeapplication/problem+json
Problem
object
type
required

The documentation URL of the code.

string format: uri
title
required

A short summary of the error, in English.

string
status
required

The HTTP status, repeated.

integer
code
required

The stable code: one of bad_request, unauthenticated, insufficient_scope, forbidden, not_found, method_not_allowed, payload_too_large, validation_failed, idempotency_key_required, idempotency_key_invalid, idempotency_key_reused, idempotency_in_progress, conflict, rate_limited, server_error, unavailable, or the code an endpoint declares for a refused action.

string
detail

The explanation for this case, in English.

string
errors

Validation only: the messages per field.

object
key
additional properties
Array<string>

Example generated

{
"type": "https://example.com",
"title": "example",
"status": 1,
"code": "example",
"detail": "example",
"errors": {
"additionalProperty": [
"example"
]
}
}
X-RateLimit-Limit
integer

Requests allowed per minute (per caller; before authentication, failed attempts per address).

X-RateLimit-Remaining
integer

Requests left in the current minute.

Idempotent-Replayed
string
Allowed values: true

true when this is the stored answer of an earlier request with the same Idempotency-Key.

Too many requests: retry after Retry-After seconds.

Media typeapplication/problem+json
Problem
object
type
required

The documentation URL of the code.

string format: uri
title
required

A short summary of the error, in English.

string
status
required

The HTTP status, repeated.

integer
code
required

The stable code: one of bad_request, unauthenticated, insufficient_scope, forbidden, not_found, method_not_allowed, payload_too_large, validation_failed, idempotency_key_required, idempotency_key_invalid, idempotency_key_reused, idempotency_in_progress, conflict, rate_limited, server_error, unavailable, or the code an endpoint declares for a refused action.

string
detail

The explanation for this case, in English.

string
errors

Validation only: the messages per field.

object
key
additional properties
Array<string>

Example generated

{
"type": "https://example.com",
"title": "example",
"status": 1,
"code": "example",
"detail": "example",
"errors": {
"additionalProperty": [
"example"
]
}
}
X-RateLimit-Limit
integer

Requests allowed per minute (per caller; before authentication, failed attempts per address).

X-RateLimit-Remaining
integer

Requests left in the current minute.

Retry-After
integer

Seconds to wait before retrying.