Romaneio (packing slip)
Gera o romaneio de separação de um pedido ou de uma remessa, em JSON ou PDF, sem preços.
O romaneio (packing slip) é a folha que acompanha a separação e a embalagem: quem monta o pacote vê o que colocar na caixa e para onde ela vai. Diferente da fatura, não mostra preços, só os itens, as quantidades e o destino. Pode ser do pedido inteiro ou de uma remessa (quando o pedido sai em mais de um pacote, cada pacote tem o seu romaneio).
Existem quatro rotas, todas de leitura, com dois formatos cada: JSON (para o seu sistema montar a própria folha) e PDF (pronto para imprimir).
/api/v1/admin/orders/{id}/packing-slipAdminRomaneio do pedido inteiro (JSON)
Dados do romaneio do pedido. Exige view_orders ou manage_orders.
Path parameters
iduuidobrigatório/api/v1/admin/orders/{id}/packing-slip.pdfAdminRomaneio do pedido inteiro (PDF)
O mesmo romaneio em PDF (application/pdf, arquivo romaneio-<número>.pdf).
Path parameters
iduuidobrigatório/api/v1/admin/orders/{id}/shipments/{shipmentId}/packing-slipAdminRomaneio de uma remessa (JSON)
Romaneio de uma remessa: só os itens e as quantidades daquele pacote, com a transportadora e o código de rastreio quando existem.
Path parameters
iduuidobrigatórioshipmentIduuidobrigatório/api/v1/admin/orders/{id}/shipments/{shipmentId}/packing-slip.pdfAdminRomaneio de uma remessa (PDF)
O romaneio da remessa em PDF (arquivo romaneio-<número>-envio-<8 primeiros caracteres da remessa>.pdf).
Path parameters
iduuidobrigatórioshipmentIduuidobrigatórioExemplo de requisição
Resposta
Campos da resposta
order_numberstringorder_datestringship_toobjectname, address_line1, address_line2, district, complement, city, state, postal_code, country, phone.company_infoobjectstore_name).itemsarrayline_number, product_name, product_sku, quantity. Sem preços.tracking_numberstringcarrierstringshipping_methodstringnotesstringgenerated_atstringErros
| Status | Quando | Corpo |
|---|---|---|
| 401 | Sem credenciais ou token expirado | {"error":"invalid or expired token"} |
| 403 | Sem view_orders/manage_orders | {"error":"insufficient privileges","privilege_required_any":["manage_orders","view_orders"]} |
| 404 | O pedido não existe (rotas do pedido), ou o pedido ou a remessa não existem (rotas da remessa) | {"error":"order not found"} ou {"error":"order or shipment not found"} |
| 500 | Falha ao gerar o romaneio ou o PDF | {"error":"failed to generate packing slip","detail":"..."} |