Constituez le catalogue de votre compte vérifié par programmation, directement depuis votre propre système.
L'API Catalog est l'une des trois façons de constituer le catalogue de votre compte vérifié. C'est l'option destinée aux expéditeurs qui disposent de ressources de développement et d'un système qui contient déjà leurs données produit : un ERP, un WMS, un PIM ou une plateforme d'expédition. Ce système reste la source de référence et transmet directement les produits à Zonos, au lieu de les synchroniser depuis une intégration de canal ou de les importer via un fichier CSV. Si vous vendez via un canal pris en charge, ou si vous préférez ne pas écrire de code, ces deux options permettent de constituer le même catalogue avec moins d'efforts.
Les articles créés via l'API sont traités exactement comme les articles provenant de toute autre source : une fois qu'un article figure dans votre catalogue, sa provenance n'a aucune importance pour Zonos. Chaque article est classé à des fins douanières si vous n'avez pas fourni de code SH, contrôlé au regard des exigences des agences gouvernementales partenaires (PGA) des États-Unis, et utilisé pour calculer les droits et taxes des expéditions dans lesquelles il figure.
Une partie de ce processus échappe toutefois à l'API. Lorsque le contrôle PGA signale un article comme Nécessite une attention, le questionnaire de conformité associé à ce signalement doit être rempli et confirmé dans Dashboard : aucune API n'existe pour cette étape, et Zonos pré-remplit tout ce qu'il peut, si bien que l'essentiel du travail consiste à vérifier et à confirmer. La personne qui développe cette intégration n'est généralement pas celle qui traite ces signalements : prévoyez donc qu'une personne de votre organisation s'en charge dans Dashboard une fois votre catalogue chargé. Les articles signalés ne sont pas bloqués à l'expédition, mais les traiter avant d'expédier permet d'éviter qu'une expédition soit retenue à la frontière américaine.
Créez un article de catalogue pour chaque produit que vous expédiez.
Assurez-vous que chaque article comporte un identifiant que votre transporteur postal transmettra.
Lorsque les données de votre expédition parviennent à Zonos, chaque ligne est rapprochée de l'article de catalogue correspondant, dont les données produit sont appliquées au calcul.
Si vous envoyez un produit dont le SKU ou l'ID produit existe déjà, Zonos met à jour ce produit au lieu d'en ajouter un second. Les nouvelles tentatives et les exécutions répétées sont donc sans risque.
En contrepartie, deux produits différents partageant le même SKU ou le même ID produit seront fusionnés en un seul. Vérifiez l'absence de doublons dans vos données avant un chargement en masse.
Champs
Champ↕
Obligatoire↕
Description↕
sku
Oui*
Votre identifiant unique pour le produit. *Chaque produit doit avoir un SKU, un ID produit, ou les deux.
productId
Oui*
L'identifiant du produit sur votre plateforme. *Chaque produit doit avoir un SKU, un ID produit, ou les deux.
name
Oui
Le nom du produit.
customsDescription
Recommandé
La nature du produit, en termes simples, pour la déclaration en douane. Utilisez « T-shirt en coton », et non « Tee Summer Vibes ».
countryOfOrigin
Recommandé
Le code ISO à 2 lettres du pays de fabrication du produit. Nécessaire pour calculer précisément les droits de douane.
measurements
Recommandé
Poids et dimensions, utilisés pour la tarification et la déclaration en douane.
hsCode
Non
Le code SH universel à 6 chiffres. Si vous l'omettez, Zonos classe le produit à partir de son nom et de sa description.
amount
Non
Le prix du produit, sous forme numérique.
currencyCode
Non
Le code ISO à 3 lettres de la devise du prix. Obligatoire lorsque vous fournissez amount.
itemType
Non
PHYSICAL_GOOD, DIGITAL_GOOD, SERVICE, SUBSCRIPTION, BUNDLE ou PARTIAL_ITEM. Évite que des articles non physiques soient déclarés comme marchandises.
provinceOfOrigin
Non
L'État ou la province d'origine du produit. Exigé par certains pays de destination.
productComposition
Non
Une liste de {material, percentage}. Sans cette information, les textiles ne peuvent pas être classés au-delà de 6 chiffres.
catalogItemUrl
Non
Un lien vers la page du produit sur votre site. Améliore la précision de la classification.
imageUrl
Non
Une URL publiquement accessible de l'image du produit. Améliore la précision de la classification.
Zonos rattache chaque ligne d'expédition à un article de catalogue à l'aide de vos identifiants, dans cet ordre : ID produit, puis SKU, puis nom. Veillez à ce que les identifiants que vous utilisez soient exacts et cohérents entre votre catalogue et les données que vous envoyez à votre transporteur.
Les envois postaux comportent une contrainte supplémentaire. Zonos reçoit un ensemble de champs limité de la part des transporteurs postaux et, sur de nombreux axes, la description douanière est le seul champ qui contient une information propre au produit. Une description identique pour l'ensemble de votre catalogue ne permet à elle seule d'identifier aucun produit.
Ajoutez votre ID produit ou votre SKU à la fin de la description douanière que vous envoyez à votre transporteur.
Men's bifold wallet, cowhide leather - 123456
L'identifiant ajouté doit correspondre exactement au productId ou au sku de l'article de catalogue concerné.
Les champs de description sont courts. Les envois via Postes Canada, par exemple, autorisent environ 49 caractères : raccourcissez donc la partie descriptive si vos identifiants sont longs. L'identifiant compte davantage que le texte descriptif.
Il n'est pas obligatoire de définir le customsDescription de l'article avec la même chaîne que celle envoyée à votre transporteur, mais cela permet de comparer directement les deux lorsqu'une ligne n'est pas rapprochée et que vous devez en déterminer la raison.
Le rapprochement échoue généralement lorsque :
L'identifiant est absent de la description.
L'identifiant ne correspond à aucun productId ni sku de votre catalogue.
L'identifiant est tronqué par la limite de caractères du transporteur.
La mise en forme varie d'une expédition à l'autre.
Ce comportement est encore en cours de finalisation et pourrait évoluer avant le lancement.
Remarque : les champs omis restent inchangés, ce qui rend les mises à jour partielles sans risque. Envoyer null n'efface pas une valeur : il est ignoré. Vous pouvez remplacer une valeur par une autre, mais vous ne pouvez pas la vider via l'API. Contactez votre représentant Zonos si vous devez effacer un champ.
catalogItemDelete prend en entrée des ID d'articles de catalogue Zonos, et non vos SKU ou ID produit. Récupérez d'abord l'ID à l'aide de la requête catalogItem.
API Catalog
API Catalog
Constituez le catalogue de votre compte vérifié par programmation, directement depuis votre propre système.
L'API Catalog est l'une des trois façons de constituer le catalogue de votre compte vérifié. C'est l'option destinée aux expéditeurs qui disposent de ressources de développement et d'un système qui contient déjà leurs données produit : un ERP, un WMS, un PIM ou une plateforme d'expédition. Ce système reste la source de référence et transmet directement les produits à Zonos, au lieu de les synchroniser depuis une intégration de canal ou de les importer via un fichier CSV. Si vous vendez via un canal pris en charge, ou si vous préférez ne pas écrire de code, ces deux options permettent de constituer le même catalogue avec moins d'efforts.
Les articles créés via l'API sont traités exactement comme les articles provenant de toute autre source : une fois qu'un article figure dans votre catalogue, sa provenance n'a aucune importance pour Zonos. Chaque article est classé à des fins douanières si vous n'avez pas fourni de code SH, contrôlé au regard des exigences des agences gouvernementales partenaires (PGA) des États-Unis, et utilisé pour calculer les droits et taxes des expéditions dans lesquelles il figure.
Une partie de ce processus échappe toutefois à l'API. Lorsque le contrôle PGA signale un article comme Nécessite une attention, le questionnaire de conformité associé à ce signalement doit être rempli et confirmé dans Dashboard : aucune API n'existe pour cette étape, et Zonos pré-remplit tout ce qu'il peut, si bien que l'essentiel du travail consiste à vérifier et à confirmer. La personne qui développe cette intégration n'est généralement pas celle qui traite ces signalements : prévoyez donc qu'une personne de votre organisation s'en charge dans Dashboard une fois votre catalogue chargé. Les articles signalés ne sont pas bloqués à l'expédition, mais les traiter avant d'expédier permet d'éviter qu'une expédition soit retenue à la frontière américaine.
Fonctionnement
Créez un article de catalogue pour chaque produit que vous expédiez.
Assurez-vous que chaque article comporte un identifiant que votre transporteur postal transmettra.
Lorsque les données de votre expédition parviennent à Zonos, chaque ligne est rapprochée de l'article de catalogue correspondant, dont les données produit sont appliquées au calcul.
Créer des articles de catalogue
catalogItemCreateaccepte une liste, ce qui vous permet d'envoyer de nombreux produits en une seule requête.mutation CatalogItemCreate($input: [CatalogItemInput!]!) {catalogItemCreate(input: $input) {iditemKeynameproductIdskuhsCodecustomsDescriptioncountryOfOrigin}}Envoyer deux fois le même produit
Si vous envoyez un produit dont le SKU ou l'ID produit existe déjà, Zonos met à jour ce produit au lieu d'en ajouter un second. Les nouvelles tentatives et les exécutions répétées sont donc sans risque.
En contrepartie, deux produits différents partageant le même SKU ou le même ID produit seront fusionnés en un seul. Vérifiez l'absence de doublons dans vos données avant un chargement en masse.
Champs
skuproductIdnamecustomsDescriptioncountryOfOriginmeasurementshsCodeamountcurrencyCodeamount.itemTypePHYSICAL_GOOD,DIGITAL_GOOD,SERVICE,SUBSCRIPTION,BUNDLEouPARTIAL_ITEM. Évite que des articles non physiques soient déclarés comme marchandises.provinceOfOriginproductComposition{material, percentage}. Sans cette information, les textiles ne peuvent pas être classés au-delà de 6 chiffres.catalogItemUrlimageUrlRendre vos articles identifiables
Zonos rattache chaque ligne d'expédition à un article de catalogue à l'aide de vos identifiants, dans cet ordre : ID produit, puis SKU, puis nom. Veillez à ce que les identifiants que vous utilisez soient exacts et cohérents entre votre catalogue et les données que vous envoyez à votre transporteur.
Les envois postaux comportent une contrainte supplémentaire. Zonos reçoit un ensemble de champs limité de la part des transporteurs postaux et, sur de nombreux axes, la description douanière est le seul champ qui contient une information propre au produit. Une description identique pour l'ensemble de votre catalogue ne permet à elle seule d'identifier aucun produit.
Ajoutez votre ID produit ou votre SKU à la fin de la description douanière que vous envoyez à votre transporteur.
L'identifiant ajouté doit correspondre exactement au
productIdou auskude l'article de catalogue concerné.Les champs de description sont courts. Les envois via Postes Canada, par exemple, autorisent environ 49 caractères : raccourcissez donc la partie descriptive si vos identifiants sont longs. L'identifiant compte davantage que le texte descriptif.
Il n'est pas obligatoire de définir le
customsDescriptionde l'article avec la même chaîne que celle envoyée à votre transporteur, mais cela permet de comparer directement les deux lorsqu'une ligne n'est pas rapprochée et que vous devez en déterminer la raison.Le rapprochement échoue généralement lorsque :
productIdniskude votre catalogue.Mettre à jour des articles de catalogue
catalogItemUpdateutilise le même type d'entrée que la création. Envoyez uniquement les champs que vous souhaitez modifier.mutation CatalogItemUpdate($input: [CatalogItemInput!]!) {catalogItemUpdate(input: $input) {iditemKeyhsCodecustomsDescription}}Relire vos articles
La requête
catalogItemaccepteid,productIdousku. Utilisez-la pour vérifier les données que Zonos détient pour un produit.query CatalogItem($sku: String!) {catalogItem(sku: $sku) {iditemKeynamecustomsDescriptionhsCodeproductIdskucountryOfOrigin}}Supprimer des articles de catalogue
catalogItemDeleteprend en entrée des ID d'articles de catalogue Zonos, et non vos SKU ou ID produit. Récupérez d'abord l'ID à l'aide de la requêtecatalogItem.mutation CatalogItemDelete($input: [ID!]!) {catalogItemDelete(input: $input)}Ressources associées
CatalogItemInput
catalogItemCreate catalogItemDelete catalogItemUpdate
Cette page a-t-elle été utile?