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

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

Конечная точка 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

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

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

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

ПРИМЕР

{
  "store": "999",
  "secret": "f5bde245-f55e-414d-b722-80b25161c12c",
  "orderId": "999-9999",
  "orderStatus": "VENDOR_END_OF_DAY_COMPLETE"
}

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

Поле Примечания

orderId ОБЯЗАТЕЛЬНО Идентификатор заказа Zonos может быть передан с вашим идентификатором магазина или без него и дефиса (пример: 123-45678 или 45678). После завершения заказа и оплаты клиент будет перенаправлен на страницу завершения заказа / страницу благодарности за заказ, размещенную на вашем домене. URL будет содержать параметр строки запроса orderID, который будет содержать это значение.integer / string

orderStatus ОБЯЗАТЕЛЬНО Это поле используется для обновления системы Zonos с новым статусом заказа. Следующие статусы заказа могут быть установлены через этот API.- VENDOR_PREPARING_ORDER

Поле	Примечания
`orderId` ОБЯЗАТЕЛЬНО	Идентификатор заказа Zonos может быть передан с вашим идентификатором магазина или без него и дефиса (пример: 123-45678 или 45678). После завершения заказа и оплаты клиент будет перенаправлен на страницу завершения заказа / страницу благодарности за заказ, размещенную на вашем домене. URL будет содержать параметр строки запроса `orderID`, который будет содержать это значение.`integer / string`
`orderStatus` ОБЯЗАТЕЛЬНО	Это поле используется для обновления системы Zonos с новым статусом заказа. Следующие статусы заказа могут быть установлены через этот API.- `VENDOR_PREPARING_ORDER`

VENDOR_SHIPMENT_READY
VENDOR_LABELS_PRINTED
VENDOR_END_OF_DAY_COMPLETE
VENDOR_CANCELLATION_REQUEST``string | | secret ОБЯЗАТЕЛЬНО | API секретный GUID, предоставленный Zonos.string | | store ОБЯЗАТЕЛЬНО | Идентификатор магазина, предоставленный Zonosinteger |

HTTPS ответ

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

Пример успешного ответа

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

Пример ответа об ошибке

{
  "error": "OrderId: 99999 cannot be moved to order status: VENDOR_PREPARING_ORDER while in status: IGLOBAL_FRAUD_REVIEW"
}

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

Коды ответов HTTP	Пример/Описание тела ответа
406 - Неприемлемо	HTML-сущность. Заголовок HTTP “Accept” недействителен.
415 - Неподдерживаемый тип медиа	HTML-сущность. Заголовок HTTP “Content-Type” недействителен.
200	“error”:“не удалось разобрать ввод”
200	“error”:“Параметр orderId требуется для updateVendorOrderStatus”
200	“error”:“Параметр orderStatus требуется для updateVendorOrderStatus.”
200	“error”:“orderId: 999-99999 не является действительным orderId”
200	“error”:“Не удалось получить заказ для updateVendorOrderStatus по orderId: 999-99999”
200	“error”:“OrderId: 999-99999 уже был отменен, и статус не может быть обновлен.”
200	“error”:“Невозможно обновить статус заказа на статус: VENDOR_CANCELLATION_REQUEST”
200	“error”:“Невозможно обновить статус заказа на недействительный статус: NEW_ORDER_STATUS”
200	“error”:“OrderId: 999-99999 уже имеет текущий статус: VENDOR_SHIPMENT_READY”
200	“error”:“OrderId: 999-99999 не может быть переведен в статус заказа: VENDOR_CANCELLATION_REQUEST, находясь в статусе: VENDOR_END_OF_DAY_COMPLETE”
200	“error”:“Новый статус: NEW_ORDER_STATUS не является действительным статусом заказа”
200	“error”:“Не удалось обработать updateVendorOrderStatus.”
200	“error”:“Недействительные учетные данные безопасности”

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

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

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

Вопросы?

Свяжитесь с нами.

Посмотреть Zonos

политики и соглашения