v2

latestOpenAPI 3.0.3Proprietary2026-07-263483431.1 MB
Customer Orders

Get an authenticated customer order

Customer-authenticated storefront endpoint.

get/v3/stores/{store_id}/customers/me/orders/{id}

Response

Authenticated customer order

idstring uuid required

Canonical UUIDv7 order primary key returned by the partitioned orders table.

secret_slugstring required
public_order_urlstring uri nullable required
payment_urlstring uri nullable required
order_idstring required
statusstring required
draft_timestring date-time nullable
pending_timestring date-time nullable
confirmed_timestring date-time nullable
in_process_timestring date-time nullable
ready_timestring date-time nullable
shipped_timestring date-time nullable
completed_timestring date-time nullable
rts_timestring date-time nullable
canceled_timestring date-time nullable
closed_timestring date-time nullable
unpaid_timestring date-time nullable
paid_timestring date-time nullable
transfer_timestring date-time nullable
created_atstring date-time nullable
last_updated_atstring date-time nullable
status_historyobject[]

Buyer-visible order status timeline retained for Scalev customer portal compatibility.

payment_statusstring nullable required

Buyer-facing payment status. A settled payment is exposed as paid; this field never returns settled.

payment_methodstring required
payment_account_holderstring nullable
payment_account_numberstring nullable
transferproof_urlstring nullable
pg_payment_infoobject required
total_quantityinteger nullable
discount_code_codestring nullable
discount_code_applied_tostring nullable
other_income_namestring nullable
final_variantsobject required

Product-name to quantity map retained for Scalev customer portal order list compatibility. Use orderlines for new integrations.

product_weightinteger nullable
total_weightinteger nullable
is_dropshippingboolean nullable
shipment_receiptstring nullable
shipment_statusstring nullable
awb_statusstring nullable
shipment_status_historyobject[]
notesstring nullable

Example response

{
  "payment_method": "bank_transfer"
}