DOCS

Обновление номера заказа

Узнайте, как работает конечная точка для обновления номера заказа.

Конечная точка updateMerchantOrderId используется для обновления заказа в системе Zonos с помощью ID заказа вашего магазина для улучшения согласования, взаимодействия и аудита.

Конечная точка 

POST | https://api.iglobalstores.com/v1/updateMerchantOrderId

HTTPS запрос

Поле↕Примечания↕
HTTP методPOST
URL конечной точкиhttps://api.iglobalstores.com/v1/updateMerchantOrderId
ПротоколHTTPS
Формат сообщенияJSON
Заголовок Accept HTTPAccept: application/json
Заголовок Content-Type HTTPContent-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 ОБЯЗАТЕЛЬНОID заказа Zonos - может быть передан с ID вашего магазина и дефисом или без него (Пример: 123-45678 или 45678).Примечание: После завершения заказа и оплаты клиент будет перенаправлен на страницу завершения заказа / спасибо за заказ, размещенную в вашем домене. URL будет содержать параметр строки запроса "orderId", который будет содержать это значение.integer / string
secret ОБЯЗАТЕЛЬНОGUID секрета API, предоставленный Zonos.string
store ОБЯЗАТЕЛЬНОID магазина, предоставленный Zonosinteger

HTTPS ответ

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

Ошибки HTTP ответов

Код ошибки↕Определение↕
406 - Не приемлемоHTML Entity. Заголовок HTTP "Accept" неверен.
415 - Неподдерживаемый тип носителяHTML Entity. Заголовок 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

Была ли эта страница полезной?


На этой странице: