Offrez à vos clients la possibilité de créer des envois et étiquettes Zonos depuis votre plateforme.
Ce guide est conçu pour les développeurs de plateformes d'expédition qui souhaitent intégrer les capacités de création d'envois Zonos dans leur plateforme pour leurs clients. Si vous utilisez déjà l'API Zonos et devez simplement créer des envois pour des commandes existantes, consultez notre guide de création d'envoi.
Si vous êtes une plateforme d'expédition qui prend en charge les clients Zonos expédiant à l'international, l'intégration avec Zonos pour la création d'envois devrait être une priorité. Cela vous permettra d'offrir l'expérience la plus fluide à vos marchands et leurs clients en tirant parti des fonctionnalités existantes de votre plateforme tout en laissant Zonos gérer la création de l'envoi, de l'étiquette et de la documentation douanière associée.
Les avantages de l'utilisation de Zonos pour créer des envois incluent :
Facturation tierce des droits et taxes — Nous veillerons à ce que votre numéro de compte transporteur ou celui de votre marchand soit utilisé pour les frais d'expédition, tandis que les factures de droits et taxes sont adressées à Zonos.
Flexibilité — Au lieu d'effectuer un travail de développement pour garantir que vous pouvez générer des étiquettes conformes avec votre plateforme, intégrez notre API et laissez-nous gérer la conformité transfrontalière en constante évolution.
Documentation douanière précise — Lorsque vous utilisez Zonos pour générer des étiquettes, nous veillons à ce que les bonnes informations soient transmises au transporteur pour que le colis passe rapidement la douane.
Ce guide vous accompagnera dans les étapes pour implémenter une intégration complète de bout en bout qui vous permettra d'appeler Zonos pour des envois depuis votre plateforme.
Suivez les étapes ci-dessous pour permettre à vos clients de récupérer des étiquettes Zonos depuis votre plateforme.
1
Autoriser les identifiants API
L'API Zonos est accessible via un credentialToken. Votre plateforme devra permettre aux clients de saisir leur credentialToken depuis Zonos Dashboard dans votre plateforme. Vous pourrez ensuite effectuer des requêtes à Zonos en leur nom.
2
Créer un envoi
Pour récupérer une label, vous devez créer un shipment auquel l'étiquette sera associée. Zonos gère ce processus avec un flux de travail qui crée shipments et labels dans la même requête. Lors de cette mutation, vous n'avez pas besoin de transmettre un serviceLevel car nous utiliserons le serviceLevel du landedCost lié à la order. Pour l'orderId, vous pouvez utiliser l'identifiant de commande Zonos ou l'accountOrderNumber probablement déjà présent dans votre système.
Lorsqu'un envoi et des étiquettes sont créés avec succès, nous renverrons les étiquettes sous forme de labelImage qui est une BASE64_ENCODED_IMAGE, ou sous forme d'url depuis laquelle l'étiquette peut être récupérée.
Utilisez ce flux de travail lorsque vous créez un envoi pour une commande existante et n'avez pas besoin de modifier les détails d'articles ou de parties. Il prend en charge les numéros de suivi facultatifs, les centres de fulfillment, la sélection du niveau de service et l'assurance valeur déclarée.
Marchands Shopify
Shopify transmet une valeur null pour person dans la partie origine. En conséquence, orderId seul ne fonctionnera pas pour les marchands Shopify — utilisez plutôt l'onglet Création d'envoi avancée et fournissez les détails complets de la partie incluant person.
Avec centre de fulfillment : Ajoutez "fulfillmentCenter": "fulfillment_center_12345" pour spécifier le lieu d'origine
Avec suivi personnalisé : Définissez "generateLabel": false et ajoutez "trackingNumbers": ["tracking_1", "tracking_2"]
Avec niveau de service : Ajoutez "serviceLevel": "dhl.express_example" pour sélectionner un service transporteur spécifique
Avec assurance valeur déclarée : Ajoutez "isDeclaredValue": true pour activer la couverture de valeur déclarée
Avec services spéciaux : Consultez le guide des services spéciaux pour les batteries, la glace carbonique, les marchandises dangereuses et les options de signature.
Valeur déclarée
Définissez "isDeclaredValue": true pour activer la couverture de valeur déclarée pour tous les articles de votre envoi. Zonos réclame automatiquement la valeur totale de tous les articles soumis dans la commande ; les marchands ne peuvent pas modifier ce montant. Cela définit la responsabilité maximale que le transporteur acceptera en cas de perte, dommage ou vol pendant le transit. Cette fonctionnalité n'est prise en charge que pour les envois UPS, FedEx et DHL. Zonos gère automatiquement l'implémentation spécifique au transporteur lorsque vous activez la valeur déclarée, y compris les paramètres appropriés dans nos appels API à ces transporteurs, vous n'avez donc pas besoin de gérer les exigences de chaque transporteur.
Limitations UPS : UPS ne couvre que des valeurs entre 100 et 50 000 USD et traite la valeur déclarée au niveau du colis. Pour les envois multi-colis, les marchands doivent diviser l'envoi pour désigner la couverture par colis. UPS génère également un formulaire d'assurance supplémentaire qui doit être imprimé avec les étiquettes.
FedEx et DHL : Traitent la valeur déclarée au niveau de l'envoi sans restrictions supplémentaires.
Services spéciaux
Utilisez specialServices sur un colis pour indiquer les exigences de manutention spéciale pour les batteries, la glace carbonique, les marchandises dangereuses ou les exigences de signature. Consultez le guide des services spéciaux pour les détails complets et des exemples.
ShipStation UPS Unlock : Les envois multipièces ne sont pas pris en charge. Lorsqu'une commande est expédiée en plusieurs colis, le champ de référence est dupliqué, ce qui fait échouer la correspondance du numéro de commande côté backend. Les marchands ayant besoin d'envois multipièces doivent créer l'étiquette dans Zonos Dashboard. Les envois en un seul colis ne sont pas affectés.
3
Annuler un envoi
Si un client souhaite annuler un shipment, vous pouvez utiliser la mutation suivante qui annulera toutes les labels liées au shipment.
Intégration d'expédition pour plateformes
Créer des envois depuis votre plateforme
Offrez à vos clients la possibilité de créer des envois et étiquettes Zonos depuis votre plateforme.
Ce guide est conçu pour les développeurs de plateformes d'expédition qui souhaitent intégrer les capacités de création d'envois Zonos dans leur plateforme pour leurs clients. Si vous utilisez déjà l'API Zonos et devez simplement créer des envois pour des commandes existantes, consultez notre guide de création d'envoi.
Si vous êtes une plateforme d'expédition qui prend en charge les clients Zonos expédiant à l'international, l'intégration avec Zonos pour la création d'envois devrait être une priorité. Cela vous permettra d'offrir l'expérience la plus fluide à vos marchands et leurs clients en tirant parti des fonctionnalités existantes de votre plateforme tout en laissant Zonos gérer la création de l'envoi, de l'étiquette et de la documentation douanière associée.
Les avantages de l'utilisation de Zonos pour créer des envois incluent :
Ce guide vous accompagnera dans les étapes pour implémenter une intégration complète de bout en bout qui vous permettra d'appeler Zonos pour des envois depuis votre plateforme.
Activer l'impression d'étiquettes
Suivez les étapes ci-dessous pour permettre à vos clients de récupérer des étiquettes Zonos depuis votre plateforme.
Autoriser les identifiants API
L'API Zonos est accessible via un
credentialToken. Votre plateforme devra permettre aux clients de saisir leurcredentialTokendepuis Zonos Dashboard dans votre plateforme. Vous pourrez ensuite effectuer des requêtes à Zonos en leur nom.Créer un envoi
Pour récupérer une
label, vous devez créer unshipmentauquel l'étiquette sera associée. Zonos gère ce processus avec un flux de travail qui créeshipmentsetlabelsdans la même requête. Lors de cette mutation, vous n'avez pas besoin de transmettre unserviceLevelcar nous utiliserons leserviceLeveldulandedCostlié à laorder. Pour l'orderId, vous pouvez utiliser l'identifiant de commande Zonos ou l'accountOrderNumberprobablement déjà présent dans votre système.Lorsqu'un envoi et des étiquettes sont créés avec succès, nous renverrons les étiquettes sous forme de
labelImagequi est uneBASE64_ENCODED_IMAGE, ou sous forme d'urldepuis laquelle l'étiquette peut être récupérée.Utilisez ce flux de travail lorsque vous créez un envoi pour une commande existante et n'avez pas besoin de modifier les détails d'articles ou de parties. Il prend en charge les numéros de suivi facultatifs, les centres de fulfillment, la sélection du niveau de service et l'assurance valeur déclarée.
Shopify transmet une valeur null pour
persondans la partie origine. En conséquence,orderIdseul ne fonctionnera pas pour les marchands Shopify — utilisez plutôt l'onglet Création d'envoi avancée et fournissez les détails complets de la partie incluantperson.mutation CreateShipment($input: ShipmentCreateWorkflowInput!) {shipmentCreateWorkflow(input: $input) {idstatustrackingDetails {number}serviceLevel {idnamecarrier {idname}}shipmentCartons {idcarton {idwidthlengthheightweightitemsitemidamountdescriptionlabelurltrackingNumberiddocumentFilingOptions de variables :
"fulfillmentCenter": "fulfillment_center_12345"pour spécifier le lieu d'origine"generateLabel": falseet ajoutez"trackingNumbers": ["tracking_1", "tracking_2"]"serviceLevel": "dhl.express_example"pour sélectionner un service transporteur spécifique"isDeclaredValue": truepour activer la couverture de valeur déclaréeValeur déclarée
Définissez
"isDeclaredValue": truepour activer la couverture de valeur déclarée pour tous les articles de votre envoi. Zonos réclame automatiquement la valeur totale de tous les articles soumis dans la commande ; les marchands ne peuvent pas modifier ce montant. Cela définit la responsabilité maximale que le transporteur acceptera en cas de perte, dommage ou vol pendant le transit. Cette fonctionnalité n'est prise en charge que pour les envois UPS, FedEx et DHL. Zonos gère automatiquement l'implémentation spécifique au transporteur lorsque vous activez la valeur déclarée, y compris les paramètres appropriés dans nos appels API à ces transporteurs, vous n'avez donc pas besoin de gérer les exigences de chaque transporteur.Limitations UPS : UPS ne couvre que des valeurs entre 100 et 50 000 USD et traite la valeur déclarée au niveau du colis. Pour les envois multi-colis, les marchands doivent diviser l'envoi pour désigner la couverture par colis. UPS génère également un formulaire d'assurance supplémentaire qui doit être imprimé avec les étiquettes.
FedEx et DHL : Traitent la valeur déclarée au niveau de l'envoi sans restrictions supplémentaires.
Services spéciaux
Utilisez
specialServicessur un colis pour indiquer les exigences de manutention spéciale pour les batteries, la glace carbonique, les marchandises dangereuses ou les exigences de signature. Consultez le guide des services spéciaux pour les détails complets et des exemples.ShipStation UPS Unlock : Les envois multipièces ne sont pas pris en charge. Lorsqu'une commande est expédiée en plusieurs colis, le champ de référence est dupliqué, ce qui fait échouer la correspondance du numéro de commande côté backend. Les marchands ayant besoin d'envois multipièces doivent créer l'étiquette dans Zonos Dashboard. Les envois en un seul colis ne sont pas affectés.
Annuler un envoi
Si un client souhaite annuler un
shipment, vous pouvez utiliser la mutation suivante qui annulera toutes leslabelsliées aushipment.mutation {shipmentStatusUpdate(input: {shipment: "shipment_f1fe4dbd-e471-49fa-94e7-84e369083223"status: VOIDEDnote: "Voiding shipment"}) {idstatus}}CartonCreateWorkflowInput ItemCreateWorkflowInput PartyCreateWorkflowInput ShipmentCreateWorkflowInput
cartonsCreateWorkflow itemCreateWorkflow partyCreateWorkflow shipmentCreateWorkflow shipmentStatusUpdate
Cette page a-t-elle été utile?