Orders

List Orders

Retrieves a list of all orders placed in the account.

get/core/v1/orders

Request

  • Base URL: https://api.dev.name.com
  • URL: https://api.dev.name.com/core/v1/orders
  • Auth: HTTP basic

Query parameters

perPageinteger

Maximum number of records to return per page for paginated list endpoints.

Per Page is the number of records to return per request. Per Page defaults to 500.

pageinteger

Page is which page to return.

dirstring

Dir indicates direction of list order. Possible values are 'asc' (default) or 'desc'.

domainNamestring

DomainName filters orders by domain name. Supports exact match or wildcard (starts with '*').

tldstring

Tld filters orders by tld.

createDateStartstring

CreateDateStart filters orders created on or after this date.

createDateEndstring

CreateDateEnd filters orders created on or before this date.

typestring

Type filters orders by order item type (e.g., 'registration', 'renewal', 'transfer', 'whois_privacy').

orderStatus'success' | 'failed' | 'initialized' | 'review' | 'started'

OrderStatus filters orders by status.

Response

A successful response.

lastPageinteger

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.

nextPageinteger

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.

totalCountinteger required

TotalCount is total number of results.

frominteger required

From specifies starting record number on current page.

tointeger required

To specifies ending record number on current page.

parentAccountIdinteger

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

Example response

{
  "orders": [
    {
      "orderItems": [
        {
          "isRefundable": true
        }
      ],
      "totalCapture": 10.95,
      "totalRefund": 10.95
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.