Este hook é ativado sempre que um código de retirada é gerado para um pedido.
Método
POST
Parâmetros de rota suportados
| Campo | Tipo | Descrição |
|---|---|---|
| identificador da loja | string | identificador da loja que preparou o pedido |
| número do pedido | string | identificador do pedido |
| identificador do canal | string | canal de origem do pedido (Vtex, ECommerece, iFood, Rappi, Shopee, MercadoLivre e outros) |
Ou seja, um endpoint poderia ter o caminho https://suaapi.domain.com/orders/{number}/pickupcodes, que ficaria assim no momento do evento https://suaapi.domain.com/orders/12345-01/pickupcodes.
Headers
Qualquer header com valor fixo pode ser configurado
Corpo
| Campo | Tipo | Descrição |
|---|---|---|
| storeCode | string | string identificadora da loja à qual o pedido com o SKU cancelado pertence |
| orderNumber | string | identificador do pedido ao qual o SKU cancelado pertence |
| sourceType | string | canal de origem do pedido |
| extras | object | informações adicionais do pedido armazenadas na entrada do pedido |
| - pickupCodes | array | códigos de retirada (te, casps e, que um pedido tem múltiplos códigos) |
| code | string | código de retirada |
| isExternal | boolean | flag para indicar se o código foi gerado por nossa plataforma (default false) |
| expiresAt | datetime | data de expiração, essa informação é opcional (fuso horário UTC) |
Exemplo do corpo da requisição que será enviado
{
"storeCode": "store-01",
"orderNumber": "1234567890-01",
"sourceType": "Ecommerce",
"pickupCodes":[
{
"code": "123456",
"isExternal": false,
"expiredAt": "2026-01-01T10:00:00.000Z"
}
]
}
Retentativas
Em caso de falha serão enviadas mais 3 requisições com intervalo entre 5 e 15min.