Orders

Columns

Name

Type

ReadOnly

Description

Id [KEY]

Long

True

A unique numeric identifier for the order.

Number

Long

True

A unique identifier for the order, used by the shop owner and customer.

CustomerId

Long

False

A unique numeric identifier for the customer.

CustomerFirstName

String

False

The first name of the customer.

CustomerLastName

String

False

The last name of the customer.

Currency

String

False

The three letter code (ISO 4217) for the currency used for the payment.

Email

String

False

The customer's email address.

Name

String

True

The customer's order name as represented by a number.

TotalDiscounts

Decimal

True

The total amount of the discounts to be applied to the price of the order.

TotalOrderItemsPrice

Decimal

True

The sum of all the prices of all the items in the order.

TotalPrice

Decimal

True

The sum of all the prices of all the items in the order, taxes and discounts included.

SubtotalPrice

Decimal

True

Price of the order before shipping and taxes.

TotalTax

Decimal

False

The sum of all the taxes applied to the order.

TotalWeight

Integer

True

The sum of all the weights of the line items in the order, in grams.

BrowserIp

String

True

The IP address of the browser used by the customer when placing the order.

BuyerAcceptsMarketing

Boolean

False

Indicates whether or not the person who placed the order would like to receive email updates from the shop.

CancelReason

String

True

The reason why the order was canceled.

CartToken

String

True

Unique identifier for a particular cart that is attached to a particular order.

OrderStatusUrl

String

True

The URL pointing to the order status web page.

Token

String

True

Unique identifier for a particular order.

TaxesIncluded

Boolean

False

States whether or not taxes are included in the order subtotal.

SourceName

String

True

Where the order originated.

ReferringSite

String

True

The website that the customer clicked on to come to the shop.

ProcessingMethod

String

True

States the type of payment processing method.

Phone

String

False

The customer's phone number.

Note

String

False

The text of an optional note that a shop owner can attach to the order.

LocationId

Long

True

The unique numeric identifier for the physical location at which the order was processed.

LandingSite

String

True

The URL for the page where the buyer landed when entering the shop.

Tags

String

False

Additional short descriptors.

FulfillmentStatus

String

False

The fulfillment status of the order.

FinancialStatus

String

False

The financial status of the order.

CustomerLocale

String

True

The customer locale of the order.

InvoiceSentAt

Datetime

True

This auto-generated property is the date and time when the invoice was emailed to the customer. Only available for draft orders.

InvoiceUrl

String

True

The URL for the invoice. Only available for draft orders.

TaxExempt

Boolean

True

States whether or not taxes are exempt for this order. Only available for draft orders.

DiscountCodes

String

True

Applicable discount codes that can be applied to the order.

LineAggregate

String

False

A JSON aggregate of line items associated with the order.

TaxAggregate

String

False

A JSON aggregate of tax line items associated with the order. Note, these taxes are applied on the order, not on individual items. If you want them to be applied on individual items, use them in LineAggregate. Tax lines must be associated with either order or line item but not both.

ShippingAggregate

String

False

A JSON aggregate of shipping line items associated with the order.

NoteAttributesAggregate

String

False

A JSON aggregate of note attributes associated with the order.

DiscountApplicationsAggregate

String

True

An ordered list of stacked discount applications.

BillingAddressFirstName

String

False

The first name of the person associated with the payment method.

BillingAddressLastName

String

False

The last name of the person associated with the payment method.

BillingAddressAddress1

String

False

The street address of the billing address.

BillingAddressAddress2

String

False

An optional additional field for the street address of the billing address.

BillingAddressPhone

String

False

The phone number at the billing address.

BillingAddressCity

String

False

The city of the billing address.

BillingAddressCompany

String

False

The company of the person associated with the billing address.

BillingAddressZip

String

False

The zip or postal code of the billing address.

BillingAddressProvince

String

False

The name of the state or province of the billing address.

BillingAddressCountry

String

False

The name of the country of the billing address.

BillingAddressLatitude

Double

False

The latitude of the billing address.

BillingAddressLongitude

Double

False

The longitude of the billing address.

BillingAddressName

String

False

The full name of the person associated with the payment method.

BillingAddressCountryCode

String

False

The two-letter code for the country of the billing address.

BillingAddressProvinceCode

String

False

The two-letter abbreviation of the state or province of the billing address.

BillingAddressDefault

Boolean

False

Whether this address is the default one or not.

ShippingAddressFirstName

String

False

The first name of the person associated with the shipping method.

ShippingAddressLastName

String

False

The last name of the person associated with the shipping method.

ShippingAddressAddress1

String

False

The street address of the shipping address.

ShippingAddressAddress2

String

False

An optional additional field for the street address of the shipping address.

ShippingAddressPhone

String

False

The phone number at the shipping address.

ShippingAddressCity

String

False

The city of the shipping address.

ShippingAddressCompany

String

False

The company of the person associated with the shipping address.

ShippingAddressZip

String

False

The zip or postal code of the shipping address.

ShippingAddressProvince

String

False

The name of the state or province of the shipping address.

ShippingAddressCountry

String

False

The name of the country of the shipping address.

ShippingAddressLatitude

Double

False

The latitude of the shipping address.

ShippingAddressLongitude

Double

False

The longitude of the shipping address.

ShippingAddressName

String

False

The full name of the person associated with the shipping method.

ShippingAddressCountryCode

String

False

The two-letter code for the country of the shipping address.

ShippingAddressProvinceCode

String

False

The two-letter abbreviation of the state or province of the shipping address.

ShippingAddressDefault

Boolean

False

Whether this address is the default one or not.

AppliedDiscountTitle

String

False

The title of the applied discount for this order. Only available for draft orders.

AppliedDiscountDescription

String

False

The description of the applied discount for order. Only available for draft orders.

AppliedDiscountValue

Decimal

False

The value of the applied discount for this order. Only available for draft orders.

AppliedDiscountValueType

String

False

The value type of the applied discount for order. Only available for draft orders.

AppliedDiscountAmount

Decimal

False

The amount of the applied discount for this order. Only available for draft orders.

PaymentTermsAmount

Long

True

The amount that is owed according to the payment terms.

PaymentTermsCurrency

String