Créer des envois via l'API
Après avoir calculé un Landed Cost et créé une commande, vous pouvez envoyer des numéros de suivi et d'autres détails d'envoi à Zonos via l'API.
Utilisez ce flux de travail lorsque vous créez un envoi 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
Pour annuler une étiquette créée, utilisez la mutation suivante pour annuler l'envoi. Toutes les étiquettes associées seront également annulées automatiquement. Notez qu'une fois qu'un envoi est annulé, il ne peut pas être mis à jour ou restauré.
Mutation
mutation {
shipmentStatusUpdate(
input: {
shipment: "shipment_12345678-1234-1234-1234-123456789stu"
status: VOIDED
note: "Voiding shipment"
}
) {
id
status
}
}
Créer un envoi pour des commandes existantes
Créez des envois et des étiquettes avec l'API Zonos après avoir calculé les coûts d'acheminement et créé des commandes.
GraphQL
Ce guide est conçu pour les utilisateurs qui sont déjà intégrés à l'API Zonos et qui ont besoin de créer des envois pour des commandes existantes dans leur système. Si vous êtes une plateforme d'expédition et souhaitez offrir la création d'envois Zonos à vos clients, consultez notre guide API d'envoi.
Si vous êtes intégré à l'API Zonos et approuvé pour expédier en dehors du Dashboard, utilisez la mutation
shipmentCreateWorkflowpour créer des envois et fournir des informations de suivi. Ces mutations vous permettent également d'informer Zonos des envois nationaux vers des installations de cross-docking.Remarque : Si vous utilisez une application de droits et taxes avec une plateforme qui synchronise automatiquement les numéros de suivi avec Zonos, ou si vous expédiez directement via le Dashboard, ces mutations ne sont pas nécessaires.