Endpoint
POST | https://api.iglobalstores.com/v1/updateMerchantOrderId
HTTPS-begäran
| Field↕ | Notes↕ |
|---|---|
| HTTP method | POST |
| Endpoint URL | https://api.iglobalstores.com/v1/updateMerchantOrderId |
| Protocol | HTTPS |
| Message format | JSON |
| Accept HTTP header | Accept: application/json |
| Content-Type HTTP header | Content-Type: application/json |
JSON-nyckel/värde-par i begärandekroppen
1
{2
"store": "999",3
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",4
"orderId": "999-9999",5
"merchantOrderId": "12-34567"6
}Definitioner för begärande-JSON
| Field↕ | Notes↕ |
|---|---|
merchantOrderId REQUIRED | Denna parameter används för att skicka er butiks interna order-ID till ordern i Zonos-systemet. Detta rekommenderas för bättre avstämning, kommunikation och revision.string |
orderId REQUIRED | Zonos order-ID – kan skickas med eller utan ert butiks-ID och bindestreck (Exempel: 123-45678 eller 45678).Obs: Efter att ordern slutförts och betalats omdirigeras kunden till en Order Completion / Order Thank You-sida som hostas på er domän. URL:en innehåller en querystring-parameter ”orderId” med detta värde.integer / string |
secret REQUIRED | API-hemlighet GUID som tillhandahålls av Zonos.string |
store REQUIRED | Butiks-ID som tillhandahålls av Zonosinteger |
HTTPS-svar
1
{2
"success": "Updated Order: 99999 with new merchantOrderId: 12-34567"3
}Fel-HTTP-svar
| Error code↕ | Definition↕ |
|---|---|
| 406 - Not Acceptable | HTML Entity. HTTP-headern ”Accept” är ogiltig. |
| 415 - Unsupported media type | HTML Entity. HTTP-headern ”Content-Type” är ogiltig. |
| 200 | “error”:”could not parse input” |
| 200 | “error”:”Parameter orderId is required to processUpdateMerchantOrderId” |
| 200 | “error”:”Parameter merchantOrderId is required to updateMerchantOrderId.” |
| 200 | “error”:”orderId: 999-99999 is not a valid orderId” |
| 200 | “error”:”Could not retrieve order to updateMerchantOrderId for orderId: 999-99999” |
| 200 | “error”:”Could not process update merchant order id.” |
| 200 | “error”:”Invalid security credentials” |
Definitioner för svars-JSON
| Message↕ | Definition↕ |
|---|---|
error | Denna parameter finns endast i svaret när ett fel har inträffat och innehåller en beskrivning av orsaken.string |
success | Denna parameter innehåller en sammanfattning av uppdateringen.string |
Uppdatera ordernummer
Lär er hur endpointen för att uppdatera ett ordernummer fungerar.
Endpointen
updateMerchantOrderIdanvänds för att uppdatera en order i Zonos-systemet med er butiks order-id för bättre avstämning, kommunikation och revision.