Checkout API için HTTPS isteği nedir?

Checkout API için HTTPS isteği, HTTP yöntemini (POST), endpoint'i ('https://api.iglobalstores.com/v2/orderDetail'), protokolü (HTTPS), ileti formatını (JSON) ve HTTP başlıklarını (Accept: application/json, Content-Type: application/json) içerir.

İstek gövdesindeki JSON anahtar/değer çiftleri nelerdir?

İstek gövdesindeki JSON anahtar/değer çiftleri 'orderId', 'referenceId', 'secret' ve 'storeId' öğelerini içerir. 'orderId' ve 'referenceId' isteğe bağlıdır, ancak biri geçilmelidir. 'secret' ve 'storeId' gereklidir.

Olası hata HTTP yanıtları nelerdir?

Olası hata HTTP yanıtları 415 (Desteklenmeyen ortam türü), 406 (Kabul Edilemez), 400 (Kötü İstek) ve 500 (İç Sunucu Hatası) öğelerini içerir. Her hata kodu, belirli bir hata türüne karşılık gelir.

Yanıt JSON tanımları nelerdir?

Yanıt JSON tanımları, sipariş ayrıntılarıyla ilgili çeşitli parametreler içerir; örneğin 'error', 'order', 'order.billingZip', 'orderboxCount', 'order.carrierAccountNumber' ve diğerleri. Her parametre sipariş hakkında belirli bilgiler sağlar.

Checkout•

Ana sayfaAPI referansı Checkout REST API Sipariş Ayrıntıları

Sipariş Ayrıntıları

Q: Checkout API endpoint'i nedir?

Checkout API endpoint'i 'orderDetail' olarak adlandırılır. Bu API endpoint'i, Zonos Checkout üzerinden tamamlanan bir siparişin ayrıntılarını ve durumunu güvenli bir şekilde almak için kullanılır.

Sipariş Ayrıntıları endpoint'inin nasıl çalıştığını öğrenin.

orderDetail endpoint'i, Zonos Checkout üzerinden tamamlanan bir siparişin ayrıntılarını ve durumunu güvenli bir şekilde almak için kullanılır.

Endpoint

Not: Yanıt anahtarları değiştirilebilir ve/veya ek anahtarlar eklenebilir. Endpoint'i kullanacaksanız, kodunuzu bu olasılıklara uyum sağlamak üzere ayarlayın.

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

HTTPS isteği

alan↕	notlar↕
HTTP metodu	POST
Endpoint	`https://api.iglobalstores.com/v2/orderDetail`
Protokol	HTTPS
İleti 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çilirse	Zonos sipariş Kimliği, mağaza Kimliğiniz ve tire ile birlikte veya bunlar olmadan geçilebilir (Ö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ş Tamamlama / Sipariş Teşekkür sayfasına yönlendirilecektir. URL, bu değeri içerecek bir "orderId" sorgu dizesi parametresi içerecektir.`integer / string`
`referenceId` İSTEĞE BAĞLI, `orderId` parametresi geçilirse	Bu parametre, `createTempCart` API Hizmet endpoint'ine geçilen benzersiz `referenceId` tarafından bir siparişin verilerini aramak için kullanılır. `orderId` parametresine dayalı olarak sipariş ayrıntılarını aramayı amaçladığınızda, bu parametre kapatılmalı veya null olmalıdır.`string`
`secret` GEREKLİ	Zonos tarafından sağlanan API gizli GUID`string`
`storeId` GEREKLİ	Zonos tarafından sağlanan Mağaza Kimliği.`integer`

Hata HTTP yanıtları

Hata kodu↕	ileti↕	anlam↕
415	Unsupported media type	HTML Varlığı. HTTP "Content-Type" başlığı geçersizdir.
406	Not Acceptable	HTML Varlığı. HTTP "Accept" başlığı geçersizdir.
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"

Yanıt JSON tanımları

alan↕	notlar↕
`error`	Bu parametre yalnızca bir hata oluştuğunda mevcuttur ve bir hata açıklaması içerecektir.`string`
`order`	Bu sipariş ayrıntılarının bir haritasıdır.`JSON string`
`order.billingZip`	Sipariş için fatura adresi - değerler Zonos Checkout'a girilmiştir.`string`
`orderboxCount`	Bu alan, createTempCart isteğine geçirilen siparişi göndermek için kullanılacak kutuları açıklar.`string`
`order.carrierAccountNumber`	Ziyaretçinin kendi kargo taşıyıcı hesap numarası; ziyaretçi taşıyıcı hesapları etkinleştirildiğinde kullanılır`string`
`order.carrierAccountShippingMethod`	Ziyaretçinin kendi kargo taşıyıcı hesabında seçilen kargo yöntemi; ziyaretçi taşıyıcı hesapları etkinleştirildiğinde kullanılır`string`
`order.cslListMatch`	Konsolide Tarama Listesi (CSL) eşleşmesi. Müşteri bilgilerinin ABD Konsolide Tarama Listesinde eşleşme oluşturmuş olup olmadığını ve yasaklanmış taraf bağlantısı açısından incelenmesi gerekip gerekmediğini gösteren bir booleandır.`boolean`
`order.customerSelectedShippingName`	Zonos Checkout'un içindeki kargo seçeneği görüntü adı`string`
`order.dutyTaxesBreakdown`	Gümrük/vergi dökümünün haritası Not - Uygulanabilirse, IPF (Uluslararası İşleme Ücreti) dahil değildir.`JSON string`
`order.dutyTaxesBreakdown.brokerageFee`	USD cinsinden aracılık ücreti miktarı; pozitif kayan nokta, iki ondalık basamak`integer`
`order.dutyTaxesBreakdown.dispursementFee`	USD cinsinden ödeme ücreti miktarı; pozitif kayan nokta, iki ondalık basamak`integer`
`order.dutyTaxesBreakdown.duty`	USD cinsinden gümrük miktarı; pozitif kayan nokta, iki ondalık basamak`integer`
`order.dutyTaxesBreakdown.prepaymentFee`	Ön ödeme ücreti miktarı USD cinsinden; pozitif kayan nokta, iki ondalık basamak`integer`
`order.dutyTaxesBreakdown.vatOnDispursementFee`	Ödeme ücreti üzerindeki KDV/vergi miktarı USD cinsinden; pozitif kayan nokta, iki ondalık basamak`integer`
`order.dutyTaxesBreakdown.vatTax`	USD cinsinden KDV/vergi miktarı, ödeme ücreti üzerindeki KDV/vergiyi içermez; pozitif kayan nokta, iki ondalık basamak`integer`
`order.dutyTaxesTotal`	USD cinsinden gümrük ve vergi toplamı; pozitif kayan nokta, iki ondalık basamak`integer`
`order.foreignCurrencyCode`	Sipariş ödemesinin ödendiği para birimi kodu.`string`
`remittance_amount`	Belirli bir ülkeye, örneğin UK KDV ödenmesi gereken para miktarı.`decimal`
`order.grandTotal`	USD cinsinden genel toplam; pozitif kayan nokta, iki ondalık basamak`integer`
`order.grandTotalForeign`	Kapatılan para biriminde genel toplam; pozitif kayan nokta, iki ondalık basamak`integer`
`order.items`	Öğe haritalarının listesi Öğe haritası, Zonos Checkout'a geçici sepet oluşturma sırasında geçirilen öğe hakkındaki detayları içerir Öğe özellikleri hakkında daha fazla bilgi için, createTempCart API dokümanını inceleyiniz`JSON string`
`order.itemsCount`	Sipariş satır öğelerinin sayısı`integer`
`order.itemsTotal`	USD cinsinden öğeler / ürün toplamı; pozitif kayan nokta, iki ondalık basamak`integer`
`order.itemsTotalForeign`	Kapatılan para biriminde öğeler / ürün toplamı; pozitif kayan nokta, iki ondalık basamak`integer`
`order.items[index].height`	Pozitif kayan nokta, iki ondalık basamak`integer`
`order.items[index].itemNonShippable`	`boolean`
`order.items[index].length`	Pozitif kayan nokta, iki ondalık basamak`integer`
`order.items[index].quantity`	`integer`
`order.items[index].weight`	Pozitif kayan nokta, iki ondalık basamak`integer`
`order.items[index].width`	Pozitif kayan nokta, iki ondalık basamak`integer`
`order.items[index].unitPrice`	Pozitif kayan nokta, iki ondalık basamak`integer`
`order.merchantOrderId`	updateMerchantOrderId API hizmet endpoint'i üzerinden sipariş ile ilişkili `MerchantOrderId`.`string`
`order.misc1`	createTempCart API hizmet endpoint'i üzerinden sipariş ile ilişkili ek değer.`string`
`order.misc2`	createTempCart API hizmet endpoint'i üzerinden sipariş ile ilişkili ek değer.`string`
`order.misc3`	createTempCart API hizmet endpoint'i üzerinden sipariş ile ilişkili ek değer.`string`
`order.misc4`	createTempCart API hizmet endpoint'i üzerinden sipariş ile ilişkili ek değer.`string`
`order.misc5`	createTempCart API hizmet endpoint'i üzerinden sipariş ile ilişkili ek değer.`string`
`order.misc6`	createTempCart API hizmet endpoint'i üzerinden sipariş ile ilişkili ek değer.`string`
`order.nationalIdentifier`	Gerektiğinde uluslararası fatura adresi bilgisi. Değerler Zonos Checkout'a girilmiştir.`string`
`order.notes`	Not haritalarının listesi; not haritası, sipariş notu hakkındaki detayları içerir.`JSON string`
`order.notes[index].createdByUser`	`string`
`order.notes[index].customerNote`	Bu müşteri tarafından sipariş, kargo vb. hakkında oluşturulan bir not olup olmadığını gösteren bir booleandır.`boolean`
`order.notes[index].dateCreated`	`millis`
`order.notes[index].dateCreatedString`	`string`
`order.notes[index].flagged`	Bu notun önemli olarak işaretlenip işaretlenmediğini gösteren bir `boolean`
`order.notes[index].note`	Not içeriği`string`
`order.optInEmail`	Müşterinin Zonos Checkout'u içinde "bültene kaydol" onay kutusunu seçip seçmediğini gösterir. Yalnızca bu onay kutusunu ödeme sayfasında görüntülemeyi seçtiyseniz geçerlidir`boolean`
`order.orderId`	Sipariş kimliği Zonos sisteminde`string`
`order.orderDate`	Sipariş oluşturma zaman damgası milisaniye cinsinden UTC/GMT.`millis`
`order.orderDateString`	Sipariş oluşturma zaman damgası dizesi UTC/GMT cinsinden.`string`
`order.orderStatus`	Zonos sistemindeki siparişin durum/hali. `orderStatus` kullanımı hakkında daha fazla bilgi için lütfen Burada bir siparişi alın belgesinigözden geçiriniz. Sipariş durumları hakkında ek bilgiler Burada bir siparişi güncelleyin belgesindebulunabilir.`string`
`order.orderStatusDate`	Zonos sisteminde en son `orderStatus` değişikliğinin UTC/GMT cinsinden zaman damgası milisaniye.`millis`
`order.orderStatusDateString`	Zonos sisteminde en son `orderStatus` değişikliğinin UTC/GMT cinsinden zaman damgası dizesi.`string`
`order.paymentProcessing`	`paymentProcessing` ayrıntılarının haritası. Bazı parametreler hesabınıza uygulanmayabilir ve yanıttan hariç tutulacaktır.`JSON string`
`order.paymentProcessing.captureDate`	Ödeme yakalama tarihi, varsa milisaniye cinsinden. Zonos ödemeyi işliyorsa, bu düğüm yanıttan hariç tutulur.`millis`
`order.paymentProcessing.captureDateString`	Ödeme yakalama tarihi, varsa dize olarak. Zonos ödemeyi işliyorsa, bu düğüm yanıttan hariç tutulur.`string`
`order.paymentProcessing.cardType`	Kredi kartı markası Zonos ödemeyi işliyorsa, bu düğüm yanıttan hariç tutulur.`string`
`order.paymentProcessing.lastFour`	Fatura kredi kartı numarasının son dört rakamı. Zonos ödemeyi işliyorsa, bu düğüm yanıttan hariç tutulur.`string`
`order.paymentProcessing.paymentGateway`	Ödeme geçidi adı Zonos ödemeyi işliyorsa, "iGlobal_CC" veya "iGlobal_PayPal" gösterecektir.`string`
`order.paymentProcessing.transactionType`	İşlem türünü gösterir "AUTH_CAPTURE" veya "AUTH_ONLY". Zonos ödemeyi işliyorsa, bu düğüm yanıttan hariç tutulur.`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'ta USD cinsinden belirtilen gümrük ve vergi; pozitif kayan nokta, iki ondalık basamak`integer`
`order.quotedDutyTaxesForeign`	Zonos Checkout'ta belirtilen gümrük ve vergi. Kapatılan para biriminde görüntülenir; pozitif kayan nokta, iki ondalık basamak`integer`
`order.referenceId`	createTempCart API hizmet endpoint'i aracılığıyla sipariş ile ilişkili benzersiz `referenceId`.`string`
`order.shipComplete`	Siparişin birden çok parçada gönderilip gönderilmemesi gerektiğini gösterir`boolean`
`order.shippingCarrierServiceLevel`	Seçilen kargo seçeneği için taşıyıcı ve hizmet seviyesi tanımlayıcı`string`
`order.shippingInstructions`	Kargo hizmet seviyesi için özelleştirilebilir talimatlar`string`
`order.shippingTotal`	USD cinsinden kargo toplamı; pozitif kayan nokta, iki ondalık basamak `integer`
`order.shippingTotalForeign`	Kapatılan para biriminde kargo toplamı; pozitif kayan nokta, iki ondalık basamak`integer`
`order.testOrder`	Siparişin bir test siparişi olup olmadığını gösterir.`boolean`
`order.trackingNumber`	Gönderim için oluşturulan izleme numarası (varsa).`string`
`order.zip`	Sipariş için hedef / kargo adresi - değerler Zonos Checkout'a girilmiş veya Zonos Checkout yönlendirmesi aracılığıyla siparişe geçmiş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

Demo rezervasyonu yap