# List Orders

Retrieves a list of all orders placed in the account.

Endpoint: GET /core/v1/orders
Version: 1.3.1
Security: BasicAuth

## Query parameters:

  - `perPage` (integer)
    Per Page is the number of records to return per request. Per Page defaults to 1,000.

  - `page` (integer)
    Page is which page to return.

## Response 200 fields (application/json):

  - `lastPage` (integer)
    LastPage is the identifier for the final page of results. It is only populated if there is another page of results after the current page.

  - `nextPage` (integer)
    NextPage is the identifier for the next page of results. It is only populated if there is another page of results after the current page.

  - `totalCount` (integer, required)
    TotalCount is total number of results.

  - `from` (integer, required)
    From specifies starting record number on current page.

  - `to` (integer, required)
    To specifies ending record number on current page.

  - `orders` (array, required)
    Orders is the collection of orders, if any, in the requesting account.

  - `orders.authAmount` (number)
    AuthAmount is the amount authorized to complete the order purchase.

  - `orders.createDate` (string)
    CreateDate is the date the order was placed.

  - `orders.currency` (string)
    Currency indicates currency of the order ('USD', 'CNY').

  - `orders.currencyRate` (number)
    CurrencyRate is the conversion rate from USD to order's currency.  This field is only populated if order's currency is non-USD.

  - `orders.finalAmount` (number)
    FinalAmount is the final amount of the order, after discounts and refunds.

  - `orders.id` (integer)

  - `orders.orderItems` (array)
    OrderItems is the collection of 1 or more items in the order.

  - `orders.orderItems.duration` (integer, required)
    Duration is the number of intervals.

  - `orders.orderItems.interval` (string,null, required)
    Interval is the  unit of time ("year", "month"). May be null for items that have no applicable interval.

  - `orders.orderItems.name` (string,null, required)
    Name is name of the item ('example.ninja').

  - `orders.orderItems.originalPrice` (number,null, required)
    OriginalPrice is the original price of the item before discounts.

  - `orders.orderItems.price` (number, required)
    Price is the final price of the item.

  - `orders.orderItems.priceNonUsd` (number)
    PriceNonUsd is the price of the item if order has non-usd currency.

  - `orders.orderItems.quantity` (integer, required)
    Quantity is the number of items.

  - `orders.orderItems.status` (string, required)
    Status indicates state of the order ('success', 'failed', 'refunded').

  - `orders.orderItems.taxAmount` (number,null)
    TaxAmount is the tax charged for this item, if applicable.

  - `orders.orderItems.tld` (string,null)
    Tld is (optional) tld of domain name, if applicable ('ninja').

  - `orders.orderItems.type` (string, required)
    Type is type of  the item ('registration', 'whois_privacy').

  - `orders.registrar` (string)
    Registrar is registrar with which order is placed.

  - `orders.status` (string)
    Status indicates the state of the order ('success', 'failed').

  - `orders.totalCapture` (number)
    TotalCapture is the amount captured.
    Example: 10.95

  - `orders.totalRefund` (number)
    TotalRefund is the amount, if any, refunded. Default is 0.00.
    Example: 10.95

  - `parentAccountId` (integer)
    ParentAccountId field is populated when requesting account has a parent account id.

## Response 401 fields (application/json):

  - `message` (string, required)
    A human-readable message providing more details about the error
    Example: "Unauthorized"

## Response 429 fields (application/json):

  - `message` (string)
    A human-readable message providing more details about the error
    Example: "Rate Limit Exceeded"

## Response 500 fields (application/json):

  - `message` (string, required)
    A human-readable message providing more details about the error.
    Example: "Internal Server Error"

  - `details` (string,null)
    Additional context or information about the error.
    Example: "Something went wrong."