DOCS

API Catalogo

Crea il catalogo del tuo Account Verificato in modo programmatico, direttamente dal tuo sistema.

L'API Catalogo è uno dei tre modi per creare il catalogo del tuo Account Verificato ed è l'opzione pensata per gli spedizionieri che dispongono di risorse di sviluppo e di un sistema che contiene già i dati dei loro prodotti: un ERP, un WMS, un PIM o una piattaforma di spedizione. Quel sistema resta la fonte di riferimento dei dati e scrive i prodotti direttamente in Zonos, invece di sincronizzarli da un'integrazione di canale o di caricare un file CSV. Se vendi tramite un canale supportato, o preferisci non scrivere codice, queste due opzioni creano lo stesso catalogo con meno lavoro.

Gli articoli creati tramite l'API vengono trattati esattamente come gli articoli provenienti da qualsiasi altra fonte: una volta che un articolo è nel tuo catalogo, per Zonos non ha importanza come ci sia arrivato. Ogni articolo viene classificato ai fini doganali se non hai fornito un codice HS, verificato rispetto ai requisiti delle Partner Government Agency (PGA) statunitensi e utilizzato per calcolare dazi e imposte sulle spedizioni in cui compare.

C'è però una parte che resta al di fuori dell'API. Quando la verifica PGA segnala un articolo come Richiede attenzione, il questionario di conformità collegato a quella segnalazione deve essere compilato e confermato in Dashboard: non esiste un'API per farlo, e Zonos precompila tutto ciò che può, quindi la maggior parte del lavoro consiste nel rivedere e confermare. Chi realizza questa integrazione di solito non è la stessa persona che risolve queste segnalazioni, quindi prevedi che qualcuno della tua organizzazione le gestisca in Dashboard dopo il caricamento del catalogo. Gli articoli segnalati non sono bloccati per la spedizione, ma risolvere le segnalazioni prima di spedire è ciò che evita che una spedizione venga trattenuta alla frontiera degli Stati Uniti.

Come funziona 

  1. Crea un articolo del catalogo per ogni prodotto che spedisci.

  2. Assicurati che ogni articolo contenga un identificatore che il tuo vettore postale trasmetterà.

  3. Quando i dati della tua spedizione raggiungono Zonos, ogni riga viene associata all'articolo corrispondente del tuo catalogo e i dati di prodotto di quell'articolo vengono applicati al calcolo.

catalogItemCreate accetta un elenco, quindi puoi inviare molti prodotti in un'unica richiesta.

1mutation CatalogItemCreate($input: [CatalogItemInput!]!) {
2 catalogItemCreate(input: $input) {
3 id
4 itemKey
5 name
6 productId
7 sku
8 hsCode
9 customsDescription
10 countryOfOrigin
11 }
12}

Inviare lo stesso prodotto due volte

Se invii un prodotto il cui SKU o ID prodotto esiste già, Zonos aggiorna quel prodotto invece di aggiungerne un secondo. Nuovi tentativi ed esecuzioni ripetute sono quindi sicuri.

Il rovescio della medaglia è che due prodotti diversi con lo stesso SKU o ID prodotto verranno uniti in uno solo. Verifica che i tuoi dati non contengano duplicati prima di un caricamento massivo.

Campi

Campo↕Obbligatorio↕Descrizione↕
skuSì*Il tuo identificatore univoco del prodotto. *Ogni prodotto richiede uno SKU, un ID prodotto o entrambi.
productIdSì*L'identificatore del prodotto nella tua piattaforma. *Ogni prodotto richiede uno SKU, un ID prodotto o entrambi.
nameSìIl nome del prodotto.
customsDescriptionConsigliatoChe cos'è il prodotto, in termini semplici, per la dichiarazione doganale. Usa "T-shirt in cotone", non "Summer Vibes Tee".
countryOfOriginConsigliatoIl codice ISO di 2 lettere del Paese in cui il prodotto è stato fabbricato. Necessario per calcolare i dazi con precisione.
measurementsConsigliatoPeso e dimensioni, utilizzati per il calcolo delle tariffe di spedizione e per le dichiarazioni doganali.
hsCodeNoIl codice HS universale a 6 cifre. Se lo ometti, Zonos classifica il prodotto in base al nome e alla descrizione.
amountNoIl prezzo del prodotto come valore numerico.
currencyCodeNoIl codice ISO di 3 lettere della valuta del prezzo. Obbligatorio quando fornisci amount.
itemTypeNoPHYSICAL_GOOD, DIGITAL_GOOD, SERVICE, SUBSCRIPTION, BUNDLE o PARTIAL_ITEM. Evita che gli articoli non fisici vengano dichiarati come merce.
provinceOfOriginNoLo stato o la provincia di origine del prodotto. Richiesto da alcuni Paesi di destinazione.
productCompositionNoUn elenco di {material, percentage}. Senza di esso, i tessili non possono essere classificati oltre le 6 cifre.
catalogItemUrlNoUn link alla pagina del prodotto sul tuo sito. Migliora l'accuratezza della classificazione.
imageUrlNoUn URL pubblicamente accessibile dell'immagine del prodotto. Migliora l'accuratezza della classificazione.

Rendere i tuoi articoli associabili 

Zonos collega ogni riga della spedizione a un articolo del catalogo utilizzando i tuoi identificatori, in questo ordine: ID prodotto, poi SKU, poi nome. Mantieni gli identificatori che utilizzi accurati e coerenti tra il tuo catalogo e i dati che invii al tuo vettore.

Le spedizioni postali comportano un ulteriore vincolo. Zonos riceve dai vettori postali un insieme limitato di campi e, su molte tratte, la descrizione doganale è l'unico campo che arriva con informazioni specifiche sul prodotto. Una descrizione identica per tutto il catalogo non può, da sola, identificare nulla.

Aggiungi il tuo ID prodotto o SKU alla descrizione doganale che invii al tuo vettore.

Men's bifold wallet, cowhide leather - 123456

L'identificatore aggiunto deve corrispondere esattamente al productId o allo sku dell'articolo del catalogo corrispondente.

I campi della descrizione sono brevi. Le dichiarazioni a Canada Post, per esempio, consentono circa 49 caratteri, quindi accorcia la parte descrittiva se i tuoi identificatori sono lunghi. L'identificatore conta più del testo descrittivo.

Impostare il customsDescription dell'articolo sulla stessa stringa che invii al tuo vettore non è obbligatorio, ma rende i due lati direttamente confrontabili quando una riga non viene associata e devi capirne il motivo.

L'associazione non riesce solitamente quando:

  • L'identificatore manca nella descrizione.
  • L'identificatore non corrisponde ad alcun productId o sku del tuo catalogo.
  • L'identificatore viene troncato dal limite di caratteri del vettore.
  • La formattazione cambia da una spedizione all'altra.

Questo comportamento è ancora in fase di definizione e potrebbe cambiare prima del lancio.

catalogItemUpdate accetta lo stesso tipo di input della creazione. Invia solo i campi che desideri modificare.

1mutation CatalogItemUpdate($input: [CatalogItemInput!]!) {
2 catalogItemUpdate(input: $input) {
3 id
4 itemKey
5 hsCode
6 customsDescription
7 }
8}

Nota: i campi omessi restano invariati, il che rende sicuri gli aggiornamenti parziali. L'invio di null non cancella un valore: viene ignorato. Puoi sovrascrivere un valore con uno diverso, ma non puoi svuotarlo tramite l'API. Contatta il tuo rappresentante Zonos se hai bisogno di cancellare un campo.

Rileggere i tuoi articoli 

La query catalogItem accetta id, productId o sku. Utilizzala per verificare quali dati Zonos conserva per un prodotto.

1query CatalogItem($sku: String!) {
2 catalogItem(sku: $sku) {
3 id
4 itemKey
5 name
6 customsDescription
7 hsCode
8 productId
9 sku
10 countryOfOrigin
11 }
12}

catalogItemDelete accetta gli ID degli articoli del catalogo Zonos, non i tuoi SKU o ID prodotto. Recupera prima l'ID con la query catalogItem.

1mutation CatalogItemDelete($input: [ID!]!) {
2 catalogItemDelete(input: $input)
3}

Risorse correlate 

  • Integrazioni di canale — Sincronizza automaticamente il tuo catalogo da un canale di vendita supportato.
  • Importazione CSV — Carica gli articoli del catalogo con un foglio di calcolo invece di scrivere codice.
  • Controlli PGA — Verifica i tuoi articoli del catalogo rispetto ai requisiti delle agenzie statunitensi (PGA).
  • Come funziona Catalog — Cosa fa Zonos con i dati dei tuoi prodotti.
GraphQL API ReferenceTypes, inputs, and operations used in this guide

Questa pagina è stata utile?