Получение заказа по ID

Возвращает информацию о заказе по его уникальному идентификатору.

Request

GET

https://api.kit.yandex.net/v1/orders/{id}

Responses

200 OK

Заказ.

Body

application/json

{
  "id": "019b56d1-5ef0-7ed2-a155-7110d25ca5ce",
  "order_number": 1234567,
  "created_at": "2020-01-01T00:00:00Z",
  "status": "NEW",
  "client": {
    "last_name": "Иванов",
    "first_name": "Иван",
    "patronymic": "Иванович",
    "phone": "+79991234567",
    "email": "user@example.com",
    "is_notify": true
  },
  "payment": {
    "method": "CARD_ONLINE",
    "status": "PAYMENT_PENDING_OR_UNPAID"
  },
  "delivery_chunks": [
    {
      "id": 0,
      "items": [
        {
          "id": "00000000-0000-0000-0000-000000000001",
          "product_variant_id": "00000000-0000-0000-0000-000000000001",
          "is_product_variant_deleted": false,
          "quantity": 2,
          "price": "1200.00",
          "final_price": "1100.00",
          "vat": 20,
          "truthful_label": "example",
          "refused_count": 0,
          "loyalty_discount": "0.00",
          "promocode_discount": "100.00",
          "gift_card_discount": "0.00"
        }
      ],
      "delivery_info": {
        "delivered_at": "2025-01-01T00:00:00Z",
        "method": "COURIER",
        "raw_status": "example",
        "human_status": "example",
        "address": {
          "pickup_point_id": "example",
          "courier_locality": "example",
          "courier_address": "example",
          "pickup_point_locality": "example",
          "pickup_point_address": "example",
          "self_pick_up_warehouse_id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
          "self_pick_up_locality": "example",
          "self_pick_up_address": "example",
          "floor": "example",
          "appartment": "example",
          "entrance": "example",
          "intercom": "example"
        },
        "interval": {
          "from": "2020-01-01T00:00:00Z",
          "to": "2020-01-01T00:00:00Z"
        },
        "courier_interval": null,
        "pickup_point_interval": null,
        "seller_costs": "1200.00",
        "customer_costs": "1200.00",
        "tracking_number": "example",
        "tracking_url": "example",
        "delivery_notes": "example",
        "courier_delivery_service_type": "YANDEX_DELIVERY",
        "pickup_point_delivery_service_type": null,
        "warehouse_id": null
      },
      "total_price": "1200.00",
      "total_final_price": "1100.00",
      "purchased_price": "1100.00"
    }
  ],
  "total_price": "1200.00",
  "total_final_price": "1200.00",
  "purchased_price": "example",
  "acquiring_id": "019b56d1-89a5-7a78-849f-4e8b174d0c77",
  "acquiring_type": "CLOUD_PAY",
  "promocode": {
    "code": "HELLO5",
    "discount": "1200.00"
  },
  "gift_card_discount": "0.00",
  "gift_card_id": "019b56d1-a80d-7afe-a2ae-09047912f03e"
}

Name	Description
client	Type: OrderClientInfo Example `{ "last_name": "Иванов", "first_name": "Иван", "patronymic": "Иванович", "phone": "+79991234567", "email": "user@example.com", "is_notify": true }`
created_at	Type: string<date-time> Дата и время создания заказа. Example: `2020-01-01T00:00:00Z`
delivery_chunks	Type: OrderDeliveryChunk[] Части заказа с информацией о доставке. Каждый чанк содержит товары, отправляемые с одного склада. Example [ { "id": 0, "items": [ { "id": "00000000-0000-0000-0000-000000000001", "product_variant_id": "00000000-0000-0000-0000-000000000001", "is_product_variant_deleted": false, "quantity": 2, "price": "1200.00", "final_price": "1100.00", "vat": 20, "truthful_label": "example", "refused_count": 0, "loyalty_discount": "0.00", "promocode_discount": "100.00", "gift_card_discount": "0.00" } ], "delivery_info": { "delivered_at": "2025-01-01T00:00:00Z", "method": "COURIER", "raw_status": "example", "human_status": "example", "address": { "pickup_point_id": "example", "courier_locality": "example", "courier_address": "example", "pickup_point_locality": "example", "pickup_point_address": "example", "self_pick_up_warehouse_id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9", "self_pick_up_locality": "example", "self_pick_up_address": "example", "floor": "example", "appartment": "example", "entrance": "example", "intercom": "example" }, "interval": { "from": "2020-01-01T00:00:00Z", "to": "2020-01-01T00:00:00Z" }, "courier_interval": null, "pickup_point_interval": null, "seller_costs": "1200.00", "customer_costs": "1200.00", "tracking_number": "example", "tracking_url": "example", "delivery_notes": "example", "courier_delivery_service_type": "YANDEX_DELIVERY", "pickup_point_delivery_service_type": null, "warehouse_id": null }, "total_price": "1200.00", "total_final_price": "1100.00", "purchased_price": "1100.00" } ]
gift_card_discount	Type: string<decimal> Скидка по подарочной карте. Example: `0.00`
id	Type: OrderID Идентификатор заказа. Example: `019b56d1-5ef0-7ed2-a155-7110d25ca5ce`
order_number	Type: integer Номер заказа, отображаемый покупателю.
purchased_price	Type: string<decimal> Итоговая стоимость после возвратов. Example: `example`
status	Type: OrderStatus Статус заказа: `NEW` — новый заказ. `PENDING_PAYMENT` — ожидает оплаты. `ORDER_PLACED` — заказ оформлен. `WAIT_FOR_CONFIRMATION` — ожидает подтверждения продавцом. `CREATING_INITIAL_RECEIPT` — создание чека. `SETUP_DELIVERY` — настройка доставки. `WAIT_FOR_DELIVERY` — ожидает доставки. `CANCELLATION_IN_PROGRESS` — отмена в процессе. `DELIVERY_CANCELLED` — доставка отменена. `FULL_REFUND` — полный возврат. `PARTIAL_REFUND` — частичный возврат. `CREATING_FINAL_RECEIPTS` — создание финальных чеков. `DELIVERED` — доставлен. `CANCELLED` — отменен. `COMPLETED` — завершен. Enum: `NEW`, `PENDING_PAYMENT`, `ORDER_PLACED`, `WAIT_FOR_CONFIRMATION`, `CREATING_INITIAL_RECEIPT`, `SETUP_DELIVERY`, `WAIT_FOR_DELIVERY`, `CANCELLATION_IN_PROGRESS`, `DELIVERY_CANCELLED`, `FULL_REFUND`, `PARTIAL_REFUND`, `CREATING_FINAL_RECEIPTS`, `DELIVERED`, `CANCELLED`, `COMPLETED`
total_final_price	Type: string<decimal> Итоговая стоимость заказа после всех скидок. Example: `1200.00`
total_price	Type: string<decimal> Общая стоимость заказа до скидок. Example: `1200.00`
acquiring_id	Type: string Идентификатор платежа в эквайринге. Example: `019b56d1-89a5-7a78-849f-4e8b174d0c77`
acquiring_type	Type: AcquiringType Тип платежной системы. Enum: `CLOUD_PAY`, `YANDEX_PAY`
gift_card_id	Type: string<uuid> Идентификатор использованной подарочной карты. Example: `019b56d1-a80d-7afe-a2ae-09047912f03e`
payment	Type: OrderPaymentInfo Example `{ "method": "CARD_ONLINE", "status": "PAYMENT_PENDING_OR_UNPAID" }`
promocode	Type: OrderPromocodeInfo Информация о примененном промокоде. Example `{ "code": "HELLO5", "discount": "1200.00" }`

OrderID

Идентификатор заказа.

Type: string<uuid>

Example: 019b56d1-5ef0-7ed2-a155-7110d25ca5ce

OrderStatus

Статус заказа:

NEW — новый заказ.
PENDING_PAYMENT — ожидает оплаты.
ORDER_PLACED — заказ оформлен.
WAIT_FOR_CONFIRMATION — ожидает подтверждения продавцом.
CREATING_INITIAL_RECEIPT — создание чека.
SETUP_DELIVERY — настройка доставки.
WAIT_FOR_DELIVERY — ожидает доставки.
CANCELLATION_IN_PROGRESS — отмена в процессе.
DELIVERY_CANCELLED — доставка отменена.
FULL_REFUND — полный возврат.
PARTIAL_REFUND — частичный возврат.
CREATING_FINAL_RECEIPTS — создание финальных чеков.
DELIVERED — доставлен.
CANCELLED — отменен.
COMPLETED — завершен.

Type: string

Enum: NEW, PENDING_PAYMENT, ORDER_PLACED, WAIT_FOR_CONFIRMATION, CREATING_INITIAL_RECEIPT, SETUP_DELIVERY, WAIT_FOR_DELIVERY, CANCELLATION_IN_PROGRESS, DELIVERY_CANCELLED, FULL_REFUND, PARTIAL_REFUND, CREATING_FINAL_RECEIPTS, DELIVERED, CANCELLED, COMPLETED

OrderClientInfo

Name	Description
is_notify	Type: boolean Нужно ли уведомлять клиента о статусах заказа.
email	Type: string<email> Email клиента. Example: `user@example.com`
first_name	Type: string Имя клиента. Example: `Иван`
last_name	Type: string Фамилия клиента. Example: `Иванов`
patronymic	Type: string Отчество клиента. Example: `Иванович`
phone	Type: string Телефон клиента. Example: `+79991234567`

Example

{
  "last_name": "Иванов",
  "first_name": "Иван",
  "patronymic": "Иванович",
  "phone": "+79991234567",
  "email": "user@example.com",
  "is_notify": true
}

PaymentMethod

Type: string

Enum: CARD_ONLINE, CARD_ON_DELIVERY, CASH_ON_DELIVERY

PaymentStatus

Type: string

Enum: PAYMENT_PENDING_OR_UNPAID, PAYMENT_PAID, PAYMENT_REFUNDED, PAYMENT_FINALLY_PAID

OrderPaymentInfo

Name

Description

method

Type: PaymentMethod

Enum: CARD_ONLINE, CARD_ON_DELIVERY, CASH_ON_DELIVERY

status

Type: PaymentStatus

Enum: PAYMENT_PENDING_OR_UNPAID, PAYMENT_PAID, PAYMENT_REFUNDED, PAYMENT_FINALLY_PAID

Example

{
  "method": "CARD_ONLINE",
  "status": "PAYMENT_PENDING_OR_UNPAID"
}

OrderItem

Товар в заказе

Name	Description
final_price	Type: string<decimal> Итоговая цена товара за единицу после всех скидок. Example: `1100.00`
gift_card_discount	Type: string<decimal> Скидка по подарочной карте. Example: `0.00`
id	Type: string<uuid> Уникальный идентификатор позиции в заказе. Example: `00000000-0000-0000-0000-000000000001`
is_product_variant_deleted	Type: boolean Является ли товар на данный момент удаленным.
loyalty_discount	Type: string<decimal> Скидка по программе лояльности. Example: `0.00`
price	Type: string<decimal> Цена товара за единицу до скидок. Example: `1200.00`
product_variant_id	Type: string<uuid> Идентификатор товара. Example: `00000000-0000-0000-0000-000000000001`
promocode_discount	Type: string<decimal> Скидка по промокоду. Example: `100.00`
quantity	Type: integer Количество товара.
vat	Type: integer НДС в процентах. Специальное значение -1 означает, что товар не облагается НДС.
refused_count	Type: integer Количество отказов по данной позиции.
truthful_label	Type: string Честный знак товара. Example: `example`

Example

{
  "id": "00000000-0000-0000-0000-000000000001",
  "product_variant_id": "00000000-0000-0000-0000-000000000001",
  "is_product_variant_deleted": false,
  "quantity": 2,
  "price": "1200.00",
  "final_price": "1100.00",
  "vat": 20,
  "truthful_label": "example",
  "refused_count": 0,
  "loyalty_discount": "0.00",
  "promocode_discount": "100.00",
  "gift_card_discount": "0.00"
}

DeliveryMethod

Type: string

Enum: COURIER, POSTAL_SERVICE, PICKUP_POINT, SELF_PICK_UP

WarehouseID

Идентификатор склада.

Type: string<uuid>

Example: 019b21d9-c5d9-777d-80bd-d67c664bc6d9

OrderAddressInfo

Name	Description
appartment	Type: string Example: `example`
courier_address	Type: string Example: `example`
courier_locality	Type: string Example: `example`
entrance	Type: string Example: `example`
floor	Type: string Example: `example`
intercom	Type: string Example: `example`
pickup_point_address	Type: string Example: `example`
pickup_point_id	Type: string Example: `example`
pickup_point_locality	Type: string Example: `example`
self_pick_up_address	Type: string Example: `example`
self_pick_up_locality	Type: string Example: `example`
self_pick_up_warehouse_id	Type: WarehouseID Идентификатор склада. Example: `019b21d9-c5d9-777d-80bd-d67c664bc6d9`

Example

{
  "pickup_point_id": "example",
  "courier_locality": "example",
  "courier_address": "example",
  "pickup_point_locality": "example",
  "pickup_point_address": "example",
  "self_pick_up_warehouse_id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
  "self_pick_up_locality": "example",
  "self_pick_up_address": "example",
  "floor": "example",
  "appartment": "example",
  "entrance": "example",
  "intercom": "example"
}

TimeInterval

Name

Description

from

Type: string<date-time>

Example: 2020-01-01T00:00:00Z

Type: string<date-time>

Example: 2020-01-01T00:00:00Z

Example

{
  "from": "2020-01-01T00:00:00Z",
  "to": "2020-01-01T00:00:00Z"
}

DeliveryServiceType

Type: string

Enum: YANDEX_DELIVERY, CDEK, META_SHIP_DALLI, META_SHIP_RUSSIAN_POST, OZON, MERCHANT_SHIP

OrderDeliveryInfo

Информация о доставке заказа.

Name	Description
address	Type: OrderAddressInfo Example `{ "pickup_point_id": "example", "courier_locality": "example", "courier_address": "example", "pickup_point_locality": "example", "pickup_point_address": "example", "self_pick_up_warehouse_id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9", "self_pick_up_locality": "example", "self_pick_up_address": "example", "floor": "example", "appartment": "example", "entrance": "example", "intercom": "example" }`
human_status	Type: string Человекочитаемый статус доставки. Example: `example`
raw_status	Type: string Статус доставки от службы доставки. Example: `example`
courier_delivery_service_type	Type: DeliveryServiceType Enum: `YANDEX_DELIVERY`, `CDEK`, `META_SHIP_DALLI`, `META_SHIP_RUSSIAN_POST`, `OZON`, `MERCHANT_SHIP`
courier_interval	Type: TimeInterval Example `{ "from": "2020-01-01T00:00:00Z", "to": "2020-01-01T00:00:00Z" }`
customer_costs	Type: string<decimal> Стоимость доставки для покупателя. Example: `1200.00`
delivered_at	Type: string<date-time> Дата и время доставки. Example: `2025-01-01T00:00:00Z`
delivery_notes	Type: string Комментарий к доставке. Example: `example`
interval	Type: TimeInterval Example `{ "from": "2020-01-01T00:00:00Z", "to": "2020-01-01T00:00:00Z" }`
method	Type: DeliveryMethod Enum: `COURIER`, `POSTAL_SERVICE`, `PICKUP_POINT`, `SELF_PICK_UP`
pickup_point_delivery_service_type	Type: DeliveryServiceType Enum: `YANDEX_DELIVERY`, `CDEK`, `META_SHIP_DALLI`, `META_SHIP_RUSSIAN_POST`, `OZON`, `MERCHANT_SHIP`
pickup_point_interval	Type: TimeInterval Example `{ "from": "2020-01-01T00:00:00Z", "to": "2020-01-01T00:00:00Z" }`
seller_costs	Type: string<decimal> Стоимость доставки для продавца. Example: `1200.00`
tracking_number	Type: string Трек-номер отправления. Example: `example`
tracking_url	Type: string Ссылка для отслеживания отправления. Example: `example`
warehouse_id	Type: WarehouseID Идентификатор склада. Example: `019b21d9-c5d9-777d-80bd-d67c664bc6d9`

Example

{
  "delivered_at": "2025-01-01T00:00:00Z",
  "method": "COURIER",
  "raw_status": "example",
  "human_status": "example",
  "address": {
    "pickup_point_id": "example",
    "courier_locality": "example",
    "courier_address": "example",
    "pickup_point_locality": "example",
    "pickup_point_address": "example",
    "self_pick_up_warehouse_id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
    "self_pick_up_locality": "example",
    "self_pick_up_address": "example",
    "floor": "example",
    "appartment": "example",
    "entrance": "example",
    "intercom": "example"
  },
  "interval": {
    "from": "2020-01-01T00:00:00Z",
    "to": "2020-01-01T00:00:00Z"
  },
  "courier_interval": null,
  "pickup_point_interval": null,
  "seller_costs": "1200.00",
  "customer_costs": "1200.00",
  "tracking_number": "example",
  "tracking_url": "example",
  "delivery_notes": "example",
  "courier_delivery_service_type": "YANDEX_DELIVERY",
  "pickup_point_delivery_service_type": null,
  "warehouse_id": null
}

OrderDeliveryChunk

Часть заказа, отправляемая с одного склада.

Name	Description
delivery_info	Type: OrderDeliveryInfo Информация о доставке заказа. Example { "delivered_at": "2025-01-01T00:00:00Z", "method": "COURIER", "raw_status": "example", "human_status": "example", "address": { "pickup_point_id": "example", "courier_locality": "example", "courier_address": "example", "pickup_point_locality": "example", "pickup_point_address": "example", "self_pick_up_warehouse_id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9", "self_pick_up_locality": "example", "self_pick_up_address": "example", "floor": "example", "appartment": "example", "entrance": "example", "intercom": "example" }, "interval": { "from": "2020-01-01T00:00:00Z", "to": "2020-01-01T00:00:00Z" }, "courier_interval": null, "pickup_point_interval": null, "seller_costs": "1200.00", "customer_costs": "1200.00", "tracking_number": "example", "tracking_url": "example", "delivery_notes": "example", "courier_delivery_service_type": "YANDEX_DELIVERY", "pickup_point_delivery_service_type": null, "warehouse_id": null }
id	Type: integer Идентификатор чанка внутри заказа.
items	Type: OrderItem[] Товары в данной части заказа. Example `[ { "id": "00000000-0000-0000-0000-000000000001", "product_variant_id": "00000000-0000-0000-0000-000000000001", "is_product_variant_deleted": false, "quantity": 2, "price": "1200.00", "final_price": "1100.00", "vat": 20, "truthful_label": "example", "refused_count": 0, "loyalty_discount": "0.00", "promocode_discount": "100.00", "gift_card_discount": "0.00" } ]`
purchased_price	Type: string<decimal> Итоговая стоимость после возвратов. Example: `1100.00`
total_final_price	Type: string<decimal> Итоговая стоимость товаров в чанке после всех скидок. Example: `1100.00`
total_price	Type: string<decimal> Стоимость товаров в чанке до скидок. Example: `1200.00`

Example

{
  "id": 0,
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000001",
      "product_variant_id": "00000000-0000-0000-0000-000000000001",
      "is_product_variant_deleted": false,
      "quantity": 2,
      "price": "1200.00",
      "final_price": "1100.00",
      "vat": 20,
      "truthful_label": "example",
      "refused_count": 0,
      "loyalty_discount": "0.00",
      "promocode_discount": "100.00",
      "gift_card_discount": "0.00"
    }
  ],
  "delivery_info": {
    "delivered_at": "2025-01-01T00:00:00Z",
    "method": "COURIER",
    "raw_status": "example",
    "human_status": "example",
    "address": {
      "pickup_point_id": "example",
      "courier_locality": "example",
      "courier_address": "example",
      "pickup_point_locality": "example",
      "pickup_point_address": "example",
      "self_pick_up_warehouse_id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
      "self_pick_up_locality": "example",
      "self_pick_up_address": "example",
      "floor": "example",
      "appartment": "example",
      "entrance": "example",
      "intercom": "example"
    },
    "interval": {
      "from": "2020-01-01T00:00:00Z",
      "to": "2020-01-01T00:00:00Z"
    },
    "courier_interval": null,
    "pickup_point_interval": null,
    "seller_costs": "1200.00",
    "customer_costs": "1200.00",
    "tracking_number": "example",
    "tracking_url": "example",
    "delivery_notes": "example",
    "courier_delivery_service_type": "YANDEX_DELIVERY",
    "pickup_point_delivery_service_type": null,
    "warehouse_id": null
  },
  "total_price": "1200.00",
  "total_final_price": "1100.00",
  "purchased_price": "1100.00"
}

AcquiringType

Тип платежной системы.

Type: string

Enum: CLOUD_PAY, YANDEX_PAY

OrderPromocodeInfo

Информация о примененном промокоде.

Name

Description

code

Type: string

Код промокода.

Example: HELLO5

discount

Type: string<decimal>

Сумма скидки по промокоду.

Example: 1200.00

Example

{
  "code": "HELLO5",
  "discount": "1200.00"
}

400 Bad Request

Некорректный запрос.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

401 Unauthorized

Не авторизован.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

404 Not Found

Ресурс не найден.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

500 Internal Server Error

Внутренняя ошибка сервера.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

Была ли статья полезна?

Получение списка заказов

Получение списка услуг заказа