端点
POST | https://api.iglobalstores.com/v1/updateMerchantOrderId
HTTPS 请求
| 字段 | 备注 |
|---|---|
| HTTP 方法 | POST |
| 端点 URL | https://api.iglobalstores.com/v1/updateMerchantOrderId |
| 协议 | HTTPS |
| 消息格式 | JSON |
| 接受 HTTP 头 | Accept: application/json |
| 内容类型 HTTP 头 | Content-Type: application/json |
请求体中的 JSON 键/值对
示例
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"orderId": "999-9999",
"merchantOrderId": "12-34567"
}
请求 JSON 定义
| 字段 | 备注 |
|---|---|
merchantOrderId 必填 | 此参数用于将您商店的内部订单 ID 传递到 Zonos 系统中的订单中。建议使用此参数以便更好地进行对账、沟通和审计。string |
orderId 必填 | Zonos 订单 ID - 可以带或不带您的商店 ID 和连字符传递（示例：123-45678 或 45678）。注意：订单完成和付款后，客户将被重定向到您域名上托管的订单完成/感谢页面。URL 将包含一个查询字符串参数“orderId”，该参数将包含此值。integer / string |
secret 必填 | 由 Zonos 提供的 API 秘密 GUID。string |
store 必填 | 由 Zonos 提供的商店 ID。integer |
HTTPS 响应
示例成功响应
1
2
3
{
"success": "Updated Order: 99999 with new merchantOrderId: 12-34567"
}
示例错误响应
1
2
3
{
"error": "Could not retrieve order to updateMerchantOrderId for orderId: 99999"
}
HTTP错误响应
| 错误代码 | 定义 |
|---|---|
| 406 - 不可接受 | HTML实体。HTTP “Accept”头无效。 |
| 415 - 不支持的媒体类型 | HTML实体。HTTP “Content-Type”头无效。 |
| 200 | “error”:”无法解析输入” |
| 200 | “error”:”参数orderId是处理updateMerchantOrderId所必需的” |
| 200 | “error”:”参数merchantOrderId是更新merchantOrderId所必需的。” |
| 200 | “error”:”orderId: 999-99999不是有效的orderId” |
| 200 | “error”:”无法检索订单以更新merchantOrderId，订单ID: 999-99999” |
| 200 | “error”:”无法处理更新商户订单ID。” |
| 200 | “error”:”无效的安全凭证” |
响应JSON定义
| 消息 | 定义 |
|---|---|
error | 该参数仅在发生错误时出现在响应中，并将包含原因的描述。string |
success | 该参数将包含更新的摘要。string |
更新订单号
了解更新订单号的端点如何工作。updateMerchantOrderId端点用于使用您商店的订单 ID 更新 Zonos 系统中的订单，以便更好地进行对账、沟通和审计。