DOCS

Обновление статуса заказа

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

Конечная точка updateVendorOrderStatus используется для обновления статуса заказа внутри системы Zonos. Она будет использоваться для программного обновления статуса доставки заказа или для запроса отмены.

Текущие значения статуса заказа 

Ниже приведён текущий список статусов заказа, которые может иметь заказ.

Внимание - Zonos может добавить дополнительные статусы в любой момент; ваша система должна предусмотреть наличие дополнительных статусов.

Статусы, используемые в производственной среде, останутся в производственной среде. Zonos никогда не удалит существующие статусы.

Статус↕Описание↕Устанавливается↕
IGLOBAL_FRAUD_REVIEWЗаказ в настоящее время проходит проверку на мошенничество компанией iGlobal.Zonos
IGLOBAL_ORDER_IN_PROCESSЗаказ действителен и готов к обработке.Zonos
IGLOBAL_ORDER_ON_HOLDЗаказ в настоящее время временно приостановлен по статусу.Zonos
IGLOBAL_ORDER_CANCELLEDЗаказ отменён в системе iGlobal.Zonos
VENDOR_PREPARING_ORDERПоставщик отметил заказ как готовящийся.Поставщик
VENDOR_SHIPMENT_READYПоставщик отметил заказ как готовый к отправке.Поставщик
VENDOR_LABELS_PRINTED_DATEПоставщик напечатал этикетки доставки.Поставщик
VENDOR_CANCELLATION_REQUESTПо заказу запрошена отмена.Поставщик
VENDOR_END_OF_DAY_COMPLETEЗаказ завершён и готов.Поставщик

vendorOrderStatus не может быть обновлён поставщиком, пока заказ находится в одном из следующих статусов:

IGLOBAL_LABELS_PROCESSINGIGLOBAL_ORDER_ON_HOLDIGLOBAL_FRAUD_REVIEWIGLOBAL_ORDER_CANCELLEDVENDOR_CANCELLATION_REQUESTVENDOR_END_OF_DAY_COMPLETE

HTTPS запрос

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

Поле↕Значение↕
Метод HTTPPOST
URL конечной точкиhttps://api.iglobalstores.com/v1/updateVendorOrderStatus
ПротоколHTTPS
Формат сообщенияJSON
Заголовок HTTP AcceptAccept: application/json
Заголовок HTTP Content-TypeContent-Type: application/json

Пары ключ/значение JSON в теле запроса

Формат сообщения: JSON

1{
2 "store": "999",
3 "secret": "f5bde245-f55e-414d-b722-80b25161c12c",
4 "orderId": "999-9999",
5 "orderStatus": "VENDOR_END_OF_DAY_COMPLETE"
6}

Определения JSON запроса

Поле↕Примечания↕
orderId REQUIREDID заказа Zonos можно передать с вашим ID магазина и дефисом или без них (Пример: 123-45678 или 45678).После завершения заказа и оплаты покупатель будет перенаправлен на страницу завершения заказа / страницу благодарности за заказ, размещённую в вашем домене. URL будет содержать параметр строки запроса orderID, который будет содержать это значение.integer / string
orderStatus REQUIREDЭто поле используется для обновления системы Zonos с новым статусом заказа.Следующие статусы заказа можно устанавливать через этот API.- VENDOR_PREPARING_ORDER
  • VENDOR_SHIPMENT_READY
  • VENDOR_LABELS_PRINTED
  • VENDOR_END_OF_DAY_COMPLETE
  • VENDOR_CANCELLATION_REQUEST``string | | secret REQUIRED | Секретный GUID API предоставлен компанией Zonos.string | | store REQUIRED | ID магазина, предоставленный компанией Zonosinteger |

HTTPS ответ

Формат сообщения: JSON

1{
2 "success": "Updated Order: 99999 to new order status: VENDOR_PREPARING_ORDER"
3}

Ошибочные HTTP ответы

Коды HTTP ответов↕Пример/Описание тела ответа↕
406 - Not AcceptableHTML Entity. Заголовок HTTP "Accept" недействителен.
415 - Unsupported media typeHTML Entity. Заголовок HTTP "Content-Type" недействителен.
200"error":"could not parse input"
200"error":"Parameter orderId required for updateVendorOrderStatus"
200"error":"Parameter orderStatus required for updateVendorOrderStatus."
200"error":"orderId: 999-99999 is not a valid orderId"
200"error":"Could not retrieve order to updateVendorOrderStatus from orderId: 999-99999"
200"error":"OrderId: 999-99999 has already been cancelled and status cannot be updated."
200"error":"Cannot update order status to status: VENDOR_CANCELLATION_REQUEST"
200"error":"Cannot update order status to invalid status: NEW_ORDER_STATUS"
200"error":"OrderId: 999-99999 already has current status: VENDOR_SHIPMENT_READY"
200"error":"OrderId: 999-99999 cannot be moved to order status: VENDOR_CANCELLATION_REQUEST while in status: VENDOR_END_OF_DAY_COMPLETE"
200"error":"New Status: NEW_ORDER_STATUS is not a valid order status"
200"error":"Could not process updateVendorOrderStatus."
200"error":"Invalid security credentials"

Определения JSON ответа

Сообщение↕Определение↕
successЭтот параметр будет содержать краткое описание обновления.string
errorЭтот параметр будет присутствовать в ответе только при возникновении ошибки и будет содержать описание причины.string

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


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