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
LAPI Zonos est accessible par un credentialToken. Votre plateforme devra donner aux clients la possibilité d'entrer leur credentialToken depuis le Tableau de bord Zonos dans votre plateforme. À partir de là, vous pourrez faire des demandes à Zonos en leur nom.
Créer une expédition
Pour récupérer une label, vous devez créer une shipment à laquelle la label sera associée. Zonos gère ce processus avec un flux de travail qui crée des shipments et des labels dans la même demande. Lors de l'exécution de cette mutation, vous n'avez pas besoin de passer un serviceLevel car nous utiliserons le serviceLevel utilisé à partir du landedCost qui est lié à la order. Pour l'orderId, vous pouvez utiliser l'ID de commande Zonos ou le accountOrderNumber qui sera probablement déjà dans votre système.
Lorsqu'une expédition et des étiquettes sont créées avec succès, nous retournerons les étiquettes sous forme de labelImage qui est une BASE64_ENCODED_IMAGE, ou sous forme de url d'où l'étiquette peut être récupérée.
Utilisez ce flux de travail lorsque vous créez une expédition pour une commande existante et que vous n'avez pas besoin de modifier les détails des articles ou des parties. Il prend en charge les numéros de suivi optionnels, les centres de traitement, la sélection du niveau de service et l'assurance de valeur déclarée.
Mutation
mutation CreateShipment($input: ShipmentCreateWorkflowInput!) {
shipmentCreateWorkflow(input: $input) {
id
status
trackingDetails {
number
}
serviceLevel {
id
name
carrier {
id
name
}
}
shipmentCartons {
id
carton {
id
width
length
height
weight
items {
item {
id
amount
description
}
}
}
label {
url
trackingNumber
id
documentFiling
}
}
}
}
Variables de base
{
"input": {
"generateLabel": true,
"orderId": "order_12345678-1234-1234-1234-123456789abc"
}
}
Avec Centre de Distribution
{
"input": {
"generateLabel": true,
"orderId": "order_12345678-1234-1234-1234-123456789def",
"fulfillmentCenter": "fulfillment_center_12345"
}
}
Avec suivi personnalisé
{
"input": {
"generateLabel": false,
"orderId": "order_12345678-1234-1234-1234-123456789ghi",
"trackingNumbers": ["tracking_example_1", "tracking_example_2"]
}
}
Avec niveau de service
{
"input": {
"generateLabel": true,
"orderId": "order_12345678-1234-1234-1234-123456789jkl",
"serviceLevel": "dhl.express_example"
}
}
Avec assurance de valeur déclarée
{
"input": {
"generateLabel": true,
"orderId": "order_12345678-1234-1234-1234-123456789mno",
"isDeclaredValue": true
}
}
Valeur déclarée
Définissez "isDeclaredValue": true pour activer la couverture de valeur déclarée pour tous les articles de votre expédition. Zonos revendique automatiquement la pleine valeur de tous les articles soumis dans la commande ; les commerçants ne peuvent pas modifier ce montant. Cela fixe la responsabilité maximale que le transporteur acceptera en cas de perte, de dommage ou de vol pendant le transport. Cette fonctionnalité n'est prise en charge que pour les expéditions UPS, FedEx et DHL. Zonos gère automatiquement la mise en œuvre 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, afin que vous n'ayez pas à gérer les exigences différentes des transporteurs.
Limitations d'UPS : UPS ne couvre que les valeurs comprises entre 100 et 50 000 USD et traite la valeur déclarée au niveau du carton. Pour les expéditions multi-cartons, les commerçants doivent diviser l'expédition pour désigner la couverture par carton. UPS génère également un formulaire d'assurance supplémentaire qui doit être imprimé avec les étiquettes.
FedEx et DHL : Traitez la valeur déclarée au niveau de l'expédition sans restrictions supplémentaires.
Annuler un envoi
Dans le cas où un client souhaite annuler un envoi, vous pouvez utiliser la mutation suivante qui annulera tous les étiquettes liées à l'envoi.
Demande
mutation {
shipmentStatusUpdate(
input: {
shipment: "shipment_f1fe4dbd-e471-49fa-94e7-84e369083223"
status: VOIDED
note: "Voiding shipment"
}
) {
id
status
}
}
Créez des expéditions depuis votre plateforme
Offrez à vos clients la possibilité de créer des expéditions et des é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'expéditions Zonos dans leur plateforme pour leurs clients. Si vous utilisez déjà l'API Zonos et que vous avez simplement besoin de créer des expéditions pour des commandes existantes, consultez notre guide de création d'expéditions.
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'expéditions devrait être une priorité. Cela vous permettra d'offrir l'expérience la plus fluide possible à vos commerçants et à leurs clients en tirant parti des fonctionnalités existantes de votre plateforme tout en laissant Zonos gérer la création de l'expédition, de l'étiquette et de la documentation douanière de soutien.
Les avantages d'utiliser Zonos pour créer des expéditions incluent :
Ce guide vous guidera à travers les étapes pour mettre en œuvre une intégration complète de bout en bout qui vous permettra d'appeler Zonos pour des expéditions depuis votre plateforme.