Apa itu permintaan HTTPS untuk Checkout API?

Permintaan HTTPS untuk Checkout API mencakup metode HTTP (POST), endpoint ('https://api.iglobalstores.com/v2/orderDetail'), protokol (HTTPS), format pesan (JSON), dan header HTTP (Accept: application/json, Content-Type: application/json).

Apa saja pasangan kunci/nilai JSON di badan permintaan?

Pasangan kunci/nilai JSON di badan permintaan mencakup 'orderId', 'referenceId', 'secret', dan 'storeId'. 'orderId' dan 'referenceId' bersifat opsional, tetapi salah satunya harus diteruskan. 'secret' dan 'storeId' diperlukan.

Apa saja respons kesalahan HTTP yang mungkin?

Respons kesalahan HTTP yang mungkin mencakup 415 (Unsupported media type), 406 (Not Acceptable), 400 (Bad Request), dan 500 (Internal Server Error). Setiap kode kesalahan sesuai dengan jenis kesalahan tertentu.

Apa saja definisi JSON respons?

Definisi JSON respons mencakup berbagai parameter yang terkait dengan detail pesanan, seperti 'error', 'order', 'order.billingZip', 'orderboxCount', 'order.carrierAccountNumber', dan banyak lainnya. Setiap parameter memberikan informasi spesifik tentang pesanan.

Checkout•

BerandaReferensi API API REST Checkout Detail Pesanan

Detail Pesanan

Q: Apa itu endpoint Checkout API?

Endpoint Checkout API adalah 'orderDetail'. Endpoint API ini digunakan untuk mengambil detail pesanan dan status pesanan yang diselesaikan melalui Zonos Checkout dengan aman.

Pelajari cara kerja endpoint Order details.

Endpoint orderDetail digunakan untuk mengambil detail pesanan dan status pesanan yang diselesaikan melalui Zonos Checkout dengan aman.

Endpoint

Catatan: Kunci respons dapat diubah dan/atau kunci tambahan dapat ditambahkan. Jika Anda akan menggunakan endpoint, silakan atur kode Anda untuk mengakomodasi kemungkinan ini.

POST | `https://api.iglobalstores.com/v2/orderDetail`

Permintaan HTTPS

field↕	notes↕
HTTP method	POST
Endpoint	`https://api.iglobalstores.com/v2/orderDetail`
Protocol	HTTPS
Message format	JSON
Accept HTTP header	Accept: application/json
Content-Type HTTP header	Content-Type: application/json

Pasangan kunci/nilai JSON di badan permintaan

field↕	notes↕
`orderId` OPTIONAL, if passing `referenceId` parameter	Id pesanan Zonos dapat diteruskan dengan atau tanpa Id toko Anda dan tanda hubung (Contoh: 123-45678 atau 45678). Catatan: Setelah penyelesaian pesanan dan pembayaran, pelanggan akan dialihkan ke halaman Order Completion / Order Thank You yang dihosting di domain Anda. URL akan berisi parameter string kueri "orderId" yang akan berisi nilai ini.`integer / string`
`referenceId` OPTIONAL, if passing "orderId" parameter	Parameter ini digunakan untuk mencari data pesanan berdasarkan `referenceId` unik yang diteruskan di endpoint API service `createTempCart`. Parameter ini harus ditinggalkan atau null saat berniat mencari detail pesanan berdasarkan parameter `orderId`.`string`
`secret` REQUIRED	GUID rahasia API yang disediakan oleh Zonos`string`
`storeId` REQUIRED	ID Toko yang disediakan oleh Zonos.`integer`

Respons kesalahan HTTP

Error code↕	message↕	meaning↕
415	Unsupported media type	HTML Entity. Header HTTP "Content-Type" tidak valid.
406	Not Acceptable	HTML Entity. Header HTTP "Accept" tidak valid.
400	Bad Request	"error":"orderId: 999-99999 is not a valid orderId""error":"Could not find an order with orderId: 999-99999""error":"Invalid security credentials""error":"Invalid post body""error":"Parameter orderId or referenceId is required""error":"Cannot specify both Parameters orderId and referenceId""error":"No order found with orderId: 999-99999""error":"Parameter store required""error":"No order found with referenceId: 999999 for storeId: 999""error":"referenceId: 999999 for storeId: 999 has been duplicated""error":"Couldn't retrieve order with referenceId: 999999"
500	Internal Server Error	"error":"Couldn't process order details"

Definisi respons JSON

field↕	notes↕
`error`	Parameter ini hadir hanya ketika kesalahan terjadi dan akan berisi deskripsi kesalahan.`string`
`order`	Ini adalah peta detail pesanan.`JSON string`
`order.billingZip`	Alamat penagihan untuk pesanan - nilai dimasukkan ke Zonos Checkout.`string`
`orderboxCount`	Bidang ini menggambarkan kotak yang akan digunakan untuk mengirim pesanan, diteruskan ke permintaan createTempCart .`string`
`order.carrierAccountNumber`	Nomor akun operator pengiriman pengunjung sendiri; digunakan ketika akun operator pengunjung diaktifkan`string`
`order.carrierAccountShippingMethod`	Metode pengiriman yang dipilih pada akun operator pengiriman pengunjung sendiri; digunakan ketika akun operator pengunjung diaktifkan`string`
`order.cslListMatch`	Consolidated Screening List (CSL) match. Boolean yang menunjukkan ketika informasi pelanggan telah menghasilkan kecocokan dalam Consolidated Screening List AS dan harus ditinjau untuk kemungkinan afiliasi pihak yang ditolak.`boolean`
`order.customerSelectedShippingName`	Nama opsi pengiriman tampilan dalam Zonos Checkout`string`
`order.dutyTaxesBreakdown`	Peta rincian bea/pajak Catatan - Jika berlaku, IPF (International Processing Fee) tidak disertakan.`JSON string`
`order.dutyTaxesBreakdown.brokerageFee`	Jumlah biaya perantara dalam USD; floating point positif, dua tempat desimal`integer`
`order.dutyTaxesBreakdown.dispursementFee`	Jumlah biaya pengeluaran dalam USD; floating point positif, dua tempat desimal`integer`
`order.dutyTaxesBreakdown.duty`	Jumlah bea dalam USD; floating point positif, dua tempat desimal`integer`
`order.dutyTaxesBreakdown.prepaymentFee`	Jumlah biaya prabayar dalam USD; floating point positif, dua tempat desimal`integer`
`order.dutyTaxesBreakdown.vatOnDispursementFee`	Jumlah PPN/pajak atas biaya pengeluaran dalam USD; floating point positif, dua tempat desimal`integer`
`order.dutyTaxesBreakdown.vatTax`	Jumlah PPN/pajak dalam USD, tidak termasuk PPN/pajak atas biaya pengeluaran; floating point positif, dua tempat desimal`integer`
`order.dutyTaxesTotal`	Total bea dan pajak dalam USD; floating point positif, dua tempat desimal`integer`
`order.foreignCurrencyCode`	Kode mata uang yang diselesaikan pembayaran pesanan.`string`
`remittance_amount`	Jumlah uang yang perlu dikirimkan ke negara tertentu, misalnya _ UK VAT_.`decimal`
`order.grandTotal`	Total keseluruhan dalam USD; floating point positif, dua tempat desimal`integer`
`order.grandTotalForeign`	Total keseluruhan dalam mata uang yang diselesaikan; floating point positif, dua tempat desimal`integer`
`order.items`	Daftar peta item. Peta item berisi detail tentang item yang diteruskan ke Zonos Checkout saat pembuatan keranjang sementara. Untuk detail lebih lanjut tentang properti item, silakan tinjau dokumentasi API createTempCart .`JSON string`
`order.itemsCount`	Jumlah item baris pesanan`integer`
`order.itemsTotal`	Total item / produk dalam USD; floating point positif, dua tempat desimal`integer`
`order.itemsTotalForeign`	Total item / produk dalam mata uang yang diselesaikan; floating point positif, dua tempat desimal`integer`
`order.items[index].height`	Floating point positif, dua tempat desimal`integer`
`order.items[index].itemNonShippable`	`boolean`
`order.items[index].length`	Floating point positif, dua tempat desimal`integer`
`order.items[index].quantity`	`integer`
`order.items[index].weight`	Floating point positif, dua tempat desimal`integer`
`order.items[index].width`	Floating point positif, dua tempat desimal`integer`
`order.items[index].unitPrice`	Floating point positif, dua tempat desimal`integer`
`order.merchantOrderId`	`MerchantOrderId` yang terkait dengan pesanan melalui endpoint layanan API updateMerchantOrderId .`string`
`order.misc1`	Nilai tambahan yang terkait dengan pesanan melalui endpoint layanan API createTempCart .`string`
`order.misc2`	Nilai tambahan yang terkait dengan pesanan melalui endpoint layanan API createTempCart .`string`
`order.misc3`	Nilai tambahan yang terkait dengan pesanan melalui endpoint layanan API createTempCart .`string`
`order.misc4`	Nilai tambahan yang terkait dengan pesanan melalui endpoint layanan API createTempCart .`string`
`order.misc5`	Nilai tambahan yang terkait dengan pesanan melalui endpoint layanan API createTempCart .`string`
`order.misc6`	Nilai tambahan yang terkait dengan pesanan melalui endpoint layanan API createTempCart .`string`
`order.nationalIdentifier`	Informasi alamat penagihan internasional tambahan untuk pesanan saat diperlukan. Nilai dimasukkan ke Zonos Checkout.`string`
`order.notes`	Daftar peta catatan; peta catatan berisi detail tentang catatan pesanan.`JSON string`
`order.notes[index].createdByUser`	`string`
`order.notes[index].customerNote`	Boolean yang menunjukkan apakah ini adalah catatan yang dibuat pelanggan tentang pesanan, pengiriman, dll.`boolean`
`order.notes[index].dateCreated`	`millis`
`order.notes[index].dateCreatedString`	`string`
`order.notes[index].flagged`	`boolean` yang menunjukkan apakah catatan ini ditandai sebagai penting
`order.notes[index].note`	Konten catatan`string`
`order.optInEmail`	Menunjukkan bahwa pelanggan memilih kotak centang untuk "daftar buletin kami" di dalam Zonos CheckoutHanya berlaku jika Anda telah memilih untuk menampilkan kotak centang ini di halaman checkout`boolean`
`order.orderId`	Nomor identifikasi pesanan dalam sistem Zonos`string`
`order.orderDate`	Stempel waktu pembuatan pesanan millis dalam UTC/GMT.`millis`
`order.orderDateString`	String stempel waktu pembuatan pesanan dalam UTC/GMT.`string`
`order.orderStatus`	Status/keadaan pesanan dalam sistem Zonos. Untuk detail lebih lanjut tentang penggunaan `orderStatus`, silakan tinjau dokumen Retrieve an order di sini.Informasi tambahan tentang status pesanan dapat ditemukan di dokumen Update an order di sini.`string`
`order.orderStatusDate`	Stempel waktu millis dalam UTC/GMT dari perubahan `orderStatus` paling baru dalam sistem Zonos.`millis`
`order.orderStatusDateString`	String stempel waktu dalam UTC/GMT dari perubahan `orderStatus` paling baru dalam sistem Zonos.`string`
`order.paymentProcessing`	Peta detail `paymentProcessing`. Beberapa parameter mungkin tidak berlaku untuk akun Anda dan akan dikecualikan dari respons.`JSON string`
`order.paymentProcessing.captureDate`	Tanggal penangkapan pembayaran dalam millis, jika tersedia.Jika Zonos memproses pembayaran, node ini dikecualikan dari respons.`millis`
`order.paymentProcessing.captureDateString`	Tanggal penangkapan pembayaran sebagai string, jika tersedia.Jika Zonos memproses pembayaran, node ini dikecualikan dari respons.`string`
`order.paymentProcessing.cardType`	Merek kartu kreditJika Zonos memproses pembayaran, node ini dikecualikan dari respons.`string`
`order.paymentProcessing.lastFour`	Empat angka terakhir dari nomor kartu kredit penagihan.Jika Zonos memproses pembayaran, node ini dikecualikan dari respons.`string`
`order.paymentProcessing.paymentGateway`	Nama gateway pembayaranJika Zonos memproses pembayaran, akan menunjukkan "iGlobal_CC" atau "iGlobal_PayPal".`string`
`order.paymentProcessing.transactionType`	Menunjukkan jenis transaksi "AUTH_CAPTURE" atau "AUTH_ONLY".Jika Zonos memproses pembayaran, node ini dikecualikan dari respons.`string`
`order.poNumber`	Nomor pesanan pembelian untuk pesanan yang ditentukan dalam Zonos Checkout; digunakan ketika pesanan pembelian diaktifkan`string`
`order.quotedDutyTaxes`	Bea dan pajak yang dikutip dalam Zonos Checkout, ditampilkan dalam USD; floating point positif, dua tempat desimal`integer`
`order.quotedDutyTaxesForeign`	Bea dan pajak yang dikutip dalam Zonos Checkout. Ditampilkan dalam mata uang yang diselesaikan; floating point positif, dua tempat desimal`integer`
`order.referenceId`	`referenceId` unik yang terkait dengan pesanan melalui endpoint layanan API createTempCart.`string`
`order.shipComplete`	Menunjukkan apakah pesanan harus dikirim dalam beberapa bagian`boolean`
`order.shippingCarrierServiceLevel`	Pengenal tingkat layanan dan operator pengiriman untuk opsi pengiriman yang dipilih`string`
`order.shippingInstructions`	Instruksi pengiriman yang dapat disesuaikan untuk tingkat layanan pengiriman`string`
`order.shippingTotal`	Total pengiriman dalam USD; floating point positif, dua tempat desimal `integer`
`order.shippingTotalForeign`	Total pengiriman dalam mata uang yang diselesaikan; floating point positif, dua tempat desimal`integer`
`order.testOrder`	Menunjukkan apakah pesanan adalah pesanan uji.`boolean`
`order.trackingNumber`	Nomor pelacakan yang dihasilkan untuk pengiriman, jika berlaku.`string`
`order.zip`	Tujuan / alamat pengiriman untuk pesanan - nilai dimasukkan ke Zonos Checkout atau diteruskan ke pesanan melalui pengalihan ke Zonos Checkout.`string`

Tipe data tambahan:

order.address1
order.address2
order.address3
order.altPhone
order.billingAddress1
order.billingAddress2
order.billingAddress3
order.billingAltPhone
order.billingCity
order.birthDate
order.billingCompany
order.billingCountryCode
order.billingCountryName
order.billingEmail
order.billingName
order.billingPhone
order.billingState
order.city
order.company
order.countryCode
order.countryName
order.email
order.items[index].countryOfOrigin
order.items[index].description
order.items[index].imageURL
order.items[index].itemBrand
order.items[index].itemCategory
order.items[index].itemColor
order.items[index].itemCustomization
order.items[index].itemDescriptionDetailed
order.items[index].itemDescriptionLong
order.items[index].itemFabricContent
order.items[index].itemHSCode
order.items[index].itemLtlClass
order.items[index].itemMaterial
order.items[index].itemURL
order.items[index].productId
order.items[index].sku
order.items[index].productId
order.items[index].weightUnits
order.name
order.phone
order.state

Pesan demo