Skip to main content
GET
/
core
/
v1
/
orders
/
{orderId}
Get Order
curl --request GET \
  --url https://api.dev.name.com/core/v1/orders/{orderId} \
  --header 'Authorization: Basic <encoded-value>'
{
  "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,
      "priceNonUsd": 123,
      "quantity": 123,
      "status": "<string>",
      "taxAmount": 123,
      "tld": "<string>",
      "type": "<string>"
    }
  ],
  "registrar": "<string>",
  "status": "<string>",
  "totalCapture": 10.95,
  "totalRefund": 10.95
}

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.

Path Parameters

orderId
integer
required

OrderId is the unique identifier of the requested order.

Response

A successful response.

Order contains all the data for an order.

authAmount
number

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

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

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

id
integer
orderItems
object[]

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

registrar
string

Registrar is registrar with which order is placed.

status
string

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

totalCapture
number

TotalCapture is the amount captured.

Example:

10.95

totalRefund
number

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

Example:

10.95

I