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).

GET/api/v1/admin/orders/{id}/packing-slipAdmin

Romaneio do pedido inteiro (JSON)

Dados do romaneio do pedido. Exige view_orders ou manage_orders.

Path parameters

iduuidobrigatório

Id do pedido.

GET/api/v1/admin/orders/{id}/packing-slip.pdfAdmin

Romaneio do pedido inteiro (PDF)

O mesmo romaneio em PDF (application/pdf, arquivo romaneio-<número>.pdf).

Path parameters

iduuidobrigatório

Id do pedido.

GET/api/v1/admin/orders/{id}/shipments/{shipmentId}/packing-slipAdmin

Romaneio 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ório

Id do pedido.

shipmentIduuidobrigatório

Id da remessa.

GET/api/v1/admin/orders/{id}/shipments/{shipmentId}/packing-slip.pdfAdmin

Romaneio de uma remessa (PDF)

O romaneio da remessa em PDF (arquivo romaneio-<número>-envio-<8 primeiros caracteres da remessa>.pdf).

Path parameters

iduuidobrigatório

Id do pedido.

shipmentIduuidobrigatório

Id da remessa.

Exemplo de requisição

bash

# JSON do pedido
curl "$BASE_URL/api/v1/admin/orders/$ORDER_ID/packing-slip" -H "Authorization: Bearer $TOKEN"

# PDF de uma remessa
curl -o romaneio.pdf \
  "$BASE_URL/api/v1/admin/orders/$ORDER_ID/shipments/$SHIPMENT_ID/packing-slip.pdf" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Romaneio em JSON

json

{
  "order_number": "PEDIDO-20261011-0001-V1",
  "order_date": "2026-10-11T20:14:40.706632Z",
  "ship_to": {
    "name": "Maria Souza",
    "address_line1": "Avenida Paulista, 1000",
    "city": "São Paulo",
    "state": "SP",
    "postal_code": "01310-100",
    "country": "BR",
    "phone": "11999990000"
  },
  "company_info": { "store_name": "Minha Loja" },
  "items": [
    { "line_number": 1, "product_name": "Notebook Vintage Vermelho", "product_sku": "SD-004018-C", "quantity": 1 }
  ],
  "tracking_number": "BR123456789BR",
  "carrier": "Correios",
  "shipping_method": "Entrega Padrão",
  "notes": "em transito",
  "generated_at": "2026-10-11T20:17:59.750555Z"
}

Campos da resposta

order_numberstring

Número do pedido.

order_datestring

Data do pedido. RFC 3339.

ship_toobject

Destinatário: name, address_line1, address_line2, district, complement, city, state, postal_code, country, phone.

company_infoobject

Dados da loja para o cabeçalho (store_name).

itemsarray

Itens a separar: line_number, product_name, product_sku, quantity. Sem preços.

tracking_numberstring

Código de rastreio, quando existe.

carrierstring

Transportadora, quando existe.

shipping_methodstring

Forma de envio escolhida na compra.

notesstring

Observações da remessa, quando existem.

generated_atstring

Quando o romaneio foi gerado. RFC 3339.

Erros

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":"..."}`

Veja também

Romaneio (packing slip)

Gera o romaneio de separação de um pedido ou de uma remessa, em JSON ou PDF, sem preços.

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).

GET/api/v1/admin/orders/{id}/packing-slipAdmin

Romaneio do pedido inteiro (JSON)

Dados do romaneio do pedido. Exige view_orders ou manage_orders.

Path parameters

iduuidobrigatório

Id do pedido.

GET/api/v1/admin/orders/{id}/packing-slip.pdfAdmin

Romaneio do pedido inteiro (PDF)

O mesmo romaneio em PDF (application/pdf, arquivo romaneio-<número>.pdf).

Path parameters

iduuidobrigatório

Id do pedido.

GET/api/v1/admin/orders/{id}/shipments/{shipmentId}/packing-slipAdmin

Romaneio 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ório

Id do pedido.

shipmentIduuidobrigatório

Id da remessa.

GET/api/v1/admin/orders/{id}/shipments/{shipmentId}/packing-slip.pdfAdmin

Romaneio de uma remessa (PDF)

O romaneio da remessa em PDF (arquivo romaneio-<número>-envio-<8 primeiros caracteres da remessa>.pdf).

Path parameters

iduuidobrigatório

Id do pedido.

shipmentIduuidobrigatório

Id da remessa.

Exemplo de requisição

bash

# JSON do pedido
curl "$BASE_URL/api/v1/admin/orders/$ORDER_ID/packing-slip" -H "Authorization: Bearer $TOKEN"

# PDF de uma remessa
curl -o romaneio.pdf \
  "$BASE_URL/api/v1/admin/orders/$ORDER_ID/shipments/$SHIPMENT_ID/packing-slip.pdf" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Romaneio em JSON

json

{
  "order_number": "PEDIDO-20261011-0001-V1",
  "order_date": "2026-10-11T20:14:40.706632Z",
  "ship_to": {
    "name": "Maria Souza",
    "address_line1": "Avenida Paulista, 1000",
    "city": "São Paulo",
    "state": "SP",
    "postal_code": "01310-100",
    "country": "BR",
    "phone": "11999990000"
  },
  "company_info": { "store_name": "Minha Loja" },
  "items": [
    { "line_number": 1, "product_name": "Notebook Vintage Vermelho", "product_sku": "SD-004018-C", "quantity": 1 }
  ],
  "tracking_number": "BR123456789BR",
  "carrier": "Correios",
  "shipping_method": "Entrega Padrão",
  "notes": "em transito",
  "generated_at": "2026-10-11T20:17:59.750555Z"
}

Campos da resposta

order_numberstring

Número do pedido.

order_datestring

Data do pedido. RFC 3339.

ship_toobject

Destinatário: name, address_line1, address_line2, district, complement, city, state, postal_code, country, phone.

company_infoobject

Dados da loja para o cabeçalho (store_name).

itemsarray

Itens a separar: line_number, product_name, product_sku, quantity. Sem preços.

tracking_numberstring

Código de rastreio, quando existe.

carrierstring

Transportadora, quando existe.

shipping_methodstring

Forma de envio escolhida na compra.

notesstring

Observações da remessa, quando existem.

generated_atstring

Quando o romaneio foi gerado. RFC 3339.

Erros

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":"..."}`