Atribut
Pasangan kunci/nilai JSON dalam body permintaan
POST https://api.iglobalstores.com/v1/createTempCart
field | notes |
---|---|
boxCount | Contoh nilai: 22x15x15(1),8x8x4(2),32x22x14(1) Format: Daftar dimensi kotak dan jumlah yang dipisahkan dengan koma. Dalam contoh di atas, terdapat total 4 kotak. Kotak pertama dalam daftar akan berukuran 22 inci panjang, 15 inci lebar, dan 15 inci tinggi. Hanya akan ada satu kotak yang digunakan untuk ukuran itu. Akan ada dua kotak berukuran: 8x8x4 inci. Diperbolehkan untuk mengirimkan dimensi kotak yang sama beberapa kali jika itu lebih mudah bagi Anda, seperti ini: “22x15x15(1),22x15x15(1)”, yang berarti 2 kotak berukuran: 22x15x15 inci. Bidang ini menggambarkan kotak yang akan digunakan untuk mengirimkan pesanan. Tidak diharapkan bahwa seorang pedagang mengetahui ini pada saat pesanan; namun, jika diketahui, dapat dikirimkan dalam format string . |
contShoppingURL | Bidang ini digunakan untuk mengirimkan URL untuk mengganti HREF dari tombol “Lanjutkan Belanja” di dalam Zonos Checkout. string |
domesticShippingCharge | Bidang ini digunakan untuk mengirimkan biaya pengiriman domestik ke Zonos Checkout, dan jumlahnya akan ditambahkan ke biaya pengiriman. Ini dapat dikonfigurasi untuk menambahkan total pengiriman atau dipisahkan sebagai item terpisah. positive floating point, two decimal places |
externalConfirmationPageURL | Bidang ini digunakan untuk mengirimkan URL halaman konfirmasi pesanan / terima kasih Anda. Setelah pelanggan menyelesaikan pembayaran di dalam Zonos Checkout, mereka akan diarahkan ke URL ini untuk konfirmasi pesanan. URL ini sering digunakan untuk memicu panggilan ke endpoint layanan API “orderDetail” Zonos untuk mengambil detail pesanan dan mengimpor pesanan ke dalam sistem. string |
footerHTML | Bidang ini digunakan untuk mengirimkan string HTML yang terkode URL. String HTML ini akan didekode dan ditempatkan sebelum tag penutup body di halaman checkout. Umumnya digunakan untuk mengirimkan kode untuk re-marketing, analitik, dll. URL encoded string |
items DIWAJIBKAN | Bidang ini adalah daftar peta item. JSON string |
items[index].countryOfOrigin | Bidang ini digunakan untuk mengirimkan negara asal item. Parameter harus berupa negara kode ISO dua huruf. string |
items[index].description DIWAJIBKAN | Bidang ini digunakan untuk mengirimkan deskripsi lengkap item dari item dalam keranjang, termasuk opsi item, warna, dll. string |
items[index].height | Bidang ini digunakan untuk mengirimkan tinggi item dan sangat dianjurkan untuk kutipan pengiriman yang akurat. Satuan tinggi DIWAJIBKAN string - positive floating point, two decimal places / integer (inches) |
items[index].imageURL DIWAJIBKAN | Bidang ini digunakan untuk mengirimkan URL ke gambar produk item. URL harus HTTPS untuk ditampilkan di dalam Zonos Checkout. string / HTTPS URL |
items[index]itemBrand | Bidang ini digunakan untuk mengirimkan merek item string |
items[index]itemCategory | Bidang ini digunakan untuk mengirimkan kategori item dan dapat dikirimkan dengan pemisah pipa jika item memiliki lebih dari satu kategori. Contoh nilai: “sepatu” atau “sepatu|sepatu-olahraga|sepatu-diskon” string |
items[index]itemCustomization | Bidang ini digunakan untuk mengirimkan detail tambahan tentang item yang tidak ditampilkan di Zonos Checkout; namun, ini dapat diambil melalui endpoint layanan API “orderDetail”. |
items[index]itemHSCode | Bidang ini digunakan untuk mengirimkan kode HS item dan dapat dengan atau tanpa titik. Contoh nilai: “3926901000” atau “3926.90.1000” string |
items[index].itemURL | Bidang ini digunakan untuk mengirimkan URL ke halaman produk item. string / URL |
items[index].length | Bidang ini digunakan untuk mengirimkan panjang item dan sangat disarankan untuk kutipan pengiriman yang akurat. Satuan panjang adalah DIWAJIBKAN string - positif floating point, dua tempat desimal / integer (inci) |
items[index].nonShippable | Bidang ini digunakan untuk menunjukkan apakah item harus dimasukkan dalam perhitungan pengiriman, bea, dan pajak. Unduhan digital, kode diskon, biaya penanganan, dll. harus dikirimkan dengan nilai “true”. boolean: true atau false |
items[index].productId | Bidang ini digunakan untuk mengirimkan jumlah item. string |
items[index].quantity DIWAJIBKAN | Bidang ini digunakan untuk mengirimkan jumlah item. string |
items[index].sku | Bidang ini digunakan untuk mengirimkan SKU / UPC / dll. item. string |
items[index].unitPrice DIWAJIBKAN | Bidang ini digunakan untuk mengirimkan harga satuan item. positif floating point, dua tempat desimal / integer |
items[index].weight | Bidang ini digunakan untuk mengirimkan berat item dan sangat disarankan untuk kutipan pengiriman yang akurat. Satuan berat secara default adalah “LBS” kecuali satuan berat lain dikirimkan dalam items[index].itemWeightUnits``string - positif floating point, dua tempat desimal / integer |
items[index].weightUnits | Bidang ini digunakan untuk menimpa satuan berat item default. Satuan berat item secara default adalah “LBS” kecuali satuan berat lain dikirimkan dalam bidang ini. string - "LB", "OZ", "KG", atau "G” |
items[index].width | Bidang ini digunakan untuk mengirimkan lebar item dan sangat disarankan untuk kutipan pengiriman yang akurat. Satuan lebar adalah DIWAJIBKAN string - positif floating point, dua tempat desimal / integer (inci) |
misc1 - misc6 | Bidang ini digunakan untuk mengirimkan data tambahan yang terkait dengan pesanan melalui API Zonos untuk diambil bersama dengan data pesanan yang dikembalikan dari endpoint layanan API “orderDetail” Zonos. string |
referenceId | Bidang ini digunakan untuk mengirimkan nilai identifikasi referensi unik untuk keranjang/sesi/dll. dalam sistem Anda. Ini dapat digunakan untuk mencari ID pesanan Zonos melalui endpoint layanan API “orderDetail” Zonos. string |
storeId DIWAJIBKAN | ID Toko yang diberikan oleh Zonos. integer |
Tipe data string tambahan
items[index].itemDescriptionLong
items[index].itemDescriptionDetailed
items[index].itemFabricContent
items[index].itemColor
items[index].itemLtlClass
items[index].status
items[index].itemMaterial
Diskon, kupon, dan kode promo
Untuk mengirimkan diskon, kupon, dan kode promo ke Zonos melalui kiriman server, mereka harus dikirimkan sebagai item terpisah dengan nilai negatif untuk parameter: “unitPrice”
dan “nonShippable”:true
.
CONTOH PETA ITEM DISKON
{
"description": "Discount (10OFF) - 10% OFF",
"unitPrice": -15.5,
"quantity": 1,
"nonShippable": true
}
Respons HTTPS
Respons HTTP Sukses
Format pesan: JSON
CONTOH RESPON SUKSES
{
"tempCartUUID": "826b8f22-0de6-4717-90c7-366def7d0782"
}
Definisi JSON Respon
field | notes |
---|---|
tempCartUUID | Parameter ini akan berisi GUID yang ditugaskan ke keranjang internasional pelanggan Anda dan dibuat dalam sistem Zonos. Bidang ini akan diteruskan melalui parameter kueri URL string saat mengalihkan browser pengguna ke Zonos Checkout. |
Respon HTTP Error
Error code | meaning |
---|---|
400 | Karakter tak terduga dalam badan permintaan. |
406 | Tidak Diterima. Header HTTP untuk “Accept” tidak valid. |
415 | Jenis media tidak didukung. Header HTTP untuk “Content-Type” tidak valid. |
422 | Entitas tidak dapat diproses. |
500 | “storeId” tidak benar atau badan JSON tidak dapat diparsing. |
CONTOH RESPON ERROR
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<title>Error 422 Unprocessable Entity</title>
</head>
<body>
<h2>HTTP ERROR 422</h2>
<p>
Problem accessing /v2/createTempCart. Reason:
<pre>Unprocessable Entity</pre>
</p>
<h2>The request entity had the following errors:</h2>
<ul>
<li>items may not be empty (was null)</li>
<li>items may not be null (was null)</li>
</ul>
</body>
</html>
Mengalihkan ke Zonos Checkout
Setelah menerima respons yang berhasil yang berisi tempCartUUID
, server Anda akan mengirimkan pengalihan dari browser pelanggan ke Zonos Checkout dengan parameter string kueri URL yang sesuai yang dijelaskan di bawah ini.
Contoh URL Pengalihan: https://[yourassignedsubdomain].iglobalstores.com/?tempCartUUID=826b8f22-0de6-4717-90c7-366def7d0782&country=CA
Catatan: [yourassignedsubdomain] - Hubungi anggota tim implementasi Zonos Anda untuk menerima subdomain Zonos.com Anda.
Parameter permintaan URL
field | notes |
---|---|
tempCartUUID DIBUTUHKAN | Nilai ini diperoleh dengan memanggil endpoint layanan API createTempCart Zonos. string / GUID |
country | Kode ISO dua huruf untuk negara tujuan kode. Kami sangat merekomendasikan untuk mengirimkan parameter ini untuk pengalaman pengguna. Parameter country akan memilih negara tujuan secara otomatis di dalam Zonos Checkout. Saat menggunakan Zonos Hello JS (JavaScript) di situs, Anda dapat memperoleh nilai ini dengan memanggil metode JavaScript: zonos.country() . string (Panjang: 2) |
Tipe data string tambahan
customerName
customerCompany
customerEmail
customerPhone
customerAltPhone
customerAddress1
customerAddress2
customerCity
customerState
customerZip
Buat checkout
Jelajahi pasangan kunci/nilai yang terlibat dalam membuat checkout.
Endpoint API ini digunakan untuk mengirim informasi keranjang dan item dari keranjang pelanggan ke API Zonos.
Anda akan menerima respons JSON yang berisi
tempCartUUID
, pengidentifikasi keranjang unik dalam Sistem Zonos. Ini akan digunakan untuk mengarahkan pelanggan ke Zonos Checkout untuk menyelesaikan pesanan.