Endpoints
Żądanie szczegółów zakończonego zamówienia
POST | https://api.iglobalstores.com/2.0/order-completed - Utwórz nowe żądanie informacji związanych z zakończonym zamówieniem.
Żądanie HTTPS
| Pole | Uwagi |
|---|---|
| Metoda HTTP | POST |
| URL endpointu | https://api.iglobalstores.com/2.0/order-completed |
| Protokół | HTTPS |
| Format wiadomości | JSON |
| Nagłówek Accept HTTP | Accept: application/json |
| Nagłówek tokena bezpieczeństwa HTTP | serviceToken: your-test-token-valueDodaj nagłówek do swojego żądania HTTPS o nazwie serviceToken z wartością swojego testowego tokena API bezpieczeństwa. (Skontaktuj się ze swoim Menedżerem Konta w celu uzyskania tego tokena.) |
| Nagłówek Content-Type HTTP | Content-Type: application/jsonPonieważ będziesz przesyłać dane JSON do usługi, dodaj nagłówek do swojego żądania HTTPS o nazwie Content-Type z wartością application/json |
Klucze/wartości JSON w ciele żądania
Format wiadomości: JSON
Przykładowe żądanie
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
{
"billingAddress": {
"address1": "123 S West Elm St",
"address2": null,
"address3": null,
"city": "Calgary",
"countryCode": "CA",
"postalCode": "T2P 5G8",
"state": "Alberta",
"stateCode": null
},
"billingCompany": null,
"billingEmail": "jdoe@jdoe.com",
"billingName": "John E. Doe",
"billingPhone": "+1 555-555-5555",
"orderGrandTotal": 1225.89,
"orderNumber": "854725421",
"paymentTypeCode": "PAYPAL",
"prepaidDutyTax": true,
"shippingQuoteId": "bcdbdbcd-0145-4d3b-a54e-0de3cdce5a0a",
"shipToCompany": null,
"shipToEmail": "jdoe@jdoe.com",
"shipToName": "John Doe",
"shipToPhone": "+1 555-555-5555"
}
Definicje JSON żądania
| Pole | Uwagi |
|---|---|
billingAddress WYMAGANE | To jest adres rozliczeniowy zamówienia. Jest to mapa zawierająca następujące pola adresowe: address1, address2, address3, city, state, stateCode, postalCode oraz countryCode. Te zawarte pola są wymagane lub nie w zależności od kraju. Punkt końcowy lokalizacji zwraca, które konkretne pola adresowe są wymagane lub nie dla każdego kraju. Uwaga: stateCode jest zawsze nie wymagane i nie zadeklarowane w punkcie końcowym lokalizacji. Możesz przekazać stateCode, jeśli jest dostępne. |
billingCompany OPCJONALNE | To jest nazwa firmy rozliczeniowej zamówienia. |
billingEmail WYMAGANE | To jest adres e-mail rozliczeniowy zamówienia. |
billingName WYMAGANE | To jest pełna nazwa rozliczeniowa zamówienia. |
billingPhone WYMAGANE | To jest numer telefonu rozliczeniowego zamówienia. |
items[index].orderGrandTotal WYMAGANE | To jest całkowita kwota zapłacona przez kupującego za ich zamówienie w USD (dolarach amerykańskich). Proszę podać bez przecinków, bez znaku dolara “$” i z dwoma miejscami po przecinku. Przykładowa wartość: 2102.99 |
items[index].orderNumber WYMAGANE | To jest numer zamówienia dla nowo zrealizowanego zamówienia. Przykładowa wartość: 854725421 |
paymentTypeCode WYMAGANE | Metoda płatności użyta przez kupującego do zapłaty za ich zamówienie. Przykładowe wartości: PayPal lub Visa lub MC lub AMEX lub DISC |
prepaidDutyTax WYMAGANE | Czy kupujący zdecydował się na prepay swoje cła i podatki importowe, czy byli zmuszeni do prepay ich? Jeśli tak, ustaw na true; jeśli nie, ustaw na false. Przykładowe wartości: true lub false |
shippingQuoteId WYMAGANE | To jest ID wyceny wysyłki, którą kupujący wybrał. Szczegóły koszyka muszą być takie same, jak były, gdy wyceny wysyłki były pobierane. Jeśli szczegóły koszyka się zmieniły, powinieneś poprosić o nowe wyceny wysyłki przed zakończeniem zamówienia kupującego. |
shipToCompany OPCJONALNE | To jest nazwa firmy osoby, która otrzyma wysłane zamówienie. |
shipToEmail WYMAGANE | To jest adres e-mail osoby, która otrzyma wysłane zamówienie. |
shipToName WYMAGANE | To jest pełna nazwa osoby, która otrzyma wysłane zamówienie. |
shipToPhone WYMAGANE | To jest numer telefonu osoby, która otrzyma wysłane zamówienie. |
Odpowiedź HTTPS
Format wiadomości: JSON
Przykładowa odpowiedź tylko dla Kanady i Australii
Uwaga: Rzeczywiste odpowiedzi będą zawierać wszystkie obsługiwane kraje.
Przykładowa odpowiedź
1
2
3
4
5
6
7
{
"igOrderId": "e55a4efc-e615-49af-b3a4-afcda87e9e5e",
"deniedParty": {
"flagged": true,
"source": "source reference for review"
}
}
Definicje odpowiedzi JSON
| Pole | Uwagi |
|---|---|
deniedParty | To jest mapa wyników skanowania pod kątem zablokowanych stron. Jeśli ustawione na null, to skanowanie pod kątem zablokowanych stron nie zostało przeprowadzone. Skontaktuj się ze swoim przedstawicielem Zonos, jeśli napotkasz ten problem. |
deniedParty.flagged | Czy to zamówienie pasuje do rekordu na zintegrowanych listach zablokowanych stron Zonos. Jeśli prawda, sprawdź to zamówienie przed przetworzeniem. W razie wątpliwości, nie przetwarzaj zamówienia, które jest oznaczone jako prawdziwe. Przykładowe wartości: true lub false |
deniedParty.source | Jeśli pole oznaczone zostało jako prawdziwe, to to pole będzie zawierać odniesienia źródłowe przydatne w przeglądaniu, dlaczego zamówienie zostało oznaczone jako pasujące do zablokowanej strony. |
igOrderId | Identyfikator Zonos dla nowo zrealizowanego zamówienia. Przykładowa wartość: e55a4efc-e615-49af-b3a4-afcda87e9e5e |
API Zakończone Zamówienie Legacy
Poznaj, jak działa API Zakończone Zamówienie Legacy.Endpoint Zakończone Zamówienie akceptuje ostateczne szczegóły zamówienia kupującego, sprawdza szczegóły zamówienia pod kątem odrzuconych stron i zwraca wyniki wraz z identyfikatorem zamówienia specyficznym dla Zonos.