Skip to main content
GET
Get an order
Returns an order created with the same API key. Your key needs the orders:find scope.

Headers

string
required
Your API key. You can use Authorization: Api-Key your_key instead.

Path parameters

string
required
Order number or order GUID.

Request example

Response

UUID
required
Order ID.
string
required
Order number.
string
required
Current order status.
number
required
Order subtotal.
number
required
Final order total.
integer
required
Total item quantity.
string
required
Order date and time in ISO 8601 format.
string
required
Customer name.
string | null
Customer phone.
string | null
Order note.
object[]
required
Order items. Each item contains productId, combinationId, name, quantity, singlePrice, and totalPrice.

Errors