Receiving notifications
The market sends notifications about events to the store:
- creating a new order;
- order modification;
- order status change;
- create a new chat with the customer;
- adding a new message in the chat;
- the beginning of a dispute;
- the end of the dispute;
- creating a new product review;
- creating a new review comment;
- creating an order cancellation request;
- cancellation of the order;
- creating a new non-purchase or refund;
- changing the non-purchase or refund status.
Учитывайте эти особенности в работе с уведомлениями
-
Yandex.Market can send multiple notifications for the same event.
In some cases, this is normal behavior. For example, there may be several notifications with a change in the order status due to the search for a courier.
-
The time in the notification, in the response to a request to the Market, and in your system may vary.
This is due to the fact that at the time the notification is sent, the order status may already be different.
In the request
POST notificationthe time of the event comes increatedAt,updatedAtorcancelledAt. The choice of the parameter depends on the type of notification.
Consider the later time of the event to be relevant. It can be in a notification, returned in response to a request to the Market, or stored in your system.
Timeout for receiving a response: 10 seconds for regular notifications and 1 second for verification notification PING.
Request
POST
/notification
Body
application/json
{
"notificationType": "PING",
"time": "2025-01-01T00:00:00Z"
}
|
Name |
Description |
|
notificationType |
Type: string Notification type:
Enum: |
One of 17 types
-
Type: object
notificationType
Type: string
Notification type:
PING— verification notification.ORDER_CREATED— A new order has been created.ORDER_CANCELLED— The order has been cancelled.ORDER_STATUS_UPDATED— the order status has been changed.ORDER_RETURN_CREATED— A new non-purchase or refund has been created.ORDER_CANCELLATION_REQUEST— an order cancellation request has been created (for DBS-stores).ORDER_RETURN_STATUS_UPDATED— the non-purchase or refund status has been changed.ORDER_UPDATED— the order has been changed.GOODS_FEEDBACK_CREATED— A new product review has been created.GOODS_FEEDBACK_COMMENT_CREATED— A new product review comment has been created.CHAT_CREATED— A new chat with the buyer has been created.CHAT_MESSAGE_SENT— A new chat message has been added.CHAT_ARBITRAGE_STARTED— at the request of the buyer, a dispute began.CHAT_ARBITRAGE_FINISHED— the dispute is over.QUESTION_CREATED— A new question has been created.QUESTION_ANSWER_CREATED— A new answer to the question has been created.QUESTION_COMMENT_CREATED— A new comment has been created on the answer to the question.
Enum:
PING,ORDER_CREATED,ORDER_CANCELLED,ORDER_STATUS_UPDATED,ORDER_RETURN_CREATED,ORDER_CANCELLATION_REQUEST,ORDER_RETURN_STATUS_UPDATED,ORDER_UPDATED,GOODS_FEEDBACK_CREATED,GOODS_FEEDBACK_COMMENT_CREATED,CHAT_CREATED,CHAT_MESSAGE_SENT,CHAT_ARBITRAGE_STARTED,CHAT_ARBITRAGE_FINISHED,QUESTION_CREATED,QUESTION_ANSWER_CREATED,QUESTION_COMMENT_CREATEDtime
Type: string<date-time>
The date and time when the notification was processed by the store.
Date format: ISO 8601 with an offset relative to UTC. For example,
2017-11-21T00:00:00.213Z.Example:
2025-01-01T00:00:00ZVerification notification.
notificationType=PINGExample
{ "notificationType": "PING", "time": "2025-01-01T00:00:00Z" } -
Type: object
campaignId
Type: integer
The ID of the campaign (store) — The technical identifier that represents your store in the Yandex Market system when working through the API. It is uniquely linked to your store, but it is intended only for automated interaction.
You can find it using a query GET v2/campaigns or find it in the seller's office on the Market. Click on your account icon → Settings and in the menu on the left, select APIs and modules:
- block Campaign ID;
- tab Query log → drop-down list in the block Show logs.
⚠️ Do not confuse it with:
- the store's identifier, which is displayed in the merchant's personal account.
- advertising campaigns.
Min value:
1createdAt
Type: string<date-time>
Date and time of the order creation.
Date format: ISO 8601 with an offset relative to UTC. For example,
2017-11-21T00:00:00.213Z.Example:
2025-01-01T00:00:00Zitems
Type: object[]
count
Type: integer
The quantity of the product.
offerId
Type: string
Your SKU — the product ID in your system.
Usage rules SKU:
-
For each product SKU there must be one.
-
Already set SKU it cannot be released and reused for another product. Each product should receive a new identifier that has never been used in your catalog before.
SKU The product can be changed in the seller's account on the Market. Read about how to do this. in the Help of the Market for sellers.
Warning
Spaces at the beginning and end of the value are automatically deleted. For example,
" SKU123 "and"SKU123"they will be treated as identical values.What is SKU and how to assign it
Min length:
1Max length:
255Pattern:
^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$Example:
exampleThe list of products in the order.
Example
[ { "offerId": "example", "count": 0 } ]notificationType
Type: string
Notification type:
PING— verification notification.ORDER_CREATED— A new order has been created.ORDER_CANCELLED— The order has been cancelled.ORDER_STATUS_UPDATED— the order status has been changed.ORDER_RETURN_CREATED— A new non-purchase or refund has been created.ORDER_CANCELLATION_REQUEST— an order cancellation request has been created (for DBS-stores).ORDER_RETURN_STATUS_UPDATED— the non-purchase or refund status has been changed.ORDER_UPDATED— the order has been changed.GOODS_FEEDBACK_CREATED— A new product review has been created.GOODS_FEEDBACK_COMMENT_CREATED— A new product review comment has been created.CHAT_CREATED— A new chat with the buyer has been created.CHAT_MESSAGE_SENT— A new chat message has been added.CHAT_ARBITRAGE_STARTED— at the request of the buyer, a dispute began.CHAT_ARBITRAGE_FINISHED— the dispute is over.QUESTION_CREATED— A new question has been created.QUESTION_ANSWER_CREATED— A new answer to the question has been created.QUESTION_COMMENT_CREATED— A new comment has been created on the answer to the question.
Enum:
PING,ORDER_CREATED,ORDER_CANCELLED,ORDER_STATUS_UPDATED,ORDER_RETURN_CREATED,ORDER_CANCELLATION_REQUEST,ORDER_RETURN_STATUS_UPDATED,ORDER_UPDATED,GOODS_FEEDBACK_CREATED,GOODS_FEEDBACK_COMMENT_CREATED,CHAT_CREATED,CHAT_MESSAGE_SENT,CHAT_ARBITRAGE_STARTED,CHAT_ARBITRAGE_FINISHED,QUESTION_CREATED,QUESTION_ANSWER_CREATED,QUESTION_COMMENT_CREATEDorderId
Type: integer
The order ID.
Notification of the creation of a new order.
notificationType=ORDER_CREATEDМетоды, которые могут быть полезны
POST v2/campaigns/{campaignId}/orders/{orderId}/external-id — transmitting the external order ID.
POST v1/businesses/{businessId}/orders — getting detailed information about the order (by
orderIds).Example
{ "notificationType": "PING", "orderId": 0, "campaignId": 1, "items": [ { "offerId": "example", "count": 0 } ], "createdAt": "2025-01-01T00:00:00Z" } -
Type: object
campaignId
Type: integer
The ID of the campaign (store) — The technical identifier that represents your store in the Yandex Market system when working through the API. It is uniquely linked to your store, but it is intended only for automated interaction.
You can find it using a query GET v2/campaigns or find it in the seller's office on the Market. Click on your account icon → Settings and in the menu on the left, select APIs and modules:
- block Campaign ID;
- tab Query log → drop-down list in the block Show logs.
⚠️ Do not confuse it with:
- the store's identifier, which is displayed in the merchant's personal account.
- advertising campaigns.
Min value:
1notificationType
Type: string
Notification type:
PING— verification notification.ORDER_CREATED— A new order has been created.ORDER_CANCELLED— The order has been cancelled.ORDER_STATUS_UPDATED— the order status has been changed.ORDER_RETURN_CREATED— A new non-purchase or refund has been created.ORDER_CANCELLATION_REQUEST— an order cancellation request has been created (for DBS-stores).ORDER_RETURN_STATUS_UPDATED— the non-purchase or refund status has been changed.ORDER_UPDATED— the order has been changed.GOODS_FEEDBACK_CREATED— A new product review has been created.GOODS_FEEDBACK_COMMENT_CREATED— A new product review comment has been created.CHAT_CREATED— A new chat with the buyer has been created.CHAT_MESSAGE_SENT— A new chat message has been added.CHAT_ARBITRAGE_STARTED— at the request of the buyer, a dispute began.CHAT_ARBITRAGE_FINISHED— the dispute is over.QUESTION_CREATED— A new question has been created.QUESTION_ANSWER_CREATED— A new answer to the question has been created.QUESTION_COMMENT_CREATED— A new comment has been created on the answer to the question.
Enum:
PING,ORDER_CREATED,ORDER_CANCELLED,ORDER_STATUS_UPDATED,ORDER_RETURN_CREATED,ORDER_CANCELLATION_REQUEST,ORDER_RETURN_STATUS_UPDATED,ORDER_UPDATED,GOODS_FEEDBACK_CREATED,GOODS_FEEDBACK_COMMENT_CREATED,CHAT_CREATED,CHAT_MESSAGE_SENT,CHAT_ARBITRAGE_STARTED,CHAT_ARBITRAGE_FINISHED,QUESTION_CREATED,QUESTION_ANSWER_CREATED,QUESTION_COMMENT_CREATEDorderId
Type: integer
The order ID.
status
Type: string
Order status:
-
PLACING— it is being processed, preparing for the reservation. -
RESERVED— reserved, but under-registered (only for LaaS). -
UNPAID— issued, but not yet paid (if payment is selected at checkout). -
PROCESSING— it is under processing. -
DELIVERY— transferred to the delivery service. -
PICKUP— delivered to the pick-up point. -
DELIVERED— received by the buyer. -
CANCELLED— cancelled. -
PENDING— awaiting processing by the seller. -
PARTIALLY_RETURNED— partially refunded. -
RETURNED— returned in full. -
UNKNOWN— unknown status.
Other values may also be returned. You don't need to process them.
Enum:
PLACING,RESERVED,UNPAID,PROCESSING,DELIVERY,PICKUP,DELIVERED,CANCELLED,PENDING,PARTIALLY_RETURNED,RETURNED,UNKNOWNsubstatus
Type: string
Order processing stage (status
PROCESSING) or the reason for the cancellation of the order (statusCANCELLED).-
Order values in the status
PROCESSING:-
STARTED— The order has been confirmed, and it can be processed. -
READY_TO_SHIP— the order is assembled and ready for shipment.
-
-
Order values in the status
CANCELLED:-
RESERVATION_EXPIRED— The customer did not complete the reserved order within 10 minutes. -
USER_NOT_PAID— the buyer did not pay for the order (for the payment typePREPAID) for 30 minutes. -
USER_UNREACHABLE— couldn't contact the buyer. To cancel with this reason, the following conditions must be met:- at least 3 calls from 8 to 21 in the buyer's time zone;
- the break between the first and third calls is at least 90 minutes;
- the connection is no shorter than 5 seconds.
If at least one of these conditions is not met (except when the number is unavailable), you will not be able to cancel the order. A response with the error code 400 will be returned.
-
USER_CHANGED_MIND— the customer cancelled the order for personal reasons. -
USER_REFUSED_DELIVERY— the buyer was not satisfied with the terms of delivery. -
USER_REFUSED_PRODUCT— the product did not fit the buyer. -
SHOP_FAILED— the store cannot complete the order. -
USER_REFUSED_QUALITY— the buyer was not satisfied with the quality of the product. -
USER_IDENTIFICATION_MISMATCH— The buyer's identification document does not match the data in the order. -
REPLACING_ORDER— the buyer decided to replace the product with another one on his own initiative. -
PROCESSING_EXPIRED— the value is no longer used. -
PICKUP_EXPIRED— The shelf life of the order at the pick-up point has expired. -
TOO_MANY_DELIVERY_DATE_CHANGES— the order has been postponed too many times. -
TOO_LONG_DELIVERY— The order is taking too long to be delivered. -
INCORRECT_PERSONAL_DATA— For an order from abroad, the recipient's information is incorrect, and the order will not be checked at customs.
-
-
TECHNICAL_ERROR— a technical error on the Market's side. Contact support.
Other values may also be returned. You don't need to process them.
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_SERVICE_UNDELIVERED,PREORDER,AWAIT_CONFIRMATION,STARTED,PACKAGING,READY_TO_SHIP,SHIPPED,ASYNC_PROCESSING,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,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,TOO_LONG_DELIVERY,DEFERRED_PAYMENT,POSTPAID_FAILED,INCORRECT_PERSONAL_DATA,CUSTOMS_FAILED_MARKET,CUSTOMS_FAILED_USER_COMMERCIAL_ITEMS,CUSTOMS_FAILED_USER_DUTY_NOT_PAID,CUSTOMS_FAILED_USER_INVALID_PERSONAL_DATA,CUSTOMS_FAILED_USER_ADDITIONAL_DATA_NOT_PROVIDED,AWAIT_PAYMENT_AFTER_DELIVERY,AWAIT_USER_STEAM_FAST_URL,USER_IDENTIFICATION_MISMATCH,UNKNOWNupdatedAt
Type: string<date-time>
Date and time of the order status change.
Date format: ISO 8601 with an offset relative to UTC. For example,
2017-11-21T00:00:00.213Z.Example:
2025-01-01T00:00:00ZNotification of a change in the order status.
notificationType=ORDER_STATUS_UPDATEDЧтобы изменить статус заказа
Use the method PUT v2/campaigns/{campaignId}/orders/{orderId}/status.
Example
{ "notificationType": "PING", "orderId": 0, "campaignId": 1, "status": "PLACING", "substatus": "RESERVATION_EXPIRED", "updatedAt": "2025-01-01T00:00:00Z" } -
Type: object
campaignId
Type: integer
The ID of the campaign (store) — The technical identifier that represents your store in the Yandex Market system when working through the API. It is uniquely linked to your store, but it is intended only for automated interaction.
You can find it using a query GET v2/campaigns or find it in the seller's office on the Market. Click on your account icon → Settings and in the menu on the left, select APIs and modules:
- block Campaign ID;
- tab Query log → drop-down list in the block Show logs.
⚠️ Do not confuse it with:
- the store's identifier, which is displayed in the merchant's personal account.
- advertising campaigns.
Min value:
1cancelledAt
Type: string<date-time>
Date and time of cancellation of the order.
Date format: ISO 8601 with an offset relative to UTC. For example,
2017-11-21T00:00:00.213Z.Example:
2025-01-01T00:00:00Zitems
Type: object[]
count
Type: integer
The quantity of the product.
offerId
Type: string
Your SKU — the product ID in your system.
Usage rules SKU:
-
For each product SKU there must be one.
-
Already set SKU it cannot be released and reused for another product. Each product should receive a new identifier that has never been used in your catalog before.
SKU The product can be changed in the seller's account on the Market. Read about how to do this. in the Help of the Market for sellers.
Warning
Spaces at the beginning and end of the value are automatically deleted. For example,
" SKU123 "and"SKU123"they will be treated as identical values.What is SKU and how to assign it
Min length:
1Max length:
255Pattern:
^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$Example:
exampleThe list of products in the order.
Example
[ { "offerId": "example", "count": 0 } ]notificationType
Type: string
Notification type:
PING— verification notification.ORDER_CREATED— A new order has been created.ORDER_CANCELLED— The order has been cancelled.ORDER_STATUS_UPDATED— the order status has been changed.ORDER_RETURN_CREATED— A new non-purchase or refund has been created.ORDER_CANCELLATION_REQUEST— an order cancellation request has been created (for DBS-stores).ORDER_RETURN_STATUS_UPDATED— the non-purchase or refund status has been changed.ORDER_UPDATED— the order has been changed.GOODS_FEEDBACK_CREATED— A new product review has been created.GOODS_FEEDBACK_COMMENT_CREATED— A new product review comment has been created.CHAT_CREATED— A new chat with the buyer has been created.CHAT_MESSAGE_SENT— A new chat message has been added.CHAT_ARBITRAGE_STARTED— at the request of the buyer, a dispute began.CHAT_ARBITRAGE_FINISHED— the dispute is over.QUESTION_CREATED— A new question has been created.QUESTION_ANSWER_CREATED— A new answer to the question has been created.QUESTION_COMMENT_CREATED— A new comment has been created on the answer to the question.
Enum:
PING,ORDER_CREATED,ORDER_CANCELLED,ORDER_STATUS_UPDATED,ORDER_RETURN_CREATED,ORDER_CANCELLATION_REQUEST,ORDER_RETURN_STATUS_UPDATED,ORDER_UPDATED,GOODS_FEEDBACK_CREATED,GOODS_FEEDBACK_COMMENT_CREATED,CHAT_CREATED,CHAT_MESSAGE_SENT,CHAT_ARBITRAGE_STARTED,CHAT_ARBITRAGE_FINISHED,QUESTION_CREATED,QUESTION_ANSWER_CREATED,QUESTION_COMMENT_CREATEDorderId
Type: integer
The order ID.
Notification of order cancellation.
notificationType=ORDER_CANCELLEDExample
{ "notificationType": "PING", "orderId": 0, "campaignId": 1, "items": [ { "offerId": "example", "count": 0 } ], "cancelledAt": "2025-01-01T00:00:00Z" } -
Type: object
campaignId
Type: integer
The ID of the campaign (store) — The technical identifier that represents your store in the Yandex Market system when working through the API. It is uniquely linked to your store, but it is intended only for automated interaction.
You can find it using a query GET v2/campaigns or find it in the seller's office on the Market. Click on your account icon → Settings and in the menu on the left, select APIs and modules:
- block Campaign ID;
- tab Query log → drop-down list in the block Show logs.
⚠️ Do not confuse it with:
- the store's identifier, which is displayed in the merchant's personal account.
- advertising campaigns.
Min value:
1notificationType
Type: string
Notification type:
PING— verification notification.ORDER_CREATED— A new order has been created.ORDER_CANCELLED— The order has been cancelled.ORDER_STATUS_UPDATED— the order status has been changed.ORDER_RETURN_CREATED— A new non-purchase or refund has been created.ORDER_CANCELLATION_REQUEST— an order cancellation request has been created (for DBS-stores).ORDER_RETURN_STATUS_UPDATED— the non-purchase or refund status has been changed.ORDER_UPDATED— the order has been changed.GOODS_FEEDBACK_CREATED— A new product review has been created.GOODS_FEEDBACK_COMMENT_CREATED— A new product review comment has been created.CHAT_CREATED— A new chat with the buyer has been created.CHAT_MESSAGE_SENT— A new chat message has been added.CHAT_ARBITRAGE_STARTED— at the request of the buyer, a dispute began.CHAT_ARBITRAGE_FINISHED— the dispute is over.QUESTION_CREATED— A new question has been created.QUESTION_ANSWER_CREATED— A new answer to the question has been created.QUESTION_COMMENT_CREATED— A new comment has been created on the answer to the question.
Enum:
PING,ORDER_CREATED,ORDER_CANCELLED,ORDER_STATUS_UPDATED,ORDER_RETURN_CREATED,ORDER_CANCELLATION_REQUEST,ORDER_RETURN_STATUS_UPDATED,ORDER_UPDATED,GOODS_FEEDBACK_CREATED,GOODS_FEEDBACK_COMMENT_CREATED,CHAT_CREATED,CHAT_MESSAGE_SENT,CHAT_ARBITRAGE_STARTED,CHAT_ARBITRAGE_FINISHED,QUESTION_CREATED,QUESTION_ANSWER_CREATED,QUESTION_COMMENT_CREATEDorderId
Type: integer
The order ID.
requestedAt
Type: string<date-time>
The date and time when the cancellation request was created.
Date format: ISO 8601 with an offset relative to UTC. For example,
2017-11-21T00:00:00.213Z.Example:
2025-01-01T00:00:00ZNotification of the creation of an order cancellation request (for DBS-stores).
notificationType=ORDER_CANCELLATION_REQUESTIt is not sent if the order is delivered to the Market's PVZ.
Чтобы подтвердить или отклонить заявку
Example
{ "notificationType": "PING", "orderId": 0, "campaignId": 1, "requestedAt": "2025-01-01T00:00:00Z" } -
Type: object
campaignId
Type: integer
The ID of the campaign (store) — The technical identifier that represents your store in the Yandex Market system when working through the API. It is uniquely linked to your store, but it is intended only for automated interaction.
You can find it using a query GET v2/campaigns or find it in the seller's office on the Market. Click on your account icon → Settings and in the menu on the left, select APIs and modules:
- block Campaign ID;
- tab Query log → drop-down list in the block Show logs.
⚠️ Do not confuse it with:
- the store's identifier, which is displayed in the merchant's personal account.
- advertising campaigns.
Min value:
1createdAt
Type: string<date-time>
The date and time when the non-purchase or refund was created.
Date format: ISO 8601 with an offset relative to UTC. For example,
2017-11-21T00:00:00.213Z.Example:
2025-01-01T00:00:00Zitems
Type: object[]
count
Type: integer
The quantity of the product.
offerId
Type: string
Your SKU — the product ID in your system.
Usage rules SKU:
-
For each product SKU there must be one.
-
Already set SKU it cannot be released and reused for another product. Each product should receive a new identifier that has never been used in your catalog before.
SKU The product can be changed in the seller's account on the Market. Read about how to do this. in the Help of the Market for sellers.
Warning
Spaces at the beginning and end of the value are automatically deleted. For example,
" SKU123 "and"SKU123"they will be treated as identical values.What is SKU and how to assign it
Min length:
1Max length:
255Pattern:
^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$Example:
exampleA list of items that have not been purchased or returned.
Example
[ { "offerId": "example", "count": 0 } ]notificationType
Type: string
Notification type:
PING— verification notification.ORDER_CREATED— A new order has been created.ORDER_CANCELLED— The order has been cancelled.ORDER_STATUS_UPDATED— the order status has been changed.ORDER_RETURN_CREATED— A new non-purchase or refund has been created.ORDER_CANCELLATION_REQUEST— an order cancellation request has been created (for DBS-stores).ORDER_RETURN_STATUS_UPDATED— the non-purchase or refund status has been changed.ORDER_UPDATED— the order has been changed.GOODS_FEEDBACK_CREATED— A new product review has been created.GOODS_FEEDBACK_COMMENT_CREATED— A new product review comment has been created.CHAT_CREATED— A new chat with the buyer has been created.CHAT_MESSAGE_SENT— A new chat message has been added.CHAT_ARBITRAGE_STARTED— at the request of the buyer, a dispute began.CHAT_ARBITRAGE_FINISHED— the dispute is over.QUESTION_CREATED— A new question has been created.QUESTION_ANSWER_CREATED— A new answer to the question has been created.QUESTION_COMMENT_CREATED— A new comment has been created on the answer to the question.
Enum:
PING,ORDER_CREATED,ORDER_CANCELLED,ORDER_STATUS_UPDATED,ORDER_RETURN_CREATED,ORDER_CANCELLATION_REQUEST,ORDER_RETURN_STATUS_UPDATED,ORDER_UPDATED,GOODS_FEEDBACK_CREATED,GOODS_FEEDBACK_COMMENT_CREATED,CHAT_CREATED,CHAT_MESSAGE_SENT,CHAT_ARBITRAGE_STARTED,CHAT_ARBITRAGE_FINISHED,QUESTION_CREATED,QUESTION_ANSWER_CREATED,QUESTION_COMMENT_CREATEDorderId
Type: integer
The order ID.
returnId
Type: integer
ID of a non-purchase or refund.
returnType
Type: string
Type of filtration:
-
UNREDEEMED— non-purchases. -
RETURN— refunds.
If you do not specify it, the response will include both non-purchases and refunds.
Enum:
UNREDEEMED,RETURNNotification of the creation of a new non-purchase or refund.
notificationType=ORDER_RETURN_CREATEDЧтобы получить подробную информацию о невыкупе или возврате
Example
{ "notificationType": "PING", "orderId": 0, "returnId": 0, "returnType": "UNREDEEMED", "campaignId": 1, "items": [ { "offerId": "example", "count": 0 } ], "createdAt": "2025-01-01T00:00:00Z" } -
Type: object
campaignId
Type: integer
The ID of the campaign (store) — The technical identifier that represents your store in the Yandex Market system when working through the API. It is uniquely linked to your store, but it is intended only for automated interaction.
You can find it using a query GET v2/campaigns or find it in the seller's office on the Market. Click on your account icon → Settings and in the menu on the left, select APIs and modules:
- block Campaign ID;
- tab Query log → drop-down list in the block Show logs.
⚠️ Do not confuse it with:
- the store's identifier, which is displayed in the merchant's personal account.
- advertising campaigns.
Min value:
1notificationType
Type: string
Notification type:
PING— verification notification.ORDER_CREATED— A new order has been created.ORDER_CANCELLED— The order has been cancelled.ORDER_STATUS_UPDATED— the order status has been changed.ORDER_RETURN_CREATED— A new non-purchase or refund has been created.ORDER_CANCELLATION_REQUEST— an order cancellation request has been created (for DBS-stores).ORDER_RETURN_STATUS_UPDATED— the non-purchase or refund status has been changed.ORDER_UPDATED— the order has been changed.GOODS_FEEDBACK_CREATED— A new product review has been created.GOODS_FEEDBACK_COMMENT_CREATED— A new product review comment has been created.CHAT_CREATED— A new chat with the buyer has been created.CHAT_MESSAGE_SENT— A new chat message has been added.CHAT_ARBITRAGE_STARTED— at the request of the buyer, a dispute began.CHAT_ARBITRAGE_FINISHED— the dispute is over.QUESTION_CREATED— A new question has been created.QUESTION_ANSWER_CREATED— A new answer to the question has been created.QUESTION_COMMENT_CREATED— A new comment has been created on the answer to the question.
Enum:
PING,ORDER_CREATED,ORDER_CANCELLED,ORDER_STATUS_UPDATED,ORDER_RETURN_CREATED,ORDER_CANCELLATION_REQUEST,ORDER_RETURN_STATUS_UPDATED,ORDER_UPDATED,GOODS_FEEDBACK_CREATED,GOODS_FEEDBACK_COMMENT_CREATED,CHAT_CREATED,CHAT_MESSAGE_SENT,CHAT_ARBITRAGE_STARTED,CHAT_ARBITRAGE_FINISHED,QUESTION_CREATED,QUESTION_ANSWER_CREATED,QUESTION_COMMENT_CREATEDorderId
Type: integer
The order ID.
returnId
Type: integer
ID of a non-purchase or refund.
statuses
Type: object
refundStatus
Type: string
Refund status:
-
STARTED_BY_USER— created by the buyer from his personal account. -
REFUND_IN_PROGRESS— awaiting a decision on a refund (pending). -
REFUNDED— The money has been refunded. -
FAILED— It is not possible to make a refund to the buyer. -
WAITING_FOR_DECISION— awaiting a decision (DBS). -
DECISION_MADE— A decision has been made on the refund (DBS). -
REFUNDED_WITH_BONUSES— The refund is made with Plus points or a promo code. -
REFUNDED_BY_SHOP— The store made a refund on its own. -
COMPLETE_WITHOUT_REFUND— No refund is required. -
CANCELLED— The refund has been canceled. -
REJECTED— The refund was rejected by moderation or by the PVZ. -
PREMODERATION_DISPUTE— There is a dispute over the refund (FBY, FBS and Express). -
PREMODERATION_DECISION_WAITING— awaiting a decision (FBY, FBS and Express). -
PREMODERATION_DECISION_MADE— A decision has been made on the refund (FBY, FBS and Express). -
PREMODERATION_SELECT_DELIVERY— the user chooses the delivery method (FBY, FBS and Express). -
UNKNOWN— unknown status, please contact support.
Enum:
STARTED_BY_USER,REFUND_IN_PROGRESS,REFUNDED,FAILED,WAITING_FOR_DECISION,DECISION_MADE,REFUNDED_WITH_BONUSES,REFUNDED_BY_SHOP,CANCELLED,REJECTED,COMPLETE_WITHOUT_REFUND,PREMODERATION_DISPUTE,PREMODERATION_DECISION_WAITING,PREMODERATION_DECISION_MADE,PREMODERATION_SELECT_DELIVERY,UNKNOWNshipmentStatus
Type: string
Refund or non-purchase transfer status:
-
CREATED— The refund or non-purchase was created by the buyer (issued). -
RECEIVED— The refund is ready for shipment (accepted from the buyer). -
IN_TRANSIT— refund or non-purchase on the way (shipped). -
READY_FOR_PICKUP— The refund or non-purchase is ready for delivery to the store. -
PICKED— refund or non-purchase has been issued to the store. -
LOST— refund or non-purchase is lost (during transportation). -
EXPIRED— The buyer did not bring the product for return on time (the refund was canceled). -
CANCELLED— The refund or non-purchase has been canceled. -
FULFILMENT_RECEIVED— refund or non-purchase is accepted at the Market warehouse. -
PREPARED_FOR_UTILIZATION— The refund or non-purchase has been placed in the disposal queue. -
NOT_IN_DEMAND— The refund or non-purchase was not picked up from the post office. -
UTILIZED— refund or non-purchase is disposed of. -
READY_FOR_EXPROPRIATION— returned or non-repurchased goods are sent for resale (checking before sale). -
RECEIVED_FOR_EXPROPRIATION— returned or non-repurchased goods are accepted for resale (sale). -
UNKNOWN— unknown status, please contact support.
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,UNKNOWNInformation about updating the non-purchase or refund status.
Only the status that was changed is returned.
For non-purchases, only
shipmentStatus.Parameter
shipmentStatusdoes not arrive for refunds with the option A quick refund for a cheap marriage, when the product remains with the buyer.Example
{ "refundStatus": "STARTED_BY_USER", "shipmentStatus": "CREATED" }updatedAt
Type: string<date-time>
Date and time when the non-purchase or refund status was changed.
Date format: ISO 8601 with an offset relative to UTC. For example,
2017-11-21T00:00:00.213Z.Example:
2025-01-01T00:00:00ZNotification of a change in the non-purchase or refund status.
notificationType=ORDER_RETURN_STATUS_UPDATEDЧтобы получить подробную информацию о невыкупе или возврате
Example
{ "notificationType": "PING", "orderId": 0, "returnId": 0, "campaignId": 1, "statuses": { "refundStatus": "STARTED_BY_USER", "shipmentStatus": "CREATED" }, "updatedAt": "2025-01-01T00:00:00Z" } -
Type: object
campaignId
Type: integer
The ID of the campaign (store) — The technical identifier that represents your store in the Yandex Market system when working through the API. It is uniquely linked to your store, but it is intended only for automated interaction.
You can find it using a query GET v2/campaigns or find it in the seller's office on the Market. Click on your account icon → Settings and in the menu on the left, select APIs and modules:
- block Campaign ID;
- tab Query log → drop-down list in the block Show logs.
⚠️ Do not confuse it with:
- the store's identifier, which is displayed in the merchant's personal account.
- advertising campaigns.
Min value:
1notificationType
Type: string
Notification type:
PING— verification notification.ORDER_CREATED— A new order has been created.ORDER_CANCELLED— The order has been cancelled.ORDER_STATUS_UPDATED— the order status has been changed.ORDER_RETURN_CREATED— A new non-purchase or refund has been created.ORDER_CANCELLATION_REQUEST— an order cancellation request has been created (for DBS-stores).ORDER_RETURN_STATUS_UPDATED— the non-purchase or refund status has been changed.ORDER_UPDATED— the order has been changed.GOODS_FEEDBACK_CREATED— A new product review has been created.GOODS_FEEDBACK_COMMENT_CREATED— A new product review comment has been created.CHAT_CREATED— A new chat with the buyer has been created.CHAT_MESSAGE_SENT— A new chat message has been added.CHAT_ARBITRAGE_STARTED— at the request of the buyer, a dispute began.CHAT_ARBITRAGE_FINISHED— the dispute is over.QUESTION_CREATED— A new question has been created.QUESTION_ANSWER_CREATED— A new answer to the question has been created.QUESTION_COMMENT_CREATED— A new comment has been created on the answer to the question.
Enum:
PING,ORDER_CREATED,ORDER_CANCELLED,ORDER_STATUS_UPDATED,ORDER_RETURN_CREATED,ORDER_CANCELLATION_REQUEST,ORDER_RETURN_STATUS_UPDATED,ORDER_UPDATED,GOODS_FEEDBACK_CREATED,GOODS_FEEDBACK_COMMENT_CREATED,CHAT_CREATED,CHAT_MESSAGE_SENT,CHAT_ARBITRAGE_STARTED,CHAT_ARBITRAGE_FINISHED,QUESTION_CREATED,QUESTION_ANSWER_CREATED,QUESTION_COMMENT_CREATEDorderId
Type: integer
The order ID.
updatedAt
Type: string<date-time>
Date and time of the order change.
Date format: ISO 8601 with an offset relative to UTC. For example,
2017-11-21T00:00:00.213Z.Example:
2025-01-01T00:00:00ZupdateType
Type: string
Type of order change:
SHIPMENT_DATE_UPDATED— change of the shipment date.DELIVERY_DATE_UPDATED— change of the delivery date.UNKNOWN— unknown type.
Enum:
SHIPMENT_DATE_UPDATED,DELIVERY_DATE_UPDATED,UNKNOWNNotification of order changes.
notificationType=ORDER_UPDATEDЧтобы получить подробную информацию о заказе
Use the method POST v1/businesses/{businessId}/orders with a filter
orderIds.Example
{ "notificationType": "PING", "orderId": 0, "campaignId": 1, "updateType": "SHIPMENT_DATE_UPDATED", "updatedAt": "2025-01-01T00:00:00Z" } -
Type: object
businessId
Type: integer
Cabinet ID. To find out, use the request GET v2/campaigns.
ℹ️ What is a cabinet and a store on the Market?
Min value:
1createdAt
Type: string<date-time>
The date and time when the review was created.
It may differ from the information in
publishedAt, since the review has been undergoing moderation for some time.Date format: ISO 8601 with an offset relative to UTC. For example,
2017-11-21T00:00:00.213Z.Example:
2025-01-01T00:00:00ZfeedbackId
Type: integer
The review ID.
notificationType
Type: string
Notification type:
PING— verification notification.ORDER_CREATED— A new order has been created.ORDER_CANCELLED— The order has been cancelled.ORDER_STATUS_UPDATED— the order status has been changed.ORDER_RETURN_CREATED— A new non-purchase or refund has been created.ORDER_CANCELLATION_REQUEST— an order cancellation request has been created (for DBS-stores).ORDER_RETURN_STATUS_UPDATED— the non-purchase or refund status has been changed.ORDER_UPDATED— the order has been changed.GOODS_FEEDBACK_CREATED— A new product review has been created.GOODS_FEEDBACK_COMMENT_CREATED— A new product review comment has been created.CHAT_CREATED— A new chat with the buyer has been created.CHAT_MESSAGE_SENT— A new chat message has been added.CHAT_ARBITRAGE_STARTED— at the request of the buyer, a dispute began.CHAT_ARBITRAGE_FINISHED— the dispute is over.QUESTION_CREATED— A new question has been created.QUESTION_ANSWER_CREATED— A new answer to the question has been created.QUESTION_COMMENT_CREATED— A new comment has been created on the answer to the question.
Enum:
PING,ORDER_CREATED,ORDER_CANCELLED,ORDER_STATUS_UPDATED,ORDER_RETURN_CREATED,ORDER_CANCELLATION_REQUEST,ORDER_RETURN_STATUS_UPDATED,ORDER_UPDATED,GOODS_FEEDBACK_CREATED,GOODS_FEEDBACK_COMMENT_CREATED,CHAT_CREATED,CHAT_MESSAGE_SENT,CHAT_ARBITRAGE_STARTED,CHAT_ARBITRAGE_FINISHED,QUESTION_CREATED,QUESTION_ANSWER_CREATED,QUESTION_COMMENT_CREATEDpublishedAt
Type: string<date-time>
Date and time of publication of the review.
It may differ from the information in
createdAt, since the review has been undergoing moderation for some time.Date format: ISO 8601 with an offset relative to UTC. For example,
2017-11-21T00:00:00.213Z.Example:
2025-01-01T00:00:00ZNotification of the creation of a new product review.
notificationType=GOODS_FEEDBACK_CREATEDYandex.Market sends notifications about reviews only when they have been moderated and published.
Чтобы получить подробную информацию об отзывах
Use the method POST v2/businesses/{businessId}/goods-feedback where specify their IDs in the parameter
feedbackIds.You will not be able to get the information if the customer or the Market has deleted the review.
Example
{ "notificationType": "PING", "feedbackId": 0, "businessId": 1, "createdAt": "2025-01-01T00:00:00Z", "publishedAt": "2025-01-01T00:00:00Z" } -
Type: object
businessId
Type: integer
Cabinet ID. To find out, use the request GET v2/campaigns.
ℹ️ What is a cabinet and a store on the Market?
Min value:
1commentId
Type: integer
ID of the review comment.
createdAt
Type: string<date-time>
Date and time when the comment was created.
Date format: ISO 8601 with an offset relative to UTC. For example,
2017-11-21T00:00:00.213Z.Example:
2025-01-01T00:00:00ZnotificationType
Type: string
Notification type:
PING— verification notification.ORDER_CREATED— A new order has been created.ORDER_CANCELLED— The order has been cancelled.ORDER_STATUS_UPDATED— the order status has been changed.ORDER_RETURN_CREATED— A new non-purchase or refund has been created.ORDER_CANCELLATION_REQUEST— an order cancellation request has been created (for DBS-stores).ORDER_RETURN_STATUS_UPDATED— the non-purchase or refund status has been changed.ORDER_UPDATED— the order has been changed.GOODS_FEEDBACK_CREATED— A new product review has been created.GOODS_FEEDBACK_COMMENT_CREATED— A new product review comment has been created.CHAT_CREATED— A new chat with the buyer has been created.CHAT_MESSAGE_SENT— A new chat message has been added.CHAT_ARBITRAGE_STARTED— at the request of the buyer, a dispute began.CHAT_ARBITRAGE_FINISHED— the dispute is over.QUESTION_CREATED— A new question has been created.QUESTION_ANSWER_CREATED— A new answer to the question has been created.QUESTION_COMMENT_CREATED— A new comment has been created on the answer to the question.
Enum:
PING,ORDER_CREATED,ORDER_CANCELLED,ORDER_STATUS_UPDATED,ORDER_RETURN_CREATED,ORDER_CANCELLATION_REQUEST,ORDER_RETURN_STATUS_UPDATED,ORDER_UPDATED,GOODS_FEEDBACK_CREATED,GOODS_FEEDBACK_COMMENT_CREATED,CHAT_CREATED,CHAT_MESSAGE_SENT,CHAT_ARBITRAGE_STARTED,CHAT_ARBITRAGE_FINISHED,QUESTION_CREATED,QUESTION_ANSWER_CREATED,QUESTION_COMMENT_CREATEDNotification of the creation of a new review comment.
notificationType=GOODS_FEEDBACK_COMMENT_CREATEDЧтобы получить подробную информацию о комментариях к отзыву
Use the method POST v2/businesses/{businessId}/goods-feedback/comments where specify their IDs in the parameter
commentIds.You will not be able to receive information if the user or the Market has deleted a comment or review to which it was added.
Example
{ "notificationType": "PING", "commentId": 0, "businessId": 1, "createdAt": "2025-01-01T00:00:00Z" } -
Type: object
businessId
Type: integer
Cabinet ID. To find out, use the request GET v2/campaigns.
ℹ️ What is a cabinet and a store on the Market?
Min value:
1chatId
Type: integer
The chat ID.
createdAt
Type: string<date-time>
Date and time when the chat was created.
Date format: ISO 8601 with an offset relative to UTC. For example,
2017-11-21T00:00:00.213Z.Example:
2025-01-01T00:00:00ZnotificationType
Type: string
Notification type:
PING— verification notification.ORDER_CREATED— A new order has been created.ORDER_CANCELLED— The order has been cancelled.ORDER_STATUS_UPDATED— the order status has been changed.ORDER_RETURN_CREATED— A new non-purchase or refund has been created.ORDER_CANCELLATION_REQUEST— an order cancellation request has been created (for DBS-stores).ORDER_RETURN_STATUS_UPDATED— the non-purchase or refund status has been changed.ORDER_UPDATED— the order has been changed.GOODS_FEEDBACK_CREATED— A new product review has been created.GOODS_FEEDBACK_COMMENT_CREATED— A new product review comment has been created.CHAT_CREATED— A new chat with the buyer has been created.CHAT_MESSAGE_SENT— A new chat message has been added.CHAT_ARBITRAGE_STARTED— at the request of the buyer, a dispute began.CHAT_ARBITRAGE_FINISHED— the dispute is over.QUESTION_CREATED— A new question has been created.QUESTION_ANSWER_CREATED— A new answer to the question has been created.QUESTION_COMMENT_CREATED— A new comment has been created on the answer to the question.
Enum:
PING,ORDER_CREATED,ORDER_CANCELLED,ORDER_STATUS_UPDATED,ORDER_RETURN_CREATED,ORDER_CANCELLATION_REQUEST,ORDER_RETURN_STATUS_UPDATED,ORDER_UPDATED,GOODS_FEEDBACK_CREATED,GOODS_FEEDBACK_COMMENT_CREATED,CHAT_CREATED,CHAT_MESSAGE_SENT,CHAT_ARBITRAGE_STARTED,CHAT_ARBITRAGE_FINISHED,QUESTION_CREATED,QUESTION_ANSWER_CREATED,QUESTION_COMMENT_CREATEDNotification of the creation of a new chat with the buyer.
notificationType=CHAT_CREATEDIt is available for all types of chats.
Рекомендуемая обработка
On notification CHAT_CREATED create a chat in your system and save
chatId.Get information via chat using the method GET v2/businesses/{businessId}/chat and save the order number, the return ID (if any), and the buyer's public details.
Re-request the chat context for this
chatIdnot required.Example
{ "notificationType": "PING", "chatId": 0, "businessId": 1, "createdAt": "2025-01-01T00:00:00Z" } -
Type: object
businessId
Type: integer
Cabinet ID. To find out, use the request GET v2/campaigns.
ℹ️ What is a cabinet and a store on the Market?
Min value:
1chatId
Type: integer
The chat ID.
messageId
Type: string
The ID of the message.
Example:
examplenotificationType
Type: string
Notification type:
PING— verification notification.ORDER_CREATED— A new order has been created.ORDER_CANCELLED— The order has been cancelled.ORDER_STATUS_UPDATED— the order status has been changed.ORDER_RETURN_CREATED— A new non-purchase or refund has been created.ORDER_CANCELLATION_REQUEST— an order cancellation request has been created (for DBS-stores).ORDER_RETURN_STATUS_UPDATED— the non-purchase or refund status has been changed.ORDER_UPDATED— the order has been changed.GOODS_FEEDBACK_CREATED— A new product review has been created.GOODS_FEEDBACK_COMMENT_CREATED— A new product review comment has been created.CHAT_CREATED— A new chat with the buyer has been created.CHAT_MESSAGE_SENT— A new chat message has been added.CHAT_ARBITRAGE_STARTED— at the request of the buyer, a dispute began.CHAT_ARBITRAGE_FINISHED— the dispute is over.QUESTION_CREATED— A new question has been created.QUESTION_ANSWER_CREATED— A new answer to the question has been created.QUESTION_COMMENT_CREATED— A new comment has been created on the answer to the question.
Enum:
PING,ORDER_CREATED,ORDER_CANCELLED,ORDER_STATUS_UPDATED,ORDER_RETURN_CREATED,ORDER_CANCELLATION_REQUEST,ORDER_RETURN_STATUS_UPDATED,ORDER_UPDATED,GOODS_FEEDBACK_CREATED,GOODS_FEEDBACK_COMMENT_CREATED,CHAT_CREATED,CHAT_MESSAGE_SENT,CHAT_ARBITRAGE_STARTED,CHAT_ARBITRAGE_FINISHED,QUESTION_CREATED,QUESTION_ANSWER_CREATED,QUESTION_COMMENT_CREATEDsentAt
Type: string<date-time>
The date and time when the message was sent.
Date format: ISO 8601 with an offset relative to UTC. For example,
2017-11-21T00:00:00.213Z.Example:
2025-01-01T00:00:00ZNotification of a new message in the chat.
notificationType=CHAT_MESSAGE_SENTIt is available for all types of chats.
It is not sent for sticker messages.
Чтобы получить сообщение от покупателя
Use the method GET v2/businesses/{businessId}/chats/message where to specify the IDs:
- chat rooms —
chatId; - messages —
messageId.
If the chat has already been saved (processed
CHAT_CREATED) in your system, you don't need to request information about it again — use the saved context.Example
{ "notificationType": "PING", "chatId": 0, "messageId": "example", "businessId": 1, "sentAt": "2025-01-01T00:00:00Z" } -
Type: object
businessId
Type: integer
Cabinet ID. To find out, use the request GET v2/campaigns.
ℹ️ What is a cabinet and a store on the Market?
Min value:
1chatId
Type: integer
The chat ID.
notificationType
Type: string
Notification type:
PING— verification notification.ORDER_CREATED— A new order has been created.ORDER_CANCELLED— The order has been cancelled.ORDER_STATUS_UPDATED— the order status has been changed.ORDER_RETURN_CREATED— A new non-purchase or refund has been created.ORDER_CANCELLATION_REQUEST— an order cancellation request has been created (for DBS-stores).ORDER_RETURN_STATUS_UPDATED— the non-purchase or refund status has been changed.ORDER_UPDATED— the order has been changed.GOODS_FEEDBACK_CREATED— A new product review has been created.GOODS_FEEDBACK_COMMENT_CREATED— A new product review comment has been created.CHAT_CREATED— A new chat with the buyer has been created.CHAT_MESSAGE_SENT— A new chat message has been added.CHAT_ARBITRAGE_STARTED— at the request of the buyer, a dispute began.CHAT_ARBITRAGE_FINISHED— the dispute is over.QUESTION_CREATED— A new question has been created.QUESTION_ANSWER_CREATED— A new answer to the question has been created.QUESTION_COMMENT_CREATED— A new comment has been created on the answer to the question.
Enum:
PING,ORDER_CREATED,ORDER_CANCELLED,ORDER_STATUS_UPDATED,ORDER_RETURN_CREATED,ORDER_CANCELLATION_REQUEST,ORDER_RETURN_STATUS_UPDATED,ORDER_UPDATED,GOODS_FEEDBACK_CREATED,GOODS_FEEDBACK_COMMENT_CREATED,CHAT_CREATED,CHAT_MESSAGE_SENT,CHAT_ARBITRAGE_STARTED,CHAT_ARBITRAGE_FINISHED,QUESTION_CREATED,QUESTION_ANSWER_CREATED,QUESTION_COMMENT_CREATEDstartedAt
Type: string<date-time>
The date and time of the beginning of the dispute.
Date format: ISO 8601 with an offset relative to UTC. For example,
2017-11-21T00:00:00.213Z.Example:
2025-01-01T00:00:00ZNotification of the beginning of the dispute.
notificationType=CHAT_ARBITRAGE_STARTEDDoesn't come for a chat with the type
DIRECT. Learn more about such chatsExample
{ "notificationType": "PING", "chatId": 0, "businessId": 1, "startedAt": "2025-01-01T00:00:00Z" } -
Type: object
businessId
Type: integer
Cabinet ID. To find out, use the request GET v2/campaigns.
ℹ️ What is a cabinet and a store on the Market?
Min value:
1chatId
Type: integer
The chat ID.
finishedAt
Type: string<date-time>
The date and time of the end of the dispute.
Date format: ISO 8601 with an offset relative to UTC. For example,
2017-11-21T00:00:00.213Z.Example:
2025-01-01T00:00:00ZnotificationType
Type: string
Notification type:
PING— verification notification.ORDER_CREATED— A new order has been created.ORDER_CANCELLED— The order has been cancelled.ORDER_STATUS_UPDATED— the order status has been changed.ORDER_RETURN_CREATED— A new non-purchase or refund has been created.ORDER_CANCELLATION_REQUEST— an order cancellation request has been created (for DBS-stores).ORDER_RETURN_STATUS_UPDATED— the non-purchase or refund status has been changed.ORDER_UPDATED— the order has been changed.GOODS_FEEDBACK_CREATED— A new product review has been created.GOODS_FEEDBACK_COMMENT_CREATED— A new product review comment has been created.CHAT_CREATED— A new chat with the buyer has been created.CHAT_MESSAGE_SENT— A new chat message has been added.CHAT_ARBITRAGE_STARTED— at the request of the buyer, a dispute began.CHAT_ARBITRAGE_FINISHED— the dispute is over.QUESTION_CREATED— A new question has been created.QUESTION_ANSWER_CREATED— A new answer to the question has been created.QUESTION_COMMENT_CREATED— A new comment has been created on the answer to the question.
Enum:
PING,ORDER_CREATED,ORDER_CANCELLED,ORDER_STATUS_UPDATED,ORDER_RETURN_CREATED,ORDER_CANCELLATION_REQUEST,ORDER_RETURN_STATUS_UPDATED,ORDER_UPDATED,GOODS_FEEDBACK_CREATED,GOODS_FEEDBACK_COMMENT_CREATED,CHAT_CREATED,CHAT_MESSAGE_SENT,CHAT_ARBITRAGE_STARTED,CHAT_ARBITRAGE_FINISHED,QUESTION_CREATED,QUESTION_ANSWER_CREATED,QUESTION_COMMENT_CREATEDNotification of the end of the dispute.
notificationType=CHAT_ARBITRAGE_FINISHEDDoesn't come for a chat with the type
DIRECT. Learn more about such chatsExample
{ "notificationType": "PING", "chatId": 0, "businessId": 1, "finishedAt": "2025-01-01T00:00:00Z" } -
Type: object
businessId
Type: integer
Cabinet ID. To find out, use the request GET v2/campaigns.
ℹ️ What is a cabinet and a store on the Market?
Min value:
1createdAt
Type: string<date-time>
The date and time when the question was created.
Date format: ISO 8601 with an offset relative to UTC. For example,
2017-11-21T00:00:00.213Z.Example:
2025-01-01T00:00:00ZnotificationType
Type: string
Notification type:
PING— verification notification.ORDER_CREATED— A new order has been created.ORDER_CANCELLED— The order has been cancelled.ORDER_STATUS_UPDATED— the order status has been changed.ORDER_RETURN_CREATED— A new non-purchase or refund has been created.ORDER_CANCELLATION_REQUEST— an order cancellation request has been created (for DBS-stores).ORDER_RETURN_STATUS_UPDATED— the non-purchase or refund status has been changed.ORDER_UPDATED— the order has been changed.GOODS_FEEDBACK_CREATED— A new product review has been created.GOODS_FEEDBACK_COMMENT_CREATED— A new product review comment has been created.CHAT_CREATED— A new chat with the buyer has been created.CHAT_MESSAGE_SENT— A new chat message has been added.CHAT_ARBITRAGE_STARTED— at the request of the buyer, a dispute began.CHAT_ARBITRAGE_FINISHED— the dispute is over.QUESTION_CREATED— A new question has been created.QUESTION_ANSWER_CREATED— A new answer to the question has been created.QUESTION_COMMENT_CREATED— A new comment has been created on the answer to the question.
Enum:
PING,ORDER_CREATED,ORDER_CANCELLED,ORDER_STATUS_UPDATED,ORDER_RETURN_CREATED,ORDER_CANCELLATION_REQUEST,ORDER_RETURN_STATUS_UPDATED,ORDER_UPDATED,GOODS_FEEDBACK_CREATED,GOODS_FEEDBACK_COMMENT_CREATED,CHAT_CREATED,CHAT_MESSAGE_SENT,CHAT_ARBITRAGE_STARTED,CHAT_ARBITRAGE_FINISHED,QUESTION_CREATED,QUESTION_ANSWER_CREATED,QUESTION_COMMENT_CREATEDquestionId
Type: integer
The issue ID.
Notification of the creation of a new question.
notificationType=QUESTION_CREATEDЧтобы получить подробную информацию о вопросе
Use the method POST v1/businesses/{businessId}/goods-questions where specify its ID in the parameter
questionIds.Example
{ "notificationType": "PING", "questionId": 0, "businessId": 1, "createdAt": "2025-01-01T00:00:00Z" } -
Type: object
answerId
Type: integer
The response ID.
businessId
Type: integer
Cabinet ID. To find out, use the request GET v2/campaigns.
ℹ️ What is a cabinet and a store on the Market?
Min value:
1createdAt
Type: string<date-time>
The date and time when the response was created.
Date format: ISO 8601 with an offset relative to UTC. For example,
2017-11-21T00:00:00.213Z.Example:
2025-01-01T00:00:00ZnotificationType
Type: string
Notification type:
PING— verification notification.ORDER_CREATED— A new order has been created.ORDER_CANCELLED— The order has been cancelled.ORDER_STATUS_UPDATED— the order status has been changed.ORDER_RETURN_CREATED— A new non-purchase or refund has been created.ORDER_CANCELLATION_REQUEST— an order cancellation request has been created (for DBS-stores).ORDER_RETURN_STATUS_UPDATED— the non-purchase or refund status has been changed.ORDER_UPDATED— the order has been changed.GOODS_FEEDBACK_CREATED— A new product review has been created.GOODS_FEEDBACK_COMMENT_CREATED— A new product review comment has been created.CHAT_CREATED— A new chat with the buyer has been created.CHAT_MESSAGE_SENT— A new chat message has been added.CHAT_ARBITRAGE_STARTED— at the request of the buyer, a dispute began.CHAT_ARBITRAGE_FINISHED— the dispute is over.QUESTION_CREATED— A new question has been created.QUESTION_ANSWER_CREATED— A new answer to the question has been created.QUESTION_COMMENT_CREATED— A new comment has been created on the answer to the question.
Enum:
PING,ORDER_CREATED,ORDER_CANCELLED,ORDER_STATUS_UPDATED,ORDER_RETURN_CREATED,ORDER_CANCELLATION_REQUEST,ORDER_RETURN_STATUS_UPDATED,ORDER_UPDATED,GOODS_FEEDBACK_CREATED,GOODS_FEEDBACK_COMMENT_CREATED,CHAT_CREATED,CHAT_MESSAGE_SENT,CHAT_ARBITRAGE_STARTED,CHAT_ARBITRAGE_FINISHED,QUESTION_CREATED,QUESTION_ANSWER_CREATED,QUESTION_COMMENT_CREATEDNotification of the creation of a new answer to a question.
notificationType=QUESTION_ANSWER_CREATEDЧтобы получить подробную информацию об ответе на вопрос
Use the method POST v1/businesses/{businessId}/goods-questions/answers where specify its ID in the parameter
answerIds.Example
{ "notificationType": "PING", "answerId": 0, "businessId": 1, "createdAt": "2025-01-01T00:00:00Z" } -
Type: object
answerId
Type: integer
The response ID.
businessId
Type: integer
Cabinet ID. To find out, use the request GET v2/campaigns.
ℹ️ What is a cabinet and a store on the Market?
Min value:
1commentId
Type: integer
ID of the comment.
createdAt
Type: string<date-time>
Date and time when the comment was created.
Date format: ISO 8601 with an offset relative to UTC. For example,
2017-11-21T00:00:00.213Z.Example:
2025-01-01T00:00:00ZnotificationType
Type: string
Notification type:
PING— verification notification.ORDER_CREATED— A new order has been created.ORDER_CANCELLED— The order has been cancelled.ORDER_STATUS_UPDATED— the order status has been changed.ORDER_RETURN_CREATED— A new non-purchase or refund has been created.ORDER_CANCELLATION_REQUEST— an order cancellation request has been created (for DBS-stores).ORDER_RETURN_STATUS_UPDATED— the non-purchase or refund status has been changed.ORDER_UPDATED— the order has been changed.GOODS_FEEDBACK_CREATED— A new product review has been created.GOODS_FEEDBACK_COMMENT_CREATED— A new product review comment has been created.CHAT_CREATED— A new chat with the buyer has been created.CHAT_MESSAGE_SENT— A new chat message has been added.CHAT_ARBITRAGE_STARTED— at the request of the buyer, a dispute began.CHAT_ARBITRAGE_FINISHED— the dispute is over.QUESTION_CREATED— A new question has been created.QUESTION_ANSWER_CREATED— A new answer to the question has been created.QUESTION_COMMENT_CREATED— A new comment has been created on the answer to the question.
Enum:
PING,ORDER_CREATED,ORDER_CANCELLED,ORDER_STATUS_UPDATED,ORDER_RETURN_CREATED,ORDER_CANCELLATION_REQUEST,ORDER_RETURN_STATUS_UPDATED,ORDER_UPDATED,GOODS_FEEDBACK_CREATED,GOODS_FEEDBACK_COMMENT_CREATED,CHAT_CREATED,CHAT_MESSAGE_SENT,CHAT_ARBITRAGE_STARTED,CHAT_ARBITRAGE_FINISHED,QUESTION_CREATED,QUESTION_ANSWER_CREATED,QUESTION_COMMENT_CREATEDNotification of the creation of a new comment on the answer to the question.
notificationType=QUESTION_COMMENT_CREATEDЧтобы получить подробную информацию о комментарии к ответу на вопрос
Use the method POST v1/businesses/{businessId}/goods-questions/answers where specify the response ID in the parameter
answerIds.Example
{ "notificationType": "PING", "answerId": 0, "commentId": 0, "businessId": 1, "createdAt": "2025-01-01T00:00:00Z" }
Responses
200 OK
A response to a valid request with information about notification processing.
Body
application/json
{
"version": "example",
"name": "example",
"time": "2025-01-01T00:00:00Z"
}
|
Name |
Description |
|
name |
Type: string The name of the integration. Min length: Max length: Example: |
|
time |
Type: string<date-time> The date and time when the notification was processed, in the format UTC. Example: |
|
version |
Type: string The integration version. Min length: Max length: Example: |
400 Bad Request
If the Market has sent an incorrect notification, return the status 400 with a description of the error.
Body
application/json
{
"error": {
"type": "UNKNOWN",
"message": "example"
}
}
|
Name |
Description |
||||
|
error |
Type: object
Error when processing the notification. Example
|
500 Internal Server Error
If a technical error has occurred on your side, return the status 500. The store's API is not responding
Body
application/json
{
"error": {
"type": "UNKNOWN",
"message": "example"
}
}
|
Name |
Description |
||||
|
error |
Type: object
Error when processing the notification. Example
|