MCPFerramentas por capacidade
get_label_pdf
Baixar etiqueta
Baixar etiqueta
Ferramenta do Meu Ecommerce MCP, na capacidade de Etiquetas e postagens. A loja é vinculada à credencial da conexão remota. Confira os requisitos de permissão e disponibilidade na página da capacidade.
Entrada
| Campo | Tipo | Obrigatório no objeto | Descrição |
|---|---|---|---|
instanceId | string | Não | Merchant/store id. Ignored on authenticated servers (the merchant comes from the API key); used only on local/unauthenticated servers. |
prepostagemId | string | Sim | Correios pré-postagem id, as returned by generate_label in the prepostagemId field. |
Saída estruturada
| Campo | Tipo | Obrigatório no objeto | Descrição |
|---|---|---|---|
prepostagemId | string | Não | The pré-postagem id the PDF belongs to. |
status | string | Não | Correios status/business message, when the label isn't printable. |
labelPdfBase64 | string | Não | Base64-encoded label PDF, once ready. |
reason | string | Não | Why the PDF wasn't returned. |
actionUrl | string | Não | When set (e.g. reason=subscription_required), send the merchant here to finish setup. |
Tratamento da resposta
Examine reason e actionUrl quando presentes. As ferramentas de etiqueta podem retornar uma pré-postagem criada antes de o PDF estar disponível. Consulte o fluxo de etiquetas e erros e limites.
Contrato JSON
{
"type": "object",
"properties": {
"instanceId": {
"type": "string",
"description": "Merchant/store id. Ignored on authenticated servers (the merchant comes from the API key); used only on local/unauthenticated servers."
},
"prepostagemId": {
"type": "string",
"description": "Correios pré-postagem id, as returned by generate_label in the `prepostagemId` field."
}
},
"required": [
"prepostagemId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Referência gerada dos schemas do servidor. Os nomes de campos e as descrições técnicas originais são preservados.