Pular para o conteúdo

GET /v1/orders

GET
/v1/orders
curl --request GET \
--url https://seu-endereco-da-api/v1/orders \
--header 'Authorization: Bearer <token>'

Permissão que a Chave de acesso precisa: Ler pedidos (orders:read).

status
string
<= 200 characters
q
string
<= 100 characters
cursor
string
<= 200 characters
limit
number
>= 1 <= 50
updatedSince
string
Media typeapplication/json
object
items
required
Array<object>
object
id
required
string
number
required
number
status
required
string
version
required

Optimistic lock; send it back when changing the status

number
source
required

Where the order came from

string
Allowed values: storefront operator agent
contactName
required
string
contactPhone
required
string
fulfillment
required
string
zoneName
required
string
nullable
totalCents
required
number
paymentMethod
required
string
paymentState
required

On_delivery, pending, paid, expired or unavailable

string
itemCount
required
number
itemsPreview
required

The first items of the order, for the list

Array<object>
object
name
required
string
quantity
required
number
nextStatuses
required

Statuses the order may move to now

Array<string>
createdAt
required
string
updatedAt
required

Last change of the order, which is when it reached its current status

string
nextCursor
required
string
nullable

Example

{
"items": [
{
"source": "storefront"
}
]
}