Orders
/
Get Order

Name.com Core API (1.0.4)

RESTful API for managing domains, DNS records, and related services at Name.com. Access via HTTPS at api.name.com (production) or api.dev.name.com (testing). Supports standard authentication, rate-limited to 20 requests/second.

Download OpenAPI description
namecom.api.json
namecom.api.yaml
Overview
Account Services

accountservices@name.com

Terms of Service

Languages
Servers
Mock server

https://docs.name.com/_mock/coreapi/namecom.api/

Testing

https://api.dev.name.com/

Hello

Use the Hello endpoint to verify that your API connection and credentials are working properly. This simple call returns a success message (along with server time and version info) to confirm the API is reachable and authenticated.

Operations

Account Info

Use Account Info endpoints to retrieve basic information about your Name.com account. For example, you can check your account’s current credit balance and other account details using these endpoints.

Operations

Accounts

Use Accounts endpoints (available upon request) to manage sub-accounts under your main account. For example, resellers can programmatically create new customer accounts with their own login credentials and permissions.

Operations

Domains

Use Domains endpoints to search for domain availability, register new domains, and manage existing domains.

Operations

DNS

Use DNS endpoints to manage DNS records for your domains. You can list all existing DNS records for a domain and create, update, or delete records as needed.

Operations

DNSSECs

Use DNSSEC endpoints to configure DNS Security Extensions for your domains. These endpoints allow you to add, retrieve, or remove DNSSEC records.

Operations

Email Forwardings

Use Email Forwardings endpoints to set up and manage email forwarding addresses on your domains.

Operations

URL Forwardings

Use URL Forwardings endpoints to control URL redirection settings for your domains.

Operations

Vanity Nameservers

Use Vanity Nameservers endpoints to configure custom nameserver hostnames (glue records) for your domains.

Operations

Transfers

Use Transfers endpoints to move domains into your Name.com account. Start by creating a transfer request, then monitor and manage the status of pending transfers. You can also cancel a transfer if needed.

Operations

Orders

Use Orders endpoints to review and track purchases made via the API.

Operations

List Orders

Request

Retrieves a list of all orders placed in the account.

Security
BasicAuth
Query
perPageinteger(int32)

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

Default 1000
pageinteger(int32)

Page is which page to return.

Default 1
curl -i -X GET \
  -u <username>:<password> \
  'https://docs.name.com/_mock/coreapi/namecom.api/core/v1/orders?page=1&perPage=1000'

Responses

A successful response.

Headers
Linkstring

String delimited list of links for pagination

Example: "<https://api.dev.name.com?page=3; rel=\"next\">,<https://api.dev.name.com?page=1; rel=\"prev\">,<https://api.dev.name.com?page=10; rel=\"last\">"
Bodyapplication/json
lastPageinteger(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.

nextPageinteger(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.

totalCountinteger(int32)required

TotalCount is total number of results.

frominteger(int32)required

From specifies starting record number on current page.

tointeger(int32)required

To specifies ending record number on current page.

ordersArray of objects(Order)required

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

orders[].​authAmountnumber(float)

AuthAmount is the amount authorized to complete the order purchase.

orders[].​createDatestring

CreateDate is the date the order was placed.

orders[].​currencystring

Currency indicates currency of the order ('USD', 'CNY').

orders[].​currencyRatenumber(float)

CurrencyRate is the conversion rate from USD to order's currency. This field is only populated if order's currency is non-USD.

orders[].​finalAmountnumber(float)

FinalAmount is the final amount of the order, after discounts and refunds.

orders[].​idinteger(int32)(Id is the unique identifier of the order.)
orders[].​orderItemsArray of objects(OrderItem)

OrderItems is the collection of 1 or more items in the order.

orders[].​registrarstring

Registrar is registrar with which order is placed.

orders[].​statusstring

Status indicates the state of the order ('success', 'failed').

orders[].​totalCapturenumber(float)

TotalCapture is the amount captured.

Example: 10.95
orders[].​totalRefundnumber(float)

TotalRefund is the amount, if any, refunded. Default is 0.00.

Example: 10.95
parentAccountIdinteger(int32)

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

Response
application/json
{
  "lastPage": 0,
  "nextPage": 0,
  "totalCount": 0,
  "from": 0,
  "to": 0,
  "orders": [
    { … }
  ],
  "parentAccountId": 0
}

Get Order

Request

Fetches full details about a specific order using its ID. This includes domains, prices, and timestamps. Useful for confirming transactions, receipts, or generating invoices.

Security
BasicAuth
Path
orderIdinteger(int32)required

OrderId is the unique identifier of the requested order.

curl -i -X GET \
  -u <username>:<password> \
  'https://docs.name.com/_mock/coreapi/namecom.api/core/v1/orders/{orderId}'

Responses

A successful response.

Bodyapplication/json
authAmountnumber(float)

AuthAmount is the amount authorized to complete the order purchase.

createDatestring

CreateDate is the date the order was placed.

currencystring

Currency indicates currency of the order ('USD', 'CNY').

currencyRatenumber(float)

CurrencyRate is the conversion rate from USD to order's currency. This field is only populated if order's currency is non-USD.

finalAmountnumber(float)

FinalAmount is the final amount of the order, after discounts and refunds.

idinteger(int32)(Id is the unique identifier of the order.)
orderItemsArray of objects(OrderItem)

OrderItems is the collection of 1 or more items in the order.

registrarstring

Registrar is registrar with which order is placed.

statusstring

Status indicates the state of the order ('success', 'failed').

totalCapturenumber(float)

TotalCapture is the amount captured.

Example: 10.95
totalRefundnumber(float)

TotalRefund is the amount, if any, refunded. Default is 0.00.

Example: 10.95
Response
application/json
{
  "authAmount": 0.1,
  "createDate": "string",
  "currency": "string",
  "currencyRate": 0.1,
  "finalAmount": 0.1,
  "id": 0,
  "orderItems": [
    { … }
  ],
  "registrar": "string",
  "status": "string",
  "totalCapture": 10.95,
  "totalRefund": 10.95
}

Webhook Notifications

Use Webhook Notification endpoints to subscribe to real-time notifications for account and domain events. This keeps your application updated on important changes without polling the API.

OperationsWebhooks