Получение уведомлений

Маркет отправляет магазину уведомления о событиях:

  • создание нового заказа;
  • изменение статуса заказа;
  • создание заявки на отмену заказа;
  • отмена заказа;
  • создание нового невыкупа или возврата;
  • изменение статуса невыкупа или возврата.

Учитывайте эти особенности в работе с уведомлениями

  • Маркет может отправлять несколько уведомлений по одному и тому же событию.

    В некоторых случаях это нормальное поведение. Например, может быть несколько уведомлений с изменением статуса заказа из-за поиска курьера.

  • Время в уведомлении, в ответе на запрос к Маркету и в вашей системе может отличаться.

    Это происходит из-за того, что в момент отправки уведомления состояние заказа уже может быть другим.

    В запросе POST notification время события приходит в createdAt, updatedAt или cancelledAt. Выбор параметра зависит от типа уведомления.

Актуальным считайте более позднее время события. Оно может быть в уведомлении, вернуться в ответе на запрос к Маркету или храниться в вашей системе.

Таймаут на получение ответа: 10 секунд.

Request

POST

/notification

Body

application/json
{
    "notificationType": "PING",
    "time": "2022-12-29T18:02:01Z"
}

Name

Description

notificationType*

Type: NotificationType

Тип уведомления:

  • PING — проверочное уведомление.
  • ORDER_CREATED — создан новый заказ.
  • ORDER_CANCELLED — заказ отменен.
  • ORDER_STATUS_UPDATED — статус заказа изменен.
  • ORDER_RETURN_CREATED — создан новый невыкуп или возврат.
  • ORDER_CANCELLATION_REQUEST — создана заявка на отмену заказа (для DBS-магазинов).
  • ORDER_RETURN_STATUS_UPDATED — статус невыкупа или возврата изменен.

Enum: PING, ORDER_CREATED, ORDER_CANCELLED, ORDER_STATUS_UPDATED, ORDER_RETURN_CREATED, ORDER_CANCELLATION_REQUEST, ORDER_RETURN_STATUS_UPDATED

...rest

oneOf PingNotificationDTO

Проверочное уведомление.

notificationType = PING

...rest

oneOf OrderCreatedNotificationDTO

Уведомление о создании нового заказа.

notificationType = ORDER_CREATED

Чтобы получить подробную информацию о заказе

Используйте метод GET campaigns/{campaignId}/orders/{orderId}.

...rest

oneOf OrderStatusUpdatedNotificationDTO

Уведомление об изменении статуса заказа.

notificationType = ORDER_STATUS_UPDATED

Чтобы изменить статус заказа

Используйте метод PUT campaigns/{campaignId}/orders/{orderId}/status.

...rest

oneOf OrderCancelledNotificationDTO

Уведомление об отмене заказа.

notificationType = ORDER_CANCELLED

...rest

oneOf OrderCancellationRequestNotificationDTO

Уведомление о создании заявки на отмену заказа (для DBS-магазинов).

notificationType = ORDER_CANCELLATION_REQUEST

Чтобы подтвердить или отклонить заявку

...rest

oneOf OrderReturnCreatedNotificationDTO

Уведомление о создании нового невыкупа или возврата.

notificationType = ORDER_RETURN_CREATED

Чтобы получить подробную информацию о невыкупе или возврате

...rest

oneOf OrderReturnStatusUpdatedNotificationDTO

Уведомление о смене статуса невыкупа или возврата.

notificationType = ORDER_RETURN_STATUS_UPDATED

Чтобы получить подробную информацию о невыкупе или возврате

NotificationType

Тип уведомления:

  • PING — проверочное уведомление.
  • ORDER_CREATED — создан новый заказ.
  • ORDER_CANCELLED — заказ отменен.
  • ORDER_STATUS_UPDATED — статус заказа изменен.
  • ORDER_RETURN_CREATED — создан новый невыкуп или возврат.
  • ORDER_CANCELLATION_REQUEST — создана заявка на отмену заказа (для DBS-магазинов).
  • ORDER_RETURN_STATUS_UPDATED — статус невыкупа или возврата изменен.

Type

Description

NotificationType

Enum: PING, ORDER_CREATED, ORDER_CANCELLED, ORDER_STATUS_UPDATED, ORDER_RETURN_CREATED, ORDER_CANCELLATION_REQUEST, ORDER_RETURN_STATUS_UPDATED

PingNotificationDTO

Проверочное уведомление.

notificationType = PING

Name

Description

notificationType

Type: NotificationType

Тип уведомления:

  • PING — проверочное уведомление.
  • ORDER_CREATED — создан новый заказ.
  • ORDER_CANCELLED — заказ отменен.
  • ORDER_STATUS_UPDATED — статус заказа изменен.
  • ORDER_RETURN_CREATED — создан новый невыкуп или возврат.
  • ORDER_CANCELLATION_REQUEST — создана заявка на отмену заказа (для DBS-магазинов).
  • ORDER_RETURN_STATUS_UPDATED — статус невыкупа или возврата изменен.

Enum: PING, ORDER_CREATED, ORDER_CANCELLED, ORDER_STATUS_UPDATED, ORDER_RETURN_CREATED, ORDER_CANCELLATION_REQUEST, ORDER_RETURN_STATUS_UPDATED

time

Type: string<date-time>

Дата и время обработки уведомления со стороны магазина.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:00:00.213Z.

OrderCreatedNotificationDTO

Уведомление о создании нового заказа.

notificationType = ORDER_CREATED

Чтобы получить подробную информацию о заказе

Используйте метод GET campaigns/{campaignId}/orders/{orderId}.

Name

Description

campaignId*

Type: integer<int64>

Идентификатор магазина.

createdAt*

Type: string<date-time>

Дата и время создания заказа.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:00:00.213Z.

items*

Type: NotificationOrderItemDTO[]

Список товаров в заказе.
Информация о товаре в заказе.

notificationType*

Type: NotificationType

Тип уведомления:

  • PING — проверочное уведомление.
  • ORDER_CREATED — создан новый заказ.
  • ORDER_CANCELLED — заказ отменен.
  • ORDER_STATUS_UPDATED — статус заказа изменен.
  • ORDER_RETURN_CREATED — создан новый невыкуп или возврат.
  • ORDER_CANCELLATION_REQUEST — создана заявка на отмену заказа (для DBS-магазинов).
  • ORDER_RETURN_STATUS_UPDATED — статус невыкупа или возврата изменен.

Enum: PING, ORDER_CREATED, ORDER_CANCELLED, ORDER_STATUS_UPDATED, ORDER_RETURN_CREATED, ORDER_CANCELLATION_REQUEST, ORDER_RETURN_STATUS_UPDATED

orderId*

Type: integer<int64>

Идентификатор заказа.

OrderStatusUpdatedNotificationDTO

Уведомление об изменении статуса заказа.

notificationType = ORDER_STATUS_UPDATED

Чтобы изменить статус заказа

Используйте метод PUT campaigns/{campaignId}/orders/{orderId}/status.

Name

Description

campaignId*

Type: integer<int64>

Идентификатор магазина.

notificationType*

Type: NotificationType

Тип уведомления:

  • PING — проверочное уведомление.
  • ORDER_CREATED — создан новый заказ.
  • ORDER_CANCELLED — заказ отменен.
  • ORDER_STATUS_UPDATED — статус заказа изменен.
  • ORDER_RETURN_CREATED — создан новый невыкуп или возврат.
  • ORDER_CANCELLATION_REQUEST — создана заявка на отмену заказа (для DBS-магазинов).
  • ORDER_RETURN_STATUS_UPDATED — статус невыкупа или возврата изменен.

Enum: PING, ORDER_CREATED, ORDER_CANCELLED, ORDER_STATUS_UPDATED, ORDER_RETURN_CREATED, ORDER_CANCELLATION_REQUEST, ORDER_RETURN_STATUS_UPDATED

orderId*

Type: integer<int64>

Идентификатор заказа.

status*

Type: OrderStatusType

Статус заказа:

  • PLACING — оформляется, подготовка к резервированию.

  • RESERVED — зарезервирован, но недооформлен.

  • UNPAID — оформлен, но еще не оплачен (если выбрана оплата при оформлении).

  • PROCESSING — находится в обработке.

  • DELIVERY — передан в службу доставки.

  • PICKUP — доставлен в пункт самовывоза.

  • DELIVERED — получен покупателем.

  • CANCELLED — отменен.

  • PENDING — ожидает обработки со стороны продавца.

  • PARTIALLY_RETURNED — возвращен частично.

  • RETURNED — возвращен полностью.

  • UNKNOWN — неизвестный статус.

Также могут возвращаться другие значения. Обрабатывать их не требуется.

Enum: PLACING, RESERVED, UNPAID, PROCESSING, DELIVERY, PICKUP, DELIVERED, CANCELLED, PENDING, PARTIALLY_RETURNED, RETURNED, UNKNOWN

substatus*

Type: OrderSubstatusType

Этап обработки заказа (если он имеет статус PROCESSING) или причина отмены заказа (если он имеет статус CANCELLED).

  • Значения для заказа в статусе PROCESSING:

    • STARTED — заказ подтвержден, его можно начать обрабатывать.

    • READY_TO_SHIP — заказ собран и готов к отправке.

  • Значения для заказа в статусе CANCELLED:

    • RESERVATION_EXPIRED — покупатель не завершил оформление зарезервированного заказа в течение 10 минут.

    • USER_NOT_PAID — покупатель не оплатил заказ (для типа оплаты PREPAID) в течение 30 минут.

    • USER_UNREACHABLE — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия:

      • не менее 3 звонков с 8 до 21 в часовом поясе покупателя;
      • перерыв между первым и третьим звонком не менее 90 минут;
      • соединение не короче 5 секунд.

      Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400.

    • USER_CHANGED_MIND — покупатель отменил заказ по личным причинам.

    • USER_REFUSED_DELIVERY — покупателя не устроили условия доставки.

    • USER_REFUSED_PRODUCT — покупателю не подошел товар.

    • SHOP_FAILED — магазин не может выполнить заказ.

    • USER_REFUSED_QUALITY — покупателя не устроило качество товара.

    • REPLACING_ORDER — покупатель решил заменить товар другим по собственной инициативе.

    • PROCESSING_EXPIRED — значение более не используется.

    • PICKUP_EXPIRED — закончился срок хранения заказа в ПВЗ.

    • TOO_MANY_DELIVERY_DATE_CHANGES — заказ переносили слишком много раз.

    • DELIVERY_DATE_CHANGED_TOO_MUCH — заказ перенесен на слишком много дней.

  • TECHNICAL_ERROR — техническая ошибка на стороне Маркета. Обратитесь в поддержку.

Также могут возвращаться другие значения. Обрабатывать их не требуется.

Enum: RESERVATION_EXPIRED, USER_NOT_PAID, USER_UNREACHABLE, USER_CHANGED_MIND, USER_REFUSED_DELIVERY, USER_REFUSED_PRODUCT, SHOP_FAILED, USER_REFUSED_QUALITY, REPLACING_ORDER, PROCESSING_EXPIRED, PENDING_EXPIRED, SHOP_PENDING_CANCELLED, PENDING_CANCELLED, USER_FRAUD, RESERVATION_FAILED, USER_PLACED_OTHER_ORDER, USER_BOUGHT_CHEAPER, MISSING_ITEM, BROKEN_ITEM, WRONG_ITEM, PICKUP_EXPIRED, DELIVERY_PROBLEMS, LATE_CONTACT, CUSTOM, DELIVERY_SERVICE_FAILED, WAREHOUSE_FAILED_TO_SHIP, DELIVERY_SERIVCE_UNDELIVERED, DELIVERY_SERVICE_UNDELIVERED, PREORDER, AWAIT_CONFIRMATION, STARTED, PACKAGING, READY_TO_SHIP, SHIPPED, ASYNC_PROCESSING, USER_REFUSED_TO_PROVIDE_PERSONAL_DATA, WAITING_USER_INPUT, WAITING_BANK_DECISION, BANK_REJECT_CREDIT_OFFER, CUSTOMER_REJECT_CREDIT_OFFER, CREDIT_OFFER_FAILED, AWAIT_DELIVERY_DATES_CONFIRMATION, SERVICE_FAULT, DELIVERY_SERVICE_RECEIVED, USER_RECEIVED, WAITING_FOR_STOCKS, AS_PART_OF_MULTI_ORDER, READY_FOR_LAST_MILE, LAST_MILE_STARTED, ANTIFRAUD, DELIVERY_USER_NOT_RECEIVED, DELIVERY_SERVICE_DELIVERED, DELIVERED_USER_NOT_RECEIVED, USER_WANTED_ANOTHER_PAYMENT_METHOD, USER_RECEIVED_TECHNICAL_ERROR, USER_FORGOT_TO_USE_BONUS, RECEIVED_ON_DISTRIBUTION_CENTER, DELIVERY_SERVICE_NOT_RECEIVED, DELIVERY_SERVICE_LOST, SHIPPED_TO_WRONG_DELIVERY_SERVICE, DELIVERED_USER_RECEIVED, WAITING_TINKOFF_DECISION, COURIER_SEARCH, COURIER_FOUND, COURIER_IN_TRANSIT_TO_SENDER, COURIER_ARRIVED_TO_SENDER, COURIER_RECEIVED, COURIER_NOT_FOUND, COURIER_NOT_DELIVER_ORDER, COURIER_RETURNS_ORDER, COURIER_RETURNED_ORDER, WAITING_USER_DELIVERY_INPUT, PICKUP_SERVICE_RECEIVED, PICKUP_USER_RECEIVED, CANCELLED_COURIER_NOT_FOUND, COURIER_NOT_COME_FOR_ORDER, DELIVERY_NOT_MANAGED_REGION, INCOMPLETE_CONTACT_INFORMATION, INCOMPLETE_MULTI_ORDER, INAPPROPRIATE_WEIGHT_SIZE, TECHNICAL_ERROR, SORTING_CENTER_LOST, COURIER_SEARCH_NOT_STARTED, LOST, AWAIT_PAYMENT, AWAIT_LAVKA_RESERVATION, USER_WANTS_TO_CHANGE_ADDRESS, FULL_NOT_RANSOM, PRESCRIPTION_MISMATCH, DROPOFF_LOST, DROPOFF_CLOSED, DELIVERY_TO_STORE_STARTED, USER_WANTS_TO_CHANGE_DELIVERY_DATE, WRONG_ITEM_DELIVERED, DAMAGED_BOX, AWAIT_DELIVERY_DATES, LAST_MILE_COURIER_SEARCH, PICKUP_POINT_CLOSED, LEGAL_INFO_CHANGED, USER_HAS_NO_TIME_TO_PICKUP_ORDER, DELIVERY_CUSTOMS_ARRIVED, DELIVERY_CUSTOMS_CLEARED, FIRST_MILE_DELIVERY_SERVICE_RECEIVED, AWAIT_AUTO_DELIVERY_DATES, AWAIT_USER_PERSONAL_DATA, NO_PERSONAL_DATA_EXPIRED, CUSTOMS_PROBLEMS, AWAIT_CASHIER, WAITING_POSTPAID_BUDGET_RESERVATION, AWAIT_SERVICEABLE_CONFIRMATION, POSTPAID_BUDGET_RESERVATION_FAILED, AWAIT_CUSTOM_PRICE_CONFIRMATION, READY_FOR_PICKUP, TOO_MANY_DELIVERY_DATE_CHANGES, DELIVERY_DATE_CHANGED_TOO_MUCH, UNKNOWN

updatedAt*

Type: string<date-time>

Дата и время изменения статуса заказа.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:00:00.213Z.

OrderCancelledNotificationDTO

Уведомление об отмене заказа.

notificationType = ORDER_CANCELLED

Name

Description

campaignId*

Type: integer<int64>

Идентификатор магазина.

cancelledAt*

Type: string<date-time>

Дата и время отмены заказа.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:00:00.213Z.

items*

Type: NotificationOrderItemDTO[]

Список товаров в заказе.
Информация о товаре в заказе.

notificationType*

Type: NotificationType

Тип уведомления:

  • PING — проверочное уведомление.
  • ORDER_CREATED — создан новый заказ.
  • ORDER_CANCELLED — заказ отменен.
  • ORDER_STATUS_UPDATED — статус заказа изменен.
  • ORDER_RETURN_CREATED — создан новый невыкуп или возврат.
  • ORDER_CANCELLATION_REQUEST — создана заявка на отмену заказа (для DBS-магазинов).
  • ORDER_RETURN_STATUS_UPDATED — статус невыкупа или возврата изменен.

Enum: PING, ORDER_CREATED, ORDER_CANCELLED, ORDER_STATUS_UPDATED, ORDER_RETURN_CREATED, ORDER_CANCELLATION_REQUEST, ORDER_RETURN_STATUS_UPDATED

orderId*

Type: integer<int64>

Идентификатор заказа.

OrderCancellationRequestNotificationDTO

Уведомление о создании заявки на отмену заказа (для DBS-магазинов).

notificationType = ORDER_CANCELLATION_REQUEST

Чтобы подтвердить или отклонить заявку

Name

Description

campaignId*

Type: integer<int64>

Идентификатор магазина.

notificationType*

Type: NotificationType

Тип уведомления:

  • PING — проверочное уведомление.
  • ORDER_CREATED — создан новый заказ.
  • ORDER_CANCELLED — заказ отменен.
  • ORDER_STATUS_UPDATED — статус заказа изменен.
  • ORDER_RETURN_CREATED — создан новый невыкуп или возврат.
  • ORDER_CANCELLATION_REQUEST — создана заявка на отмену заказа (для DBS-магазинов).
  • ORDER_RETURN_STATUS_UPDATED — статус невыкупа или возврата изменен.

Enum: PING, ORDER_CREATED, ORDER_CANCELLED, ORDER_STATUS_UPDATED, ORDER_RETURN_CREATED, ORDER_CANCELLATION_REQUEST, ORDER_RETURN_STATUS_UPDATED

orderId*

Type: integer<int64>

Идентификатор заказа.

requestedAt*

Type: string<date-time>

Дата и время создания заявки на отмену заказа.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:00:00.213Z.

OrderReturnCreatedNotificationDTO

Уведомление о создании нового невыкупа или возврата.

notificationType = ORDER_RETURN_CREATED

Чтобы получить подробную информацию о невыкупе или возврате

Name

Description

campaignId*

Type: integer<int64>

Идентификатор магазина.

createdAt*

Type: string<date-time>

Дата и время создания невыкупа или возврата.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:00:00.213Z.

items*

Type: NotificationReturnItemDTO[]

Список товаров в невыкупе или возврате.
Информация о товаре в невыкупе или возврате.

notificationType*

Type: NotificationType

Тип уведомления:

  • PING — проверочное уведомление.
  • ORDER_CREATED — создан новый заказ.
  • ORDER_CANCELLED — заказ отменен.
  • ORDER_STATUS_UPDATED — статус заказа изменен.
  • ORDER_RETURN_CREATED — создан новый невыкуп или возврат.
  • ORDER_CANCELLATION_REQUEST — создана заявка на отмену заказа (для DBS-магазинов).
  • ORDER_RETURN_STATUS_UPDATED — статус невыкупа или возврата изменен.

Enum: PING, ORDER_CREATED, ORDER_CANCELLED, ORDER_STATUS_UPDATED, ORDER_RETURN_CREATED, ORDER_CANCELLATION_REQUEST, ORDER_RETURN_STATUS_UPDATED

orderId*

Type: integer<int64>

Идентификатор заказа.

returnId*

Type: integer<int64>

Идентификатор невыкупа или возврата.

returnType*

Type: ReturnType

Тип заказа для фильтрации:

  • UNREDEEMED — невыкуп.

  • RETURN — возврат.

Если не указать, в ответе будут и невыкупы, и возвраты.

Enum: UNREDEEMED, RETURN

OrderReturnStatusUpdatedNotificationDTO

Уведомление о смене статуса невыкупа или возврата.

notificationType = ORDER_RETURN_STATUS_UPDATED

Чтобы получить подробную информацию о невыкупе или возврате

Name

Description

campaignId*

Type: integer<int64>

Идентификатор магазина.

notificationType*

Type: NotificationType

Тип уведомления:

  • PING — проверочное уведомление.
  • ORDER_CREATED — создан новый заказ.
  • ORDER_CANCELLED — заказ отменен.
  • ORDER_STATUS_UPDATED — статус заказа изменен.
  • ORDER_RETURN_CREATED — создан новый невыкуп или возврат.
  • ORDER_CANCELLATION_REQUEST — создана заявка на отмену заказа (для DBS-магазинов).
  • ORDER_RETURN_STATUS_UPDATED — статус невыкупа или возврата изменен.

Enum: PING, ORDER_CREATED, ORDER_CANCELLED, ORDER_STATUS_UPDATED, ORDER_RETURN_CREATED, ORDER_CANCELLATION_REQUEST, ORDER_RETURN_STATUS_UPDATED

orderId*

Type: integer<int64>

Идентификатор заказа.

returnId*

Type: integer<int64>

Идентификатор невыкупа или возврата.

statuses*

Type: NotificationUpdatedReturnStatusesDTO

Информация об обновлении статуса невыкупа или возврата.

Возвращается только тот статус, который был изменен.

Для невыкупов приходит только shipmentStatus.

Параметр shipmentStatus не приходит для возвратов с опцией Быстрый возврат денег за дешевый брак, когда товар остается у покупателя.

NotificationOrderItemDTO

Информация о товаре в заказе.

Name

Description

count*

Type: integer

Количество товара.

offerId*

Type: string

Ваш SKU — идентификатор товара в вашей системе.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

SKU товара можно изменить в кабинете продавца на Маркете. О том, как это сделать, читайте в Справке Маркета для продавцов.

Что такое SKU и как его назначать

Min length: 1

Max length: 255

Pattern: ^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$

OrderStatusType

Статус заказа:

  • PLACING — оформляется, подготовка к резервированию.

  • RESERVED — зарезервирован, но недооформлен.

  • UNPAID — оформлен, но еще не оплачен (если выбрана оплата при оформлении).

  • PROCESSING — находится в обработке.

  • DELIVERY — передан в службу доставки.

  • PICKUP — доставлен в пункт самовывоза.

  • DELIVERED — получен покупателем.

  • CANCELLED — отменен.

  • PENDING — ожидает обработки со стороны продавца.

  • PARTIALLY_RETURNED — возвращен частично.

  • RETURNED — возвращен полностью.

  • UNKNOWN — неизвестный статус.

Также могут возвращаться другие значения. Обрабатывать их не требуется.

Type

Description

OrderStatusType

Enum: PLACING, RESERVED, UNPAID, PROCESSING, DELIVERY, PICKUP, DELIVERED, CANCELLED, PENDING, PARTIALLY_RETURNED, RETURNED, UNKNOWN

OrderSubstatusType

Этап обработки заказа (если он имеет статус PROCESSING) или причина отмены заказа (если он имеет статус CANCELLED).

  • Значения для заказа в статусе PROCESSING:

    • STARTED — заказ подтвержден, его можно начать обрабатывать.

    • READY_TO_SHIP — заказ собран и готов к отправке.

  • Значения для заказа в статусе CANCELLED:

    • RESERVATION_EXPIRED — покупатель не завершил оформление зарезервированного заказа в течение 10 минут.

    • USER_NOT_PAID — покупатель не оплатил заказ (для типа оплаты PREPAID) в течение 30 минут.

    • USER_UNREACHABLE — не удалось связаться с покупателем. Для отмены с этой причиной необходимо выполнить условия:

      • не менее 3 звонков с 8 до 21 в часовом поясе покупателя;
      • перерыв между первым и третьим звонком не менее 90 минут;
      • соединение не короче 5 секунд.

      Если хотя бы одно из этих условий не выполнено (кроме случая, когда номер недоступен), отменить заказ не получится. Вернется ответ с кодом ошибки 400.

    • USER_CHANGED_MIND — покупатель отменил заказ по личным причинам.

    • USER_REFUSED_DELIVERY — покупателя не устроили условия доставки.

    • USER_REFUSED_PRODUCT — покупателю не подошел товар.

    • SHOP_FAILED — магазин не может выполнить заказ.

    • USER_REFUSED_QUALITY — покупателя не устроило качество товара.

    • REPLACING_ORDER — покупатель решил заменить товар другим по собственной инициативе.

    • PROCESSING_EXPIRED — значение более не используется.

    • PICKUP_EXPIRED — закончился срок хранения заказа в ПВЗ.

    • TOO_MANY_DELIVERY_DATE_CHANGES — заказ переносили слишком много раз.

    • DELIVERY_DATE_CHANGED_TOO_MUCH — заказ перенесен на слишком много дней.

  • TECHNICAL_ERROR — техническая ошибка на стороне Маркета. Обратитесь в поддержку.

Также могут возвращаться другие значения. Обрабатывать их не требуется.

Type

Description

OrderSubstatusType

Enum: RESERVATION_EXPIRED, USER_NOT_PAID, USER_UNREACHABLE, USER_CHANGED_MIND, USER_REFUSED_DELIVERY, USER_REFUSED_PRODUCT, SHOP_FAILED, USER_REFUSED_QUALITY, REPLACING_ORDER, PROCESSING_EXPIRED, PENDING_EXPIRED, SHOP_PENDING_CANCELLED, PENDING_CANCELLED, USER_FRAUD, RESERVATION_FAILED, USER_PLACED_OTHER_ORDER, USER_BOUGHT_CHEAPER, MISSING_ITEM, BROKEN_ITEM, WRONG_ITEM, PICKUP_EXPIRED, DELIVERY_PROBLEMS, LATE_CONTACT, CUSTOM, DELIVERY_SERVICE_FAILED, WAREHOUSE_FAILED_TO_SHIP, DELIVERY_SERIVCE_UNDELIVERED, DELIVERY_SERVICE_UNDELIVERED, PREORDER, AWAIT_CONFIRMATION, STARTED, PACKAGING, READY_TO_SHIP, SHIPPED, ASYNC_PROCESSING, USER_REFUSED_TO_PROVIDE_PERSONAL_DATA, WAITING_USER_INPUT, WAITING_BANK_DECISION, BANK_REJECT_CREDIT_OFFER, CUSTOMER_REJECT_CREDIT_OFFER, CREDIT_OFFER_FAILED, AWAIT_DELIVERY_DATES_CONFIRMATION, SERVICE_FAULT, DELIVERY_SERVICE_RECEIVED, USER_RECEIVED, WAITING_FOR_STOCKS, AS_PART_OF_MULTI_ORDER, READY_FOR_LAST_MILE, LAST_MILE_STARTED, ANTIFRAUD, DELIVERY_USER_NOT_RECEIVED, DELIVERY_SERVICE_DELIVERED, DELIVERED_USER_NOT_RECEIVED, USER_WANTED_ANOTHER_PAYMENT_METHOD, USER_RECEIVED_TECHNICAL_ERROR, USER_FORGOT_TO_USE_BONUS, RECEIVED_ON_DISTRIBUTION_CENTER, DELIVERY_SERVICE_NOT_RECEIVED, DELIVERY_SERVICE_LOST, SHIPPED_TO_WRONG_DELIVERY_SERVICE, DELIVERED_USER_RECEIVED, WAITING_TINKOFF_DECISION, COURIER_SEARCH, COURIER_FOUND, COURIER_IN_TRANSIT_TO_SENDER, COURIER_ARRIVED_TO_SENDER, COURIER_RECEIVED, COURIER_NOT_FOUND, COURIER_NOT_DELIVER_ORDER, COURIER_RETURNS_ORDER, COURIER_RETURNED_ORDER, WAITING_USER_DELIVERY_INPUT, PICKUP_SERVICE_RECEIVED, PICKUP_USER_RECEIVED, CANCELLED_COURIER_NOT_FOUND, COURIER_NOT_COME_FOR_ORDER, DELIVERY_NOT_MANAGED_REGION, INCOMPLETE_CONTACT_INFORMATION, INCOMPLETE_MULTI_ORDER, INAPPROPRIATE_WEIGHT_SIZE, TECHNICAL_ERROR, SORTING_CENTER_LOST, COURIER_SEARCH_NOT_STARTED, LOST, AWAIT_PAYMENT, AWAIT_LAVKA_RESERVATION, USER_WANTS_TO_CHANGE_ADDRESS, FULL_NOT_RANSOM, PRESCRIPTION_MISMATCH, DROPOFF_LOST, DROPOFF_CLOSED, DELIVERY_TO_STORE_STARTED, USER_WANTS_TO_CHANGE_DELIVERY_DATE, WRONG_ITEM_DELIVERED, DAMAGED_BOX, AWAIT_DELIVERY_DATES, LAST_MILE_COURIER_SEARCH, PICKUP_POINT_CLOSED, LEGAL_INFO_CHANGED, USER_HAS_NO_TIME_TO_PICKUP_ORDER, DELIVERY_CUSTOMS_ARRIVED, DELIVERY_CUSTOMS_CLEARED, FIRST_MILE_DELIVERY_SERVICE_RECEIVED, AWAIT_AUTO_DELIVERY_DATES, AWAIT_USER_PERSONAL_DATA, NO_PERSONAL_DATA_EXPIRED, CUSTOMS_PROBLEMS, AWAIT_CASHIER, WAITING_POSTPAID_BUDGET_RESERVATION, AWAIT_SERVICEABLE_CONFIRMATION, POSTPAID_BUDGET_RESERVATION_FAILED, AWAIT_CUSTOM_PRICE_CONFIRMATION, READY_FOR_PICKUP, TOO_MANY_DELIVERY_DATE_CHANGES, DELIVERY_DATE_CHANGED_TOO_MUCH, UNKNOWN

NotificationReturnItemDTO

Информация о товаре в невыкупе или возврате.

Name

Description

count*

Type: integer

Количество товара.

offerId*

Type: string

Ваш SKU — идентификатор товара в вашей системе.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

SKU товара можно изменить в кабинете продавца на Маркете. О том, как это сделать, читайте в Справке Маркета для продавцов.

Что такое SKU и как его назначать

Min length: 1

Max length: 255

Pattern: ^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$

ReturnType

Тип заказа для фильтрации:

  • UNREDEEMED — невыкуп.

  • RETURN — возврат.

Если не указать, в ответе будут и невыкупы, и возвраты.

Type

Description

ReturnType

Enum: UNREDEEMED, RETURN

NotificationUpdatedReturnStatusesDTO

Информация об обновлении статуса невыкупа или возврата.

Возвращается только тот статус, который был изменен.

Для невыкупов приходит только shipmentStatus.

Параметр shipmentStatus не приходит для возвратов с опцией Быстрый возврат денег за дешевый брак, когда товар остается у покупателя.

Name

Description

refundStatus

Type: RefundStatusType

Статус возврата денег:

  • STARTED_BY_USER — создан клиентом из личного кабинета.

  • REFUND_IN_PROGRESS — ждет решение о возврате денег.

  • REFUNDED — по возврату проведены все возвратные денежные транзакции.

  • FAILED — невозможно провести возврат покупателю.

  • WAITING_FOR_DECISION — ожидает решения.

  • DECISION_MADE — по возврату принято решение.

  • REFUNDED_WITH_BONUSES — возврат осуществлен баллами Плюса или промокодом.

  • REFUNDED_BY_SHOP — магазин сделал самостоятельно возврат денег.

  • COMPLETE_WITHOUT_REFUND — возврат денег не требуется.

  • CANCELLED — возврат отменен.

  • UNKNOWN — неизвестный статус.

Enum: STARTED_BY_USER, REFUND_IN_PROGRESS, REFUNDED, FAILED, WAITING_FOR_DECISION, DECISION_MADE, REFUNDED_WITH_BONUSES, REFUNDED_BY_SHOP, CANCELLED, COMPLETE_WITHOUT_REFUND, UNKNOWN

shipmentStatus

Type: ReturnShipmentStatusType

Статус передачи возврата:

  • CREATED — возврат создан.

  • RECEIVED — принят у покупателя.

  • IN_TRANSIT — возврат в пути.

  • READY_FOR_PICKUP — возврат готов к выдаче магазину.

  • PICKED — возврат выдан магазину.

  • LOST — возврат утерян при транспортировке.

  • EXPIRED — покупатель не принес товар на возврат вовремя.

  • CANCELLED — возврат отменен.

  • FULFILMENT_RECEIVED — возврат принят на складе Маркета.

  • PREPARED_FOR_UTILIZATION — возврат передан в утилизацию.

  • NOT_IN_DEMAND — возврат не забрали с почты.

  • UTILIZED — возврат утилизирован.

  • READY_FOR_EXPROPRIATION — товары в возврате направлены на перепродажу.

  • RECEIVED_FOR_EXPROPRIATION — товары в возврате приняты для перепродажи.

  • UNKNOWN — неизвестный статус.

Enum: CREATED, RECEIVED, IN_TRANSIT, READY_FOR_PICKUP, PICKED, LOST, EXPIRED, CANCELLED, FULFILMENT_RECEIVED, PREPARED_FOR_UTILIZATION, NOT_IN_DEMAND, UTILIZED, READY_FOR_EXPROPRIATION, RECEIVED_FOR_EXPROPRIATION, UNKNOWN

RefundStatusType

Статус возврата денег:

  • STARTED_BY_USER — создан клиентом из личного кабинета.

  • REFUND_IN_PROGRESS — ждет решение о возврате денег.

  • REFUNDED — по возврату проведены все возвратные денежные транзакции.

  • FAILED — невозможно провести возврат покупателю.

  • WAITING_FOR_DECISION — ожидает решения.

  • DECISION_MADE — по возврату принято решение.

  • REFUNDED_WITH_BONUSES — возврат осуществлен баллами Плюса или промокодом.

  • REFUNDED_BY_SHOP — магазин сделал самостоятельно возврат денег.

  • COMPLETE_WITHOUT_REFUND — возврат денег не требуется.

  • CANCELLED — возврат отменен.

  • UNKNOWN — неизвестный статус.

Type

Description

RefundStatusType

Enum: STARTED_BY_USER, REFUND_IN_PROGRESS, REFUNDED, FAILED, WAITING_FOR_DECISION, DECISION_MADE, REFUNDED_WITH_BONUSES, REFUNDED_BY_SHOP, CANCELLED, COMPLETE_WITHOUT_REFUND, UNKNOWN

ReturnShipmentStatusType

Статус передачи возврата:

  • CREATED — возврат создан.

  • RECEIVED — принят у покупателя.

  • IN_TRANSIT — возврат в пути.

  • READY_FOR_PICKUP — возврат готов к выдаче магазину.

  • PICKED — возврат выдан магазину.

  • LOST — возврат утерян при транспортировке.

  • EXPIRED — покупатель не принес товар на возврат вовремя.

  • CANCELLED — возврат отменен.

  • FULFILMENT_RECEIVED — возврат принят на складе Маркета.

  • PREPARED_FOR_UTILIZATION — возврат передан в утилизацию.

  • NOT_IN_DEMAND — возврат не забрали с почты.

  • UTILIZED — возврат утилизирован.

  • READY_FOR_EXPROPRIATION — товары в возврате направлены на перепродажу.

  • RECEIVED_FOR_EXPROPRIATION — товары в возврате приняты для перепродажи.

  • UNKNOWN — неизвестный статус.

Type

Description

ReturnShipmentStatusType

Enum: CREATED, RECEIVED, IN_TRANSIT, READY_FOR_PICKUP, PICKED, LOST, EXPIRED, CANCELLED, FULFILMENT_RECEIVED, PREPARED_FOR_UTILIZATION, NOT_IN_DEMAND, UTILIZED, READY_FOR_EXPROPRIATION, RECEIVED_FOR_EXPROPRIATION, UNKNOWN

Responses

200 OK

Ответ на корректный запрос с информацией об обработке уведомления.

Body

application/json
{
    "version": "string",
    "name": "string",
    "time": "2022-12-29T18:02:01Z"
}

Name

Description

name*

Type: string

Название интеграции.

Min length: 1

Max length: 100

time*

Type: string<date-time>

Дата и время начала обработки уведомления в формате UTC.

version*

Type: string

Версия интеграции.

Min length: 1

Max length: 100

400 Bad Request

Если Маркет прислал некорректное уведомление, верните статус 400 с описанием ошибки.

Body

application/json
{
    "error": {
        "type": "UNKNOWN",
        "message": "string"
    }
}

Name

Description

error

Type: NotificationApiErrorDTO

Ошибка при обработке уведомления.

NotificationApiErrorDTO

Ошибка при обработке уведомления.

Name

Description

message

Type: string

Описание ошибки.

type

Type: NotificationApiErrorType

Тип ошибки:

  • UNKNOWN — неизвестная ошибка.
  • WRONG_EVENT_FORMAT — неправильный тип уведомления.
  • DUPLICATED_EVENT — дублирующее уведомление.

Enum: UNKNOWN, WRONG_EVENT_FORMAT, DUPLICATED_EVENT

NotificationApiErrorType

Тип ошибки:

  • UNKNOWN — неизвестная ошибка.
  • WRONG_EVENT_FORMAT — неправильный тип уведомления.
  • DUPLICATED_EVENT — дублирующее уведомление.

Type

Description

NotificationApiErrorType

Enum: UNKNOWN, WRONG_EVENT_FORMAT, DUPLICATED_EVENT

500 Internal Server Error

Если произошла техническая ошибка на вашей стороне, верните статус 500. API магазина не отвечает

Body

application/json
{
    "error": {
        "type": "UNKNOWN",
        "message": "string"
    }
}

Name

Description

error

Type: NotificationApiErrorDTO

Ошибка при обработке уведомления.