Rincian pesanan

Pelajari cara kerja endpoint Rincian pesanan.

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

Endpoint

Catatan: Kunci respons dapat dimodifikasi dan/atau kunci tambahan dapat ditambahkan. Jika Anda akan menggunakan endpoint ini, harap siapkan kode Anda untuk mengakomodasi kemungkinan ini.

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

Permintaan HTTPS

field	notes
Metode HTTP	POST
Endpoint	`https://api.iglobalstores.com/v2/orderDetail`
Protokol	HTTPS
Format pesan	JSON
Header HTTP Accept	Accept: application/json
Header HTTP Content-Type	Content-Type: application/json

Pasangan kunci/nilai JSON dalam tubuh permintaan

field	notes
`orderId` OPSIONAL, jika melewatkan parameter `referenceId`	ID pesanan Zonos dapat dilewatkan dengan atau tanpa ID toko Anda dan tanda hubung (Contoh: 123-45678 atau 45678). Catatan: Setelah penyelesaian pesanan dan pembayaran, pelanggan akan diarahkan ke halaman Penyelesaian Pesanan / Terima Kasih Pesanan yang dihosting di domain Anda. URL akan berisi parameter querystring “orderId” yang akan berisi nilai ini.`integer / string`
`referenceId` OPSIONAL, jika melewatkan parameter “orderId”	Parameter ini digunakan untuk mencari data pesanan berdasarkan `referenceId` unik yang dilewatkan dalam endpoint Layanan API `createTempCart`. Parameter ini harus dibiarkan kosong atau null saat bermaksud untuk mencari rincian pesanan berdasarkan parameter `orderId` yang diberikan.`string`
`secret` DIWAJIBKAN	API secret GUID yang diberikan oleh Zonos`string`
`storeId` DIWAJIBKAN	ID Toko yang diberikan oleh Zonos.`integer`

Respons HTTP Error

Error code	message	meaning
415	Jenis media tidak didukung	Entitas HTML. Header “Content-Type” HTTP tidak valid.
406	Tidak Diterima	Entitas HTML. Header “Accept” HTTP tidak valid.
400	Permintaan Buruk	“error”:”orderId: 999-99999 bukan orderId yang valid”“error”:”Tidak dapat menemukan pesanan dengan orderId: 999-99999”“error”:”Kredensial keamanan tidak valid”“error”:”Badan pos tidak valid”“error”:”Parameter orderId atau referenceId diperlukan”“error”:”Tidak dapat menentukan kedua Parameter orderId dan referenceId”“error”:”Tidak ada pesanan yang ditemukan dengan orderId: 999-99999”“error”:”Parameter toko diperlukan”“error”:”Tidak ada pesanan yang ditemukan dengan referenceId: 999999 untuk storeId: 999”“error”:”referenceId: 999999 untuk storeId: 999 telah diduplikasi”“error”:”Tidak dapat mengambil pesanan dengan referenceId: 999999”
500	Kesalahan Server Internal	“error”:”Tidak dapat memproses rincian pesanan”

Definisi JSON Respon

field	notes
`error`	Parameter ini hanya ada ketika terjadi kesalahan dan akan berisi deskripsi kesalahan.`string`
`order`	Ini adalah peta dari detail pesanan.`JSON string`
`order.billingZip`	Alamat penagihan untuk pesanan - nilai-nilai dimasukkan ke dalam Zonos Checkout.`string`
`orderboxCount`	Bidang ini menggambarkan kotak yang akan digunakan untuk mengirim pesanan, diteruskan ke dalam permintaan createTempCart .`string`
`order.carrierAccountNumber`	Nomor akun pengiriman carrier milik pengunjung; digunakan ketika akun carrier pengunjung diaktifkan`string`
`order.carrierAccountShippingMethod`	Metode pengiriman yang dipilih pada akun carrier pengiriman milik pengunjung; digunakan ketika akun carrier pengunjung diaktifkan`string`
`order.cslListMatch`	Kecocokan Daftar Penyaringan Terpadu (CSL). Sebuah boolean yang menunjukkan ketika informasi pelanggan telah menghasilkan kecocokan dalam Daftar Penyaringan Terpadu AS dan harus ditinjau untuk kemungkinan afiliasi pihak yang ditolak.`boolean`
`order.customerSelectedShippingName`	Nama tampilan opsi pengiriman di dalam Zonos Checkout`string`
`order.dutyTaxesBreakdown`	Peta rincian bea/pajakCatatan - Jika berlaku, IPF (Biaya Pemrosesan Internasional) tidak termasuk.`JSON string`
`order.dutyTaxesBreakdown.brokerageFee`	Jumlah biaya perantara dalam USD; angka positif dengan titik desimal, dua tempat desimal`integer`
`order.dutyTaxesBreakdown.dispursementFee`	Jumlah biaya pencairan dalam USD; angka positif dengan titik desimal, dua tempat desimal`integer`
`order.dutyTaxesBreakdown.duty`	Jumlah bea dalam USD; angka positif dengan titik desimal, dua tempat desimal`integer`
`order.dutyTaxesBreakdown.prepaymentFee`	Jumlah biaya pembayaran di muka dalam USD; angka positif dengan titik desimal, dua tempat desimal`integer`
`order.dutyTaxesBreakdown.vatOnDispursementFee`	Jumlah PPN/pajak pada biaya pencairan dalam USD; angka positif dengan titik desimal, dua tempat desimal`integer`
`order.dutyTaxesBreakdown.vatTax`	Jumlah PPN/pajak dalam USD, tidak termasuk PPN/pajak pada biaya pencairan; angka positif dengan titik desimal, dua tempat desimal`integer`
`order.dutyTaxesTotal`	Total bea dan pajak dalam USD; angka positif dengan titik desimal, dua tempat desimal`integer`
`order.foreignCurrencyCode`	Kode mata uang yang digunakan untuk penyelesaian pembayaran pesanan.`string`
`remittance_amount`	Jumlah uang yang perlu dikirim ke negara tertentu (misalnya PPN Inggris).`decimal`
`order.grandTotal`	Total keseluruhan dalam USD; angka positif dengan titik desimal, dua tempat desimal`integer`
`order.grandTotalForeign`	Total keseluruhan dalam mata uang yang diselesaikan; angka positif dengan titik desimal, dua tempat desimal`integer`
`order.items`	Daftar peta itemPeta item berisi detail tentang item yang diteruskan ke dalam Zonos Checkout saat pembuatan keranjang sementaraUntuk detail lebih lanjut tentang properti item, silakan tinjau dokumen API createTempCart `JSON string`
`order.itemsCount`	Jumlah item baris pesanan`integer`
`order.itemsTotal`	Total item / produk dalam USD; angka positif dengan titik desimal, dua tempat desimal`integer`
`order.itemsTotalForeign`	Total item / produk dalam mata uang yang diselesaikan; angka positif dengan titik desimal, dua tempat desimal`integer`
`order.items[index].height`	Angka positif dengan titik desimal, dua tempat desimal`integer`
`order.items[index].itemNonShippable`	`boolean`
`order.items[index].length`	Angka positif dengan titik desimal, dua tempat desimal`integer`
`order.items[index].quantity`	`integer`
`order.items[index].weight`	Bilangan positif dengan titik desimal, dua tempat desimal`integer`
`order.items[index].width`	Bilangan positif dengan titik desimal, dua tempat desimal`integer`
`order.items[index].unitPrice`	Bilangan positif dengan titik desimal, dua tempat desimal`integer`
`order.merchantOrderId`	`MerchantOrderId` yang terkait dengan pesanan melalui updateMerchantOrderId API service endpoint.`string`
`order.misc1`	Nilai tambahan yang terkait dengan pesanan melalui createTempCart API service endpoint.`string`
`order.misc2`	Nilai tambahan yang terkait dengan pesanan melalui createTempCart API service endpoint.`string`
`order.misc3`	Nilai tambahan yang terkait dengan pesanan melalui createTempCart API service endpoint.`string`
`order.misc4`	Nilai tambahan yang terkait dengan pesanan melalui createTempCart API service endpoint.`string`
`order.misc5`	Nilai tambahan yang terkait dengan pesanan melalui createTempCart API service endpoint.`string`
`order.misc6`	Nilai tambahan yang terkait dengan pesanan melalui createTempCart API service endpoint.`string`
`order.nationalIdentifier`	Informasi alamat penagihan internasional tambahan untuk pesanan jika diperlukan. Nilai dimasukkan ke dalam Zonos Checkout.`string`
`order.notes`	Daftar peta catatan; peta catatan berisi rincian tentang catatan pesanan.`JSON string`
`order.notes[index].createdByUser`	`string`
`order.notes[index].customerNote`	Sebuah boolean yang menunjukkan apakah ini adalah catatan yang dibuat oleh pelanggan tentang pesanan, pengiriman, dll.`boolean`
`order.notes[index].dateCreated`	`millis`
`order.notes[index].dateCreatedString`	`string`
`order.notes[index].flagged`	Sebuah `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 untuk buletin kami” di dalam Zonos Checkout. Berlaku hanya jika Anda telah memilih untuk menampilkan kotak centang ini di halaman checkout`boolean`
`order.orderId`	Nomor identifikasi pesanan dalam sistem Zonos`string`
`order.orderDate`	Timestamp pembuatan pesanan dalam millis di UTC/GMT.`millis`
`order.orderDateString`	String timestamp pembuatan pesanan dalam UTC/GMT.`string`
`order.orderStatus`	Status/keadaan pesanan dalam sistem Zonos. Untuk detail lebih lanjut tentang penggunaan `orderStatus`, silakan tinjau Retrieve an order document here. Informasi tambahan tentang status pesanan dapat ditemukan di Update an order document here.`string`
`order.orderStatusDate`	Timestamp millis di UTC/GMT dari perubahan `orderStatus` terbaru dalam sistem Zonos.`millis`
`order.orderStatusDateString`	String timestamp di UTC/GMT dari perubahan `orderStatus` terbaru dalam sistem Zonos.`string`
`order.paymentProcessing`	Peta rincian `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 kredit. Jika 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 gerbang pembayaran. Jika 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 di dalam Zonos Checkout; digunakan ketika pesanan pembelian diaktifkan.`string`
`order.quotedDutyTaxes`	Bea dan pajak yang dikutip di Zonos Checkout, ditampilkan dalam USD; angka positif dengan titik desimal, dua tempat desimal.`integer`
`order.quotedDutyTaxesForeign`	Bea dan pajak yang dikutip di Zonos Checkout. Ditampilkan dalam mata uang yang diselesaikan; angka positif dengan titik desimal, 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`	Identifikasi carrier dan tingkat layanan untuk opsi pengiriman yang dipilih.`string`
`order.shippingInstructions`	Instruksi yang dapat disesuaikan untuk tingkat layanan pengiriman.`string`
`order.shippingTotal`	Total pengiriman dalam USD; angka positif dengan titik desimal, dua tempat desimal.`integer`
`order.shippingTotalForeign`	Total pengiriman dalam mata uang yang diselesaikan; angka positif dengan titik desimal, 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`	Alamat tujuan / pengiriman untuk pesanan - nilai dimasukkan ke dalam 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

Apakah halaman ini membantu?

Pertanyaan?

Hubungi kami.

Lihat Zonos

kebijakan dan perjanjian