Information about orders in the cabinet

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: 1

creationDate

Type: string<date-time>

The date and time of the order.

Date format: ISO 8601 with an offset relative to UTC.

Example: 2020-02-02T14:30:30+03:00

delivery

{
  "fromDate": "2025-01-01",
  "toDate": "2025-01-01",
  "fromTime": "12:00:00",
  "toTime": "12:00:00",
  "realDeliveryDate": "2025-01-01"
}

[
  {
    "cis": "example",
    "uin": "example",
    "rnpt": "example",
    "gtd": "example",
    "countryCode": "RU"
  }
]

{
  "current": 1,
  "total": 2
}

[
  {
    "id": 0,
    "fullCount": 1,
    "partialCount": {
      "current": 1,
      "total": 2
    },
    "instances": [
      {
        "cis": "example",
        "uin": "example",
        "rnpt": "example",
        "gtd": "example",
        "countryCode": "RU"
      }
    ]
  }
]

[
  {
    "items": [
      {
        "id": 0,
        "fullCount": 1,
        "partialCount": {
          "current": 1,
          "total": 2
        },
        "instances": [
          {}
        ]
      }
    ],
    "boxId": 0,
    "barcode": "example"
  }
]

{
  "latitude": 0.5,
  "longitude": 0.5
}

{
  "country": "example",
  "postcode": "example",
  "city": "example",
  "district": "example",
  "subway": "example",
  "street": "example",
  "house": "example",
  "block": "example",
  "entrance": "example",
  "entryphone": "example",
  "floor": "example",
  "apartment": "example",
  "gps": {
    "latitude": 0.5,
    "longitude": 0.5
  }
}

{
  "id": 0,
  "name": "example",
  "type": "OTHER",
  "parent": null
}

{
  "address": {
    "country": "example",
    "postcode": "example",
    "city": "example",
    "district": "example",
    "subway": "example",
    "street": "example",
    "house": "example",
    "block": "example",
    "entrance": "example",
    "entryphone": "example",
    "floor": "example",
    "apartment": "example",
    "gps": {
      "latitude": 0.5,
      "longitude": 0.5
    }
  },
  "region": {
    "id": 0,
    "name": "example",
    "type": "OTHER",
    "parent": null
  }
}

{
  "latitude": 0.5,
  "longitude": 0.5
}

{
  "country": "example",
  "postcode": "example",
  "city": "example",
  "district": "example",
  "subway": "example",
  "street": "example",
  "house": "example",
  "block": "example",
  "entrance": "example",
  "entryphone": "example",
  "floor": "example",
  "apartment": "example",
  "gps": {
    "latitude": 0.5,
    "longitude": 0.5
  }
}

{
  "id": 0,
  "name": "example",
  "type": "OTHER",
  "parent": null
}

{
  "address": {
    "country": "example",
    "postcode": "example",
    "city": "example",
    "district": "example",
    "subway": "example",
    "street": "example",
    "house": "example",
    "block": "example",
    "entrance": "example",
    "entryphone": "example",
    "floor": "example",
    "apartment": "example",
    "gps": {
      "latitude": 0.5,
      "longitude": 0.5
    }
  },
  "region": {
    "id": 0,
    "name": "example",
    "type": "OTHER",
    "parent": null
  },
  "logisticPointId": 1,
  "outletCode": "example",
  "outletStorageLimitDate": "2025-01-01"
}

{
  "id": 0,
  "shipmentDate": "2025-01-01",
  "shipmentTime": "12:00:00"
}

[
  {
    "trackCode": "example",
    "deliveryServiceId": 0
  }
]

{
  "fullName": "example",
  "phone": "example",
  "phoneExtension": "example",
  "vehicleNumber": "example",
  "vehicleDescription": "example"
}

{
  "eacType": "MERCHANT_TO_COURIER",
  "eacCode": "example"
}

{
  "courier": {
    "fullName": "example",
    "phone": "example",
    "phoneExtension": "example",
    "vehicleNumber": "example",
    "vehicleDescription": "example"
  },
  "eac": {
    "eacType": "MERCHANT_TO_COURIER",
    "eacCode": "example"
  }
}

Order delivery information.

{
  "type": "DELIVERY",
  "serviceName": "example",
  "deliveryServiceId": 0,
  "warehouseId": "example",
  "deliveryPartnerType": "SHOP",
  "dispatchType": "UNKNOWN",
  "dates": {
    "fromDate": "2025-01-01",
    "toDate": "2025-01-01",
    "fromTime": "12:00:00",
    "toTime": "12:00:00",
    "realDeliveryDate": "2025-01-01"
  },
  "shipment": {
    "id": 0,
    "shipmentDate": "2025-01-01",
    "shipmentTime": "12:00:00"
  },
  "courier": {
    "address": {
      "country": "example",
      "postcode": "example",
      "city": "example",
      "district": "example",
      "subway": "example",
      "street": "example",
      "house": "example",
      "block": "example",
      "entrance": "example",
      "entryphone": "example",
      "floor": "example",
      "apartment": "example",
      "gps": {
        "latitude": 0.5,
        "longitude": 0.5
      }
    },
    "region": {
      "id": 0,
      "name": "example",
      "type": "OTHER",
      "parent": null
    }
  },
  "pickup": {
    "address": {
      "country": "example",
      "postcode": "example",
      "city": "example",
      "district": "example",
      "subway": "example",
      "street": "example",
      "house": "example",
      "block": "example",
      "entrance": "example",
      "entryphone": "example",
      "floor": "example",
      "apartment": "example",
      "gps": {
        "latitude": 0.5,
        "longitude": 0.5
      }
    },
    "region": {
      "id": 0,
      "name": "example",
      "type": "OTHER",
      "parent": null
    },
    "logisticPointId": 1,
    "outletCode": "example",
    "outletStorageLimitDate": "2025-01-01"
  },
  "transfer": {
    "courier": {
      "fullName": "example",
      "phone": "example",
      "phoneExtension": "example",
      "vehicleNumber": "example",
      "vehicleDescription": "example"
    },
    "eac": {
      "eacType": "MERCHANT_TO_COURIER",
      "eacCode": "example"
    }
  },
  "boxesLayout": [
    {
      "items": [
        {
          "id": 0,
          "fullCount": 1,
          "partialCount": {},
          "instances": [
            null
          ]
        }
      ],
      "boxId": 0,
      "barcode": "example"
    }
  ],
  "tracks": [
    {
      "trackCode": "example",
      "deliveryServiceId": 0
    }
  ],
  "estimated": true
}

fake

Type: boolean

Order type:

• false — the real customer's order.

• true — test order Yandex. Market.

items

[
  {
    "cis": "example",
    "cisFull": "example",
    "uin": "example",
    "rnpt": "example",
    "gtd": "example",
    "countryCode": "RU"
  }
]

{
  "value": 0.5,
  "currencyId": "RUR"
}

{
  "value": 0.5,
  "currencyId": "RUR"
}

{
  "value": 0.5,
  "currencyId": "RUR"
}

{
  "payment": {
    "value": 0.5,
    "currencyId": "RUR"
  },
  "subsidy": {
    "value": 0.5,
    "currencyId": "RUR"
  },
  "cashback": {
    "value": 0.5,
    "currencyId": "RUR"
  },
  "vat": "NO_VAT"
}

[
  "CIS"
]

[
  "ULTIMA"
]

The list of products in the order.

[
  {
    "id": 0,
    "offerId": "example",
    "offerName": "example",
    "count": 0,
    "prices": {
      "payment": {
        "value": 0.5,
        "currencyId": "RUR"
      },
      "subsidy": {
        "value": 0.5,
        "currencyId": "RUR"
      },
      "cashback": {
        "value": 0.5,
        "currencyId": "RUR"
      },
      "vat": "NO_VAT"
    },
    "instances": [
      {
        "cis": "example",
        "cisFull": "example",
        "uin": "example",
        "rnpt": "example",
        "gtd": "example",
        "countryCode": "RU"
      }
    ],
    "requiredInstanceTypes": [
      "CIS"
    ],
    "tags": [
      "ULTIMA"
    ]
  }
]

orderId

Type: integer

The order ID.

paymentMethod

Type: string

Order payment method:

• Values if payment is selected at checkout ("paymentType": "PREPAID"):

  • YANDEX — by bank card.

  • APPLE_PAY — Apple Pay (not in use).

  • GOOGLE_PAY — Google Pay (not in use).

  • CREDIT — on credit.

  • TINKOFF_CREDIT — on credit from Tinkoff Bank.

  • TINKOFF_INSTALLMENTS — installments at Tinkoff Bank.

  • EXTERNAL_CERTIFICATE — with a gift certificate (for example, from the Sberbank Online application).

  • SBP — through the fast payment system.

  • B2B_ACCOUNT_PREPAYMENT — The organization pays for the order.

  • MICROCREDIT - Split based on MCC (Micro-credit company).

  • BNPL_TBYB - Payment after delivery based on Split.

• Values if payment is selected upon receipt of the order ("paymentType": "POSTPAID"):

  • CARD_ON_DELIVERY — by bank card.

  • BOUND_CARD_ON_DELIVERY — with a linked bank card upon receipt.

  • BNPL_BANK_ON_DELIVERY — super Split.

  • BNPL_ON_DELIVERY — Split.

  • CASH_ON_DELIVERY — in cash.

  • B2B_ACCOUNT_POSTPAYMENT — the order is paid for by the organization after delivery.

• UNKNOWN — unknown type.

Default value: CASH_ON_DELIVERY.

Enum: CASH_ON_DELIVERY, CARD_ON_DELIVERY, BOUND_CARD_ON_DELIVERY, BNPL_BANK_ON_DELIVERY, BNPL_ON_DELIVERY, YANDEX, APPLE_PAY, EXTERNAL_CERTIFICATE, CREDIT, GOOGLE_PAY, TINKOFF_CREDIT, SBP, TINKOFF_INSTALLMENTS, B2B_ACCOUNT_PREPAYMENT, B2B_ACCOUNT_POSTPAYMENT, MICROCREDIT, BNPL_TBYB, UNKNOWN

paymentType

Type: string

Order payment type:

• PREPAID — payment at checkout.

• POSTPAID — payment is made upon receipt of the order.

• UNKNOWN — unknown type.

If this parameter is omitted, the order will be paid upon receipt.

Enum: PREPAID, POSTPAID, UNKNOWN

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

substatus

Type: string

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

buyerType

Type: string

Type of buyer:

• PERSON — a natural person.

• BUSINESS — organization.

Enum: PERSON, BUSINESS

cancelRequested

Type: boolean

For the model only DBS

Whether a cancellation has been requested.

externalOrderId

Type: string

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

Min length: 1

Example: example

notes

Type: string

Comment on the order.

Example: example

prices

{
  "value": 0.5,
  "currencyId": "RUR"
}

{
  "value": 0.5,
  "currencyId": "RUR"
}

{
  "value": 0.5,
  "currencyId": "RUR"
}

{
  "payment": {
    "value": 0.5,
    "currencyId": "RUR"
  },
  "subsidy": {
    "value": 0.5,
    "currencyId": "RUR"
  },
  "vat": "NO_VAT"
}

{
  "value": 0.5,
  "currencyId": "RUR"
}

{
  "value": 0.5,
  "currencyId": "RUR"
}

Information about the cost of the order.

{
  "payment": {
    "value": 0.5,
    "currencyId": "RUR"
  },
  "subsidy": {
    "value": 0.5,
    "currencyId": "RUR"
  },
  "cashback": {
    "value": 0.5,
    "currencyId": "RUR"
  },
  "delivery": {
    "payment": {
      "value": 0.5,
      "currencyId": "RUR"
    },
    "subsidy": {
      "value": 0.5,
      "currencyId": "RUR"
    },
    "vat": "NO_VAT"
  }
}

programType

Type: string

Working model:

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

Enum: FBY, FBS, DBS, EXPRESS, LAAS

services

Services added to the order.

{
  "liftType": "NOT_NEEDED"
}

sourcePlatform

Type: string

The site is the source of the order:

• MARKET — an order placed on the Market.

• OTHER — LaaS is an order created by the seller.

Enum: MARKET, OZON, WILDBERRIES, OTHER

updateDate

Type: string<date-time>

The date and time of the last order update.

Date format: ISO 8601 with an offset relative to UTC.

Example: 2020-02-02T14:30:30+03:00

nextPageToken

Type: string

ID of the next results page.

Example: example