Marcar pedido como retirado

Atualiza o pedido para o status `SUCCESSFUL.WITHDRAWN`, indicando que o cliente retirou o pacote presencialmente.

Header obrigatório. Toda chamada exige o header x-abbiamo-seller-group-key. Preencha-o no canto superior direito desta página ou veja como obter a sua chave.

Rate limit: 300 requisições por minuto por chave. Acima disso a API retorna HTTP 429.

Este endpoint move o pedido para SUCCESSFUL com sub_status WITHDRAWN. É o fim do ciclo de vida do pedido — nenhuma outra atualização pode ser feita depois disso.

A requisição falha se o pedido não for do tipo TAKEOUT ou ainda não estiver pronto pra retirada (status DISPATCHED).

POST
/v1/orders/{order_id}/withdrawn
x-abbiamo-seller-group-key<token>

In: header

Path Parameters

order_id*string

ID do pedido enviado nos eventos de webhook

Default"5c2c1dc2-0509-415c-a68c-a04d355d993c"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/v1/orders/5c2c1dc2-0509-415c-a68c-a04d355d993c/withdrawn" \  -H "Content-Type: application/json" \  -d '{    "event_at": "2022-12-15T12:15:08.060-03:00",    "receiver": {      "name": "Julio"    }  }'
"{ \n  \"success\": true\n}"
"{\n  \"statusCode\": \"400\",\n  \"message\": [\n    \"Invoice not found or not belongs to seller group\"\n  ],\n  \"error\": \"Bad Request\"\n}"
"{\n  \"message\": \"Unauthorized\"\n}"