Punkt końcowy
POST | https://api.iglobalstores.com/v1/updateMerchantOrderId
Żądanie HTTPS
Pole | Uwagi |
---|---|
Metoda HTTP | POST |
URL punktu końcowego | https://api.iglobalstores.com/v1/updateMerchantOrderId |
Protokół | HTTPS |
Format wiadomości | JSON |
Nagłówek Accept HTTP | Accept: application/json |
Nagłówek Content-Type HTTP | Content-Type: application/json |
Parzyste klucze/wartości JSON w ciele żądania
Przykład
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"orderId": "999-9999",
"merchantOrderId": "12-34567"
}
Definicje JSON żądania
Pole | Uwagi |
---|---|
merchantOrderId WYMAGANE | Ten parametr jest używany do przekazania wewnętrznego identyfikatora zamówienia Twojego sklepu do zamówienia w systemie Zonos. Zaleca się to dla lepszej rekonsyliacji, komunikacji i audytu.string |
orderId WYMAGANE | Identyfikator zamówienia Zonos - może być przekazywany z lub bez identyfikatora Twojego 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 |
secret WYMAGANE | Tajny klucz API GUID dostarczony przez Zonos.string |
store WYMAGANE | Identyfikator sklepu dostarczony przez Zonosinteger |
Odpowiedź HTTPS
Przykład odpowiedzi sukcesu
1
2
3
{
"success": "Updated Order: 99999 with new merchantOrderId: 12-34567"
}
Przykładowa odpowiedź błędu
1
2
3
{
"error": "Could not retrieve order to updateMerchantOrderId for orderId: 99999"
}
Odpowiedzi błędów HTTP
Kod błędu | Definicja |
---|---|
406 - Nieakceptowalne | HTML Entity. Nagłówek HTTP “Accept” jest nieprawidłowy. |
415 - Nieobsługiwany typ mediów | HTML Entity. Nagłówek HTTP “Content-Type” jest nieprawidłowy. |
200 | “error”:”nie można przetworzyć wejścia” |
200 | “error”:”Parametr orderId jest wymagany do processUpdateMerchantOrderId” |
200 | “error”:”Parametr merchantOrderId jest wymagany do updateMerchantOrderId.” |
200 | “error”:”orderId: 999-99999 nie jest prawidłowym orderId” |
200 | “error”:”Nie można pobrać zamówienia do updateMerchantOrderId dla orderId: 999-99999” |
200 | “error”:”Nie można przetworzyć aktualizacji identyfikatora zamówienia handlowego.” |
200 | “error”:”Nieprawidłowe dane uwierzytelniające” |
Definicje odpowiedzi JSON
Wiadomość | Definicja |
---|---|
error | Ten parametr będzie obecny w odpowiedzi tylko wtedy, gdy wystąpił błąd i będzie zawierał opis przyczyny.string |
success | Ten parametr będzie zawierał podsumowanie aktualizacji.string |
Aktualizacja numeru zamówienia
Dowiedz się, jak działa punkt końcowy do aktualizacji numeru zamówienia.
Punkt końcowy
updateMerchantOrderId
jest używany do aktualizacji zamówienia w systemie Zonos z identyfikatorem zamówienia Twojego sklepu w celu lepszej rekonsyliacji, komunikacji i audytu.