端点
POST | https://api.iglobalstores.com/v1/updateMerchantOrderId
HTTPS 请求
| 字段↕ | 说明↕ |
|---|---|
| HTTP 方法 | POST |
| 端点 URL | https://api.iglobalstores.com/v1/updateMerchantOrderId |
| 协议 | HTTPS |
| 消息格式 | JSON |
| Accept HTTP 标头 | Accept: application/json |
| Content-Type HTTP 标头 | Content-Type: application/json |
请求正文中的 JSON 键值对
1
{2
"store": "999",3
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",4
"orderId": "999-9999",5
"merchantOrderId": "12-34567"6
}请求 JSON 定义
| 字段↕ | 说明↕ |
|---|---|
merchantOrderId 必需 | 此参数用于将您商店的内部订单 ID 传递到 Zonos 系统中的订单。建议用于更好地协调、沟通和审计。string |
orderId 必需 | Zonos 订单 ID - 可以通过或不通过您的商店 ID 和连字符传递(例如:123-45678 或 45678)。注意:订单完成并支付后,客户将被重定向到托管在您的域上的订单完成/订单感谢页面。URL 将包含一个查询字符串参数"orderId",其中包含此值。integer / string |
secret 必需 | Zonos 提供的 API 密钥 GUID。string |
store 必需 | Zonos 提供的商店 IDinteger |
HTTPS 响应
1
{2
"success": "Updated Order: 99999 with new merchantOrderId: 12-34567"3
}错误 HTTP 响应
| 错误代码↕ | 定义↕ |
|---|---|
| 406 - Not Acceptable | HTML 实体。HTTP"Accept"标头无效。 |
| 415 - Unsupported media type | HTML 实体。HTTP"Content-Type"标头无效。 |
| 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" |
响应 JSON 定义
| 消息↕ | 定义↕ |
|---|---|
error | 当发生错误时,此参数将仅出现在响应中,并将包含错误原因的描述。string |
success | 此参数将包含更新摘要。string |
更新订单号
了解如何使用端点更新订单号。updateMerchantOrderId端点用于使用您商店的订单 ID 更新 Zonos 系统中的订单,以便更好地进行协调、沟通和审计。