Update Order Number

Service End Point -updateMerchantOrderId

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.

HTTPS Request

HTTP Method POST
End Point 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

Request Parameters

Message Format JSON

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

Request JSON Definitions

store

Required

Store id provided by Zonos.

Integer

secret

Required

API secret GUID provided by Zonos.

String

orderId

Required

The iGlobal 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

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

HTTPS Response

Message Format JSON

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

Example Error Response

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

Error HTTP Responses

HTTP Response Codes Response Body Example/Description
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”

Response JSON Definitions

success

This parameter will contain a summary of the update.

String

error

This parameter will only be present in the response when an error has occurred and will contain a description of the cause.

String