Orders

Billing address matches shipping address

Whether the billing address matches the shipping address.

Can mark as paid

Whether the order can be manually marked as paid.

Can notify customer

Whether notifications can be sent to the customer.

Cancel reason

Reason the order was canceled. Returns null if the order wasn't canceled.

Cancelled at

The date and time when the order was canceled. Returns null if the order wasn't canceled.

Capturable

Whether payment for the order can be captured. Returns true when the customer's credit card has been authorized for payment and the authorization period has not expired.

Client IP

The IP address of the client that is associated with this order.

Closed

Whether the order is closed.

Closed at

Date and time when the order closed. If the order is not closed, then this field returns null.

Confirmed

Whether inventory has been reserved for the order.

Created at

Date and time when the order was created in Shopify.

Currency code

The currency of the store at the time of the order. If payment hasn't occurred, then this field returns null.

Current subtotal line items quantity

The sum of the quantities for the line items that contribute to the order's subtotal. This doesn't include returned quantities.

Current total weight

The total weight (grams) of the order minus the weights for line items that have been returned.

Customer accepts marketing

Whether the customer agreed to receive marketing materials.

Customer locale

A two-letter or three-letter language code, optionally followed by a region modifier. Example values could be 'en', 'en-CA', 'en-PIRATE'.

Discount code

Discount code provided by the customer.

Display financial status

Financial status of the order that can be shown to the merchant. This field does not capture all the possible details of an order's financial state and should only be used for display summary purposes.

Display fulfillment status

Fulfillment status for the order that can be shown to the merchant. This field does not capture all the possible details of an order's fulfillment state. It should only be used for display summary purposes.

Edited

Whether the order has had any edits applied.

Email

The email address associated with the customer.

Fulfillable

Whether there are items that can be fulfilled. This field returns false after an order is completely fulfilled, or completely refunded without any fulfillments.

Fully paid

Whether the order has been paid in full.

Has timeline comment

Whether the merchant added timeline comments to the order.

ID

Globally unique ID.

Legacy resource ID

The ID of the corresponding resource in the REST Admin API.

Merchant editable

Whether the order can be edited by the merchant.

Name

Unique identifier for the order that appears on the order. For example, #1000 or _Store1001. This value is not unique across multiple stores.

Note

Contents of the note associated with the order.

Payment gateway names

List of all payment gateways used for the order. For example, authorize_net and Cash on Delivery (COD).

Phone

The phone number associated with the customer.

Presentment currency code

The payment currency of the customer for this order.

Processed at

Date and time when the order was processed. When orders are imported from an app, this date and time may not match the date and time when the order was created.

Refundable

Whether the order can be refunded.

Requires shipping

Whether any line item on the order requires physical shipping.

Restockable

Whether any line item on the order can be restocked.

Risk level

Fraud risk level of the order.

Subtotal line items quantity

The sum of the quantities for the line items that contribute to the order's subtotal.

Tags

A comma separated list of tags associated with the order.

Taxes included

Whether taxes are included in the subtotal price of the order.

Test

Whether the order is a test. Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled. A test order cannot be converted into a real order and vice versa.

Total tax

Total of all taxes applied to the order.

Total weight

The total weight of the order in grams. The total isn't adjusted for returns or removals. For the total with returns or removals, use currentTotalWeight.

Unpaid

Whether no payments have been made for the order.

Updated at

Date and time when the order was last modified.

totalRefunded

Total amount refunded for the order.

City

The name of the city, district, village, or town.

Company

The name of the customer's company or organization.

Country

The name of the country.

Country code

The two-letter code for the country of the address. For example, US.

First line

The first line of the address. Typically the street address or PO Box number.

First name

The first name of the customer.

Formatted

A formatted version of the address, customized by the provided arguments.

Formatted area

A comma-separated list of the values for city, province, and country.

ID

Globally unique ID.

Last name

The last name of the customer.

Latitude

The latitude coordinate of the customer address.

Longitude

The longitude coordinate of the customer address.

Name

The full name of the customer, based on firstName and lastName.

Phone

A unique phone number for the customer. Formatted using E.164 standard. For example, +16135551111.

Province

The region of the address, such as the province, state, or district.

Province code

The two-letter code for the region. For example, ON.

Second line

The second line of the address. Typically the number of the apartment, suite, or unit.

Zip

The zip or postal code of the address.

Presentment money amount

Amount in presentment currency.

Presentment money currency code

Currency code of the amount in presentment currency.

Shop money amount

Amount in shop currency.

Shop money currency code

Currency code of the amount in shop currency.

Channel ID

The unique identifier for the channel.

ID

Globally unique ID.

Channel name

Name of the channel that this sub channel belongs to.

Handle

Unique string used as a public identifier for the channel definition.

ID

The unique identifier for the channel definition.

Sub channel name

Name of the sub channel (e.g. Online Store, Instagram Shopping, TikTok Live).

Svg icon

Icon displayed when showing the channel in admin.

Presentment money amount

Amount in presentment currency.

Presentment money currency code

Currency code of the amount in presentment currency.

Shop money amount

Amount in shop currency.

Shop money currency code

Currency code of the amount in shop currency.

Presentment money amount

Amount in presentment currency.

Presentment money currency code

Currency code of the amount in presentment currency.

Shop money amount

Amount in shop currency.

Shop money currency code

Currency code of the amount in shop currency.

Price

The amount of tax to be charged.

Rate

The tax rate to be applied.

Rate percentage

The percentage of the price that the tax rate represents.

Title

The name of the tax.

Presentment money amount

Amount in presentment currency.

Presentment money currency code

Currency code of the amount in presentment currency.

Shop money amount

Amount in shop currency.

Shop money currency code

Currency code of the amount in shop currency.

Presentment money amount

Amount in presentment currency.

Presentment money currency code

Currency code of the amount in presentment currency.

Shop money amount

Amount in shop currency.

Shop money currency code

Currency code of the amount in shop currency.

Presentment money amount

Amount in presentment currency.

Presentment money currency code

Currency code of the amount in presentment currency.

Shop money amount

Amount in shop currency.

Shop money currency code

Currency code of the amount in shop currency.

Presentment money amount

Amount in presentment currency.

Presentment money currency code

Currency code of the amount in presentment currency.

Shop money amount

Amount in shop currency.

Shop money currency code

Currency code of the amount in shop currency.

Key

Key or name of the attribute.

Value

Value of the attribute.

Customer ID

Globally unique ID.

Customer order index

The position of the current order within the customer's order history. Test orders aren't included.

Days to conversion

The number of days between the first session and the order creation date. The first session represents the first session since the last order, or the first session within the 30 day attribution window, if more than 30 days have passed since the last order.

ID

Globally unique ID.

Landing page

URL of the first page the customer landed on for the session.

Landing page HTML

Landing page information with URL linked in HTML. For example, the first page the customer visited was store.myshopify.com/products/1.

Occurred at

When the customer moment occurred.

Referral code

Marketing referral code from the link that the customer clicked to visit the store. Supports the following URL attributes: ref, source, or r. For example, if the URL is myshopifystore.com/products/slide?ref=j2tj1tn2, then this value is j2tj1tn2.

Referral info HTML

Referral information with URLs linked in HTML.

Referrer URL

Webpage where the customer clicked a link that sent them to the online store. For example, https://randomblog.com/page1 or android-app://com.google.android.gm.

Source

Source from which the customer visited the store, such as a platform (Facebook, Google), email, direct, a website domain, QR code, or unknown.

Source description

Describes the source explicitly for first or last session.

Source type

Type of marketing tactic.

Campaign

The name of a marketing campaign.

Content

Identifies specific content in a marketing campaign. Used to differentiate between similar content or links in a marketing campaign to determine which is the most effective.

Medium

The medium of a marketing campaign, such as a banner or email newsletter.

Source

The source of traffic to the merchant's store, such as Google or an email newsletter.

Term

Paid search terms used by a marketing campaign.

ID

Globally unique ID.

Landing page

URL of the first page the customer landed on for the session.

Landing page HTML

Landing page information with URL linked in HTML. For example, the first page the customer visited was store.myshopify.com/products/1.

Occurred at

When the customer moment occurred.

Referral code

Marketing referral code from the link that the customer clicked to visit the store. Supports the following URL attributes: ref, source, or r. For example, if the URL is myshopifystore.com/products/slide?ref=j2tj1tn2, then this value is j2tj1tn2.

Referral info HTML

Referral information with URLs linked in HTML

Referrer URL

Webpage where the customer clicked a link that sent them to the online store. For example, https://randomblog.com/page1 or android-app://com.google.android.gm.

Source

Source from which the customer visited the store, such as a platform (Facebook, Google), email, direct, a website domain, QR code, or unknown.

Source description

Describes the source explicitly for first or last session.

Source type

Type of marketing tactic.

Campaign

The name of a marketing campaign.

Content

Identifies specific content in a marketing campaign. Used to differentiate between similar content or links in a marketing campaign to determine which is the most effective.

Medium

The medium of a marketing campaign, such as a banner or email newsletter.

Source

The source of traffic to the merchant's store, such as Google or an email newsletter.

Term

Paid search terms used by a marketing campaign.

ID

Globally unique ID.

Landing page

URL of the first page the customer landed on for the session.

Landing page HTML

Landing page information with URL linked in HTML. For example, the first page the customer visited was store.myshopify.com/products/1.

Occurred at

When the customer moment occurred.

Referral code

Marketing referral code from the link that the customer clicked to visit the store. Supports the following URL attributes: ref, source, or r. For example, if the URL is myshopifystore.com/products/slide?ref=j2tj1tn2, then this value is j2tj1tn2.

Referral info HTML

Referral information with URLs linked in HTML.

Referrer URL

Webpage where the customer clicked a link that sent them to the online store. For example, https://randomblog.com/page1 or android-app://com.google.android.gm.

Source

Source from which the customer visited the store, such as a platform (Facebook, Google), email, direct, a website domain, QR code, or unknown.

Source description

Describes the source explicitly for first or last session.

Source type

Type of marketing tactic.

City

The name of the city, district, village, or town.

Company

The name of the customer's company or organization.

Country

The name of the country.

Country code

The two-letter code for the country of the address. For example, US.

First line

The first line of the address. Typically the street address or PO Box number.

First name

The first name of the customer.

Formatted

A formatted version of the address, customized by the provided arguments.

Formatted area

A comma-separated list of the values for city, province, and country.

ID

Globally unique ID.

Last name

The last name of the customer.

Latitude

The latitude coordinate of the customer address.

Longitude

The longitude coordinate of the customer address.

Name

The full name of the customer, based on firstName and lastName.

Phone

A unique phone number for the customer. Formatted using E.164 standard. For example, +16135551111.

Province

The region of the address, such as the province, state, or district.

Province code

The two-letter code for the region. For example, ON.

Second line

The second line of the address. Typically the number of the apartment, suite, or unit.

Zip

The zip or postal code of the address.