# Obter lista de pedidos para o período especificado

Recupera a lista de pedidos, organizada da data de criação mais antiga para a mais recente.

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

## Path parameters:

  - `project_id` (integer, required)
    ID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.
    Example: 44056

## Request fields (application/json):

  - `created_date_from` (string)
    Data de início ou data-hora do período de criação do pedido de acordo com o padrão [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601).
    Example: "2020-04-15T18:16:00+05:00"

  - `created_date_until` (string)
    Data de finalização ou data-hora do período de criação do pedido de acordo com o padrão [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601).
    Example: "2020-04-16T18:16:00+05:00"

  - `limit` (integer)
    Um limite no número de pedidos incluídos na resposta.

  - `offset` (integer)
    Número da ordem a partir do qual a lista é gerada (a contagem começa em 0).

## Response 200 fields (application/json):

  - `has_more` (boolean)
    Se existem páginas adicionais ou não.
    Example: true

  - `orders` (array)
    Lista de pedidos.

  - `orders.coupons` (array,null)
    Lista de cupons aplicada ao pedido.

  - `orders.coupons.code` (string)
    Código de cupom usado. Código exclusivo que diferencia maiúsculas de minúsculas. Contém letras e números.

  - `orders.coupons.coupon_id` (integer)
    ID do cupom, gerado pela Xsolla ao criar uma promoção com um cupom.

  - `orders.coupons.sku` (string)
    SKU do cupom, gerado pela Xsolla ao criar uma promoção com cupom.

  - `orders.coupons.type` (string)
    Tipo de cupom.
    Enum: "unique_catalog_offer", "coupon", "promocode"

  - `orders.date_created` (string)
    Data de criação do pedido ou código de data e hora de acordo com o padrão [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601).
    Example: "2020-08-11T10:00:00+03:00"

  - `orders.invoice_id` (string)
    ID da fatura.

  - `orders.is_free` (boolean)
    Se o pedido é gratuito ou não.

  - `orders.items` (array)
    Lista de itens.

  - `orders.items.description` (object,null)
    Objeto com informações sobre o item.

  - `orders.items.description.description` (string)
    Descrição do item.

  - `orders.items.description.image_url` (string)
    URL da imagem do item.

  - `orders.items.description.name` (string)
    Nome do item.

  - `orders.items.is_bonus` (boolean)
    Se o item é um bônus ou não.

  - `orders.items.is_free` (boolean)
    Se o item é gratuito ou não.

  - `orders.items.item_id` (integer)
    ID do item. Ele é gerado pela Xsolla ao criar um item.
    Example: 1

  - `orders.items.order_item_id` (integer)
    ID do item na ordem. Ele é gerado pela Xsolla durante a criação do pedido.

  - `orders.items.price` (object,null)
    Preço do item.

  - `orders.items.price.amount` (string)
    Preço do item com desconto.
    Example: "30"

  - `orders.items.price.amount_without_discount` (string)
    Preço do item sem descontos.
    Example: "30"

  - `orders.items.price.currency` (string)
    SKU da moeda virtual ou código de três letras de acordo com o padrão [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Consulte a documentação para obter informações detalhadas sobre as [moedas suportadas pela Xsolla](https://developers.xsolla.com/pt/doc/pay-station/references/supported-currencies/).
    Example: "USD"

  - `orders.items.price.is_virtual_currency` (boolean)
    Se a moeda é virtual ou não.

  - `orders.items.quantity` (integer)
    Quantidade do item.
    Example: 1

  - `orders.items.region_id` (integer,null)
    ID da região onde o item está disponível. Consulte a [documentação](https://developers.xsolla.com/pt/doc/shop-builder/features/regional-restrictions/) para obter mais informações sobre restrições de vendas regionais.

  - `orders.items.sku` (string)
    ID do item especificado durante sua criação. O SKU pode conter apenas caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados.
    Example: "elven_shield"

  - `orders.items.tax_category` (string)
    Categoria fiscal.
    Example: "DG00002"

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

  - `orders.mode` (string)
    Modo de criação de pedidos.
    Enum: "default", "sandbox"

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

  - `orders.price` (object,null)
    Preço do pedido.

  - `orders.price.amount` (string)
    Preço final do pedido.
    Example: "30"

  - `orders.price.amount_without_discount` (string)
    Preço do pedido sem descontos.
    Example: "30"

  - `orders.price.currency` (string)
    SKU da moeda virtual ou código de três letras de uma moeda real de acordo com o padrão [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Consulte a documentação para obter informações detalhadas sobre as [moedas suportadas pela Xsolla](https://developers.xsolla.com/pt/doc/pay-station/references/supported-currencies/).
    Example: "USD"

  - `orders.project_id` (integer)
    ID do projeto. Você pode encontrar esse parâmetro em sua [Conta de Distribuidor](https://publisher.xsolla.com/) ao lado do nome do projeto.
    Example: 44056

  - `orders.promotions` (array,null)
    Lista de promoções aplicada ao pedido.

  - `orders.promotions.promotion_id` (integer)
    ID da promoção dentro do projeto.
    Example: 111425

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

  - `orders.user` (object)

  - `orders.user.country` (string)
    Código de país de duas letras maiúsculas de acordo com o padrão [ISO 3166-1 alfa-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Verifique a documentação para obter informações detalhadas sobre os [países suportados pela Xsolla](https://developers.xsolla.com/pt/doc/shop-builder/references/supported-countries/).
    Example: "US"

  - `orders.user.email` (string)
    E-mail do usuário formatado de acordo com o protocolo [RFC 822](https://www.w3.org/Protocols/rfc822/#z8).
    Example: "user@xsolla.com"

  - `orders.user.id` (string)
    ID de usuário passado ao criar o pedido.
    Example: "07e653a2b15011e6818f005056a54369"

  - `orders.user.region_id` (integer,null)
    ID da região do usuário. Ele será devolvido se as restrições de vendas regionais forem configuradas. O país do usuário, passado ao criar o pedido, é correspondido com a lista de países especificados ao [criar a região](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-create-region/). Consulte a [documentação](https://developers.xsolla.com/pt/doc/shop-builder/features/regional-restrictions/) para obter mais informações sobre restrições de vendas regionais.
    Example: 12

  - `total_items_count` (integer)
    O número total de pedidos para o período de tempo especificado.
    Example: 1

## Response 401 fields (application/json):

  - `errorCode` (integer)
    Example: 1020

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

  - `statusCode` (integer)
    Example: 401