Szczegóły zamówienia

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

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

Punkt końcowy

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

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

Żądanie HTTPS

pole	uwagi
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 HTTP	Content-Type: application/json

Klucze/wartości JSON w ciele żądania

pole	uwagi
`orderId` OPCJONALNE, jeśli przekazujesz parametr `referenceId`	Id zamówienia Zonos można przekazać z lub bez identyfikatora sklepu i myślnika (Przykład: 123-45678 lub 45678). Uwaga: Po zakończeniu zamówienia i płatności klient zostanie przekierowany na stronę zakończenia zamówienia / podziękowania za zamówienie hostowaną na Twojej domenie. URL będzie zawierać parametr zapytania „orderId”, który będzie zawierał tę wartość.`integer / string`
`referenceId` OPCJONALNE, jeśli przekazujesz parametr “orderId”	Ten parametr służy do wyszukiwania danych zamówienia na podstawie unikalnego `referenceId` przekazanego w punkcie końcowym usługi API `createTempCart`. Ten parametr powinien być pominięty lub ustawiony na null, gdy zamierzasz wyszukiwać szczegóły zamówienia na podstawie parametru `orderId` .`string`
`secret` WYMAGANE	Tajny klucz API GUID dostarczony przez Zonos`string`
`storeId` WYMAGANE	Identyfikator sklepu dostarczony przez Zonos.`integer`

Odpowiedzi błędów HTTP

Kod błędu	wiadomość	znaczenie
415	Nieobsługiwany typ mediów	HTML Entity. Nagłówek HTTP “Content-Type” jest nieprawidłowy.
406	Nieakceptowalne	HTML Entity. Nagłówek HTTP “Accept” jest nieprawidłowy.
400	Złe żądanie	“error”:”orderId: 999-99999 nie jest prawidłowym orderId”“error”:”Nie znaleziono zamówienia z orderId: 999-99999”“error”:”Nieprawidłowe dane uwierzytelniające”“error”:”Nieprawidłowe ciało postu”“error”:”Parametr orderId lub referenceId jest wymagany”“error”:”Nie można określić obu parametrów orderId i referenceId”“error”:”Nie znaleziono zamówienia z orderId: 999-99999”“error”:”Wymagany parametr sklepu”“error”:”Nie znaleziono zamówienia z referenceId: 999999 dla storeId: 999”“error”:”referenceId: 999999 dla storeId: 999 zostało zdublowane”“error”:”Nie można pobrać zamówienia z referenceId: 999999”
500	Wewnętrzny błąd serwera	“error”:”Nie można przetworzyć szczegółów zamówienia”

Definicje odpowiedzi JSON

pole	uwagi
`error`	Ten parametr jest obecny tylko wtedy, gdy wystąpił błąd i będzie zawierał opis błędu.`string`
`order`	To mapa szczegółów zamówienia.`JSON string`
`order.billingZip`	Adres rozliczeniowy dla zamówienia - wartości zostały wprowadzone do Zonos Checkout.`string`
`orderboxCount`	To pole opisuje pudełka, które będą używane do wysyłki zamówienia, przekazane do createTempCart request.`string`
`order.carrierAccountNumber`	Numer konta przewoźnika dla odwiedzającego; używane, gdy konta przewoźników odwiedzających są włączone`string`
`order.carrierAccountShippingMethod`	Wybrana metoda wysyłki na koncie przewoźnika odwiedzającego; używane, gdy konta przewoźników odwiedzających są włączone`string`
`order.cslListMatch`	Dopasowanie do Zsynchronizowanej Listy Kontroli (CSL). Wartość logiczna, która wskazuje, kiedy informacje o kliencie dały dopasowanie w Zsynchronizowanej Liście Kontroli USA i powinny być sprawdzone pod kątem możliwego powiązania z osobą objętą zakazem.`boolean`
`order.customerSelectedShippingName`	Nazwa wyświetlana opcji wysyłki wewnątrz Zonos Checkout`string`
`order.dutyTaxesBreakdown`	Mapa szczegółów dotyczących opłat celnych/podatków. Uwaga - Jeśli dotyczy, IPF (Opłata za przetwarzanie międzynarodowe) nie jest wliczona.`JSON string`
`order.dutyTaxesBreakdown.brokerageFee`	Kwota opłaty brokerskiej w USD; dodatnia liczba zmiennoprzecinkowa, dwie miejsca po przecinku`integer`
`order.dutyTaxesBreakdown.dispursementFee`	Kwota opłaty za wypłatę w USD; dodatnia liczba zmiennoprzecinkowa, dwie miejsca po przecinku`integer`
`order.dutyTaxesBreakdown.duty`	Kwota cła w USD; dodatnia liczba zmiennoprzecinkowa, dwie miejsca po przecinku`integer`
`order.dutyTaxesBreakdown.prepaymentFee`	Kwota opłaty za przedpłatę w USD; dodatnia liczba zmiennoprzecinkowa, dwie miejsca po przecinku`integer`
`order.dutyTaxesBreakdown.vatOnDispursementFee`	Kwota VAT/podatku od opłaty za wypłatę w USD; dodatnia liczba zmiennoprzecinkowa, dwie miejsca po przecinku`integer`
`order.dutyTaxesBreakdown.vatTax`	Kwota VAT/podatku w USD, nie obejmuje VAT/podatku od opłaty za wypłatę; dodatnia liczba zmiennoprzecinkowa, dwie miejsca po przecinku`integer`
`order.dutyTaxesTotal`	Całkowita kwota cła i podatków w USD; dodatnia liczba zmiennoprzecinkowa, dwie miejsca po przecinku`integer`
`order.foreignCurrencyCode`	Kod waluty, w której dokonano płatności za zamówienie.`string`
`remittance_amount`	Kwota pieniędzy, która musi być przekazana do konkretnego kraju (np. VAT w Wielkiej Brytanii).`decimal`
`order.grandTotal`	Całkowita kwota w USD; dodatnia liczba zmiennoprzecinkowa, dwie miejsca po przecinku`integer`
`order.grandTotalForeign`	Całkowita kwota w walucie rozliczeniowej; dodatnia liczba zmiennoprzecinkowa, dwie miejsca po przecinku`integer`
`order.items`	Lista map przedmiotów. Mapa przedmiotu zawiera szczegóły dotyczące przedmiotu, które zostały przekazane do Zonos Checkout podczas tworzenia tymczasowego koszyka. Aby uzyskać więcej informacji na temat właściwości przedmiotów, zapoznaj się z dokumentacją API createTempCart `JSON string`
`order.itemsCount`	Liczba pozycji zamówienia`integer`
`order.itemsTotal`	Całkowita kwota przedmiotów / produktów w USD; dodatnia liczba zmiennoprzecinkowa, dwie miejsca po przecinku`integer`
`order.itemsTotalForeign`	Całkowita kwota przedmiotów / produktów w walucie rozliczeniowej; dodatnia liczba zmiennoprzecinkowa, dwie miejsca po przecinku`integer`
`order.items[index].height`	Dodatnia liczba zmiennoprzecinkowa, dwie miejsca po przecinku`integer`
`order.items[index].itemNonShippable`	`boolean`
`order.items[index].length`	Dodatnia liczba zmiennoprzecinkowa, dwie miejsca po przecinku`integer`
`order.items[index].quantity`	`integer`
`order.items[index].weight`	Pozytywna liczba zmiennoprzecinkowa, dwa miejsca po przecinku`integer`
`order.items[index].width`	Pozytywna liczba zmiennoprzecinkowa, dwa miejsca po przecinku`integer`
`order.items[index].unitPrice`	Pozytywna liczba zmiennoprzecinkowa, dwa miejsca po przecinku`integer`
`order.merchantOrderId`	`MerchantOrderId` powiązany z zamówieniem przez updateMerchantOrderId API service endpoint.`string`
`order.misc1`	Dodatkowa wartość powiązana z zamówieniem przez createTempCart API service endpoint.`string`
`order.misc2`	Dodatkowa wartość powiązana z zamówieniem przez createTempCart API service endpoint.`string`
`order.misc3`	Dodatkowa wartość powiązana z zamówieniem przez createTempCart API service endpoint.`string`
`order.misc4`	Dodatkowa wartość powiązana z zamówieniem przez createTempCart API service endpoint.`string`
`order.misc5`	Dodatkowa wartość powiązana z zamówieniem przez createTempCart API service endpoint.`string`
`order.misc6`	Dodatkowa wartość powiązana z zamówieniem przez createTempCart API service endpoint.`string`
`order.nationalIdentifier`	Dodatkowe informacje o międzynarodowym adresie rozliczeniowym dla zamówienia, gdy jest to wymagane. Wartości zostały wprowadzone do Zonos Checkout.`string`
`order.notes`	Lista map notatek; mapa notatek zawiera szczegóły dotyczące notatki zamówienia.`JSON string`
`order.notes[index].createdByUser`	`string`
`order.notes[index].customerNote`	Wartość logiczna wskazująca, czy była to notatka stworzona 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, jeśli wybrałeś wyświetlenie tego pola 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 jako ciąg w UTC/GMT.`string`
`order.orderStatus`	Status/stanu zamówienia w systemie Zonos. Aby uzyskać więcej informacji na temat użycia `orderStatus`, zapoznaj się z Pobierz dokument zamówienia tutaj. Dodatkowe informacje na temat statusów zamówień można znaleźć w Zaktualizuj dokument zamówienia tutaj.`string`
`order.orderStatusDate`	Znacznik czasu w milisekundach w UTC/GMT ostatniej zmiany `orderStatus` w systemie Zonos.`millis`
`order.orderStatusDateString`	Ciąg znaczników czasu w UTC/GMT ostatniej zmiany `orderStatus` w systemie Zonos.`string`
`order.paymentProcessing`	Mapa szczegółów `paymentProcessing`. Niektóre parametry mogą nie być stosowane do Twojego konta i zostaną wykluczone z odpowiedzi.`JSON string`
`order.paymentProcessing.captureDate`	Data przechwycenia płatności w milisekundach, jeśli jest dostępna. Jeśli Zonos przetwarza płatność, ten węzeł jest wykluczony z odpowiedzi.`millis`
`order.paymentProcessing.captureDateString`	Data przechwycenia płatności jako ciąg, jeśli jest dostępna. Jeśli Zonos przetwarza płatność, ten węzeł jest wykluczony z odpowiedzi.`string`
`order.paymentProcessing.cardType`	Marka karty kredytowej. Jeśli Zonos przetwarza płatność, ten węzeł jest wykluczony z odpowiedzi.`string`
`order.paymentProcessing.lastFour`	Ostatnie cztery cyfry numeru karty kredytowej do fakturowania. Jeśli Zonos przetwarza płatność, ten węzeł jest wykluczony z odpowiedzi.`string`
`order.paymentProcessing.paymentGateway`	Nazwa bramki płatniczej. Jeśli Zonos przetwarza płatność, wskaże “iGlobal_CC” lub “iGlobal_PayPal”.`string`
`order.paymentProcessing.transactionType`	Wskazuje typ transakcji “AUTH_CAPTURE” lub “AUTH_ONLY”. Jeśli Zonos przetwarza płatność, ten węzeł jest wykluczony z odpowiedzi.`string`
`order.poNumber`	Numer zamówienia zakupu dla zamówienia określonego w Zonos Checkout; używane, gdy zamówienia zakupu są włączone.`string`
`order.quotedDutyTaxes`	Cło i podatek podane w Zonos Checkout, wyświetlane w USD; dodatnia liczba zmiennoprzecinkowa, dwie cyfry po przecinku.`integer`
`order.quotedDutyTaxesForeign`	Cło i podatek podane w Zonos Checkout. Wyświetlane w walucie rozliczeniowej; dodatnia liczba zmiennoprzecinkowa, dwie cyfry po przecinku.`integer`
`order.referenceId`	Unikalny `referenceId` powiązany z zamówieniem przez punkt końcowy usługi API createTempCart.`string`
`order.shipComplete`	Wskazuje, czy zamówienie powinno być wysyłane w wielu częściach.`boolean`
`order.shippingCarrierServiceLevel`	Identyfikator przewoźnika i poziomu usługi dla wybranej opcji wysyłki.`string`
`order.shippingInstructions`	Dostosowywalne instrukcje dla poziomu usługi wysyłkowej.`string`
`order.shippingTotal`	Całkowity koszt wysyłki w USD; dodatnia liczba zmiennoprzecinkowa, dwie cyfry po przecinku.`integer`
`order.shippingTotalForeign`	Całkowity koszt wysyłki w walucie rozliczeniowej; dodatnia liczba zmiennoprzecinkowa, dwie cyfry po przecinku.`integer`
`order.testOrder`	Wskazuje, czy zamówienie jest zamówieniem testowym.`boolean`
`order.trackingNumber`	Numer śledzenia wygenerowany dla przesyłki, jeśli dotyczy.`string`
`order.zip`	Adres docelowy / wysyłkowy dla zamówienia - wartości zostały wprowadzone do Zonos Checkout lub zostały przekazane do zamówienia przez 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

Czy ta strona była pomocna?

Pytania?

Skontaktuj się z nami.

Zobacz Zonos

polityki i umowy