Slutpunkt
POST | https://api.iglobalstores.com/v1/updateMerchantOrderId
HTTPS-förfrågan
| Fält | Anteckningar |
|---|---|
| HTTP-metod | POST |
| Slutpunkts-URL | https://api.iglobalstores.com/v1/updateMerchantOrderId |
| Protokoll | HTTPS |
| Meddelandeformat | JSON |
| Accept HTTP-header | Accept: application/json |
| Content-Type HTTP-header | Content-Type: application/json |
JSON nyckel/värde-par i begärans kropp
Exempel
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"orderId": "999-9999",
"merchantOrderId": "12-34567"
}
Begäran JSON-definitioner
| Fält | Anteckningar |
|---|---|
merchantOrderId KRÄVS | Denna parameter används för att överföra din butiks interna order-ID till beställningen i Zonos-systemet. Detta rekommenderas för bättre avstämning, kommunikation och granskning.string |
orderId KRÄVS | Zonos beställnings-ID - kan överföras med eller utan din butiks-ID och bindestreck (Exempel: 123-45678 eller 45678).Obs: Efter att beställningen har slutförts och betalningen har genomförts kommer kunden att omdirigeras till en sida för Beställningsslutförande / Tack för beställningen som är värd på din domän. URL:en kommer att innehålla en frågesträngparameter "orderId" som kommer att innehålla detta värde.integer / string |
secret KRÄVS | API-hemlig GUID som tillhandahålls av Zonos.string |
store KRÄVS | Butiks-ID som tillhandahålls av Zonosinteger |
HTTPS-svar
Exempel på framgångssvar
1
2
3
{
"success": "Updated Order: 99999 with new merchantOrderId: 12-34567"
}
Exempel på felrespons
1
2
3
{
"error": "Could not retrieve order to updateMerchantOrderId for orderId: 99999"
}
HTTP-felmeddelanden
| Felkod | Definition |
|---|---|
| 406 - Inte acceptabel | HTML-enhet. HTTP "Accept"-huvudet är ogiltigt. |
| 415 - Ogiltig mediatyp | HTML-enhet. HTTP "Content-Type"-huvudet är ogiltigt. |
| 200 | “error”:”kunde inte analysera indata” |
| 200 | “error”:”Parameter orderId krävs för att processa updateMerchantOrderId” |
| 200 | “error”:”Parameter merchantOrderId krävs för att updateMerchantOrderId.” |
| 200 | “error”:”orderId: 999-99999 är inte ett giltigt orderId” |
| 200 | “error”:”Kunde inte hämta order för updateMerchantOrderId för orderId: 999-99999” |
| 200 | “error”:”Kunde inte processa uppdatering av merchant order id.” |
| 200 | “error”:”Ogiltiga säkerhetsuppgifter” |
Svars-JOSN-definitioner
| Meddelande | Definition |
|---|---|
error | Denna parameter kommer endast att finnas i svaret när ett fel har inträffat och kommer att innehålla en beskrivning av orsaken.string |
success | Denna parameter kommer att innehålla en sammanfattning av uppdateringen.string |
Uppdatera beställningsnummer
Lär dig hur slutpunkten för att uppdatera ett beställningsnummer fungerar.
Den
updateMerchantOrderIdslutpunkten används för att uppdatera en beställning i Zonos-systemet med din butiks beställnings-id för bättre avstämning, kommunikation och granskning.