Search.../
  1. Home
  2. Getting Started
  3. Overview
Generate a test token to explore our APIs

Order Object

Attributes

NAME
TYPE
DESCRIPTION
read
Deprecated

boolean

Deprecated.

number

integer

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

cartId

string

Shopping cart ID.

lineItems

Array<object>

Line items ordered.

invoiceInfo

object

Invoice information.

paymentStatus

string

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

Current status of the payment.

lastUpdated

string

Date and time of latest update.

archived

boolean

Whether or not the order was archived.

enteredBy

object

Identity of the order's initiator.

shippingInfo

object

Shipping information.

activities

Array<object>

Log of updates related to the order.

customField

object

Custom field information.

weightUnit

string

Supported values: UNSPECIFIED_WEIGHT_UNIT, KG, LB.

Weight unit used in this store.

id

string

Order ID (auto-generated upon order creation).

dateCreated

string

Order creation date and time.

buyerNote

string

A note added by the buyer.

billingInfo

object

Billing information.

buyerInfo

object

Buyer information.

currency

string

Currency used for pricing in this store.

numericId

integer

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

discount

object

Discount information.

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.

totals

object

Totals for order's line items.

fulfillmentStatus

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).

fulfillments

Array<object>

Order fulfillment information.

Was this helpful?