Endpoint
Permintaan detail pesanan selesai
POST | https://api.iglobalstores.com/2.0/order-completed - Buat permintaan baru untuk informasi terkait pesanan yang telah selesai.
Permintaan HTTPS
| Field | Notes |
|---|---|
| Metode HTTP | POST |
| URL Endpoint | https://api.iglobalstores.com/2.0/order-completed |
| Protokol | HTTPS |
| Format pesan | JSON |
| Header HTTP Accept | Accept: application/json |
| Header token keamanan HTTP | 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 Content-Type HTTP | 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 dalam tubuh 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
{
"billingAddress": {
"address1": "123 S West Elm St",
"address2": null,
"address3": null,
"city": "Calgary",
"countryCode": "CA",
"postalCode": "T2P 5G8",
"state": "Alberta",
"stateCode": null
},
"billingCompany": null,
"billingEmail": "jdoe@jdoe.com",
"billingName": "John E. Doe",
"billingPhone": "+1 555-555-5555",
"orderGrandTotal": 1225.89,
"orderNumber": "854725421",
"paymentTypeCode": "PAYPAL",
"prepaidDutyTax": true,
"shippingQuoteId": "bcdbdbcd-0145-4d3b-a54e-0de3cdce5a0a",
"shipToCompany": null,
"shipToEmail": "jdoe@jdoe.com",
"shipToName": "John Doe",
"shipToPhone": "+1 555-555-5555"
}
Definisi JSON Permintaan
| Field | Catatan |
|---|---|
billingAddress WAJIB | Ini adalah alamat penagihan dari pesanan. Ini adalah peta yang berisi bidang alamat berikut: address1, address2, address3, city, state, stateCode, postalCode, dan countryCode. Bidang-bidang yang terkandung ini ada yang wajib atau tidak wajib berdasarkan negara. Endpoint lokalisasi mengembalikan bidang alamat spesifik mana yang wajib atau tidak untuk setiap negara. Catatan: stateCode selalu tidak wajib dan tidak dinyatakan dalam endpoint lokalisasi. Anda dapat mengirimkan stateCode, jika tersedia. |
billingCompany OPSIONAL | Ini adalah nama perusahaan penagihan dari pesanan. |
billingEmail WAJIB | Ini adalah alamat email penagihan dari pesanan. |
billingName WAJIB | Ini adalah nama penagihan lengkap dari pesanan. |
billingPhone WAJIB | Ini adalah nomor telepon penagihan dari pesanan. |
items[index].orderGrandTotal WAJIB | Ini adalah total besar yang dibayar oleh pembeli untuk pesanan mereka dalam USD (Dolar AS). Harap berikan tanpa koma, tanpa tanda dolar “$”, dan dengan dua tempat desimal. Contoh nilai: 2102.99 |
items[index].orderNumber WAJIB | Ini adalah nomor pesanan Anda untuk pesanan yang baru selesai. Contoh nilai: 854725421 |
paymentTypeCode WAJIB | Metode pembayaran yang digunakan oleh pembeli untuk membayar pesanan mereka. Contoh nilai: PayPal atau Visa atau MC atau AMEX atau DISC |
prepaidDutyTax WAJIB | Apakah pembeli memilih untuk prepay bea dan pajak impor mereka atau apakah mereka terpaksa prepay? Jika ya, setel ke true; jika tidak, setel ke false. Contoh nilai: true atau false |
shippingQuoteId WAJIB | Ini adalah ID dari kutipan pengiriman yang dipilih oleh pembeli. Detail keranjang perlu sama seperti saat kutipan pengiriman diambil. Jika detail keranjang telah berubah, maka Anda harus meminta kutipan pengiriman baru sebelum menyelesaikan pesanan pembeli. |
shipToCompany OPSIONAL | Ini adalah nama perusahaan dari individu yang akan menerima pesanan yang dikirim. |
shipToEmail WAJIB | Ini adalah alamat email dari individu yang akan menerima pesanan yang dikirim. |
shipToName WAJIB | Ini adalah nama lengkap dari individu yang akan menerima pesanan yang dikirim. |
shipToPhone WAJIB | Ini adalah nomor telepon dari individu yang akan menerima pesanan yang dikirim. |
Respons HTTPS
Format pesan: JSON
Contoh respons untuk hanya Kanada & Australia
Catatan: Respons aktual akan berisi semua negara yang didukung.
Contoh respons
1
2
3
4
5
6
7
{
"igOrderId": "e55a4efc-e615-49af-b3a4-afcda87e9e5e",
"deniedParty": {
"flagged": true,
"source": "source reference for review"
}
}
Definisi JSON Respons
| Field | Catatan |
|---|---|
deniedParty | Ini adalah peta dari hasil penyaringan pihak yang ditolak. Jika disetel ke null, maka penyaringan pihak yang ditolak tidak dilakukan. Hubungi perwakilan Zonos Anda jika Anda menemui hal ini. |
deniedParty.flagged | Apakah pesanan ini telah cocok dengan catatan dalam daftar pihak yang ditolak konsolidasi Zonos. Jika benar, tinjau pesanan ini sebelum diproses. Jika ragu, jangan proses pesanan yang ditandai benar. Contoh nilai: true atau false |
deniedParty.source | Jika bidang yang ditandai disetel ke true, bidang ini akan menyimpan referensi sumber yang berguna dalam meninjau mengapa pesanan ditandai sebagai cocok dengan pihak yang ditolak. |
igOrderId | Identifikasi Zonos untuk pesanan yang baru selesai. Contoh nilai: e55a4efc-e615-49af-b3a4-afcda87e9e5e |
API Pesanan Selesai Warisan
Pelajari cara kerja API Pesanan Selesai warisan.Endpoint Pesanan Selesai menerima detail akhir dari pesanan pembeli, memeriksa detail pesanan untuk pihak yang ditolak, dan mengembalikan hasilnya bersama dengan ID pesanan yang spesifik untuk Zonos.