MCPFerramentas por capacidade
recover_label_pdf
Recuperar PDF de etiqueta
Recuperar PDF de 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.
Sem nova emissão
Recupera o PDF de uma pré-postagem já confirmada na tentativa indicada por
supportCode, o código devolvido por generate_label. Não cria outra pré-postagem. Sem pré-postagem confirmada, retorna recovery_not_allowed: confira nos Correios antes de qualquer nova emissão. Cobre emissões feitas pelo MCP.Entrada
| Campo | Tipo | Obrigatório no objeto | Descrição |
|---|---|---|---|
instanceId | string | Não | Ignorado no servidor autenticado; a credencial determina a loja. |
supportCode | string | Sim | — |
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. |
labelPdfUrl | string | Não | Clickable link to download the label PDF — share this with the merchant/customer in chat. |
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. |
supportCode | string | Não | — |
journalUnavailable | boolean | Não | — |
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": "Ignorado no servidor autenticado; a credencial determina a loja."
},
"supportCode": {
"type": "string",
"format": "uuid"
}
},
"required": [
"supportCode"
],
"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.