Question 1

What is the purpose of the 'updateMerchantOrderId' endpoint?

Accepted Answer

This API endpoint is used to update an order in the Zonos system with your store’s order id for better reconciliation, communication, and auditing.

Question 2

What are the required parameters for the 'updateMerchantOrderId' request?

Accepted Answer

The required parameters are 'merchantOrderId', 'orderId', 'secret', and 'store'.

Question 3

What does the 'updateMerchantOrderId' success response look like?

Accepted Answer

The success response will contain a message indicating the order update, for example: 'Updated Order: 99999 with new merchantOrderId: 12-34567'.

Question 4

What does the 'updateMerchantOrderId' error response look like?

Accepted Answer

The error response will contain an 'error' parameter with a description of the cause, for example: 'Could not retrieve order to updateMerchantOrderId for orderId: 99999'.

Question 5

What are the possible error HTTP responses for the 'updateMerchantOrderId' request?

Accepted Answer

Possible error HTTP responses include 406 - Not Acceptable, 415 - Unsupported media type, and various 200 responses with different error messages.

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

Field↕	Notes↕
`merchantOrderId` REQUIRED	This parameter is used to pass your store’s internal order ID to the order in the Zonos system. This is recommended for better reconciliation, communication, and auditing.`string`
`orderId` REQUIRED	The Zonos order ID - can be passed with or without your store ID and hyphen (Example: 123-45678 or 45678).Note: After order completion and payment, the customer will be redirected to an Order Completion / Order Thank You page hosted on your domain. The URL will contain a querystring parameter “orderId” that will contain this value.`integer / string`
`secret` REQUIRED	API secret GUID provided by Zonos.`string`
`store` REQUIRED	Store ID provided by Zonos`integer`

Error code↕	Definition↕
406 - Not Acceptable	HTML Entity. HTTP “Accept” header is invalid.
415 - Unsupported media type	HTML Entity. HTTP “Content-Type” header is invalid.
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”

Message↕	Definition↕
`error`	This parameter will only be present in the response when an error has occurred and will contain a description of the cause.`string`
`success`	This parameter will contain a summary of the update.`string`

Update order number

Endpoint

HTTPS request

JSON key/value pairs in the request body

Request JSON definitions

HTTPS response

Error HTTP responses

Response JSON definitions

Was this page helpful?