Get an Order
GET/v2/orders/:orderID
Use this endpoint to retrieve a specific order.
Request
Path Parameters
The ID of the order.
Responses
- 200
- 401
OK
- application/json
- Schema
- Example (from schema)
Schema
data object
Specifies the type of object being returned. You must use order
.
Specifies a user-managed, optional field used as an alternative to the existing order_id
. If provided, the order-number will be sent to Authorize.net instead of the order_id
, and will appear as the invoice number in Authorize.net transactions.
An optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.
Specifies the unique identifier of the order.
Specifies the status of the order, such as incomplete
, complete
, processing
, or cancelled
.
Specifies the status of the payment, such as unpaid
, authorized
, paid
, or refunded
.
Specifies the status of the shipment, such as fulfilled
or unfulfilled
.
Specifies if the order is anonymized.
meta object
timestamps object
The date this was created.
The date this was last updated.
with_tax object
The raw total of this cart.
The currency set for this cart.
The tax inclusive formatted total based on the currency.
without_tax object
The raw total of this cart.
The currency set for this cart.
The tax inclusive formatted total based on the currency.
tax object
The raw total of this cart.
The currency set for this cart.
The tax inclusive formatted total based on the currency.
discount object
The raw total of this cart.
The currency set for this cart.
The tax inclusive formatted total based on the currency.
paid object
The raw total of this cart.
The currency set for this cart.
The tax inclusive formatted total based on the currency.
authorized object
The raw total of this cart.
The currency set for this cart.
The tax inclusive formatted total based on the currency.
without_discount object
The raw total of this cart.
The currency set for this cart.
The tax inclusive formatted total based on the currency.
billing_address object
First name of the billing recipient.
Last name of the billing recipient.
Company name of the billing recipient.
First line of the billing address.
Second line of the billing address.
City of the billing address.
Postcode of the billing address.
County of the billing address.
Country of the billing address.
State, province, or region of the billing address.
contact object
The email address of the contact.
The name of the contact.
shipping_address object
First name of the shipping recipient.
Last name of the shipping recipient.
Phone number of the shipping recipient.
Company of the shipping recipient.
First line of the shipping address.
Second line of the shipping address.
City of the shipping address.
Post code of the shipping address.
County of the shipping address.
Country of the shipping address.
State, province, or region of the shipping address.
Delivery instructions.
{
"data": {
"type": "string",
"order_number": "string",
"external_ref": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "string",
"payment": "string",
"shipping": "string",
"anonymized": true,
"meta": {
"timestamps": {
"created_at": "string"
},
"with_tax": {
"amount": 0,
"currency": "string",
"formatted": "string"
},
"without_tax": {
"amount": 0,
"currency": "string",
"formatted": "string"
},
"tax": {
"amount": 0,
"currency": "string",
"formatted": "string"
},
"discount": {
"amount": 0,
"currency": "string",
"formatted": "string"
},
"paid": {
"amount": 0,
"currency": "string",
"formatted": "string"
},
"authorized": {
"amount": 0,
"currency": "string",
"formatted": "string"
},
"without_discount": {
"amount": 0,
"currency": "string",
"formatted": "string"
}
},
"billing_address": {
"first_name": "string",
"last_name": "string",
"company_name": "string",
"line_1": "string",
"line_2": "string",
"city": "string",
"postcode": "string",
"county": "string",
"country": "string",
"region": "string"
},
"contact": {
"email": "string",
"name": "string"
},
"shipping_address": {
"first_name": "string",
"last_name": "string",
"phone_number": "string",
"company_name": "string",
"line_1": "string",
"line_2": "string",
"city": "string",
"postcode": "string",
"county": "string",
"country": "string",
"region": "string",
"instructions": "string"
}
}
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example
Schema
[
null
]
{
"errors": {
"status": 401,
"title": "Unauthorized"
}
}