Skip to content
ShopentlyLearn
English

Orders

Read order summaries and details, then update order or payment status.

Operations

GETList order statuses/api/v1/order-statuses

Request exampleResponse example

GETList orders/api/v1/orders

Request exampleResponse example

GETGet an order/api/v1/orders/{order_id}

Request exampleResponse example

PATCHUpdate order payment status/api/v1/orders/{order_id}/payment-status

Request exampleResponse example

PATCHUpdate order status/api/v1/orders/{order_id}/status

Request exampleResponse example

How it works

Order lists and details include delivery.dates. YYYY-MM-DD dates are planned and do not confirm shipment. Current dates take precedence; older orders use the recorded estimate. Cleared or unknown values are null. Details also include all order lines and product images.

Obtain valid status identifiers from /api/v1/order-statuses. Order status and payment status use separate PATCH endpoints and permissions. Changing the recorded payment status does not charge a card or issue a refund through a payment provider.

Safe writes

Permissions and plans

delivery.dates: planned_dispatch_on, dispatch_timezone, estimated_delivery_from, estimated_delivery_to. Dispatch and delivery dates: YYYY-MM-DD; null. Dispatch timezone: IANA.

Order · Totals

Amounts and tax rates come from the saved order, including item corrections. Missing history is null and is never replaced with current catalog tax rates. Monetary values remain decimal strings.

  • tax_country_code · Tax country · Recorded order snapshot · ISO 3166-1 alpha-2; null.
  • lines[].unit_* · One unit · Before discounts; lines[].original_total_* · Before discounts; lines[].total_* · After discounts.
  • lines[].discount_* · Discounts; manual_discount · Manual discount; percentage "10" = 10%.
  • delivery.net / tax / gross · After discounts; delivery.original_* · Before discounts; delivery.discount_* · Discounts.
  • tax_rate: "0.23" = 23%; "0" ≠ null. Unknown: null; known zero: 0.
  • totals · Totals; tax_breakdown.groups · Tax groups; Unallocated tax = order.tax − Σ groups.tax; ±.

The list returns summaries. Fetch GET /api/v1/orders/{order_id} for each result to export full financial details. GET retries are bounded; respect Retry-After. A creation-date export does not synchronize later corrections.

payment.amount is the order total. Payment status does not establish amounts paid, refunded or outstanding.

Data schemas

Guides

How to export orders