Jaki jest punkt końcowy interfejsu API Checkout?

Punkt końcowy interfejsu API Checkout to 'orderDetail'. Ten punkt końcowy interfejsu API służy do bezpiecznego pobierania szczegółów zamówienia i stanu zamówienia ukończonego za pośrednictwem Zonos Checkout.

Jakie jest żądanie HTTPS dla interfejsu API Checkout?

Żądanie HTTPS dla interfejsu API Checkout obejmuje metodę HTTP (POST), punkt końcowy ('https://api.iglobalstores.com/v2/orderDetail'), protokół (HTTPS), format wiadomości (JSON) i nagłówki HTTP (Accept: application/json, Content-Type: application/json).

Jakie są pary klucz/wartość JSON w treści żądania?

Pary klucz/wartość JSON w treści żądania obejmują 'orderId', 'referenceId', 'secret' i 'storeId'. 'orderId' i 'referenceId' są opcjonalne, ale jeden z nich musi być przekazany. 'secret' i 'storeId' są wymagane.

Jakie są możliwe odpowiedzi błędu HTTP?

Możliwe odpowiedzi błędu HTTP obejmują 415 (Nieobsługiwany typ mediów), 406 (Nie do zaakceptowania), 400 (Złe żądanie) i 500 (Wewnętrzny błąd serwera). Każdy kod błędu odpowiada określonemu typowi błędu.

Jakie są definicje JSON odpowiedzi?

Definicje JSON odpowiedzi obejmują różne parametry związane ze szczegółami zamówienia, takie jak 'error', 'order', 'order.billingZip', 'orderboxCount', 'order.carrierAccountNumber' i wiele innych. Każdy parametr zawiera określone informacje o zamówieniu.

Checkout•

Strona głównaDokumentacja API REST API Checkout Szczegóły zamówienia

Szczegóły zamówienia

Dowiedz się, jak działa punkt końcowy Szczegóły zamówienia.

Punkt końcowy orderDetail służy do bezpiecznego pobierania szczegółów zamówienia i stanu zamówienia ukończonego za pośrednictwem Zonos Checkout.

Punkt końcowy

Uwaga: Klucze odpowiedzi mogą być modyfikowane i/lub mogą być dodawane dodatkowe klucze. Jeśli będziesz korzystać z punktu końcowego, skonfiguruj swój kod tak, aby uwzględniał te możliwości.

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

Żądanie HTTPS

pole↕	notatki↕
Metoda HTTP	POST
Punkt końcowy	`https://api.iglobalstores.com/v2/orderDetail`
Protokół	HTTPS
Format wiadomości	JSON
Nagłówek Accept HTTP	Accept: application/json
Nagłówek Content-Type	Content-Type: application/json

Pary klucz/wartość JSON w treści żądania

pole↕	notatki↕
`orderId` OPCJONALNIE, jeśli przechodzisz `referenceId`	Identyfikator zamówienia Zonos można przesłać z lub bez identyfikatora sklepu i łącznika (Przykład: 123-45678 lub 45678). Uwaga: Po ukończeniu zamówienia i dokonaniu płatności klient zostanie przekierowany na stronę Potwierdzenia zamówienia / Strona podziękowań za zamówienie hostowaną w Twojej domenie. Adres URL będzie zawierać parametr ciągu zapytania “orderId”, który będzie zawierać tę wartość.`integer / string`
`referenceId` OPCJONALNIE, jeśli przechodzisz “orderId”	Ten parametr służy do wyszukiwania danych zamówienia za pomocą unikatowego `referenceId` przekazanego w punkcie końcowym usługi API `createTempCart`. Ten parametr powinien być pominięty lub pusty, gdy zamierzasz wyszukiwać szczegóły zamówienia na podstawie parametru `orderId`.`string`
`secret` WYMAGANE	Tajny identyfikator GUID API udostępniony przez Zonos`string`
`storeId` WYMAGANE	Identyfikator sklepu udostępniony przez Zonos.`integer`

Odpowiedzi błędu HTTP

Kod błędu↕	komunikat↕	znaczenie↕
415	Nieobsługiwany typ mediów	Encja HTML. Nagłówek HTTP “Content-Type” jest nieprawidłowy.
406	Nie do zaakceptowania	Encja HTML. Nagłówek HTTP “Accept” jest nieprawidłowy.
400	Nieprawidłowe żądanie	“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	Wewnętrzny błąd serwera	“error”:”Couldn’t process order details”

Definicje JSON odpowiedzi

pole↕	notatki↕
`error`	Ten parametr jest obecny tylko wtedy, gdy wystąpił błąd, i będzie zawierał opis błędu.`string`
`order`	To jest mapa szczegółów zamówienia.`JSON string`
`order.billingZip`	Adres rozliczeniowy zamówienia — wartości zostały wprowadzone w Zonos Checkout.`string`
`orderboxCount`	To pole opisuje pudełka, które zostaną użyte do wysyłki zamówienia, przekazane w żądaniu createTempCart .`string`
`order.carrierAccountNumber`	Własny numer konta przewoźnika wysyłkowego odwiedzającego; używany, gdy włączone są konta przewoźników odwiedzających`string`
`order.carrierAccountShippingMethod`	Wybrana metoda wysyłki na własnym koncie przewoźnika odwiedzającego; używana, gdy włączone są konta przewoźników odwiedzających`string`
`order.cslListMatch`	Zgodność z Consolidated Screening List (CSL). Wartość logiczna wskazująca, że dane klienta wygenerowały zgodność na amerykańskiej liście Consolidated Screening List i powinny zostać sprawdzone pod kątem możliwego powiązania z podmiotem objętym zakazem.`boolean`
`order.customerSelectedShippingName`	Wyświetlana nazwa opcji wysyłki w Zonos Checkout`string`
`order.dutyTaxesBreakdown`	Mapa podziału cła i podatków. Uwaga — jeśli dotyczy, IPF (International Processing Fee) nie jest uwzględniony.`JSON string`
`order.dutyTaxesBreakdown.brokerageFee`	Kwota opłaty brokerskiej w USD; liczba dodatnia zmiennoprzecinkowa, dwa miejsca po przecinku`integer`
`order.dutyTaxesBreakdown.dispursementFee`	Kwota opłaty za wypłatę środków w USD; liczba dodatnia zmiennoprzecinkowa, dwa miejsca po przecinku`integer`
`order.dutyTaxesBreakdown.duty`	Kwota cła w USD; liczba dodatnia zmiennoprzecinkowa, dwa miejsca po przecinku`integer`
`order.dutyTaxesBreakdown.prepaymentFee`	Kwota opłaty przedpłaty w USD; liczba dodatnia zmiennoprzecinkowa, dwa miejsca po przecinku`integer`
`order.dutyTaxesBreakdown.vatOnDispursementFee`	Kwota VAT/podatku od opłaty za wypłatę środków w USD; liczba dodatnia zmiennoprzecinkowa, dwa miejsca po przecinku`integer`
`order.dutyTaxesBreakdown.vatTax`	Kwota VAT/podatku w USD, nie obejmuje VAT/podatku od opłaty za wypłatę środków; liczba dodatnia zmiennoprzecinkowa, dwa miejsca po przecinku`integer`
`order.dutyTaxesTotal`	Suma cła i podatku w USD; liczba dodatnia zmiennoprzecinkowa, dwa miejsca po przecinku`integer`
`order.foreignCurrencyCode`	Kod waluty, w której rozliczono płatność za zamówienie.`string`
`remittance_amount`	Kwota pieniędzy, którą należy przekazać do określonego kraju, np. VAT w Wielkiej Brytanii.`decimal`
`order.grandTotal`	Suma całkowita w USD; liczba dodatnia zmiennoprzecinkowa, dwa miejsca po przecinku`integer`
`order.grandTotalForeign`	Suma całkowita w walucie rozliczeniowej; liczba dodatnia zmiennoprzecinkowa, dwa miejsca po przecinku`integer`
`order.items`	Lista map pozycji. Mapa pozycji zawiera szczegóły dotyczące pozycji, które zostały przekazane do Zonos Checkout podczas tworzenia tymczasowego koszyka. Więcej informacji o właściwościach pozycji znajdziesz w dokumentacji createTempCart .`JSON string`
`order.itemsCount`	Liczba pozycji zamówienia`integer`
`order.itemsTotal`	Suma pozycji/produktów w USD; liczba dodatnia zmiennoprzecinkowa, dwa miejsca po przecinku`integer`
`order.itemsTotalForeign`	Suma pozycji/produktów w walucie rozliczeniowej; liczba dodatnia zmiennoprzecinkowa, dwa miejsca po przecinku`integer`
`order.items[index].height`	Liczba dodatnia zmiennoprzecinkowa, dwa miejsca po przecinku`integer`
`order.items[index].itemNonShippable`	`boolean`
`order.items[index].length`	Liczba dodatnia zmiennoprzecinkowa, dwa miejsca po przecinku`integer`
`order.items[index].quantity`	`integer`
`order.items[index].weight`	Liczba dodatnia zmiennoprzecinkowa, dwa miejsca po przecinku`integer`
`order.items[index].width`	Liczba dodatnia zmiennoprzecinkowa, dwa miejsca po przecinku`integer`
`order.items[index].unitPrice`	Liczba dodatnia zmiennoprzecinkowa, dwa miejsca po przecinku`integer`
`order.merchantOrderId`	`MerchantOrderId` powiązany z zamówieniem za pośrednictwem punktu końcowego usługi API updateMerchantOrderId .`string`
`order.misc1`	Dodatkowa wartość powiązana z zamówieniem za pośrednictwem punktu końcowego usługi API createTempCart .`string`
`order.misc2`	Dodatkowa wartość powiązana z zamówieniem za pośrednictwem punktu końcowego usługi API createTempCart .`string`
`order.misc3`	Dodatkowa wartość powiązana z zamówieniem za pośrednictwem punktu końcowego usługi API createTempCart .`string`
`order.misc4`	Dodatkowa wartość powiązana z zamówieniem za pośrednictwem punktu końcowego usługi API createTempCart .`string`
`order.misc5`	Dodatkowa wartość powiązana z zamówieniem za pośrednictwem punktu końcowego usługi API createTempCart .`string`
`order.misc6`	Dodatkowa wartość powiązana z zamówieniem za pośrednictwem punktu końcowego usługi API createTempCart .`string`
`order.nationalIdentifier`	Dodatkowe informacje o międzynarodowym adresie rozliczeniowym zamówienia, jeśli są wymagane. Wartości zostały wprowadzone w Zonos Checkout.`string`
`order.notes`	Lista map notatek; mapa notatki zawiera szczegóły dotyczące notatki zamówienia.`JSON string`
`order.notes[index].createdByUser`	`string`
`order.notes[index].customerNote`	Wartość logiczna wskazująca, czy jest to notatka utworzona przez klienta dotycząca zamówienia, wysyłki itp.`boolean`
`order.notes[index].dateCreated`	`millis`
`order.notes[index].dateCreatedString`	`string`
`order.notes[index].flagged`	Wartość `boolean` wskazująca, czy ta notatka została oznaczona jako ważna
`order.notes[index].note`	Treść notatki`string`
`order.optInEmail`	Wskazuje, że klient zaznaczył pole wyboru „zapisz się do naszego newslettera” w Zonos Checkout. Dotyczy tylko sytuacji, gdy zdecydowano się wyświetlać to pole wyboru na stronie checkout`boolean`
`order.orderId`	Numer identyfikacyjny zamówienia w systemie Zonos`string`
`order.orderDate`	Znacznik czasu utworzenia zamówienia w milisekundach w UTC/GMT.`millis`
`order.orderDateString`	Znacznik czasu utworzenia zamówienia w formacie ciągu znaków w UTC/GMT.`string`
`order.orderStatus`	Status/stan zamówienia w systemie Zonos. Więcej informacji o użyciu `orderStatus` znajdziesz w dokumencie Pobierz zamówienie tutaj. Dodatkowe informacje o statusach zamówienia znajdziesz w dokumencie Zaktualizuj zamówienie tutaj.`string`
`order.orderStatusDate`	Znacznik czasu w milisekundach w UTC/GMT ostatniej zmiany `orderStatus` w systemie Zonos.`millis`
`order.orderStatusDateString`	Znacznik czasu w formacie ciągu znaków w UTC/GMT ostatniej zmiany `orderStatus` w systemie Zonos.`string`
`order.paymentProcessing`	Mapa szczegółów `paymentProcessing`. Niektóre parametry mogą nie mieć zastosowania do Twojego konta i zostaną wykluczone z odpowiedzi.`JSON string`
`order.paymentProcessing.captureDate`	Data przechwycenia płatności w milisekundach, jeśli dostępna. Jeśli płatność przetwarza Zonos, ten węzeł jest wykluczony z odpowiedzi.`millis`
`order.paymentProcessing.captureDateString`	Data przechwycenia płatności w formacie ciągu znaków, jeśli dostępna. Jeśli płatność przetwarza Zonos, ten węzeł jest wykluczony z odpowiedzi.`string`
`order.paymentProcessing.cardType`	Marka karty kredytowej. Jeśli płatność przetwarza Zonos, ten węzeł jest wykluczony z odpowiedzi.`string`
`order.paymentProcessing.lastFour`	Ostatnie cztery cyfry numeru karty kredytowej rozliczeniowej. Jeśli płatność przetwarza Zonos, ten węzeł jest wykluczony z odpowiedzi.`string`
`order.paymentProcessing.paymentGateway`	Nazwa bramki płatności. Jeśli płatność przetwarza Zonos, wskaże „iGlobal_CC” lub „iGlobal_PayPal”.`string`
`order.paymentProcessing.transactionType`	Wskazuje typ transakcji: „AUTH_CAPTURE” lub „AUTH_ONLY”. Jeśli płatność przetwarza Zonos, ten węzeł jest wykluczony z odpowiedzi.`string`
`order.poNumber`	Numer zamówienia zakupu określony w Zonos Checkout; używany, gdy włączone są zamówienia zakupu`string`
`order.quotedDutyTaxes`	Cło i podatek wycenione w Zonos Checkout, wyświetlane w USD; liczba dodatnia zmiennoprzecinkowa, dwa miejsca po przecinku`integer`
`order.quotedDutyTaxesForeign`	Cło i podatek wycenione w Zonos Checkout. Wyświetlane w walucie rozliczeniowej; liczba dodatnia zmiennoprzecinkowa, dwa miejsca po przecinku`integer`
`order.referenceId`	Unikatowy `referenceId` powiązany z zamówieniem za pośrednictwem punktu końcowego usługi API createTempCart.`string`
`order.shipComplete`	Wskazuje, czy zamówienie powinno być wysłane w wielu częściach`boolean`
`order.shippingCarrierServiceLevel`	Identyfikator przewoźnika i poziomu usługi dla wybranej opcji wysyłki`string`
`order.shippingInstructions`	Konfigurowalne instrukcje dla poziomu usługi wysyłki`string`
`order.shippingTotal`	Suma kosztów wysyłki w USD; liczba dodatnia zmiennoprzecinkowa, dwa miejsca po przecinku `integer`
`order.shippingTotalForeign`	Suma kosztów wysyłki w walucie rozliczeniowej; liczba dodatnia zmiennoprzecinkowa, dwa miejsca po przecinku`integer`
`order.testOrder`	Wskazuje, czy zamówienie jest zamówieniem testowym.`boolean`
`order.trackingNumber`	Numer śledzenia wygenerowany dla przesyłki, jeśli ma zastosowanie.`string`
`order.zip`	Adres docelowy/wysyłki zamówienia — wartości zostały wprowadzone w Zonos Checkout lub przekazane do zamówienia poprzez przekierowanie do Zonos Checkout.`string`

Dodatkowe typy danych:

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

Zarezerwuj demonstrację