Tracking

Analyseur de Conformité Payload pour /shipping/v3.1/shipping-order Boxtal v3.1

Validation API v3.1 d'après schéma dans la documentation Boxtal et le document Open API.
Comment ça marche ? Collez le corps JSON d'une requête POST /shipping/v3.1/shipping-order, tel quel, même mal formaté (copié d'un e-mail par exemple), puis cliquez sur « Formater et vérifier » : Chaque remarque a une gravité : erreur (refus probable), avertissement (risque) ou information. Pour comprendre chaque champ, voir le guide interactif ou la FAQ API Boxtal.

Payload JSON à tester

Visualisation de la structure

En attente de soumission...

« Créer l'expédition (build) » envoie réellement le payload à l'environnement de test api.boxtal.build (non facturé) avec les clés API v3 de test.

Résultat de l'analyse

Soumettez un payload pour voir les erreurs de paramètres manquants ou de types.

📖 Schéma (CreateShippingOrderRequest)

💡 Mode d'emploi : cliquez sur les dossiers 📁 pour dérouler les objets et voir les champs attendus. Cette documentation est générée à partir de la spécification (api-v3.json), avec les corrections de ses incohérences connues ; les champs renseignés par Boxtal (lecture seule) ne sont pas affichés.
🎯 Légende : 🔴 obligatoire | 🟠 obligatoire selon le cas | ⚪ facultatif | 💡 conseil pratique
⚪ insured boolean défaut : false
🔴 shipment object
💡 L'envoi lui-même : adresses, colis, points relais et douane.
🔴 packages tableau de Package
Tableau de colis à expédier.
⚪ type string PARCEL | LETTER | PALLET défaut : PARCEL
Le type de conteneur physique pour tous les éléments de cet envoi (colis, lettre ou palette)
🔴 value object
La valeur des marchandises contenues dans le colis.
💡 La valeur doit être strictement supérieure à 0.
🔴 value number
⚪ currency string EUR défaut : EUR
💡 Seule valeur acceptée : EUR (valeur par défaut).
🔴 width integer ex. 15
Le second côté le plus long du colis en centimètres.
🟠 height integer défaut : 0 ex. 11
Obligatoire en pratique, sauf pour le type LETTER (0 par défaut, refusé par la plupart des offres colis).
Le côté le plus court du colis en centimètres. Non requis pour les colis de type LETTER.
🔴 length integer ex. 16
Le côté le plus long du colis en centimètres.
🔴 weight number ex. 1.5
Le poids du colis en kilogrammes. La précision est au gramme près (0,001 kg)
🔴 content object
La description du contenu du colis. L'id de la catégorie de contenu doit être le même pour tous les éléments.
💡 Obligatoire en pratique (la spécification le déclare par erreur au niveau du shipment). Liste des catégories : GET /shipping/v3.1/content-category.
🔴 id string
L'id de la catégorie de contenu (voir GET /content-category)
🔴 description string
Une description en texte libre du contenu.
⚪ stackable boolean ex. true
Si le package est empilable ou non. Ce champ n'est pas encore utilisé.
⚪ externalId string ex. XYZ12345
Un identifiant unique pour le Package, généralement provenant d'un autre système.
🔴 toAddress object
L'adresse de destination.
🔴 type string RESIDENTIAL | BUSINESS
BUSINESS: l'adresse est une adresse professionnelle (accessible durant les heures de bureau) RESIDENTIAL: l'adresse est résidentielle ou considérée comme telle
🔴 contact object
🔴 email string
🔴 phone string
numéro de téléphone portable.
💡 Portable au format international, sans espaces : +33612345678.
⚪ company string
💡 Recommandé pour une adresse BUSINESS. Conseil : 35 caractères maximum.
🔴 lastName string
💡 Conseil : 35 caractères maximum.
🔴 firstName string
💡 Conseil : 35 caractères maximum.
🔴 location object
🔴 city string ex. Paris
💡 Conseil : 35 caractères maximum chez la plupart des transporteurs.
🟠 state string
Généralement exigé pour les États-Unis et le Canada.
Code ISO à 2 lettres pour l'état
⚪ number string ex. 4
🔴 street string ex. boulevard des capucines
💡 Conseil : 35 caractères maximum chez la plupart des transporteurs.
🟠 postalCode string ex. 75009
Facultatif dans la spécification, mais indispensable en pratique (sauf pays sans code postal).
💡 Toujours entre guillemets (ex. "01000") pour ne pas perdre le zéro initial.
🔴 countryIsoCode string ex. FR
Code ISO à 2 lettres pour le pays
💡 Obligatoire : la spécification déclare par erreur un champ « country », c'est bien countryIsoCode qu'il faut envoyer.
⚪ additionalInformation string
⚪ externalId string ex. ABC1234
Identifiant pour le Shipment, généralement issu d'un autre système.
💡 Mettez votre numéro de commande : il revient dans les webhooks (shipmentExternalId).
🔴 fromAddress object
L'adresse d'expédition.
🔴 type string RESIDENTIAL | BUSINESS
BUSINESS: l'adresse est une adresse professionnelle (accessible durant les heures de bureau) RESIDENTIAL: l'adresse est résidentielle ou considérée comme telle
🔴 contact object
🔴 email string
🔴 phone string
numéro de téléphone portable.
💡 Portable au format international, sans espaces : +33612345678.
⚪ company string
💡 Recommandé pour une adresse BUSINESS. Conseil : 35 caractères maximum.
🔴 lastName string
💡 Conseil : 35 caractères maximum.
🔴 firstName string
💡 Conseil : 35 caractères maximum.
🔴 location object
🔴 city string ex. Paris
💡 Conseil : 35 caractères maximum chez la plupart des transporteurs.
🟠 state string
Généralement exigé pour les États-Unis et le Canada.
Code ISO à 2 lettres pour l'état
⚪ number string ex. 4
🔴 street string ex. boulevard des capucines
💡 Conseil : 35 caractères maximum chez la plupart des transporteurs.
🟠 postalCode string ex. 75009
Facultatif dans la spécification, mais indispensable en pratique (sauf pays sans code postal).
💡 Toujours entre guillemets (ex. "01000") pour ne pas perdre le zéro initial.
🔴 countryIsoCode string ex. FR
Code ISO à 2 lettres pour le pays
💡 Obligatoire : la spécification déclare par erreur un champ « country », c'est bien countryIsoCode qu'il faut envoyer.
⚪ additionalInformation string
⚪ returnAddress object
Si cette adresse n'est pas définie, l'adresse fromAddress sera utilisée comme adresse de retour.
🔴 type string RESIDENTIAL | BUSINESS
BUSINESS: l'adresse est une adresse professionnelle (accessible durant les heures de bureau) RESIDENTIAL: l'adresse est résidentielle ou considérée comme telle
🔴 contact object
🔴 email string
🔴 phone string
numéro de téléphone portable.
💡 Portable au format international, sans espaces : +33612345678.
⚪ company string
💡 Recommandé pour une adresse BUSINESS. Conseil : 35 caractères maximum.
🔴 lastName string
💡 Conseil : 35 caractères maximum.
🔴 firstName string
💡 Conseil : 35 caractères maximum.
🔴 location object
🔴 city string ex. Paris
💡 Conseil : 35 caractères maximum chez la plupart des transporteurs.
🟠 state string
Généralement exigé pour les États-Unis et le Canada.
Code ISO à 2 lettres pour l'état
⚪ number string ex. 4
🔴 street string ex. boulevard des capucines
💡 Conseil : 35 caractères maximum chez la plupart des transporteurs.
🟠 postalCode string ex. 75009
Facultatif dans la spécification, mais indispensable en pratique (sauf pays sans code postal).
💡 Toujours entre guillemets (ex. "01000") pour ne pas perdre le zéro initial.
🔴 countryIsoCode string ex. FR
Code ISO à 2 lettres pour le pays
💡 Obligatoire : la spécification déclare par erreur un champ « country », c'est bien countryIsoCode qu'il faut envoyer.
⚪ additionalInformation string
🟠 pickupPointCode string ex. 99439
Obligatoire pour une livraison en point relais.
Le point de proximité où le destinataire récupérera le colis. Obligatoire dans le cas d'un service d'expédition de colis en point relais.
💡 Valeur du champ « code » renvoyé par la recherche de points relais ou par le composant Carte.
⚪ dropOffPointCode string ex. 99438
Le point de proximité où l'expéditeur déposera le colis. Obligatoire dans le cas d'un service d'expédition de colis en point relais.
🟠 customsDeclaration object
Obligatoire hors UE, en outre-mer, aux Canaries, à Ceuta et Melilla.
⚪ reason string SALE | REPAIR | RETURN | GIFT | SAMPLE | DOCUMENTS | PERSONAL_USE | OTHER
Utilisez: - SALE pour une vente. - REPAIR pour une réparation. - RETURN pour un retour. - GIFT pour un cadeau. - SAMPLE pour un échantillon. - DOCUMENTS pour des documents inter-entreprise. - PERSONAL_USE pour un usage personnel. - OTHER pour tout autre raison.
⚪ articles tableau de Article
Tableau des descriptions de marchandises destinées à l'expédition internationale.
🔴 quantity number ex. 2
🔴 unitValue object
valeur unitaire
💡 Valeur unitaire, strictement supérieure à 0.
🔴 value number
⚪ currency string EUR défaut : EUR
💡 Seule valeur acceptée : EUR (valeur par défaut).
🔴 unitWeight number ex. 0.7
poids unitaire en kilo
🔴 description string ex. Illustrated book for children
description de la marchandise (en anglais si possible)
⚪ tariffNumber string ex. 49030000
Le code de l'article dans le système harmonisé. Voir https://help.boxtal.com/fr/fr/article/understanding-hs-codes
🔴 originCountry string ex. FR
Code ISO à 2 lettres du pays d'origine
⚪ packageExternalId string ex. XYZ12345
L'identifiant du colis contenant cet article. Non utilisé actuellement.
⚪ labelType string PDF_A4 | PDF_10x15 ex. PDF_A4
Le format des bordereaux d'expédition de cet envoi. Si aucune préférence n'est spécifiée, les préférences du compte sont utilisées pour définir la valeur par défaut de ce paramètre. Si aucune préférence n'est spécifiée, PDF_A4 est choisi.
🟠 shippingOfferId string
à utiliser à la place de shippingOfferCode, pour les offres de contrats hébergés.
L'identifiant de l'offre d'expédition. Doit être spécifié lorsque vous souhaitez utiliser des offres d'expédition de contrats hébergés.
💡 Exemple : expédier avec votre propre contrat Colissimo.
🟠 shippingOfferCode string ex. MONR-CpourToi
Obligatoire sauf si shippingOfferId est renseigné.
Le code de l'offre d'expédition. Ce champ est obligatoire sauf si vous spécifiez un shippingOfferId.
💡 Format TRANSPORTEUR-Service. Les offres disponibles dépendent des contrats activés sur le compte.
⚪ expectedTakingOverDate string ex. 2022-10-20
La date souhaitée à laquelle le transporteur devra traiter (recevra en dépôt ou collectera) les colis à expédier.
💡 Format AAAA-MM-JJ, de préférence un jour ouvré à venir.