Skip to main content
GET
/
core
/
v1
/
orders
List Orders
curl --request GET \
  --url https://api.dev.name.com/core/v1/orders \
  --header 'Authorization: Basic <encoded-value>'
{
  "totalCount": 123,
  "from": 123,
  "to": 123,
  "orders": [
    {
      "authAmount": 123,
      "createDate": "<string>",
      "currency": "<string>",
      "currencyRate": 123,
      "finalAmount": 123,
      "id": 123,
      "orderItems": [
        {
          "duration": 123,
          "id": 123,
          "interval": "<string>",
          "name": "<string>",
          "originalPrice": 123,
          "price": 123,
          "quantity": 123,
          "status": "<string>",
          "type": "<string>",
          "priceNonUsd": 123,
          "taxAmount": 123,
          "tld": "<string>"
        }
      ],
      "registrar": "<string>",
      "status": "<string>",
      "totalCapture": 10.95,
      "totalRefund": 10.95
    }
  ],
  "lastPage": 123,
  "nextPage": 123,
  "parentAccountId": 123
}

Authorizations

​
Authorization
string
header
required

Authenticate via HTTP Basic with your account username and API token. Examples use an explicit 'Authorization: Basic <base64(username:token)>' header; 'curl -u username:token' is equivalent. For sandbox, append "-test" to your username and use your sandbox token on api.dev.name.com.

Query Parameters

​
perPage
integer<int32>
default:1000

Per Page is the number of records to return per request. Per Page defaults to 1,000.

​
page
integer<int32>
default:1

Page is which page to return.

Response

A successful response.

ListOrdersResponse is the response from a list request, it contains the paginated list of Orders.

​
totalCount
integer<int32>
required

TotalCount is total number of results.

​
from
integer<int32>
required

From specifies starting record number on current page.

​
to
integer<int32>
required

To specifies ending record number on current page.

​
orders
object[]
required

Orders is the collection of orders, if any, in the requesting account.

​
lastPage
integer<int32>

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<int32>

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.

​
parentAccountId
integer<int32>

ParentAccountId field is populated when requesting account has a parent account id.