Эндпоинт
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
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"orderId": "999-9999",
"merchantOrderId": "12-34567"
}
Определения JSON запросов
| Поле | Примечания |
|---|---|
merchantOrderId ОБЯЗАТЕЛЬНО | Этот параметр используется для передачи внутреннего идентификатора заказа вашего магазина в систему Zonos. Это рекомендуется для лучшей сверки, коммуникации и аудита.string |
orderId ОБЯЗАТЕЛЬНО | Идентификатор заказа Zonos - может быть передан с или без идентификатора вашего магазина и дефиса (Пример: 123-45678 или 45678). Примечание: После завершения заказа и оплаты клиент будет перенаправлен на страницу Завершения заказа / Благодарности за заказ, размещенную на вашем домене. URL будет содержать параметр строки запроса “orderId”, который будет содержать это значение.integer / string |
secret ОБЯЗАТЕЛЬНО | API секретный GUID, предоставленный Zonos.string |
store ОБЯЗАТЕЛЬНО | Идентификатор магазина, предоставленный Zonosinteger |
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 обязателен для processUpdateMerchantOrderId” |
| 200 | “error”:”Параметр merchantOrderId обязателен для updateMerchantOrderId.” |
| 200 | “error”:”orderId: 999-99999 не является допустимым orderId” |
| 200 | “error”:”Не удалось получить заказ для updateMerchantOrderId для orderId: 999-99999” |
| 200 | “error”:”Не удалось обработать обновление идентификатора заказа продавца.” |
| 200 | “error”:”Недействительные учетные данные безопасности” |
Определения JSON-ответов
| Сообщение | Определение |
|---|---|
error | Этот параметр будет присутствовать в ответе только в случае ошибки и будет содержать описание причины.string |
success | Этот параметр будет содержать сводку обновления.string |
Обновление номера заказа
Узнайте, как работает эндпоинт для обновления номера заказа.
Эндпоинт
updateMerchantOrderIdиспользуется для обновления заказа в системе Zonos с идентификатором заказа вашего магазина для лучшей сверки, коммуникации и аудита.