Endpoint
Permintaan kutipan pengiriman
POST | https://api.iglobalstores.com/2.0/shipping-quotes - Buat permintaan baru untuk kutipan pengiriman pada barang di keranjang belanja yang mencakup bea masuk dan pajak serta informasi penyaringan pembatasan barang.
Permintaan HTTPS
| Field | Notes |
|---|---|
| Metode HTTP | POST |
| URL Endpoint | https://api.iglobalstores.com/2.0/shipping-quotes |
| Protokol | HTTPS |
| Format pesan | JSON |
| Header HTTP Accept | Accept: application/json |
| Header HTTP Token Keamanan | serviceToken: your-test-token-valueTambahkan header ke permintaan HTTPS Anda bernama serviceToken dengan nilai Token API Keamanan Uji Anda. (Hubungi Manajer Akun Anda untuk token ini) |
| Header HTTP Content-Type | Content-Type: application/jsonKarena Anda akan mengirim data JSON ke layanan, tambahkan header ke permintaan HTTPS Anda bernama Content-Type dengan nilai application/json |
PASANGAN KUNCI/NILAI JSON di badan permintaan
Format Pesan: JSON
Contoh permintaan
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
{
"boxCount": null,
"items": [
{
"cartItemId": 1,
"detailedDescription": "description including options, material content, etc",
"category": "sunglasses",
"productId": "17898-675234",
"sku": "oakley-123",
"unitPrice": 199.0,
"quantity": 1,
"length": 2.5,
"width": 6.5,
"height": 2.5,
"dimensionalUnits": null,
"weight": 4,
"weightUnits": "OZ",
"hsCode": null,
"brandName": "Oakley",
"countryOfOrigin": "CN"
},
{
"cartItemId": 2,
"detailedDescription": "description including options, material content, etc",
"category": "sunglasses",
"productId": "17898-675235",
"sku": "oakley-125",
"unitPrice": 179.0,
"quantity": 1,
"length": 2.5,
"width": 6.5,
"height": 2.5,
"dimensionalUnits": null,
"weight": 4,
"weightUnits": "OZ",
"hsCode": null,
"brandName": "Oakley",
"countryOfOrigin": "CN"
}
],
"shippingAmountOverride": null,
"shipFromAddress": null,
"shipToAddress": {
"name": "John Doe",
"address1": "123 S West Elm St",
"address2": null,
"address3": null,
"city": "Calgary",
"state": "Alberta",
"stateCode": "AB",
"postalCode": "T2P 5G8",
"countryCode": "CA"
}
}
Definisi JSON Permintaan
| Field | Catatan |
|---|---|
boxCount | Field ini menjelaskan kotak-kotak yang akan digunakan untuk mengirim pesanan. Tidak diharapkan bahwa pedagang mengetahui ini pada saat pemesanan; namun, jika diketahui, dapat diteruskan dalam format spesifik berikut. Contoh nilai: 22x15x15(1),8x8x4(2),32x22x14(1) Format: Daftar dimensi kotak dan jumlah yang dipisahkan dengan koma. Dalam contoh di atas, ada total 4 kotak. Kotak pertama dalam daftar akan memiliki panjang 22 inci, lebar 15 inci, dan tinggi 15 inci. Hanya akan ada satu kotak yang digunakan untuk ukuran tersebut. Akan ada dua kotak berukuran 8x8x4 inci. Dapat diterima untuk meneruskan dimensi kotak yang sama beberapa kali jika itu mudah bagi Anda, seperti ini: “22x15x15(1),22x15x15(1)”, yang berarti 2 kotak berukuran 22x15x15 inci. |
items REQUIRED | Daftar peta item |
items[index].brandName | Nama merek dari item tertentu akan membantu mesin aturan kami menentukan dengan baik apakah ada pembatasan yang berlaku untuk item tersebut di negara tujuan. Bahkan jika nama merek item secara tekstual cocok atau tidak dengan pembatasan tertentu, mesin aturan kami akan menggunakan SKU item dan/atau productId untuk lebih memutuskan apakah item tersebut memang dibatasi di negara tujuan. Harap kirimkan nama merek jika tersedia. Contoh nilai: “Oakley” atau “Nike” atau null |
items[index].cartItemId REQUIRED | Field ini diperlukan untuk mengidentifikasi item, khususnya dalam daftar item. Ini bisa sesederhana nilai indeks. Kami akan menggunakan cartItemId ini untuk mengidentifikasi item jika dibatasi dalam respons JSON. Jadi pastikan bahwa Anda dapat mengidentifikasi item yang sama di keranjang Anda dengan cartItemId yang Anda kirimkan kepada kami. Contoh nilai: 1 atau 2 atau 3 |
items[index].category | Kategori produk - produk spesifik yang menjadi bagiannya. Kategori akan membantu mesin aturan kami menentukan dengan baik apakah ada pembatasan yang berlaku untuk item tersebut di negara tujuan. Bahkan jika kategori item secara tekstual cocok atau tidak dengan pembatasan tertentu, mesin aturan kami akan menggunakan SKU item dan/atau productId untuk lebih memutuskan apakah item tersebut memang dibatasi di negara tujuan. Format: Daftar nama kategori yang dipisahkan dengan pipa. Setiap nama kategori dapat terdiri dari satu atau lebih kata. Jika suatu item ada dalam lebih dari satu kategori, harap daftarkan keduanya dipisahkan oleh karakter pipa “”. Contoh: nilai “Kacamata Hitam” atau “Aksesori MalamTas Tangan” |
items[index].countryOfOrigin | Negara asal adalah negara tempat barang dibuat atau berasal. Negara asal akan membantu mesin aturan kami menentukan apakah ada pembatasan yang berlaku untuk barang tersebut untuk negara tujuan. Beberapa negara tidak mengizinkan jenis barang tertentu dari negara tertentu. Contoh nilai: “CN” untuk China atau “US” untuk Amerika Serikat atau null |
items[index].detailedDescription REQUIRED | Bidang ini hanyalah teks, tetapi harus mencakup sebanyak mungkin informasi tentang barang yang dibeli. Misalnya, nama lengkap dan kode barang jika berlaku, warna atau opsi lain yang dipilih, konten material, dan teks deskripsi apa pun yang Anda miliki untuk barang tersebut. Ada banyak jenis pembatasan impor yang berbeda ke negara asing, seperti sepatu kulit ke Italia. Terkadang, satu-satunya cara untuk menangkap barang-barang yang dibatasi ini adalah melalui detailedDescription. Catatan: Bahkan jika detailedDescription barang tidak cocok secara tekstual dengan pembatasan tertentu, mesin aturan kami akan menggunakan SKU barang dan/atau productId untuk lebih baik memutuskan apakah barang tersebut memang dibatasi ke negara tujuan. Untuk hasil terbaik, harap kirim sebanyak mungkin informasi dalam bidang detailedDescription. Contoh nilai: “Tory Burch, Robinson – Double Zip’ Tote, warna: New Carnival, konten material: kulit, Kulit yang kaya warna memberikan daya tarik yang mencolok pada tote yang terstruktur rapi, dilengkapi dengan perangkat keras logo dan pegangan yang digulung untuk tampilan yang sepenuhnya canggih. Penutupan magnetik dengan dua kompartemen berzip. Saku zip interior, dinding, dan ponsel. Kaki logam pelindung. Kulit. Oleh Tory Burch; diimpor.” |
items[index].height | Ini adalah tinggi barang Anda. Ada bidang lain bernama dimensionalUnits, di mana Anda menentukan inci atau sentimeter untuk pengukuran ini. Harap berikan tanpa koma dan dengan tidak lebih dari dua tempat desimal. Contoh nilai: 25.5 Tarif pengiriman Anda akan paling akurat jika Anda mengisi bidang ini. |
items[index].hsCode | Ini adalah Kode HS yang mengidentifikasi barang ke negara asing. Mengisi hsCode akan membantu dalam mengidentifikasi tarif bea masuk rate yang tepat untuk barang tertentu. Tidak diperlukan jika tidak tersedia – kami akan mengurusnya jika Anda tidak memilikinya. Format: Kode 10 digit atau 6 digit; dapat menyertakan karakter pemisah “.” atau tidak. Contoh nilai: “20.4560.0000” atau “20.4560” atau “204560” (kode 10 atau 6 digit diterima) |
items[index].length | Ini adalah panjang barang Anda. Ada bidang lain bernama dimensionalUnits, di mana Anda menentukan inci atau sentimeter untuk pengukuran ini. Harap berikan tanpa koma dan dengan tidak lebih dari dua tempat desimal. Contoh nilai: 25.5 Tarif pengiriman Anda akan paling akurat jika Anda mengisi bidang ini. |
items[index].productId | Ini adalah ID produk Anda untuk barang tertentu. Mesin aturan kami akan menggunakan nilai ini sebagai ID untuk mengaitkan informasi barang yang dipelajari dengan barang Anda. Contoh nilai: “17898-675235” Harap kirim setidaknya productID atau SKU. Mengirimkan keduanya lebih disukai. |
items[index].quantity REQUIRED | Ini adalah jumlah yang dibeli untuk barang tertentu. Harap berikan sebagai bilangan bulat positif, tanpa koma dan tanpa tempat desimal. Contoh nilai: 1 atau 9999 (kami lebih suka Anda menjual lebih banyak barang daripada lebih sedikit!) |
items[index].sku | Ini adalah SKU Anda untuk barang tertentu. Mesin aturan kami akan menggunakan nilai ini sebagai ID untuk mengaitkan informasi barang yang dipelajari dengan barang Anda. Contoh nilai: “oakley-125” Harap kirim setidaknya productId atau SKU. Mengirimkan keduanya lebih disukai. |
items[index].unitPrice REQUIRED | Ini adalah harga satuan barang Anda dalam USD (dolar AS). Harap berikan tanpa koma, tanpa tanda dolar “$”, dan dengan dua tempat desimal. Contoh nilai: 2102.99 |
items[index].weight | Ini adalah berat item Anda. Ada bidang lain yang disebut weightUnits, di mana Anda menentukan pound, ons, gram, atau kilogram untuk pengukuran ini. Harap berikan tanpa koma dan dengan tidak lebih dari dua tempat desimal. Contoh nilai: 4.2 Tarif pengiriman Anda akan paling akurat jika Anda mengisi bidang ini. |
items[index].weightUnits | Secara default adalah “LB” untuk pound. Unit pengukuran untuk nilai berat. Jika diatur ke null, “LB” (pound) akan diasumsikan. Contoh nilai: “LB” untuk pound atau “OZ” untuk ons atau “G” untuk gram atau “KG” untuk kilogram atau null |
items[index].width | Ini adalah lebar item Anda. Ada bidang lain yang disebut dimensionalUnits, di mana Anda menentukan inci atau sentimeter untuk pengukuran ini. Harap berikan tanpa koma dan dengan tidak lebih dari dua tempat desimal. Contoh nilai: 25.5 Tarif pengiriman Anda akan paling akurat jika Anda mengisi bidang ini. |
shipFromAddress | Jika diisi sebagai null, kami akan menggunakan shipFromAddress default yang terkait dengan akun pedagang Anda. Ini adalah alamat dari mana pesanan akan dikirim, yaitu gudang Anda. Ini adalah peta yang berisi bidang alamat berikut: address1, address2, address3, city, state, stateCode, postalCode, countryCode. Bidang yang terkandung ini diperlukan atau tidak diperlukan, tergantung pada negara. Titik akhir lokalisasi mengembalikan bidang alamat spesifik mana yang diperlukan untuk setiap negara. Catatan: stateCode selalu tidak diperlukan dan tidak dinyatakan dalam titik akhir lokalisasi. Anda dapat mengisi stateCode, jika tersedia. |
shippingAmountOverride | Ini hanya digunakan jika Anda mengetahui biaya pengiriman sebelum memanggil API. Ini dalam USD (dolar AS). Harap berikan tanpa koma, tanpa tanda dolar “$”, dan dengan dua tempat desimal. Fitur ini tidak akan berfungsi tanpa mengaturnya dengan perwakilan Zonos. Contoh nilai: 212.99 |
shipToAddress REQUIRED | Ini adalah alamat tempat pesanan akan dikirim. Ini adalah peta yang berisi bidang alamat berikut: name, address1, address2, address3, city, state, stateCode, postalCode, countryCode. Bidang yang terkandung ini diperlukan atau tidak tergantung pada negara. Titik akhir lokalisasi mengembalikan bidang alamat spesifik mana yang diperlukan untuk setiap negara. Catatan: name dan stateCode selalu tidak diperlukan dan tidak dinyatakan dalam titik akhir lokalisasi. Anda dapat mengisi name dan/atau stateCode, jika tersedia. |
HTTPS response
Format pesan: JSON
Contoh respons untuk hanya Kanada & Australia
Catatan: Respons aktual akan berisi semua negara yang didukung.
Contoh permintaan
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
{
"shippingQuotes": [
{
"id": "bcdbdbcd-0145-4d3b-a54e-0de3cdce5a0a",
"carrier": "UPS",
"conversionRate": 1.32,
"currencyCode": "CAD",
"displayName": "Express Air 2-4 Day Delivery",
"duty": 10.2,
"dutyTaxBrokerageFee": 5.0,
"dutyTaxCarrierPrepaymentFee": 5.0,
"dutyTaxEnabled": true,
"dutyTaxForced": false,
"dutyTaxTotal": 29.38,
"dutyTaxUnderDeminimus": false,
"restrictedItems": [
{
"cartItemId": 1,
"message": "We are unable to sell Oakley products to your country.",
"reasonCode": "BRAND_COUNTRY"
},
{
"cartItemId": 2,
"message": "We are unable to sell Oakley products to your country.",
"reasonCode": "BRAND_COUNTRY"
}
],
"shippingTotal": 23.62,
"taxOrVat": 9.18
},
{
"id": "80c57724-ab4e-4997-8477-08b668fef103",
"carrier": "USPS",
"conversionRate": 1.32,
"currencyCode": "CAD",
"displayName": "Post 5-10 Day Delivery",
"duty": 9.2,
"dutyTaxBrokerageFee": 5.0,
"dutyTaxCarrierPrepaymentFee": 5.0,
"dutyTaxEnabled": true,
"dutyTaxForced": false,
"dutyTaxTotal": 27.38,
"dutyTaxUnderDeminimus": false,
"restrictedItems": [
{
"cartItemId": 1,
"message": "We are unable to sell Oakley products to your country.",
"reasonCode": "BRAND_COUNTRY"
},
{
"cartItemId": 2,
"message": "We are unable to sell Oakley products to your country.",
"reasonCode": "BRAND_COUNTRY"
}
],
"shippingTotal": 13.62,
"taxOrVat": 8.18
}
]
}
Definisi JSON Respon
| Field | Notes |
|---|---|
shippingQuotes | Ini adalah daftar peta kutipan pengiriman. |
shippingQuotes[index].carrier | Pengangkut yang spesifik untuk kutipan pengiriman. Hanya akan diatur ke null jika pedagang meminta untuk memiliki profil pengiriman generik yang tidak spesifik untuk pengangkut. Kutipan pengiriman tidak perlu spesifik untuk pengangkut; tetapi bisa saja. Hubungi Manajer Akun Anda untuk bantuan dalam mengatur profil pengiriman Anda. Contoh nilai: UPS atau FEDEX atau DHL atau USPS atau CAPOST atau null |
shippingQuotes[index].displayName | Nama tampilan untuk opsi pengiriman, cocok untuk ditampilkan kepada pembeli. Nilai-nilai ini dapat disesuaikan untuk pedagang. Hubungi Manajer Akun Anda untuk melakukannya. Contoh nilai: “Pengiriman Udara Ekspres 2-4 Hari” |
shippingQuotes[index].duty | Jumlah bea masuk yang termasuk dalam dutyTaxTotal. Jumlah ini dalam USD, tidak akan mengandung koma, dan akan memiliki dua tempat desimal. Contoh nilai: 8.29 |
shippingQuotes[index] .dutyTaxBrokerageFee | Ini adalah biaya yang akan dikenakan oleh broker impor asing untuk memproses bea dan pajak impor Anda. Jumlah ini termasuk dalam dutyTaxTotal. Jumlah ini dalam USD, tidak akan mengandung koma, dan akan memiliki dua tempat desimal. Contoh nilai: 5.00 |
shippingQuotes[index] .duyTaxCarrierPrepaymentFee | Ini adalah biaya yang akan dikenakan oleh pengangkut untuk prepay bea dan pajak ke negara tujuan impor. Jumlah ini termasuk dalam dutyTaxTotal. Jumlah ini dalam USD, tidak akan mengandung koma, dan akan memiliki dua tempat desimal. Contoh nilai: 5.00 |
shippingQuotes[index] .duyTaxEnabled | Apakah kutipan pengiriman ini memungkinkan pembeli untuk prepay bea dan pajak impor mereka. Jika diatur ke false, dutyTaxTotal harus diabaikan. Contoh nilai: true atau false |
shippingQuotes[index] .duyTaxForced | Apakah kutipan pengiriman ini memaksa pembeli untuk prepay bea dan pajak impor mereka. Jika diatur ke true, Anda harus menyertakan dutyTaxTotal dalam pesanan, menjelaskan kepada pembeli bahwa itu diperlukan dengan opsi pengiriman spesifik ini. Jika diatur ke false, Anda dapat membiarkan pembeli memilih apakah mereka ingin prepay bea dan pajak impor mereka. Contoh nilai: true atau false |
shippingQuotes[index].dutyTaxTotal | Total biaya bea dan pajak untuk kutipan pengiriman yang diberikan. Bea dan pajak mungkin bersifat opsional, tidak tersedia, atau dipaksa untuk kutipan pengiriman yang diberikan. Jumlah ini tidak termasuk dalam shippingTotal. Jumlah ini dalam USD, tidak akan mengandung koma, dan akan memiliki dua tempat desimal. Contoh nilai: 19.55 |
shippingQuotes[index] .dutyTaxUnderDeMinimis | Apakah total pesanan, menggunakan opsi pengiriman spesifik ini, berada di bawah jumlah de minimis pajak/PPN dan jumlah de minimis bea. Jika diatur ke true, dutyTaxTotal akan diatur ke 0.00, dan Anda harus memberi tahu pelanggan bahwa tidak akan ada bea atau pajak impor yang harus dibayar pada pesanan mereka. Selain itu, paksa pembayaran di muka bea dan pajak, karena biayanya adalah 0.00. |
shippingQuotes[index].id | Sebuah pengidentifikasi untuk kutipan pengiriman spesifik; UUID 36 karakter. Contoh nilai: bcdbdbcd-0145-4d3b-a54e-0de3cdce5a0a |
shippingQuotes[index].restrictedItems | Ini adalah daftar peta, yang berisi rincian tentang item apa pun dalam keranjang yang dibatasi menggunakan kutipan pengiriman spesifik ini. Setiap item yang dibatasi memiliki reasonCode. Alasan tersebut mungkin spesifik atau tidak untuk opsi pengiriman. Beberapa alasan untuk pembatasan item disebabkan oleh undang-undang impor negara, pembatasan merek, atau bahkan aturan yang dibuat oleh pedagang. Setiap kali opsi pengiriman dipilih oleh pembeli, item keranjang harus dicocokkan dengan daftar restrictedItems dari kutipan pengiriman. Jika ada item keranjang yang dibatasi, pesan harus ditampilkan kepada pembeli, dan item yang dibatasi harus dihapus dari total pesanan, dll. |
shippingQuotes[index] .restrictedItems[index].cartItemId | Ini adalah cartItemId dari JSON permintaan item keranjang yang dibatasi. Anda harus dapat mengaitkan cartItemId ini kembali ke item tertentu dalam keranjang pembeli Anda. Contoh nilai: 1 atau 2 atau 3 |
shippingQuotes[index] .restrictedItems[index].message | Ini adalah pesan yang mungkin ditampilkan kepada pembeli tentang mengapa item tersebut dibatasi. Pesan ini dapat disesuaikan oleh pedagang. Silakan hubungi perwakilan Zonos Anda untuk rincian. Contoh nilai: “Kami tidak dapat menjual produk Oakley ke negara Anda.” |
shippingQuotes[index] .restrictedItems[index].reasonCode | Ini adalah kode alasan untuk item yang dibatasi. Pembatasan selalu spesifik untuk negara dan kode alasan kami membuat itu jelas. Contoh nilai: BRAND_COUNTRY atau IMPORT_COUNTRY atau EXPORT_COUNTRY atau CARRIER_COUNTRY atau MERCHANT_COUNTRY. BRAND_COUNTRY berarti Anda telah menentukan bahwa Anda tidak dapat menjual merek ke seperangkat negara tertentu. IMPORT_COUNTRY berarti negara pengimpor tidak akan mengizinkan item tersebut untuk diimpor. EXPORT_COUNTRY berarti negara pengekspor (biasanya Amerika Serikat) tidak akan mengizinkan item tersebut untuk diekspor. CARRIER_COUNTRY berarti pengangkut tertentu tidak akan mengangkut item tersebut. MERCHANT_COUNTRY berarti Anda telah menetapkan aturan pembatasan khusus yang telah memicu item tersebut. |
shippingQuotes[index] .shippingTotal | Total biaya pengiriman untuk kutipan pengiriman yang diberikan. Kutipan pengiriman juga dapat memiliki jumlah dutyTaxTotal, yang tidak termasuk dalam shippingTotal ini. Jumlah ini dalam USD, tidak akan mengandung koma, dan akan mengandung dua tempat desimal. Contoh nilai: 25.82 |
shippingQuotes[index].taxOrVat | Jumlah pajak atau PPN yang termasuk dalam dutyTaxTotal. Untuk beberapa negara, ini adalah pajak; untuk negara lain, ini adalah PPN. Jumlah ini dalam USD, tidak akan mengandung koma, dan akan mengandung dua tempat desimal. Contoh nilai: 4.35 |
API Warisan Landed Cost
Pelajari cara kerja API Warisan Landed Cost.Informasi di bawah ini adalah untuk API Warisan Landed Cost kami. Lihat API Landed Cost kami untuk versi terbaru.
Endpoint shipping-quotes menerima rincian tentang keranjang belanja Anda, mengembalikan kutipan pengiriman lengkap dengan kutipan bea masuk dan pajak, serta memeriksa barang untuk pembatasan. Kutipan pengiriman yang dikembalikan ini didasarkan pada profil pengiriman yang telah disiapkan sebelum penggunaan endpoint API ini.
Kami memiliki profil pengiriman default untuk tujuan pengujian, tetapi Anda perlu bekerja dengan Manajer Akun Anda untuk mengatur profil dan pengaturan pengiriman yang ingin digunakan perusahaan Anda.