POST /v1/orders/{id}/status
POST
/v1/orders/{id}/status
const url = 'https://seu-endereco-da-api/v1/orders/example/status';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"status":"received","version":1,"reason":"example","acknowledgePaidCharge":true}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://seu-endereco-da-api/v1/orders/example/status \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "status": "received", "version": 1, "reason": "example", "acknowledgePaidCharge": true }'Permissão que a Chave de acesso precisa: Criar e atualizar pedidos (orders:manage).
Authorizations
Seção intitulada “Authorizations”Parameters
Seção intitulada “Parameters”Path Parameters
Seção intitulada “Path Parameters”id
required
string
Request Bodyrequired
Seção intitulada “Request Bodyrequired”Media typeapplication/json
object
status
required
string
version
required
number
reason
string
acknowledgePaidCharge
boolean
Responses
Seção intitulada “Responses”Media typeapplication/json
object
id
required
string
number
required
number
status
required
string
version
required
number
source
required
string
contactId
required
string
contactName
required
string
contactPhone
required
string
conversationId
required
string
fulfillment
required
string
zoneName
required
string
deliveryFeeCents
required
number
subtotalCents
required
number
totalCents
required
number
address
required
object
notes
required
string
paymentMethod
required
string
changeForCents
required
number
payment
required
object
state
required
string
canceledReason
required
string
createdAt
required
string
updatedAt
required
Last change of the order, which is when it reached its current status
string
items
required
Array<object>
object
retailerId
required
string
name
required
string
amountCents
required
number
quantity
required
number
timeline
required
Array<object>
object
status
required
string
at
required
string
byName
required
string
notifications
required
Array<object>
object
status
required
string
outcome
required
Queued, held, skipped_window_closed or failed
string
reason
required
string
nextStatuses
required
Statuses the order may move to now
Array<string>
publicUrl
required
Customer tracking link, null while STORE_PUBLIC_URL is unset
string
pixCancel
required
What happened to the open Pix when the order was canceled
string
Example
{ "source": "storefront", "pixCancel": "none"}Stale version, invalid transition, not enough stock or a paid Pix not acknowledged