DOCS

Catalog API

Bangun katalog Verified Account Anda secara terprogram, langsung dari sistem Anda sendiri.

Catalog API adalah salah satu dari tiga cara untuk membangun katalog Verified Account Anda, dan merupakan pilihan bagi pengirim yang memiliki sumber daya developer serta sistem yang sudah menyimpan data produk mereka—ERP, WMS, PIM, atau platform pengiriman. Sistem tersebut tetap menjadi sumber data utama dan menulis produk langsung ke Zonos, alih-alih menyinkronkan dari integrasi kanal atau mengunggah file CSV. Jika Anda berjualan melalui kanal yang didukung, atau lebih memilih tidak menulis kode, kedua opsi tersebut membangun katalog yang sama dengan usaha yang lebih sedikit.

Item yang dibuat melalui API diperlakukan persis sama seperti item dari sumber lain mana pun—begitu sebuah item masuk ke katalog Anda, Zonos tidak mempedulikan bagaimana item itu sampai di sana. Setiap item diklasifikasikan untuk keperluan pabean jika Anda tidak menyertakan kode HS, disaring berdasarkan persyaratan U.S. Partner Government Agency (PGA), dan digunakan untuk menghitung bea masuk dan pajak atas pengiriman tempat item tersebut muncul.

Ada satu bagian dari proses itu yang berada di luar API. Ketika penyaringan PGA menandai sebuah item sebagai Needs attention, kuesioner kepatuhan di balik tanda tersebut harus dijawab dan dikonfirmasi di Dashboard—tidak ada API untuk itu, dan Zonos mengisi terlebih dahulu apa yang bisa diisi sehingga sebagian besar pekerjaannya adalah meninjau dan mengonfirmasi. Orang yang membangun integrasi ini biasanya bukan orang yang menyelesaikan tanda-tanda tersebut, jadi rencanakan agar seseorang di organisasi Anda menanganinya di Dashboard setelah katalog Anda dimuat. Item yang ditandai tidak diblokir untuk dikirim, tetapi menyelesaikannya sebelum Anda mengirim adalah hal yang mencegah pengiriman tertahan di perbatasan AS.

Cara kerjanya 

  1. Buat item katalog untuk setiap produk yang Anda kirim.

  2. Pastikan setiap item memiliki pengenal yang akan diteruskan oleh operator pos Anda.

  3. Saat data pengiriman Anda sampai ke Zonos, setiap baris dicocokkan kembali dengan item katalog Anda, dan data produk item tersebut diterapkan pada perhitungan.

Membuat item katalog 

catalogItemCreate menerima daftar, sehingga Anda dapat mengirim banyak produk dalam satu permintaan.

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}

Mengirim produk yang sama dua kali

Jika Anda mengirim produk yang SKU atau ID produknya sudah ada, Zonos akan memperbarui produk tersebut alih-alih menambahkan produk kedua. Percobaan ulang dan pengiriman berulang aman dilakukan.

Konsekuensinya, dua produk berbeda yang memiliki SKU atau ID produk yang sama akan digabungkan menjadi satu. Periksa data Anda untuk menemukan duplikat sebelum melakukan pemuatan massal.

Kolom

Kolom↕Wajib↕Deskripsi↕
skuYa*Pengenal unik Anda untuk produk tersebut. *Setiap produk memerlukan SKU atau ID produk, atau keduanya.
productIdYa*Pengenal produk dari platform Anda. *Setiap produk memerlukan SKU atau ID produk, atau keduanya.
nameYaNama produk.
customsDescriptionDisarankanPenjelasan tentang produk dalam istilah sederhana, untuk deklarasi pabean. Gunakan "Kaus katun", bukan "Summer Vibes Tee".
countryOfOriginDisarankanKode ISO 2 huruf untuk negara tempat produk diproduksi. Diperlukan untuk menghitung bea masuk secara akurat.
measurementsDisarankanBerat dan dimensi, digunakan untuk penghitungan tarif dan pengajuan pabean.
hsCodeTidakKode HS universal 6 digit. Jika Anda tidak menyertakannya, Zonos akan mengklasifikasikan produk dari nama dan deskripsinya.
amountTidakHarga produk dalam bentuk angka.
currencyCodeTidakKode ISO 3 huruf untuk mata uang harga. Wajib jika Anda menyertakan amount.
itemTypeTidakPHYSICAL_GOOD, DIGITAL_GOOD, SERVICE, SUBSCRIPTION, BUNDLE, atau PARTIAL_ITEM. Mencegah item nonfisik dideklarasikan sebagai barang dagangan.
provinceOfOriginTidakNegara bagian atau provinsi asal produk. Diwajibkan oleh beberapa negara tujuan.
productCompositionTidakDaftar {material, percentage}. Tekstil tidak dapat diklasifikasikan lebih dari 6 digit tanpa informasi ini.
catalogItemUrlTidakTautan ke halaman produk di situs Anda. Meningkatkan akurasi klasifikasi.
imageUrlTidakURL gambar produk yang dapat diakses publik. Meningkatkan akurasi klasifikasi.

Membuat item Anda dapat dicocokkan 

Zonos menautkan setiap baris pengiriman kembali ke item katalog menggunakan pengenal Anda, dengan urutan berikut: ID produk, lalu SKU, lalu nama. Pastikan pengenal mana pun yang Anda gunakan akurat dan konsisten antara katalog Anda dan data yang Anda kirim ke operator Anda.

Pengiriman pos memiliki batasan tambahan. Zonos menerima kumpulan kolom yang terbatas dari operator pos, dan di banyak jalur pengiriman, deskripsi pabean adalah satu-satunya kolom yang memuat informasi spesifik produk. Deskripsi yang sama di seluruh katalog Anda tidak dapat mengidentifikasi apa pun dengan sendirinya.

Tambahkan ID produk atau SKU Anda di akhir deskripsi pabean yang Anda kirim ke operator Anda.

Men's bifold wallet, cowhide leather - 123456

Pengenal yang ditambahkan harus sama persis dengan productId atau sku pada item katalog yang bersangkutan.

Kolom deskripsi berukuran pendek. Pengajuan Canada Post, misalnya, hanya mengizinkan sekitar 49 karakter, jadi persingkat bagian deskriptifnya jika pengenal Anda panjang. Pengenal lebih penting daripada teks deskripsinya.

Menetapkan customsDescription item ke string yang sama dengan yang Anda kirim ke operator tidak wajib, tetapi hal ini membuat kedua sisi dapat dibandingkan secara langsung ketika suatu baris tidak cocok dan Anda perlu mencari tahu penyebabnya.

Pencocokan umumnya gagal ketika:

  • Pengenal tidak ada dalam deskripsi.
  • Pengenal tidak sesuai dengan productId atau sku mana pun di katalog Anda.
  • Pengenal terpotong oleh batas karakter operator.
  • Format berubah di antara pengiriman.

Perilaku ini masih dalam tahap finalisasi dan dapat berubah sebelum peluncuran.

Memperbarui item katalog 

catalogItemUpdate menggunakan tipe input yang sama dengan pembuatan. Kirim hanya kolom yang ingin Anda ubah.

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

Catatan: Kolom yang tidak disertakan tidak akan diubah, sehingga pembaruan parsial aman dilakukan. Mengirim null tidak menghapus nilai, melainkan diabaikan. Anda dapat menimpa nilai dengan nilai lain, tetapi Anda tidak dapat mengosongkannya melalui API. Hubungi perwakilan Zonos Anda jika Anda perlu mengosongkan suatu kolom.

Membaca kembali item Anda 

Query catalogItem menerima id, productId, atau sku. Gunakan query ini untuk memastikan data yang disimpan Zonos untuk suatu produk.

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}

Menghapus item katalog 

catalogItemDelete menerima ID item katalog Zonos, bukan SKU atau ID produk Anda. Dapatkan ID tersebut terlebih dahulu dengan query catalogItem.

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

Terkait 

  • Integrasi kanal — Sinkronkan katalog Anda secara otomatis dari kanal penjualan yang didukung.
  • Impor CSV — Unggah item katalog dengan spreadsheet alih-alih menulis kode.
  • Pemeriksaan PGA — Periksa item katalog Anda terhadap persyaratan badan pemerintah AS (PGA).
  • Cara kerja Catalog — Apa yang dilakukan Zonos dengan data produk Anda.
GraphQL API ReferenceTypes, inputs, and operations used in this guide
Pesan demo

Apakah halaman ini bermanfaat?