GET /v1/orders
GET
/v1/orders
const url = 'https://seu-endereco-da-api/v1/orders';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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).
Authorizations
Seção intitulada “Authorizations”Parameters
Seção intitulada “Parameters”Query Parameters
Seção intitulada “Query Parameters”status
string
q
string
cursor
string
limit
number
updatedSince
string
Responses
Seção intitulada “Responses”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
contactName
required
string
contactPhone
required
string
fulfillment
required
string
zoneName
required
string
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
Example
{ "items": [ { "source": "storefront" } ]}