Skip to content

Send a batch of orders

POST
/orders/batch
curl --request POST \
--url https://api.connectato.com/v1/orders/batch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "orders": [ { "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.

Up to 50 orders of a store app, each whole and named by its external_id, taken in one by one as if sent alone; the answer holds one result per order, in the batch’s order. For a store’s history and for what a reconciliation found missing or older: counted apart from the live orders’ rate limit, and checked behind them. One invalid order refuses the batch (422, errors per orders.<n>.<field>).

Refusals (code, the reason in detail): not_a_store (403), integration_paused (409), order_in_progress (409: another send of one of its orders is still being taken in; the orders before it are taken, send the batch 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
SendOrderBatchRequest

Up to 50 orders a store app sends at once (its history, or what a reconciliation found missing or older), each whole and named by its own external_id, once per batch. Every order is validated as one sent alone (the fields of POST /orders); one invalid order refuses the batch whole.

object
orders
required
Array<object>
>= 1 items <= 50 items unique items
object
external_id
required
string
<= 255 characters
number
string | null
<= 255 characters
source_state
required
SourceState

What the store’s own status means for us, and nothing more: whether the store still considers the order live, cancelled it, or closed it. Set on every sync through the store’s status mapping (settings, editable per integration); the store’s raw value stays in source_status_raw. A fact about the source, never shown as the order’s status: the one status the merchant works with is {@see OrderStatus}, derived from this and the rest. New values may appear: treat one you do not know as such.

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

Fulfillment lifecycle, unified across direct stores and marketplaces. Nullable on the order until the source reports a fulfillment state. New values may appear: treat one you do not know as such.

string
test
boolean
currency
required
string
/^[A-Za-z]{3}$/
prices_include_tax
required
boolean
totals
required
object
subtotal
string | null
/^\d{1,11}(\.\d{1,4})?$/
discount
string | null
/^\d{1,11}(\.\d{1,4})?$/
shipping
string | null
/^\d{1,11}(\.\d{1,4})?$/
tax
string | null
/^\d{1,11}(\.\d{1,4})?$/
total
required
string
/^\d{1,11}(\.\d{1,4})?$/
payment
required
object
method
required
PaymentMethod

Our own nomenclator of how an order is paid, independent of the store’s gateway names. Each store gateway maps onto one case through the driver’s payment_method catalog, overridable per integration; the raw gateway stays on the order. Downstream reads only this: the courier collects on CashOnDelivery, the invoice picks its collect type from it. New values may appear: treat one you do not know as such.

string
status
Any of:
PaymentStatus

Payment lifecycle. Nullable on the order: some sources do not expose it (marketplaces that own the payment use NotApplicable). New values may appear: treat one you do not know as such.

string
gateway
string | null
gateway_label
string | null
cod
string | null
/^\d{1,11}(\.\d{1,4})?$/
billing_address
object
first_name
string | null
last_name
string | null
company
string | null
email
string | null
phone
string | null
address_line_1
string | null
address_line_2
string | null
city
string | null
region
string | null
region_code
string | null
<= 10 characters
postal_code
string | null
country_code
string | null
/^[A-Za-z]{2}$/
tax_id
string | null
shipping_address
object
first_name
string | null
last_name
string | null
company
string | null
email
string | null
phone
string | null
address_line_1
string | null
address_line_2
string | null
city
string | null
region
string | null
region_code
string | null
<= 10 characters
postal_code
string | null
country_code
string | null
/^[A-Za-z]{2}$/
tax_id
string | null
line_items
required
Array<object>
object
external_id
string | null
<= 255 characters
sku
string | null
name
string | null
quantity
required
integer
>= 1 <= 1000000
unit_price
string | null
/^\d{1,11}(\.\d{1,4})?$/
discount
string | null
/^\d{1,11}(\.\d{1,4})?$/
tax_rate
string | null
/^\d{1,3}(\.\d{1,4})?$/
tax
required
string
/^\d{1,11}(\.\d{1,4})?$/
total
required
string
/^\d{1,11}(\.\d{1,4})?$/
weight_kg
string | null
/^\d{1,7}(\.\d{1,3})?$/
shipping_lines
Array<object>
object
external_id
string | null
<= 255 characters
code
string | null
title
string | null
price
string | null
/^\d{1,11}(\.\d{1,4})?$/
discount
string | null
/^\d{1,11}(\.\d{1,4})?$/
tax_rate
string | null
/^\d{1,3}(\.\d{1,4})?$/
tax
required
string
/^\d{1,11}(\.\d{1,4})?$/
total
required
string
/^\d{1,11}(\.\d{1,4})?$/
fees
Array<object>
object
external_id
string | null
<= 255 characters
name
string | null
tax_rate
string | null
/^\d{1,3}(\.\d{1,4})?$/
tax
required
string
/^-?\d{1,11}(\.\d{1,4})?$/
total
required
string
/^-?\d{1,11}(\.\d{1,4})?$/
delivery
required
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
string | null
<= 64 characters
pickup_point
object
external_id
string | null
<= 255 characters
provider
string | null
<= 255 characters
name
string | null
address
string | null
total_weight_kg
string | null
/^\d{1,7}(\.\d{1,3})?$/
placed_at
required
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
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

{
"orders": [
{
"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"
}
]
}

Array of PushedOrderResource

Media typeapplication/json
object
data
required
Array<object>
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

{
"data": [
{
"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.