Créer un article du panier avec l'API Melhor Envio

Ajoute une étiquette au panier du compte et la renvoie. Son id est l'id de l'étiquette dans les autres outils. Rien n'est payé avant Acheter des étiquettes. Correios, J&T et Loggi acceptent un colis par appel : pour plusieurs colis, ajoutez un article par colis.

Identifiant
melhor_envio_create_cart_item

L'appel

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "service": 1,
    "from": {},
    "to": {},
    "products": [],
    "volumes": []
  }
}

Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.

Paramètres

Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.

ParamètreTypeObligatoireDescription
serviceintegerOuiId of the service chosen in Calculate shipping, such as 1 for PAC.
fromobjectOuiSender. A person sends document (CPF); a company sends company_document (CNPJ) and state_register.
toobjectOuiRecipient. A person sends document (CPF); a company sends company_document (CNPJ) and state_register.
productsarrayOuiEvery product in the shipment, complete: it goes into the content declaration sent to SEFAZ.
volumesarrayOuiPackages of the shipment, with the dimensions and weight of the packages of the chosen service in Calculate shipping.
optionsobjectNonInsurance, additional services and documents of the shipment.

Connexions possibles

Votre client connecte son compte Melhor Envio une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.

OAuth avec l'app de votre produit

Vous enregistrez une fois l'app OAuth de votre produit, avec POST /api/merchants/credentials/melhor_envio, et votre client autorise le compte sur un écran de consentement. Connect renouvelle le token avant son expiration.

La réponse

En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.

Prête pour les agents IA

L'input de cette tool est un JSON Schema, disponible via GET /api/tools/melhor_envio_create_cart_item. Il devient la définition de tool de votre agent sans conversion.

Autres tools Melhor Envio

Voir les 12 tools

Toolkits de la même catégorie

Voir les 100 toolkits

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.