# Get orders list for specified period

Retrieves orders list, arranged from the earliest to the latest creation date.

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

## Path parameters:

  - `project_id` (integer, required)
    Project ID. You can find this parameter in your Publisher Account next to the name of the project.
    Example: 44056

## Request fields (application/json):

  - `limit` (integer)
    A limit on the number of orders included in the response.

  - `offset` (integer)
    Number of the order from which the list is generated (the count starts from 0).

  - `created_date_from` (string)
    Start date or date-time of the order creation period per [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601).
    Example: "2020-04-15T18:16:00+05:00"

  - `created_date_until` (string)
    End date or date-time of the order creation period per [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 list.

  - `orders.order_id` (integer)
    Order ID.
    Example: 1

  - `orders.project_id` (integer)
    Project ID. You can find this parameter in your [Publisher Account](https://publisher.xsolla.com/) next to the name of the project.
    Example: 44056

  - `orders.status` (string)
    Order status.
    Enum: "new", "paid", "done", "canceled", "expired"

  - `orders.date_created` (string)
    Order creation date or date-time code per [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601).
    Example: "2020-08-11T10:00:00+03:00"

  - `orders.mode` (string)
    Order creation mode.
    Enum: "default", "sandbox"

  - `orders.is_free` (boolean)
    Whether the order is free.

  - `orders.invoice_id` (string)
    Invoice ID.

  - `orders.price` (object,null)
    Order price.

  - `orders.price.amount` (string)
    Final order price.
    Example: "30"

  - `orders.price.amount_without_discount` (string)
    Order price without discounts.
    Example: "30"

  - `orders.price.currency` (string)
    SKU of virtual currency or three-letter code of real currency per [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Check the documentation for detailed information about [currencies supported by Xsolla](https://developers.xsolla.com/doc/pay-station/references/supported-currencies/).
    Example: "USD"

  - `orders.price.is_virtual_currency` (boolean)
    Whether the currency is virtual.

  - `orders.user` (object)

  - `orders.user.id` (string)
    User ID passed when creating the order.
    Example: "07e653a2b15011e6818f005056a54369"

  - `orders.user.country` (string)
    Two-letter uppercase country code per [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Check the documentation for detailed information about [countries supported by Xsolla](https://developers.xsolla.com/doc/shop-builder/references/supported-countries/).
    Example: "US"

  - `orders.user.email` (string)
    User email formatted according to the [RFC 822](https://www.w3.org/Protocols/rfc822/#z8) protocol.
    Example: "user@xsolla.com"

  - `orders.user.region_id` (integer,null)
    User's region ID. It is returned if regional sales restrictions are set up. The user's country, passed when creating the order, is matched with the list of countries specified when [creating the region](https://developers.xsolla.com/api/shop-builder/operation/admin-create-region/). Refer to the [documentation](https://developers.xsolla.com/doc/shop-builder/features/regional-restrictions/) for more information about regional sales restrictions.
    Example: 12

  - `orders.items` (array)
    Items list.

  - `orders.items.order_item_id` (integer)
    Item ID in the order. It is generated by Xsolla during the order creation.

  - `orders.items.item_id` (integer)
    Item ID. It is generated by Xsolla when creating an item.
    Example: 1

  - `orders.items.sku` (string)
    Item ID specified during its creation. The SKU may contain only lowercase and uppercase Latin alphanumeric characters, periods, dashes, and underscores.
    Example: "elven_shield"

  - `orders.items.type` (string)
    Type of item.
    Enum: "virtual_good", "virtual_currency", "bundle", "game_key", "physical_good", "value_point"

  - `orders.items.quantity` (integer)
    Item quantity.
    Example: 1

  - `orders.items.is_free` (boolean)
    Whether the item is free.

  - `orders.items.is_bonus` (boolean)
    Whether the item is a bonus.

  - `orders.items.region_id` (integer,null)
    ID of the region where the item is available. Refer to the [documentation](https://developers.xsolla.com/doc/shop-builder/features/regional-restrictions/) for more information about regional sales restrictions.

  - `orders.items.tax_category` (string)
    Tax category.
    Example: "DG00002"

  - `orders.items.price` (object,null)
    Item price.

  - `orders.items.price.amount` (string)
    Discounted item price.
    Example: "30"

  - `orders.items.price.amount_without_discount` (string)
    Item price without discounts.
    Example: "30"

  - `orders.items.price.currency` (string)
    SKU of virtual currency or three-letter code per [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Check the documentation for detailed information about [currencies supported by Xsolla](https://developers.xsolla.com/doc/pay-station/references/supported-currencies/).
    Example: "USD"

  - `orders.items.description` (object,null)
    Object with information about the item.

  - `orders.items.description.name` (string)
    Item name.

  - `orders.items.description.image_url` (string)
    Item image URL.

  - `orders.items.description.description` (string)
    Item description.

  - `orders.promotions` (array,null)
    Promotions list applied to order.

  - `orders.promotions.promotion_id` (integer)
    Promotion ID within the project.
    Example: 111425

  - `orders.coupons` (array,null)
    Coupons list applied to order.

  - `orders.coupons.coupon_id` (integer)
    Coupon ID, generated by Xsolla when creating a promotion with a coupon.

  - `orders.coupons.sku` (string)
    Coupon SKU, generated by Xsolla when creating a promotion with a coupon.

  - `orders.coupons.code` (string)
    Used coupon code. Unique case-sensitive code. Contains letters and numbers.

  - `orders.coupons.type` (string)
    Type of coupon.
    Enum: "unique_catalog_offer", "coupon", "promocode"

  - `total_items_count` (integer)
    The total number of orders for the specified period of time.
    Example: 1

  - `has_more` (boolean)
    Whether there are any additional pages.
    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"