Etiquetas

Envio de etiquetas customizadas nos pedidos de venda

POST {url_base}/labels/{id}

Permite o envio de etiquetas de frete customizada para um pedido de venda que tem como origem, por exemplo, um marketplace e precisa obrigatoriamente ter uma etiqueta externa.

O tipo do conteúdo dessa requisição deve ser: multipart/form-data

Headers

Name	Type	Description
X-Api-Version*	String	Versão da API a ser utilizada, de acordo com a documentação Enviar "v1" como default
X-Api-Key*	String	Chave de API criada através da plataforma

Request Body

Name	Type	Description
file*	File	Arquivo da etiqueta no formato PDF ou .ZPL

Limitações

• Tamanho máximo por arquivo é de 1MB

• Serão aceitos arquivos no formato PDF (tipo application/pdf) ou no formato ZPL (tipo text/plain - recomendado, ou application/octet-stream)

Especificações ZPL

• Formato: Texto que comece com ^XA e termine com ^XZ

• Dimensões: 4x6" (10x15 cm)

• Validação: O sistema detecta automaticamente pelo conteúdo ^XA

200: OK Etiqueta enviada com sucesso

{
	"message": "Label integrated successfully"
}

400: Bad Request Parâmetros obrigatórios inválidos

400: Bad Request Parâmetros obrigatórios inválidos

400: Bad Request ID do pedido inválido

401: Unauthorized Acesso não autorizado

---

Envio em lote de etiquetas customizadas nos pedidos de venda

POST {url_base}/labels

Permite o envio de múltiplas etiquetas de frete para múltiplos pedidos simultaneamente.

O tipo do conteúdo dessa requisição deve ser: multipart/form-data

Headers

Name	Type	Description
X-Api-Version*	String	Versão da API a ser utilizada, de acordo com a documentação Enviar "v1" como default
X-Api-Key*	String	Chave de API criada através da plataforma

Parâmetros do Body

Nome	Tipo	Descrição
orders[n].file*	File	Arquivo no formato PDF ou ZPL da etiqueta de envio
orders[n].order_id*	String	ID externo do pedido ao qual a etiqueta será associada

Limitações

• Tamanho máximo por arquivo é de 1MB

• Tamanho máximo total (soma dos arquivos enviados na requisição): 10MB

• Serão aceitos arquivos no formato PDF (tipo application/pdf) ou no formato ZPL (tipo text/plain - recomendado, ou application/octet-stream)

Especificações ZPL

• Formato: Texto que comece com ^XA e termine com ^XZ

• Dimensões: 4x6" (10x15 cm)

• Validação: O sistema detecta automaticamente pelo conteúdo ^XA

200: OK Etiquetas enviadas com sucesso

{
	"success": [
		{
			"order_id": "6910",
			"message": "Label integrated successfully"
		},
		{
			"order_id": "6456",
			"message": "Label integrated successfully"
		}
	],
	"failures": []
}

400: Bad Request Tamanho do arquivo excede limite

400: Bad Request Tamanho da soma dos arquivos excede o limite

400: Bad Request Parâmetros obrigatórios inválidos

400: Bad Request ID do pedido inválido

401: Unauthorized Acesso não autorizado