Uç Nokta
Not: Yanıt anahtarları değiştirilebilir ve/veya ek anahtarlar eklenebilir. Uç noktayı kullanacaksanız, kodunuzu bu olasılıkları göz önünde bulunduracak şekilde ayarlayın.
POST | https://api.iglobalstores.com/v2/orderDetail
HTTPS isteği
alan | notlar |
---|---|
HTTP yöntemi | POST |
Uç nokta | https://api.iglobalstores.com/v2/orderDetail |
Protokol | HTTPS |
Mesaj formatı | JSON |
Accept HTTP başlığı | Accept: application/json |
Content-Type HTTP başlığı | Content-Type: application/json |
İstek gövdesindeki JSON anahtar/değer çiftleri
alan | notlar |
---|---|
orderId İSTEĞE BAĞLI, referenceId parametresi geçiliyorsa | Zonos sipariş Kimliği, mağaza Kimliğiniz ve tire ile birlikte veya olmadan geçirilebilir (Örnek: 123-45678 veya 45678). Not: Sipariş tamamlandıktan ve ödeme yapıldıktan sonra, müşteri alan adınızda barındırılan Sipariş Tamamlandı / Sipariş Teşekkür Sayfasına yönlendirilecektir. URL, bu değeri içerecek “orderId” sorgu dizesi parametresini içerecektir.integer / string |
referenceId İSTEĞE BAĞLI, “orderId” parametresi geçiliyorsa | Bu parametre, createTempCart API Servis uç noktasında geçirilen benzersiz referenceId ile bir siparişin verilerini aramak için kullanılır. Bu parametre, orderId parametresine göre sipariş detayını aramak istediğinizde bırakılmalı veya null olmalıdır.string |
secret GEREKEN | Zonos tarafından sağlanan API gizli GUIDstring |
storeId GEREKEN | Zonos tarafından sağlanan Mağaza Kimliği.integer |
Hata HTTP yanıtları
Hata kodu | mesaj | anlamı |
---|---|---|
415 | Desteklenmeyen medya türü | HTML Varlığı. HTTP “Content-Type” başlığı geçersiz. |
406 | Kabul Edilemez | HTML Varlığı. HTTP “Accept” başlığı geçersiz. |
400 | Geçersiz İstek | “error”:”orderId: 999-99999 geçerli bir orderId değil”“error”:”orderId: 999-99999 ile bir sipariş bulunamadı”“error”:”Geçersiz güvenlik kimlik bilgileri”“error”:”Geçersiz post gövdesi”“error”:”orderId veya referenceId parametresi gereklidir”“error”:”Her iki Parametreyi de orderId ve referenceId olarak belirtemezsiniz”“error”:”orderId: 999-99999 ile sipariş bulunamadı”“error”:”Mağaza parametresi gereklidir”“error”:”storeId: 999 için referenceId: 999999 ile sipariş bulunamadı”“error”:”storeId: 999 için referenceId: 999999 tekrarlandı”“error”:”referenceId: 999999 ile sipariş alınamadı” |
500 | Sunucu Hatası | “error”:”Sipariş detaylarını işleyemedim” |
Yanıt JSON tanımları
alan | notlar |
---|---|
error | Bu parametre yalnızca bir hata meydana geldiğinde bulunur ve bir hata açıklaması içerecektir.string |
order | Bu, sipariş detaylarının haritasıdır.JSON string |
order.billingZip | Sipariş için fatura adresi - değerler Zonos Checkout içine girilmiştir.string |
orderboxCount | Bu alan, siparişi göndermek için kullanılacak kutuları tanımlar, createTempCart isteğine geçirilmiştir.string |
order.carrierAccountNumber | Ziyaretçinin kendi nakliye taşıyıcı hesap numarası; ziyaretçi taşıyıcı hesapları etkinleştirildiğinde kullanılırstring |
order.carrierAccountShippingMethod | Ziyaretçinin kendi nakliye taşıyıcı hesabındaki seçilen nakliye yöntemi; ziyaretçi taşıyıcı hesapları etkinleştirildiğinde kullanılırstring |
order.cslListMatch | Konsolide Tarama Listesi (CSL) eşleşmesi. Müşteri bilgilerinin ABD Konsolide Tarama Listesi'nde bir eşleşme ürettiğini ve olası reddedilen taraf bağlantısı için gözden geçirilmesi gerektiğini belirten bir boolean.boolean |
order.customerSelectedShippingName | Zonos Checkout içindeki nakliye seçeneği görüntüleme adıstring |
order.dutyTaxesBreakdown | Gümrük/vergilerin ayrıntılı haritasıNot - Uygulanabilir ise, IPF (Uluslararası İşlem Ücreti) dahil değildir.JSON string |
order.dutyTaxesBreakdown.brokerageFee | USD cinsinden aracılık ücreti miktarı; pozitif ondalık, iki ondalık basamakinteger |
order.dutyTaxesBreakdown.dispursementFee | USD cinsinden dağıtım ücreti miktarı; pozitif ondalık, iki ondalık basamakinteger |
order.dutyTaxesBreakdown.duty | USD cinsinden gümrük ücreti miktarı; pozitif ondalık, iki ondalık basamakinteger |
order.dutyTaxesBreakdown.prepaymentFee | USD cinsinden ön ödeme ücreti miktarı; pozitif ondalık, iki ondalık basamakinteger |
order.dutyTaxesBreakdown.vatOnDispursementFee | USD cinsinden dağıtım ücreti üzerindeki KDV/vergisi miktarı; pozitif ondalık, iki ondalık basamakinteger |
order.dutyTaxesBreakdown.vatTax | USD cinsinden KDV/vergisi miktarı, dağıtım ücreti üzerindeki KDV/vergisini içermez; pozitif ondalık, iki ondalık basamakinteger |
order.dutyTaxesTotal | USD cinsinden gümrük ve vergi toplamı; pozitif ondalık, iki ondalık basamakinteger |
order.foreignCurrencyCode | Sipariş ödemesinin yapıldığı para birimi kodu.string |
remittance_amount | Belirli bir ülkeye (örneğin, Birleşik Krallık KDV) gönderilmesi gereken para miktarı.decimal |
order.grandTotal | USD cinsinden toplam; pozitif ondalık, iki ondalık basamakinteger |
order.grandTotalForeign | Yerleşik para birimindeki toplam; pozitif ondalık, iki ondalık basamakinteger |
order.items | Zonos Checkout'a geçici sepet oluşturma sırasında iletilen öğeler hakkında ayrıntıları içeren öğe haritalarının bir listesiÖğe özellikleri hakkında daha fazla bilgi için lütfen createTempCart API belgesini inceleyinJSON string |
order.itemsCount | Sipariş satır öğelerinin sayısıinteger |
order.itemsTotal | USD cinsinden ürün toplamı; pozitif ondalık, iki ondalık basamakinteger |
order.itemsTotalForeign | Yerleşik para birimindeki ürün toplamı; pozitif ondalık, iki ondalık basamakinteger |
order.items[index].height | Pozitif ondalık, iki ondalık basamakinteger |
order.items[index].itemNonShippable | boolean |
order.items[index].length | Pozitif ondalık, iki ondalık basamakinteger |
order.items[index].quantity | integer |
order.items[index].weight | Pozitif ondalık, iki ondalık basamakinteger |
order.items[index].width | Pozitif ondalık, iki ondalık basamakinteger |
order.items[index].unitPrice | Pozitif ondalık, iki ondalık basamakinteger |
order.merchantOrderId | Siparişle ilişkili MerchantOrderId updateMerchantOrderId API hizmet uç noktası aracılığıyla.string |
order.misc1 | createTempCart API hizmet uç noktası aracılığıyla siparişle ilişkili ek değer.string |
order.misc2 | createTempCart API hizmet uç noktası aracılığıyla siparişle ilişkili ek değer.string |
order.misc3 | createTempCart API hizmet uç noktası aracılığıyla siparişle ilişkili ek değer.string |
order.misc4 | createTempCart API hizmet uç noktası aracılığıyla siparişle ilişkili ek değer.string |
order.misc5 | createTempCart API hizmet uç noktası aracılığıyla siparişle ilişkili ek değer.string |
order.misc6 | createTempCart API hizmet uç noktası aracılığıyla siparişle ilişkili ek değer.string |
order.nationalIdentifier | Gerekli olduğunda sipariş için ek uluslararası fatura adresi bilgisi. Değerler Zonos Checkout içine girilmiştir.string |
order.notes | Not haritalarının bir listesi; not haritası sipariş notu hakkında ayrıntıları içerir.JSON string |
order.notes[index].createdByUser | string |
order.notes[index].customerNote | Bu notun sipariş, gönderim vb. hakkında müşteri tarafından oluşturulmuş bir not olup olmadığını belirten bir boolean.boolean |
order.notes[index].dateCreated | millis |
order.notes[index].dateCreatedString | string |
order.notes[index].flagged | Bu notun önemli olarak işaretlenip işaretlenmediğini belirten bir boolean |
order.notes[index].note | Not içeriğistring |
order.optInEmail | Müşterinin Zonos Checkout içinde “bültenimize kaydol” için onay kutusunu seçtiğini gösterir. Bu onay kutusunu checkout sayfasında görüntülemeyi seçtiyseniz geçerlidir.boolean |
order.orderId | Siparişin Zonos sistemindeki tanımlama numarasıstring |
order.orderDate | Sipariş oluşturma zaman damgası millis UTC/GMT.millis |
order.orderDateString | Sipariş oluşturma zaman damgası dizesi UTC/GMT.string |
order.orderStatus | Siparişin Zonos sistemindeki durumu/halidir. orderStatus kullanımı hakkında daha fazla bilgi için lütfen Buradan sipariş belgesini alın. Sipariş durumları hakkında daha fazla bilgi Buradan siparişi güncelleme belgesini bulabilirsiniz.string |
order.orderStatusDate | Zonos sistemindeki en son orderStatus değişikliğinin UTC/GMT'deki zaman damgası millis.millis |
order.orderStatusDateString | Zonos sistemindeki en son orderStatus değişikliğinin UTC/GMT'deki zaman damgası dizesi.string |
order.paymentProcessing | paymentProcessing ayrıntılarının bir haritası. Bazı parametreler hesabınıza uygulanmayabilir ve yanıttan hariç tutulacaktır.JSON string |
order.paymentProcessing.captureDate | Mevcutsa, ödeme yakalama tarihinin millis cinsinden değeri. Eğer Zonos ödemeyi işliyorsa, bu düğüm yanıttan hariç tutulur.millis |
order.paymentProcessing.captureDateString | Mevcutsa, ödeme yakalama tarihinin dize cinsinden değeri. Eğer Zonos ödemeyi işliyorsa, bu düğüm yanıttan hariç tutulur.string |
order.paymentProcessing.cardType | Kredi kartı markası. Eğer Zonos ödemeyi işliyorsa, bu düğüm yanıttan hariç tutulur.string |
order.paymentProcessing.lastFour | Fatura kredi kartı numarasının son dört hanesi. Eğer Zonos ödemeyi işliyorsa, bu düğüm yanıtın dışında bırakılır. string |
order.paymentProcessing.paymentGateway | Ödeme geçidi adı. Eğer Zonos ödemeyi işliyorsa, “iGlobal_CC” veya “iGlobal_PayPal” olarak belirtilecektir. string |
order.paymentProcessing.transactionType | İşlem türünü belirtir. “AUTH_CAPTURE” veya “AUTH_ONLY”. Eğer Zonos ödemeyi işliyorsa, bu düğüm yanıtın dışında bırakılır. string |
order.poNumber | Zonos Checkout içinde belirtilen sipariş için bir satın alma siparişi numarası; satın alma siparişleri etkinleştirildiğinde kullanılır. string |
order.quotedDutyTaxes | Zonos Checkout içinde belirtilen gümrük ve vergi; USD cinsinden gösterilir; pozitif ondalık, iki ondalık basamak. integer |
order.quotedDutyTaxesForeign | Zonos Checkout içinde belirtilen gümrük ve vergi. Yerleşik para biriminde gösterilir; pozitif ondalık, iki ondalık basamak. integer |
order.referenceId | createTempCart API hizmet uç noktası aracılığıyla siparişle ilişkilendirilmiş benzersiz referenceId . string |
order.shipComplete | Siparişin birden fazla parça halinde gönderilip gönderilmeyeceğini belirtir. boolean |
order.shippingCarrierServiceLevel | Seçilen gönderim seçeneği için taşıyıcı ve hizmet seviyesi tanımlayıcısı. string |
order.shippingInstructions | Gönderim hizmet seviyesi için özelleştirilebilir talimatlar. string |
order.shippingTotal | USD cinsinden gönderim toplamı; pozitif ondalık, iki ondalık basamak. integer |
order.shippingTotalForeign | Yerleşik para biriminde gönderim toplamı; pozitif ondalık, iki ondalık basamak. integer |
order.testOrder | Siparişin bir test siparişi olup olmadığını belirtir. boolean |
order.trackingNumber | Gönderim için oluşturulan takip numarası, varsa. string |
order.zip | Siparişin varış / gönderim adresi - değerler Zonos Checkout içine girilmiş veya Zonos Checkout'a yönlendirme yoluyla siparişe geçirilmiştir. string |
Ek veri türleri:
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
Sipariş detayları
Sipariş detayları uç noktasının nasıl çalıştığını öğrenin.orderDetail
uç noktası, Zonos Checkout aracılığıyla tamamlanan bir siparişin detaylarını ve durumunu güvenli bir şekilde almak için kullanılır.