Endpoint
POST | https://api.iglobalstores.com/v1/updateMerchantOrderId
Richiesta HTTPS
| Campo↕ | Note↕ |
|---|---|
| Metodo HTTP | POST |
| URL dell'endpoint | https://api.iglobalstores.com/v1/updateMerchantOrderId |
| Protocollo | HTTPS |
| Formato del messaggio | JSON |
| Intestazione HTTP Accept | Accept: application/json |
| Intestazione HTTP Content-Type | Content-Type: application/json |
Coppie chiave/valore JSON nel corpo della richiesta
1
{2
"store": "999",3
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",4
"orderId": "999-9999",5
"merchantOrderId": "12-34567"6
}Definizioni JSON della richiesta
| Campo↕ | Note↕ |
|---|---|
merchantOrderId OBBLIGATORIO | Questo parametro viene utilizzato per passare l'ID d'ordine interno del tuo negozio all'ordine nel sistema Zonos. È consigliato per una migliore riconciliazione, comunicazione e verifica.string |
orderId OBBLIGATORIO | L'ID d'ordine Zonos - può essere passato con o senza l'ID del tuo negozio e il trattino (Esempio: 123-45678 o 45678). Nota: dopo il completamento dell'ordine e il pagamento, il cliente verrà reindirizzato a una pagina di completamento ordine / pagina di ringraziamento ospitata sul tuo dominio. L'URL conterrà un parametro querystring “orderId” che conterrà questo valore.integer / string |
secret OBBLIGATORIO | GUID segreto dell'API fornito da Zonos.string |
store OBBLIGATORIO | ID del negozio fornito da Zonosinteger |
Risposta HTTPS
1
{2
"success": "Updated Order: 99999 with new merchantOrderId: 12-34567"3
}Risposte di errore HTTP
| Codice errore↕ | Definizione↕ |
|---|---|
| 406 - Not Acceptable | Entità HTML. L'intestazione HTTP “Accept” non è valida. |
| 415 - Unsupported media type | Entità HTML. L'intestazione HTTP “Content-Type” non è valida. |
| 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” |
Definizioni JSON della risposta
| Messaggio↕ | Definizione↕ |
|---|---|
error | Questo parametro sarà presente nella risposta solo quando si è verificato un errore e conterrà una descrizione della causa.string |
success | Questo parametro conterrà un riepilogo dell'aggiornamento.string |
Aggiornare il numero d'ordine
Scopri come funziona l'endpoint per aggiornare un numero d'ordine.
L'endpoint
updateMerchantOrderIdviene utilizzato per aggiornare un ordine nel sistema Zonos con l'ID d'ordine del tuo negozio, per una migliore riconciliazione, comunicazione e verifica.