Abbiamo DocsInstruções de retirada (PDF)
Retorna um PDF com as instruções de Clique e Retire da filial, prontas para impressão ou exibição no ponto de venda.
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 devolve um PDF com as instruções de retirada de uma filial — o material de apoio que acompanha o QR Code estático no ponto de venda. Traz o passo a passo que o cliente segue para retirar o pedido:
- Escanear o QR Code de retirada.
- Informar o código de rastreio recebido por e-mail e SMS para buscar o pedido.
- Preencher os dados e o código de confirmação para validar a retirada na loja.
- Conferir que a retirada foi confirmada com sucesso.
A filial é identificada pelo identifier na URL (o mesmo seller_identifier usado na criação de pedidos) e precisa pertencer ao seller group autenticado.
Exemplo do material
O PDF vem pronto para impressão, com a marca, o QR Code da filial e o passo a passo da retirada:
A resposta é binária (application/pdf). Salve o corpo da resposta direto como arquivo .pdf para imprimir ou exibir no ponto de venda.
A requisição falha com 403 se a filial informada não pertencer ao seller group autenticado, e com 404 se nenhuma filial for encontrada para o identifier.
Authorization
sellerGroupKey In: header
Path Parameters
Identificador da filial — o mesmo seller_identifier usado na criação de pedidos. Default: documento (CNPJ) da filial.
Response Body
application/pdf
application/json
application/json
application/json
curl -X GET "https://example.com/v1/takeout/seller/string/instructions""string"{
"message": "Unauthorized"
}{
"message": "Given seller does not belong to seller group",
"code": "SELLER_NOT_IN_SELLER_GROUP",
"status": "FORBIDDEN"
}{
"message": "Seller not found",
"code": "SELLER_NOT_FOUND",
"status": "NOT_FOUND"
}