Pular para o conteúdo

POST /v1/orders/{id}/status

POST
/v1/orders/{id}/status
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).

id
required
string
Media typeapplication/json
object
status
required
string
Allowed values: received confirmed preparing ready out_for_delivery delivered canceled
version
required
number
reason
string
<= 200 characters
acknowledgePaidCharge
boolean
Media typeapplication/json
object
id
required
string
number
required
number
status
required
string
version
required
number
source
required
string
Allowed values: storefront operator agent
contactId
required
string
contactName
required
string
contactPhone
required
string
conversationId
required
string
nullable
fulfillment
required
string
zoneName
required
string
nullable
deliveryFeeCents
required
number
subtotalCents
required
number
totalCents
required
number
address
required
object
notes
required
string
nullable
paymentMethod
required
string
changeForCents
required
number
nullable
payment
required
object
state
required
string
canceledReason
required
string
nullable
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
nullable
notifications
required
Array<object>
object
status
required
string
outcome
required

Queued, held, skipped_window_closed or failed

string
reason
required
string
nullable
nextStatuses
required

Statuses the order may move to now

Array<string>
publicUrl
required

Customer tracking link, null while STORE_PUBLIC_URL is unset

string
nullable
pixCancel
required

What happened to the open Pix when the order was canceled

string
Allowed values: none canceled failed

Example

{
"source": "storefront",
"pixCancel": "none"
}

Stale version, invalid transition, not enough stock or a paid Pix not acknowledged