# Получение списка заказов за указанный период

Возвращает список заказов, упорядоченный по дате создания — от самой ранней до самой поздней.

Endpoint: POST /v3/project/{project_id}/admin/order/search
Version: 2.0.0
Security: basicAuth

## Path parameters:

  - `project_id` (integer, required)
    ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта, а также в адресной строке браузера при работе с проектом. URL-адрес имеет следующий формат: https://publisher.xsolla.com//projects/.
    Example: 44056

## Request fields (application/json):

  - `limit` (integer)
    Ограничение на количество заказов для вывода в ответе.

  - `offset` (integer)
    Номер заказа, с которого формируется список в ответе (нумерация ведется с 0).

  - `created_date_from` (string)
    Дата или дата и время начала периода создания заказов согласно стандарту [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601).
    Example: "2020-04-15T18:16:00+05:00"

  - `created_date_until` (string)
    Дата или дата и время окончания периода создания заказов согласно стандарту [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601).
    Example: "2020-04-16T18:16:00+05:00"

## Response 200 fields (application/json):

  - `orders` (array)
    Список заказов.

  - `orders.order_id` (integer)
    ID заказа.
    Example: 1

  - `orders.project_id` (integer)
    ID проекта. Вы можете найти этот параметр в [Личном кабинете](https://publisher.xsolla.com/) рядом с названием проекта.
    Example: 44056

  - `orders.status` (string)
    Статус заказа. Подробное описание статусов приведено в разделе [Жизненный цикл заказа](https://developers.xsolla.com/ru/api/catalog/order-life-cycle).
    Enum: "new", "paid", "done", "canceled", "expired"

  - `orders.date_created` (string)
    Дата или дата и время создания заказа согласно стандарту [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601).
    Example: "2020-08-11T10:00:00+03:00"

  - `orders.mode` (string)
    Режим создания заказа.
    Enum: "default", "sandbox"

  - `orders.is_free` (boolean)
    Является ли заказ бесплатным.

  - `orders.invoice_id` (string)
    ID счета.

  - `orders.price` (object,null)
    Стоимость заказа.

  - `orders.price.amount` (string)
    Финальная стоимость заказа.
    Example: "30"

  - `orders.price.amount_without_discount` (string)
    Стоимость заказа без учета скидки.
    Example: "30"

  - `orders.price.currency` (string)
    Артикул виртуальной валюты или трехбуквенный код реальной валюты согласно стандарту [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Список валют, поддерживаемых Xsolla, [приведен в документации](https://developers.xsolla.com/ru/doc/pay-station/references/supported-currencies/).
    Example: "USD"

  - `orders.price.is_virtual_currency` (boolean)
    Является ли валюта виртуальной.

  - `orders.user` (object)

  - `orders.user.id` (string)
    ID пользователя, переданный при создании заказа.
    Example: "07e653a2b15011e6818f005056a54369"

  - `orders.user.country` (string)
    Двухбуквенное обозначение страны в верхнем регистре согласно стандарту [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Список стран, поддерживаемых Xsolla, приведен [в документации](https://developers.xsolla.com/ru/doc/shop-builder/references/supported-countries/).
    Example: "US"

  - `orders.user.email` (string)
    Email-адрес пользователя. Должен быть валидным в соответствии с протоколом [ RFC 822](https://www.w3.org/Protocols/rfc822/#z8).
    Example: "user@xsolla.com"

  - `orders.user.region_id` (integer,null)
    ID региона пользователя. Возвращается, если настроены региональные ограничения продаж. Страна пользователя, переданная при создании заказа, сопоставляется со списком стран, указанных при [создании региона](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-create-region/). Подробную информацию о региональных ограничениях продаж читайте в [документации](https://developers.xsolla.com/ru/doc/shop-builder/features/regional-restrictions/).
    Example: 12

  - `orders.items` (array)
    Список товаров.

  - `orders.items.order_item_id` (integer)
    ID товара в заказе. Генерируется на стороне Xsolla во время создания заказа.

  - `orders.items.item_id` (integer)
    ID товара. Генерируется на стороне Xsolla при создании товара.
    Example: 1

  - `orders.items.sku` (string)
    ID товара, указанный при его создании. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания.
    Example: "elven_shield"

  - `orders.items.type` (string)
    Тип товара.
    Enum: "virtual_good", "virtual_currency", "bundle", "game_key", "physical_good", "value_point"

  - `orders.items.quantity` (integer)
    Количество товаров.
    Example: 1

  - `orders.items.is_free` (boolean)
    Является ли товар бесплатным.

  - `orders.items.is_bonus` (boolean)
    Является ли товар бонусным.

  - `orders.items.region_id` (integer,null)
    ID региона, в котором товар доступен. Подробную информацию о региональных ограничениях продаж читайте в [документации](https://developers.xsolla.com/ru/doc/shop-builder/features/regional-restrictions/).

  - `orders.items.tax_category` (string)
    Налоговая категория.
    Example: "DG00002"

  - `orders.items.price` (object,null)
    Цена товара.

  - `orders.items.price.amount` (string)
    Цена товара со скидкой.
    Example: "30"

  - `orders.items.price.amount_without_discount` (string)
    Цена товара без скидки.
    Example: "30"

  - `orders.items.price.currency` (string)
    Артикул виртуальной валюты или трехбуквенный код реальной валюты согласно стандарту [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Список валют, поддерживаемых Xsolla, [приведен в документации](https://developers.xsolla.com/ru/doc/pay-station/references/supported-currencies/).
    Example: "USD"

  - `orders.items.price.is_virtual_currency` (boolean)
    Является ли валюта виртуальной.

  - `orders.items.description` (object,null)
    Объект с информацией о товаре.

  - `orders.items.description.name` (string)
    Название товара.

  - `orders.items.description.image_url` (string)
    URL-адрес изображения товара.

  - `orders.items.description.description` (string)
    Описание товара.

  - `orders.promotions` (array,null)
    Список акций, примененных к заказу.

  - `orders.promotions.promotion_id` (integer)
    ID акции в рамках проекта.
    Example: 111425

  - `orders.coupons` (array,null)
    Список купонов, примененных к заказу.

  - `orders.coupons.coupon_id` (integer)
    ID купона, сгенерированный на стороне Xsolla при создании акции с купоном.

  - `orders.coupons.sku` (string)
    Артикул купона, сгенерированный на стороне Xsolla при создании акции с купоном.

  - `orders.coupons.code` (string)
    Используемый код купона. Уникальный код, чувствительный к регистру. Содержит буквы и цифры.

  - `orders.coupons.type` (string)
    Тип купона.
    Enum: "unique_catalog_offer", "coupon", "promocode"

  - `total_items_count` (integer)
    Общее количество заказов за указанный период времени.
    Example: 1

  - `has_more` (boolean)
    Есть ли дополнительные страницы.
    Example: true

## Response 401 fields (application/json):

  - `statusCode` (integer)
    Example: 401

  - `errorCode` (integer)
    Example: 1020

  - `errorMessage` (string)
    Example: "[0401-1020]: Error in Authentication method occurred"