Information about orders in the store

Name

Description

Type: integer<int64>

The campaign ID.

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 send the store ID instead, which is indicated in the seller's account on the Market next to the store name and in some reports.

Min value: 1

Name

Description

Type: string

Filtering orders by customer type.
Type of buyer:

• PERSON — a natural person.

• BUSINESS — organization.

Enum: PERSON, BUSINESS

Type: string

Shipping method
Shipping method:

• BUYER — courier delivery to the buyer.

• MARKET_BRANDED_OUTLET — delivery to the pick-up point of the Market.

• SHOP_OUTLET — delivery to the store's order pick-up point.

• UNKNOWN — unknown type.

Enum: UNKNOWN, BUYER, MARKET_BRANDED_OUTLET, SHOP_OUTLET

Type: boolean

Filtering orders by type:

• false — the real customer's order.

• true — test order Yandex. Market.
  

Default: false

Type: string<date>

The starting date for filtering orders by checkout date.

Date format: DD-MM-YYYY.

Between the start and end date (parameter toDate) should be no more than 30 days old.

Default value: 30 days ago from the current date.

Type: boolean

A filter for receiving orders that contain at least one product with an identification code in the system. «Честный ЗНАК» or «ASL BELGISI» (for sellers Market Yandex Go):

• true — Yes.

• false — No.

Such codes are assigned to products that are subject to labeling and belong to certain categories.

Default: false

Type: integer<int32>

The number of values per page.

Min value: 1
Example: 20

Type: boolean

Filtering orders with long delivery (31-60 days) by confirmed delivery date:

• true — Only orders with an unconfirmed delivery date are returned.
• false — filtering is not applied.
  

Default: false

Type: boolean

For the model only DBS

A filter for receiving orders for which there was a cancellation request.

With the value true only orders with the following status are returned DELIVERY or PICKUP and which the users decided to cancel.

To confirm or reject the cancellation, send a request PUT v2/campaigns/{campaignId}/orders/{orderId}/cancellation/accept.

Default: false

Type: integer[]

Filtering orders by IDs.

⚠️ Do not use this field at the same time as other filters. If you want to use them, leave the field empty.

Min items: 1

Max items: 50

Type: integer<int32>

The number of the results page.

Used together with the parameter pageSize.

page ignored if specified page_token or limit.

Default: 1

Max value: 10000

Type: integer<int32>

Page size.

Used together with the parameter page.

pageSize ignored if specified page_token or limit.

Type: string

ID of the results page.

If the parameter is omitted, the first page is returned.

We recommend transmitting the value of the output parameter nextPageToken, received during the last request.

If set page_token and the request has parameters page and pageSize they are ignored.
Example: eyBuZXh0SWQ6IDIzNDIgfQ==

Type: string[]

Order status:

• CANCELLED — The order has been cancelled.

• DELIVERED — the order was received by the buyer.

• DELIVERY — The order has been sent to the delivery service.

• PICKUP — The order has been delivered to the pick-up point.

• PROCESSING — the order is being processed.

• UNPAID — the order has been placed, but not yet paid (if payment is selected at checkout).
  Order status:

• PLACING — it is being processed, preparing for the reservation.

• RESERVED — reserved, but under-booked.

• 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, UNKNOWN

Unique items  

Type: string[]

Order processing stage (status PROCESSING) or the reason for the cancellation of the order (status CANCELLED).

Possible values for the order 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.
• SHIPPED — the order has been transferred to the delivery service.

Possible values for the order 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 type of payment PREPAID) 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 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.

• 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 storage period of the order in the PVZ has expired.

• DELIVERY_SERVICE_UNDELIVERED — The delivery service was unable to deliver the order.

• CANCELLED_COURIER_NOT_FOUND — couldn't find the courier.

• USER_WANTS_TO_CHANGE_DELIVERY_DATE — the customer wants to receive the order on another day.

• RESERVATION_FAILED — The Market cannot continue further processing of the order.
  Order processing stage (status PROCESSING) or the reason for the cancellation of the order (status CANCELLED).

• 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 type of payment PREPAID) 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.

  • 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, UNKNOWN

Unique items  

Type: string<date>

The starting date for filtering orders by the date of shipment to the delivery service (parameter shipmentDate).

Date format: DD-MM-YYYY.

Between the start and end date (parameter supplierShipmentDateTo) should be no more than 30 days old.

The start date is included in the interval for filtering.

Type: string<date>

The end date for filtering orders by the date of shipment to the delivery service (parameter shipmentDate).

Date format: DD-MM-YYYY.

Between the initial (parameter supplierShipmentDateFrom) and the end date should be no more than 30 days.

The end date is not included in the filtering interval.

If the time interval between supplierShipmentDateTo and supplierShipmentDateFrom less than a day, then supplierShipmentDateTo equal to supplierShipmentDateFrom + a day.

Type: string<date>

The end date for filtering orders by checkout date.

Orders created before 00:00 on the specified day are shown.

Date format: DD-MM-YYYY.

Between the initial (parameter fromDate) and the end date should be no more than 30 days.

Default value: current date.

If the time interval between toDate and fromDate less than a day, then toDate equal to fromDate + a day.

Type: string<date-time>

The starting date for filtering orders by date and time of the update (parameter updatedAt).

Date format: ISO 8601 with an offset relative to UTC. For example, 2017-11-21T00:42:42+03:00.

Between the start and end date (parameter updatedAtTo) should be no more than 30 days old.

The start date is included in the interval for filtering.

Type: string<date-time>

The end date for filtering orders by date and time of the update (parameter updatedAt).

Date format: ISO 8601 with an offset relative to UTC. For example, 2017-11-21T00:42:42+03:00.

Between the initial (parameter updatedAtFrom) and the end date should be no more than 30 days.

The end date is not included in the filtering interval.