Aggiorna il numero dell'ordine

Scopri come funziona l'endpoint per aggiornare un numero d'ordine.

L'endpoint updateMerchantOrderId viene utilizzato per aggiornare un ordine nel sistema Zonos con l'ID ordine del tuo negozio per una migliore riconciliazione, comunicazione e auditing.

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 messaggio	JSON
Intestazione Accept HTTP	Accept: application/json
Intestazione Content-Type HTTP	Content-Type: application/json

Coppie chiave/valore JSON nel corpo della richiesta

Esempio

{
  "store": "999",
  "secret": "f5bde245-f55e-414d-b722-80b25161c12c",
  "orderId": "999-9999",
  "merchantOrderId": "12-34567"
}

Definizioni JSON della richiesta

Campo	Note
`merchantOrderId` OBBLIGATORIO	Questo parametro viene utilizzato per passare l'ID interno dell'ordine del tuo negozio all'ordine nel sistema Zonos. Questo è raccomandato per una migliore riconciliazione, comunicazione e auditing.`string`
`orderId` OBBLIGATORIO	L'ID 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 dell'ordine / pagina di ringraziamento per l'ordine ospitata sul tuo dominio. L'URL conterrà un parametro di querystring "orderId" che conterrà questo valore.`integer / string`
`secret` OBBLIGATORIO	GUID segreto API fornito da Zonos.`string`
`store` OBBLIGATORIO	ID negozio fornito da Zonos`integer`

Risposta HTTPS

Esempio di risposta di successo

{
  "success": "Updated Order: 99999 with new merchantOrderId: 12-34567"
}

Esempio di risposta di errore

{
  "error": "Could not retrieve order to updateMerchantOrderId for orderId: 99999"
}

Risposte di errore HTTP

Codice di errore	Definizione
406 - Non accettabile	Entità HTML. L'intestazione HTTP “Accept” non è valida.
415 - Tipo di media non supportato	Entità HTML. L'intestazione HTTP “Content-Type” non è valida.
200	“error”:”impossibile analizzare l'input”
200	“error”:”Il parametro orderId è necessario per processUpdateMerchantOrderId”
200	“error”:”Il parametro merchantOrderId è necessario per updateMerchantOrderId.”
200	“error”:”orderId: 999-99999 non è un orderId valido”
200	“error”:”Impossibile recuperare l'ordine per updateMerchantOrderId per orderId: 999-99999”
200	“error”:”Impossibile elaborare l'aggiornamento dell'ID ordine commerciale.”
200	“error”:”Credenziali di sicurezza non valide”

Definizioni JSON di 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`

Questa pagina è stata utile?

Domande?

Contattaci.

Vedi Zonos

politiche e accordi