Information about orders in the store

buyer

Type: object

Information about the buyer.

Parameters id, lastName, firstName and middleName They are returned only if you work according to the model. DBS.

{
  "id": "example",
  "lastName": "example",
  "firstName": "example",
  "middleName": "example",
  "type": "PERSON",
  "phone": "example"
}

buyerItemsTotalBeforeDiscount

Type: number

The cost of all items in the order in the buyer's currency, excluding shipping costs and before applying discounts on:

• shares;
• coupons;
• promo codes.

creationDate

Type: string<date-dd-MM-yyyy-HH-mm-ss>

Example: 23-09-2022 09:12:41

currency

Type: string

Currency codes:

• RUR — the Russian ruble.
• UAH — the Ukrainian hryvnia.
• BYR — the Belarusian ruble.
• KZT — Kazakhstani tenge.
• UZS — Uzbek sum.

Enum: RUR, USD, EUR, UAH, AUD, GBP, BYR, BYN, DKK, ISK, KZT, CAD, CNY, NOK, XDR, SGD, TRY, SEK, CHF, JPY, AZN, ALL, DZD, AOA, ARS, AMD, AFN, BHD, BGN, BOB, BWP, BND, BRL, BIF, HUF, VEF, KPW, VND, GMD, GHS, GNF, HKD, GEL, AED, EGP, ZMK, ILS, INR, IDR, JOD, IQD, IRR, YER, QAR, KES, KGS, COP, CDF, CRC, KWD, CUP, LAK, LVL, SLL, LBP, LYD, SZL, LTL, MUR, MRO, MKD, MWK, MGA, MYR, MAD, MXN, MZN, MDL, MNT, NPR, NGN, NIO, NZD, OMR, PKR, PYG, PEN, PLN, KHR, SAR, RON, SCR, SYP, SKK, SOS, SDG, SRD, TJS, THB, TWD, BDT, TZS, TND, TMM, UGX, UZS, UYU, PHP, DJF, XAF, XOF, HRK, CZK, CLP, LKR, EEK, ETB, RSD, ZAR, KRW, NAD, TL, UE

delivery

{
  "fromDate": "23-09-2022",
  "toDate": "23-09-2022",
  "fromTime": "12:00:00",
  "toTime": "12:00:00",
  "realDeliveryDate": "23-09-2022"
}

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

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

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

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

[
  {
    "id": 0,
    "fulfilmentId": "example"
  }
]

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

[
  {
    "id": 0,
    "shipmentDate": "23-09-2022",
    "shipmentTime": "example",
    "tracks": [
      {
        "trackCode": "example",
        "deliveryServiceId": 0
      }
    ],
    "boxes": [
      {
        "id": 0,
        "fulfilmentId": "example"
      }
    ]
  }
]

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

Delivery information.

{
  "id": "example",
  "type": "DELIVERY",
  "serviceName": "example",
  "price": 0.5,
  "deliveryPartnerType": "SHOP",
  "courier": {
    "fullName": "example",
    "phone": "example",
    "phoneExtension": "example",
    "vehicleNumber": "example",
    "vehicleDescription": "example"
  },
  "dates": {
    "fromDate": "23-09-2022",
    "toDate": "23-09-2022",
    "fromTime": "12:00:00",
    "toTime": "12:00:00",
    "realDeliveryDate": "23-09-2022"
  },
  "region": {
    "id": 0,
    "name": "example",
    "type": "OTHER",
    "parent": null
  },
  "address": {
    "country": "example",
    "postcode": "example",
    "city": "example",
    "district": "example",
    "subway": "example",
    "street": "example",
    "house": "example",
    "estate": "example",
    "block": "example",
    "building": "example",
    "entrance": "example",
    "entryphone": "example",
    "floor": "example",
    "apartment": "example",
    "phone": "example",
    "recipient": "example",
    "gps": {
      "latitude": 0.5,
      "longitude": 0.5
    }
  },
  "vat": "NO_VAT",
  "deliveryServiceId": 0,
  "logisticPointId": 1,
  "liftType": "NOT_NEEDED",
  "liftPrice": 0.5,
  "outletCode": "example",
  "outletStorageLimitDate": "23-09-2022",
  "dispatchType": "UNKNOWN",
  "tracks": [
    {
      "trackCode": "example",
      "deliveryServiceId": 0
    }
  ],
  "shipments": [
    {
      "id": 0,
      "shipmentDate": "23-09-2022",
      "shipmentTime": "example",
      "tracks": [
        {
          "trackCode": "example",
          "deliveryServiceId": 0
        }
      ],
      "boxes": [
        {
          "id": 0,
          "fulfilmentId": "example"
        }
      ]
    }
  ],
  "estimated": true,
  "eacType": "MERCHANT_TO_COURIER",
  "eacCode": "example"
}

deliveryTotal

Type: number

The cost of delivery.

fake

Type: boolean

Order type:

• false — the real customer's order.

• true — test order Yandex. Market.

id

Type: integer

The order ID.

items

[
  {
    "itemCount": 0,
    "itemStatus": "REJECTED",
    "updateDate": "23-09-2022"
  }
]

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

[
  {
    "type": "DIRECT_DISCOUNT",
    "discount": 0.5,
    "subsidy": 0.5,
    "shopPromoId": "example",
    "marketPromoId": "example"
  }
]

[
  "CIS"
]

[
  {
    "type": "YANDEX_CASHBACK",
    "amount": 0.5
  }
]

[
  "ULTIMA"
]

The list of products in the order.

[
  {
    "id": 0,
    "offerId": "example",
    "offerName": "example",
    "price": 0.5,
    "buyerPrice": 0.5,
    "buyerPriceBeforeDiscount": 0.5,
    "priceBeforeDiscount": 0.5,
    "count": 0,
    "vat": "NO_VAT",
    "shopSku": "example",
    "subsidy": 0.5,
    "partnerWarehouseId": "example",
    "promos": [
      {
        "type": "DIRECT_DISCOUNT",
        "discount": 0.5,
        "subsidy": 0.5,
        "shopPromoId": "example",
        "marketPromoId": "example"
      }
    ],
    "instances": [
      {
        "cis": "example",
        "cisFull": "example",
        "uin": "example",
        "rnpt": "example",
        "gtd": "example",
        "countryCode": "RU"
      }
    ],
    "details": [
      {
        "itemCount": 0,
        "itemStatus": "REJECTED",
        "updateDate": "23-09-2022"
      }
    ],
    "subsidies": [
      {
        "type": "YANDEX_CASHBACK",
        "amount": 0.5
      }
    ],
    "requiredInstanceTypes": [
      "CIS"
    ],
    "tags": [
      "ULTIMA"
    ]
  }
]

itemsTotal

Type: number

Buyer's payment.

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.

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

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

taxSystem

Type: string

The store's taxation system at the time of placing the order:

• ECHN — the Unified Agricultural Tax (UST).

• ENVD — the Unified imputed Income Tax (UTII).

• OSN — the general system of taxation (OSN).

• PSN — patent Taxation System (PSN).

• USN — simplified Taxation System (STS).

• USN_MINUS_COST — simplified taxation system, income reduced by the amount of expenses (USN "Income minus expenses").

• NPD — the tax on professional income (NAP).

• UNKNOWN_VALUE — unknown value.

Enum: OSN, USN, USN_MINUS_COST, ENVD, ECHN, PSN, NPD, UNKNOWN_VALUE

buyerItemsTotal

Type: number

The cost of all items in the order is in the buyer's currency after applying discounts and excluding shipping costs.

buyerTotal

Type: number

The cost of all items in the order in the buyer's currency after applying the discounts and taking into account the shipping cost.

buyerTotalBeforeDiscount

Type: number

The cost of all items in the order in the buyer's currency before applying discounts and including shipping costs (buyerItemsTotalBeforeDiscount + shipping cost).

cancelRequested

Type: boolean

For the model only DBS

Whether a cancellation has been requested.

expiryDate

Type: string<date-dd-MM-yyyy-HH-mm-ss>

Example: 23-09-2022 09:12:41

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

subsidies

List of subsidies by type.

Min items: 1

[
  {
    "type": "YANDEX_CASHBACK",
    "amount": 0.5
  }
]

updatedAt

Type: string<date-dd-MM-yyyy-HH-mm-ss>

Example: 23-09-2022 09:12:41

currentPage

Type: integer

The current page.

from

Type: integer

The initial number of the found element on the page.

pagesCount

Type: integer

The total number of pages.

pageSize

Type: integer

Page size.

to

Type: integer

The final number of the found element on the page.

total

Type: integer

How many items were found in total.

nextPageToken

Type: string

ID of the next results page.

Example: example