MCPFerramentas por capacidade
track_shipment
Rastrear objetos
Rastrear objetos
Ferramenta do Meu Ecommerce MCP, na capacidade de Rastreamento. 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. |
codes | array | Sim | Correios tracking codes, e.g. "AA123456789BR". Spaces are ignored; up to 50 per call. Mín. 1 itens. |
Saída estruturada
| Campo | Tipo | Obrigatório no objeto | Descrição |
|---|---|---|---|
results | array | Sim | — |
results[].code | string | Sim | — |
results[].found | boolean | Sim | — |
results[].delivered | boolean | Sim | — |
results[].lastStatus | object | Não | — |
results[].lastStatus.code | string | Sim | — |
results[].lastStatus.type | string | Não | — |
results[].lastStatus.timestamp | string | Não | — |
results[].lastStatus.description | string | Sim | — |
results[].lastStatus.origin | string | Não | — |
results[].lastStatus.destination | string | Não | — |
results[].events | array | Sim | — |
results[].events[].code | string | Sim | — |
results[].events[].type | string | Não | — |
results[].events[].timestamp | string | Não | — |
results[].events[].description | string | Sim | — |
results[].events[].origin | string | Não | — |
results[].events[].destination | string | Não | — |
results[].message | string | Não | — |
reason | string | Não | Why no lookup could be performed, when results is empty. |
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."
},
"codes": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"description": "Correios tracking codes, e.g. \"AA123456789BR\". Spaces are ignored; up to 50 per call."
}
},
"required": [
"codes"
],
"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.