Endepunkt
POST | https://api.iglobalstores.com/v1/updateMerchantOrderId
HTTPS anmodning
Felt | Noter |
---|---|
HTTP metode | POST |
Endepunkt URL | https://api.iglobalstores.com/v1/updateMerchantOrderId |
Protokol | HTTPS |
Meddelelsesformat | JSON |
Accept HTTP header | Accept: application/json |
Content-Type HTTP header | Content-Type: application/json |
JSON nøgle/værdi par i anmodningskroppen
Eksempel
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"orderId": "999-9999",
"merchantOrderId": "12-34567"
}
Anmodning JSON definitioner
Felt | Noter |
---|---|
merchantOrderId PÅKRÆVET | Denne parameter bruges til at overføre din butiks interne ordre-ID til ordren i Zonos systemet. Dette anbefales for bedre afstemning, kommunikation og revision.string |
orderId PÅKRÆVET | Zonos ordre-ID - kan overføres med eller uden dit butiks-ID og bindestreg (Eksempel: 123-45678 eller 45678).Bemærk: Efter ordreafslutning og betaling vil kunden blive omdirigeret til en Ordreafslutning / Tak for ordren side, der er hostet på dit domæne. URL'en vil indeholde en forespørgselsparameter "orderId", der vil indeholde denne værdi.integer / string |
secret PÅKRÆVET | API hemmelig GUID leveret af Zonos.string |
store PÅKRÆVET | Butiks-ID leveret af Zonosinteger |
HTTPS svar
Eksempel på succes svar
1
2
3
{
"success": "Updated Order: 99999 with new merchantOrderId: 12-34567"
}
Eksempel på fejlrespons
1
2
3
{
"error": "Could not retrieve order to updateMerchantOrderId for orderId: 99999"
}
HTTP fejl svar
Fejlkode | Definition |
---|---|
406 - Ikke Acceptabel | HTML Enhed. HTTP “Accept” header er ugyldig. |
415 - Ikke understøttet medietype | HTML Enhed. HTTP “Content-Type” header er ugyldig. |
200 | “error”:”kunne ikke analysere input” |
200 | “error”:”Parameter orderId er påkrævet for at processUpdateMerchantOrderId” |
200 | “error”:”Parameter merchantOrderId er påkrævet for at updateMerchantOrderId.” |
200 | “error”:”orderId: 999-99999 er ikke et gyldigt orderId” |
200 | “error”:”Kunne ikke hente ordre for at updateMerchantOrderId for orderId: 999-99999” |
200 | “error”:”Kunne ikke behandle opdatering af handelsordre id.” |
200 | “error”:”Ugyldige sikkerhedsgodkendelser” |
Response JSON definitioner
Besked | Definition |
---|---|
error | Denne parameter vil kun være til stede i svaret, når der er opstået en fejl, og vil indeholde en beskrivelse af årsagen.string |
success | Denne parameter vil indeholde et resumé af opdateringen.string |
Opdater ordre nummer
Lær hvordan endepunktet til at opdatere et ordre nummer fungerer.
updateMerchantOrderId
endepunktet bruges til at opdatere en ordre i Zonos systemet med din butiks ordre-id for bedre afstemning, kommunikation og revision.