Listar itens do carrinho no Melhor Envio, por uma API

Lista as etiquetas do carrinho que ainda não foram pagas, com id, serviço, preço, remetente, destinatário e volumes. As etiquetas ficam 20 dias no carrinho. 10 por página: passe page para as próximas, até last_page.

Identificador
melhor_envio_list_cart_items

A chamada

POST https://connect.reportei.com/api/tools/melhor_envio_list_cart_items/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "page": 1
  }
}

Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.

Parâmetros

As descrições dos parâmetros seguem a documentação oficial do app, em inglês.

ParâmetroTipoObrigatórioDescrição
pageintegerNãoPage to read. The default is 1.

Conexões possíveis

O seu cliente conecta a conta do Melhor Envio uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.

OAuth com o app do seu produto

Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/melhor_envio, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.

A resposta

Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.

Pronta para agentes de IA

O input desta tool é um JSON Schema, disponível em GET /api/tools/melhor_envio_list_cart_items. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Melhor Envio

Ver as 12 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.