Search.../
  1. REST
Generate a test token to explore our APIs

Order Object

Attributes

NAME
TYPE
DESCRIPTION
id
Read Only
string

Order ID (auto-generated upon order creation).

number
Read Only
integer

Order number displayed in the owner's store (auto-generated).

dateCreated
Read Only
string

Order creation date and time.

buyerInfo
object

Buyer information.

currency
string

Currency used for pricing in this store.

weightUnit
string

Supported values: UNSPECIFIED_WEIGHT_UNIT, KG, LB.

Weight unit used in this store.

totals
object

Totals for order's line items.

billingInfo
object

Billing information.

shippingInfo
object

Shipping information.

buyerNote
string

A note added by the buyer.

read
Deprecated
Read Only
boolean

Deprecated.

archived
Read Only
boolean

Whether or not the order was archived.

paymentStatus
string

Supported values: UNSPECIFIED_PAYMENT_STATUS, NOT_PAID, PAID, PARTIALLY_REFUNDED, FULLY_REFUNDED, PENDING.

Current status of the payment.

fulfillmentStatus
Read Only
string

Supported values: NOT_FULFILLED, FULFILLED, CANCELED, PARTIALLY_FULFILLED.

Order's current fulfillment status (whether the order received a tracking number or was delivered/picked up).

lineItems
Array<object>

Line items ordered.

activities
Read Only
Array<object>

Log of updates related to the order.

invoiceInfo
object

Invoice information.

fulfillments
Read Only
Array<object>

Order fulfillment information.

discount
object

Discount information.

customField
object

Custom field information.

cartId
string

Shopping cart ID.

buyerLanguage
string

Language to be used when communicating with the customer. For a site that supports multiple languages, this is the language the customer selected (otherwise this defaults to the site language).

channelInfo
object

Information about the sales channel that submitted this order.

enteredBy
Read Only
object

Identity of the order's initiator.

lastUpdated
Read Only
string

Date and time of latest update.

subscriptionInfo
object

Subscription information.

numericId
Read Only
string

Order’s unique numeric ID. Primarily used for sorting and filtering when crawling all orders.

refunds
Read Only
Array<object>

Refund information.

Was this helpful?