Эндпоинты
Номера заказов
Получает список номеров заказов.
Детали заказа
Получает подробную информацию о заказе.
Использование эндпоинта API "Получить заказ"
Существует два распространенных способа использования этих эндпоинтов.
- (Часть 1 + Часть 2) – Используйте пользовательскую страницу подтверждения заказа / успеха на вашем домене, чтобы инициировать вызов вашего системы к эндпоинту
orderDetail
и импортировать завершенный заказ. Кроме того, регулярно вызывайте эндпоинтorderNumbers
, чтобы согласовать любые заказы в системе Zonos, которые не были импортированы в вашу систему. - (Только Часть 2) – Используйте базовую страницу подтверждения заказа / успеха Zonos или статическую страницу на вашем домене, чтобы указать клиенту на завершение заказа. Запланируйте вашу систему на регулярный вызов эндпоинта
orderNumbers
, чтобы определить, когда новый заказ готов к импорту в вашу систему. Когда будет найден незавершенный заказ, вызовите эндпоинтorderDetail
для получения данных по этим заказам.
Часть 1: Страница успеха на вашем домене
Каждый раз, когда покупатель завершает заказ в Zonos Checkout, он немедленно перенаправляется на URL страницы успеха заказа. Идентификатор завершенного заказа будет добавлен к URL перенаправления в виде строки запроса. URL страницы успеха заказа должен быть предоставлен Zonos. URL также может быть передан как параметр в эндпоинте createTempCart
при создании временной корзины в системе Zonos.
Пример: http://www.examplestore.com/internationalThankYou?orderId=999-99999
Когда клиент перенаправляется на эту страницу, вашей системе необходимо будет разобрать значение для orderId
из URL. Затем вы будете использовать orderId
, чтобы вызвать эндпоинт orderDetail
для получения данных о заказе.
Часть 2: Используйте запланированную задачу
В дополнение к вызову деталей заказа, когда страница успеха активируется, мы рекомендуем вам настроить запланированный вызов для всех заказов и их деталей в качестве общего решения. Таким образом, вы сможете получить любые завершенные заказы в системе Zonos, которые еще не были импортированы в вашу систему.
Этот процесс должен быть запланированной задачей/скриптом, например, задачей Cron, выполняемой раз в час/смену/день и т.д. (планируйте так часто, как это необходимо для ваших бизнес-процессов). Скрипт должен запрашивать все заказы и их детали, которые произошли с момента последнего вызова заказов. Эндпоинт orderNumbers
позволяет вам получать заказы sinceOrderId
или sinceDate
, как показано на тестовом интерфейсе API, расположенном здесь. Все заказы, полученные через этот запланированный вызов, должны быть согласованы с заказами, вставленными в вашу систему каждый раз, когда страница успеха была активирована. Любые заказы, которых еще нет в вашей системе, должны быть вставлены в вашу систему и считаться законными заказами.
Начальный статус заказа
IGLOBAL_ORDER_IN_PROCESS
или IGLOBAL_FRAUD_REVIEW
При вызове эндпоинта orderDetail
мы рекомендуем вашей системе сначала проверить свойство orderStatus
данных заказа.
Заказы, которые не требуют проверки на мошенничество, будут инициализированы со статусом orderStatus
: IGLOBAL_ORDER_IN_PROCESS
. Заказ в этом статусе готов к обработке и отправке.
Заказы, которые требуют проверки на мошенничество, будут инициализированы со статусом orderStatus
: IGLOBAL_FRAUD_REVIEW
. Заказ в этом статусе в настоящее время проходит проверку и анализ на предмет подозрительного мошенничества. Мы рекомендуем вам поместить этот заказ в статус проверки или удержания в вашей системе и продолжать вызывать эндпоинт orderDetail
, пока заказ не пройдет процесс проверки мошенничества Zonos.
После завершения процесса проверки мошенничества Zonos заказ перейдет в одно из следующих состояний:
-
Заказ проходит проверку на мошенничество
- Заказ перейдет в
orderStatus
:IGLOBAL_ORDER_IN_PROCESS
и может продолжить движение к отправке.
- Заказ перейдет в
-
Заказ не проходит проверку на мошенничество
- Заказ перейдет в
orderStatus
:IGLOBAL_ORDER_CANCELLED
и должен быть отменен в вашей системе.
- Заказ перейдет в
Тестовый интерфейс API
Пожалуйста, свяжитесь с поддержкой для получения учетных данных вашей учетной записи.
Получить заказ
Получите список номеров заказов или подробную информацию о заказе.
Этот эндпоинт API "Получить заказ" используется для получения данных о завершенном заказе в системе Zonos. Ответ будет содержать объект JSON, представляющий всю доступную информацию о заказе, включая адреса выставления счета и доставки, способ доставки, общую сумму заказа и статус.