Information about orders in the cabinet

The method is available for models: FBY, FBS, Express and DBS.

If you are using an API Key token, one of the accesses in the list is required to call the method

Returns information about orders in the merchant profile. The query can be used to track orders and their statuses.

You can also set up API notifications.

Yandex.Market will send you request when a new order appears or its status changes. And full information can be obtained using this method., GET v2/campaigns/{campaignId}/orders/{orderId} or GET v2/campaigns/{campaignId}/orders.

How to work with notifications

Filtering by parameters is available:

  • the date of the order.

  • date and time of the order update;

  • date of shipment;

  • order statuses (statuses);

  • stages of processing or reasons for cancellation (substatuses);

  • campaign IDs;

  • order IDs;

  • external order IDs;

  • the type of order (real or test);

  • the type of buyer;

  • placement models;

  • the availability of requests from customers to cancel the order.

Maximum date range per request — 30 days (passed in the parameters fromDate and toDate). If they are not transmitted, the information for the last 30 days is returned.

The results are returned page by page. To navigate, use the parameters page_token and limit.

You can get more detailed information about the buyer and his phone number by requesting GET v2/campaigns/{campaignId}/orders/{orderId}/buyer.

Restriction for the parameter limit

Do not transmit a value greater than 50.

⚙️ Limit: 10,000 requests per hour

Request

POST

https://api.partner.market.yandex.ru/v1/businesses/{businessId}/orders

Path parameters

Name

Description

businessId*

Type: integer<int64>

Cabinet ID. To find out, use the request GET v2/campaigns.

ℹ️ What is a cabinet and a store on the Market?

Min value: 1

Query parameters

Name

Description

limit

Type: integer<int32>

The number of values per page.

Min value: 1
Example: 20

page_token

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==

Body

application/json
{
    "orderIds": [
        0
    ],
    "externalOrderIds": [
        "string"
    ],
    "programTypes": [
        "FBY"
    ],
    "campaignIds": [
        0
    ],
    "statuses": [
        "PLACING"
    ],
    "substatuses": [
        "RESERVATION_EXPIRED"
    ],
    "dates": {
        "creationDateFrom": "string",
        "creationDateTo": "string",
        "shipmentDateFrom": "string",
        "shipmentDateTo": "string",
        "updateDateFrom": "2022-12-29T18:02:01Z",
        "updateDateTo": "2022-12-29T18:02:01Z"
    },
    "fake": false,
    "waitingForCancellationApprove": false
}

Name

Description

campaignIds

Type: integer[]

Campaign IDs.

Min items: 1

Max items: 50

Unique items  

dates
Type: object

creationDateFrom

Type: string<date>

The initial date of the order (YYYY-MM-DD).

creationDateTo

Type: string<date>

The end date of the order (YYYY-MM-DD).

shipmentDateFrom

Type: string<date>

The initial date of shipment (YYYY-MM-DD).

shipmentDateTo

Type: string<date>

The final date of shipment (YYYY-MM-DD).

updateDateFrom

Type: string<date-time>

The initial date of the order update (ISO 8601).

updateDateTo

Type: string<date-time>

The end date of the order update (ISO 8601).

Filter by order dates.

externalOrderIds

Type: string[]

External order IDs.
The external ID of the order that you submitted to POST v2/campaigns/{campaignId}/orders/{orderId}/external-id.

Min length: 1

Min items: 1

Max items: 50

Unique items  

fake

Type: boolean

Order type:

  • false — the real customer's order.

  • true — test order Yandex. Market.

orderIds

Type: integer[]

Order IDs.

Min items: 1

Max items: 50

Unique items  

programTypes

Type: string[]

Models of the store's operation on the Market.
Work model:

  • FBY — FBY.
  • FBS — FBS.
  • DBS — DBS.
  • EXPRESS — Express.

Enum: FBY, FBS, DBS, EXPRESS, LAAS

Min items: 1

Unique items  

statuses

Type: string[]

Order statuses.
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

Min items: 1

Unique items  

substatuses

Type: string[]

Stages of processing or reasons for canceling orders.
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 payment type 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

Min items: 1

Unique items  

waitingForCancellationApprove

Type: boolean

For the model only DBS

A filter for receiving orders that have cancellation requests.

With the value true only those orders that are in the status are returned. DELIVERY or PICKUP, and the users decided to cancel them.

Responses

200 OK

The list of orders in the cabinet.

Body

application/json
{
    "orders": [
        {
            "orderId": 0,
            "campaignId": 0,
            "programType": "FBY",
            "externalOrderId": "string",
            "status": "PLACING",
            "substatus": "RESERVATION_EXPIRED",
            "creationDate": "2020-02-02T14:30:30+03:00",
            "updateDate": "2020-02-02T14:30:30+03:00",
            "paymentType": "PREPAID",
            "paymentMethod": "CASH_ON_DELIVERY",
            "fake": false,
            "items": [
                {
                    "id": 0,
                    "offerId": "string",
                    "offerName": "string",
                    "count": 0,
                    "prices": {
                        "payment": {
                            "value": 0,
                            "currencyId": "RUR"
                        },
                        "subsidy": {
                            "value": 0,
                            "currencyId": "RUR"
                        },
                        "cashback": {
                            "value": 0,
                            "currencyId": "RUR"
                        },
                        "vat": "NO_VAT"
                    },
                    "instances": [
                        {
                            "cis": "string",
                            "cisFull": "string",
                            "uin": "string",
                            "rnpt": "string",
                            "gtd": "string",
                            "countryCode": "RU"
                        }
                    ],
                    "requiredInstanceTypes": [
                        "CIS"
                    ],
                    "tags": [
                        "ULTIMA"
                    ]
                }
            ],
            "prices": {
                "payment": {
                    "value": 0,
                    "currencyId": "RUR"
                },
                "subsidy": {
                    "value": 0,
                    "currencyId": "RUR"
                },
                "cashback": {
                    "value": 0,
                    "currencyId": "RUR"
                },
                "delivery": {
                    "payment": {
                        "value": 0,
                        "currencyId": "RUR"
                    },
                    "subsidy": {
                        "value": 0,
                        "currencyId": "RUR"
                    },
                    "vat": "NO_VAT"
                }
            },
            "delivery": {
                "type": "DELIVERY",
                "serviceName": "string",
                "deliveryServiceId": 0,
                "warehouseId": "string",
                "deliveryPartnerType": "SHOP",
                "dispatchType": "UNKNOWN",
                "dates": {
                    "fromDate": "string",
                    "toDate": "string",
                    "fromTime": "string",
                    "toTime": "string",
                    "realDeliveryDate": "string"
                },
                "shipment": {
                    "id": 0,
                    "shipmentDate": "string",
                    "shipmentTime": "string"
                },
                "courier": {
                    "address": {
                        "country": "string",
                        "postcode": "string",
                        "city": "string",
                        "district": "string",
                        "subway": "string",
                        "street": "string",
                        "house": "string",
                        "block": "string",
                        "entrance": "string",
                        "entryphone": "string",
                        "floor": "string",
                        "apartment": "string",
                        "gps": {
                            "latitude": 0,
                            "longitude": 0
                        }
                    },
                    "region": {
                        "id": 0,
                        "name": "string",
                        "type": "OTHER"
                    }
                },
                "pickup": {
                    "address": {
                        "country": "string",
                        "postcode": "string",
                        "city": "string",
                        "district": "string",
                        "subway": "string",
                        "street": "string",
                        "house": "string",
                        "block": "string",
                        "entrance": "string",
                        "entryphone": "string",
                        "floor": "string",
                        "apartment": "string",
                        "gps": {
                            "latitude": 0,
                            "longitude": 0
                        }
                    },
                    "region": {
                        "id": 0,
                        "name": "string",
                        "type": "OTHER"
                    },
                    "logisticPointId": 0,
                    "outletCode": "string",
                    "outletStorageLimitDate": "string"
                },
                "transfer": {
                    "courier": {
                        "fullName": "string",
                        "phone": "string",
                        "phoneExtension": "string",
                        "vehicleNumber": "string",
                        "vehicleDescription": "string"
                    },
                    "eac": {
                        "eacType": "MERCHANT_TO_COURIER",
                        "eacCode": "string"
                    }
                },
                "boxesLayout": [
                    {
                        "items": [
                            {
                                "id": 0,
                                "fullCount": 0,
                                "partialCount": {
                                    "current": 0,
                                    "total": 0
                                },
                                "instances": [
                                    {
                                        "cis": "string",
                                        "uin": "string",
                                        "rnpt": "string",
                                        "gtd": "string",
                                        "countryCode": "RU"
                                    }
                                ]
                            }
                        ],
                        "boxId": 0,
                        "barcode": "string"
                    }
                ],
                "tracks": [
                    {
                        "trackCode": "string",
                        "deliveryServiceId": 0
                    }
                ],
                "estimated": false
            },
            "services": {
                "liftType": "NOT_NEEDED"
            },
            "buyerType": "PERSON",
            "notes": "string",
            "cancelRequested": false
        }
    ],
    "paging": {
        "nextPageToken": "string"
    }
}

Name

Description

orders*

Type: object[]

The list of orders in the cabinet.
Order information.

Max items: 50

paging
Type: object

nextPageToken

Type: string

ID of the next results page.

The ID of the next page.

400 Bad Request

The request contains incorrect data. More information about the error

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

  • OK — There are no errors.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

401 Unauthorized

The authorization data is not specified in the request. More information about the error

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

  • OK — There are no errors.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

403 Forbidden

The authorization data is incorrect or access to the resource is prohibited. More information about the error

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

  • OK — There are no errors.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

404 Not Found

The requested resource was not found. More information about the error

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

  • OK — There are no errors.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

420 Method Failure

The resource access limit has been exceeded. More information about the error

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

  • OK — There are no errors.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

500 Internal Server Error

Internal error of the Market. More information about the error

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

  • OK — There are no errors.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

No longer supported, please use an alternative and newer version.

The security tag helps to prevent the product from being replaced upon return. You will not be able to return the product without the protective tag that was present at the time of purchase.

Previous
The list of orders in the store
Next
Order preparation