---
title: "List Orders"
method: GET
path: "/core/v1/orders"
tags: ["Orders"]
---

# List Orders

`GET /core/v1/orders`

Retrieves a list of all orders placed in the account.

## Query parameters

- `perPage` integer — Maximum number of records to return per page for paginated list endpoints.
- `page` integer
- `dir` string
- `domainName` string
- `tld` string
- `createDateStart` string
- `createDateEnd` string
- `type` string
- `orderStatus` 'success' | 'failed' | 'initialized' | 'review' | 'started'

## Response `200`

A successful response.

- ListOrdersResponse — ListOrdersResponse is the response from a list request, it contains the paginated list of Orders.
  - `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` Order[], required — Orders is the collection of orders, if any, in the requesting account.
    - `authAmount` number, float — AuthAmount is the amount authorized to complete the order purchase.
    - `createDate` string — CreateDate is the date the order was placed.
    - `currency` string — Currency indicates currency of the order ('USD', 'CNY').
    - `currencyRate` number, float — CurrencyRate is the conversion rate from USD to order's currency. This field is only populated if order's currency is non-USD.
    - `finalAmount` number, float — FinalAmount is the final amount of the order, after discounts and refunds.
    - `id` integer
    - `orderItems` OrderItem[] — OrderItems is the collection of 1 or more items in the order.
      - `duration` integer, required — Duration is the number of intervals.
      - `id` integer, required
      - `interval` string, nullable, required — Interval is the unit of time ("year", "month"). May be null for items that have no applicable interval.
      - `name` string, nullable, required — Name is name of the item ('example.ninja').
      - `originalPrice` number, float, nullable, required — OriginalPrice is the original price of the item before discounts.
      - `price` number, float, required — Price is the final price of the item.
      - `priceNonUsd` number, float — PriceNonUsd is the price of the item if order has non-usd currency.
      - `quantity` integer, required — Quantity is the number of items.
      - `status` string, required — Status indicates state of the order ('success', 'failed', 'refunded').
      - `taxAmount` number, float, nullable — TaxAmount is the tax charged for this item, if applicable.
      - `tld` string, nullable — Tld is (optional) tld of domain name, if applicable ('ninja').
      - `type` string, required — Type is type of the item ('registration', 'whois_privacy').
      - `isRefundable` boolean, required — IsRefundable indicates whether the item in your order is currently eligible for a refund through the refund endpoint based on name.com's refund rules. These refunds are only applicable for invalid or fraudulent orders within a few days or registration (usually 5).
    - `registrar` string — Registrar is registrar with which order is placed.
    - `status` string — Status indicates the state of the order ('success', 'failed').
    - `totalCapture` number, float — TotalCapture is the amount captured.
    - `totalRefund` number, float — TotalRefund is the amount, if any, refunded. Default is 0.00.
  - `parentAccountId` integer — ParentAccountId field is populated when requesting account has a parent account id.

## Other responses

- `400` — Bad request - Invalid query parameters.
- `401` — Unauthorized.
- `403` — Forbidden - you do not have permission to perform this action.
- `405` — Method not allowed.
- `429` — Rate limit has been exceeded.
- `500` — Internal server error.
- `502` — Bad Gateway
- `504` — Gateway Timeout

---

[API](https://skmtc.dev/name/apis/name-com-core-api.md) · [All operations](https://skmtc.dev/name/apis/name-com-core-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/name/name-com-core-api/revisions/a37d4cbd3991/schema)