Page Comparison

Table of Contents

minLevel	3
maxLevel	3
style	square
printable	false

Expand

title	Products

Represents products in your Shopify store.

Expand

title	Products

Field	Description
ID	Globally unique identifier.
Handle	The date and time the metafield was created.
Created at	Description of the metafield.
Description	Key name for the meta field.
Description HTML	The namespace for the metafield.
Gift card template suffix	Owner type of metafield visible to the Storefront API.
Has only default variant	The date and time the metafield was updated.
Has out of stock variants	The value of the metafield.
Is gift card	Represents the metafield value type.
Media count	The date and time when metafield was updated.
Online store preview URL	The value of metafield.
Online store URL	Represents the metafield value type.
Options	A list of custom product options (maximum of 3 per product).
Highest variant's price	The highest variant's price of the product, formatted as decimals.
Lowest variant's price	The lowest variant's price of the product, formatted as decimals.
Product type	The product type specified by merchant.
Published at	The date and time (in ISO 8601 format) when the product was published on the online store.
SEO title	SEO information about the product.
SEO description	SEO informational description of the product.
Status	Product status.
Storefront ID	Product storefront ID.
Tags	Comma-separated list of tags associated with the product.
Theme template	The theme template used when viewing the item in the store.
Title	The product's name.
Total inventory	Quantity of goods in stock.
Total variants	The number of variants associated with the product.
Tracks inventory	Whether inventory tracking has been enabled for the product.
Updated at	The date and time (ISO 8601 format) when the product was last modified.
Vendor	The product's vendor name.

Expand

title	Products / Collections

List of collections containing products.

Field	Description
ID	Globally unique identifier.
Handle	A unique human-friendly string for the collection. Automatically generated from the collection's title.
Description	The stripped description of the collection, in a single line with HTML tags removed.
Description HTML	The description of the collection, complete with HTML formatting.
Image alt text	A word or phrase to share the nature or contents of an image associated with the collection.
Original image URL	The location of the original image associated with the collection as a URL.
Transformed image URL	The location of the transformed image associated with the collection as a URL.
Products count	The number of products included in the collection.
Rule set	The rules are used to assign products to the collection. This applies only to smart collections.
SEO title	SEO information title for the collection.
SEO description	SEO information description for the collection.
Sort order	The order in which the collection's products are sorted.
Storefront ID	The storefront ID of the collection.
Template	The theme template used when viewing this collection in a store.
Title	The title of the collection.
Updated at	The date and time (ISO 8601 format) when the collection was last modified.

Expand

title	Products / Variants

Represents a product variant.

Field	Description
ID	Globally unique identifier.
Title	The title of the product variant.
Available for sale	Whether the product variant is available for sale.
Barcode	The value of the barcode associated with the product.
Compare-at price	The compare-at price of the variant in the default shop currency.
Created at	The date and time when the variant was created.
Display name	Display name of the variant, based on product's title + variant's title.
Image alt text	A word or phrase to share the nature or contents of the featured image for the variant.
Original image URL	The location of the original featured image for the variant as a URL.
Transformed image URL	The location of the transformed featured image for the variant as a URL.
Inventory policy	Whether customers are allowed to place an order for the product variant when it's out of stock.
Inventory quantity	The total sellable quantity of the variant.
Position	The order of the product variant in the list of product variants. The first position in the list is 1.
Price	The price of the product variant in the default shop currency.
SKU	An identifier for the product variant in the shop.
Storefront ID	The storefront ID of the product variant.
Tax code	The tax code for the product variant.
Taxable	Whether a tax is charged when the product variant is sold.
Updated at	The date and time (ISO 8601 format) when the product variant was last modified.
Weight	The weight of the product variant in the unit system specified with weight_unit.
Weight unit	The unit of measurement that applies to the product variant's weight.

Expand

title	Products / Metafields

Represents custom metadata attached to a resource.

Fields	Description
ID	Globally unique identifier.
Created at	The date and time when the metafield was created.
Description	The description of a metafield.
Key	The key name for a metafield.
Namespace	The namespace for a metafield.
Owner type	Owner type of a metafield visible to the Storefront API.
Updated at	The date and time when the metafield was updated.
Value	The value of a metafield.
Value type	Represents the metafield value type.

Expand

title	Products / Images

Represents an image resource.

Field	Description
ID	A unique identifier for the image.
Alt text	A word or phrase to share the nature or contents of an image.
Original image URL	The location of the original image as a URL.
Transformed image URL	The location of the transformed image as a URL.

Expand

title	Products / Media images

Shopify-hosted images related to a product.

Field	Description
ID	Globally unique identifier.
Alt	A word or phrase to share the nature or contents of a media.
Image ID	A unique identifier for the image for the media.
Image alt text	A word or phrase to share the nature or contents of an image for the media.
Original image URL	The location of the original image for the media as a URL.
Transformed image URL	The location of the transformed image for the media as a URL.
Media content type	The media content type.
MIME type	The MIME type of the image.
Status	Current status of the media.

Expand

title	Products / Media 3D models

Represents a Shopify-hosted 3D model related to a product.

Field	Description
ID	Globally unique identifier.
Alt	A word or phrase to share the nature or contents of a media.
Filename	The filename of the 3d model.
Media content type	The media content type.
Original source URL	The URL of the original source for a 3d model.
Original source filesize	The filesize of the original source for a 3d model.
Original source format	The format of the original source for a 3d model.
Original MIME type	The MIME type of the original source for a 3d model.
Status	Current status of the media.

Expand

title	Products / Media videos

Shopify-hosted videos related to a product.

Field	Description
ID	Globally unique identifier.
Alt	A word or phrase to share the nature or contents of a media.
Filename	The filename of the video.
Media content type	The media content type.
Original source format	The format of the original source for a video.
Original source height	The height of the original source for a video.
Original source MIME type	The original source video MIME type.
Original source URL	The URL of the original source for a video.
Original source width	The width of the original source for a video.
Status	Current status of the media.

Expand

title	Products / Media external videos

Represents product-related videos hosted outside of Shopify.

Field	Description
ID	Globally unique identifier.
Alt	A word or phrase to share the nature or contents of a media.
Embedded URL	The URL.
Media content type	The media content type.
Status	Current status of the media.

Expand

title	Customers

Represents store customer information such as contact details, order history, and consent to receive email marketing information..

Field	Description
ID	Globally unique identifier.
Display name	The customer's full name, based on the first and last name values. If the first and last name are not available, then this is returned to the customer's email address, and if it is not available, to the customer's phone number.
Accepts marketing	Whether the customer has agreed to receive marketing materials.
Accepts marketing updated at	The date and time the customer agreed or objected to receiving email marketing materials.
Average order amount	The average amount that the customer spent per order.
Can delete	Whether the merchant can delete the customer from their store.
Created at	The date and time when the customer was added to the store.
Email	The customer's email address.
First name	The customer's first name.
Has note	Whether the customer has a note associated with them.
Has timeline comment	Whether the merchant has added timeline comments about the customer on the customer's page.
Image alt text	A word or phrase to share the nature or contents of an image associated with the customer.
Original image URL	The location of the original image associated with the customer as a URL.
Transformed image URL	The location of the transformed image associated with the customer as a URL.
Last name	The customer's last name.
Lifetime duration	The amount of time since the customer was first added to the store.
Locale	The customer's locale.
Marketing opt-in level	The marketing subscription opt-in level (as described by the M3AAWG best practices guideline) that the customer gave when they consented to receive marketing material by email. If the customer does not accept email marketing, then this property will be null.
Multipass identifier	A unique identifier for the customer that's used with Multipass login.
Note	A note about the customer.
Orders count	The number of orders that the customer has made at the store in their lifetime.
Phone	The customer's phone number.
State	The state of the customer's account with the shop.
Tags	A comma-separated list of tags that have been added to the customer.
Tax exempt	Whether the customer is exempt from being charged taxes on their orders.
Total spent	The total amount that the customer has spent on orders in their lifetime.
Updated at	The date and time when the customer was last updated.
Valid email address	Whether the email address is formatted correctly. This does not guarantee that the email address actually exists.
Verified email	Whether the customer has verified their email address.

Expand

title	Customers / Default address

The default address associated with the customer.

Field	Description
ID	Globally unique identifier.
First line	The first line of the address. Typically the street address or PO Box number.
Second line	The second line of the address. Typically the number of the apartment, suite, or unit.
Full address	The first and the second line of the address.
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.
First name	The first name of the customer.
Formatted	A comma-separated list of the values for city, province, and country.
Formatted area	A formatted version of the address, customized by the provided arguments.
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 first and last name.
Phone	A unique phone number for the customer.
Province	The region of the address, such as the province, state, or district.
Province code	The two-letter code for the region.
Zip	The zip or postal code of the address.

Expand

title	Customers / Addresses

A list of customer-related addresses.

Field	Description
ID	Globally unique identifier.
First line	The first line of the address. Typically the street address or PO Box number.
Second line	The second line of the address. Typically the number of the apartment, suite, or unit.
Full address	The first and the second line of the address.
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.
First name	The first name of the customer.
Formatted	A comma-separated list of the values for city, province, and country.
Formatted area	A formatted version of the address, customized by the provided arguments.
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 the first and last name.
Phone	A unique phone number for the customer.
Province	The region of the address, such as the province, state, or district.
Province code	The two-letter code for the region.
Zip	The zip or postal code of the address.

Expand

title	Customers / Orders

A list of the customer's orders.

Field	Description
ID	Globally unique identifier.
Name	Unique identifier for the order that appears on the order. For example, #1000 or _Store1001. This value is not unique across multiple stores.
Billing address matches the shipping address	Whether the billing address matches the shipping address.
Can marked as paid	Whether the order can be manually marked as paid.
Can notify customer	Whether notifications can be sent to the customer or not.
Cancel reason	Reason the order was canceled. Returns null if the order wasn't canceled.
Cancelled at	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.
Presentment cart discount	Amount of the order-level discount (does not contain any line item discounts) in presentment currency.
Shop cart discount	Amount of the order-level discount (does not contain any line item discounts) in shop currency.
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 is 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 is null.
Presentment current cart discount	The amount of the order-level discount minus the amounts for line items that have been returned in presentment currency. This doesn't include line item discounts.
Shop current cart discount	The amount of the order-level discount minus the amounts for line items that have been returned in shop currency. This doesn't include line item discounts.
Current subtotal line items quantity	The sum of the quantities for the line items that contribute to the order's subtotal.
Presentment current subtotal price	The subtotal of line items and their discounts minus the line items that have been returned in presentment currency. This includes order-level discounts, unless the argument with_cart_discount is set to false. This doesn't include shipping costs and shipping discounts. Taxes are not included unless the order is a taxes-included order.
Shop current subtotal price	The subtotal of line items and their discounts minus the line items that have been returned in shop currency. This includes order-level discounts, unless the argument with_cart_discount is set to false. This doesn't include shipping costs and shipping discounts. Taxes are not included unless the order is a taxes-included order.
Presentment current total discounts	The total amount discounted from the order (including order-level and line item discounts) minus the amounts for items that have been returned in presentment currency.
Shop current total discounts	The total amount discounted from the order (including order-level and line item discounts) minus the amounts for items that have been returned in shop currency.
Presentment current total duties	Total amount of duties for the order in presentment currency. If duties are not applicable, then this value is null.
Shop current total duties	Total amount of duties for the order in shop currency. If duties are not applicable, then this value is null.
Presentment current total price	The total amount of the order (including taxes and discounts) minus the amounts for line items that have been returned in presentment currency.
Shop current total price	The total amount of the order (including taxes and discounts) minus the amounts for line items that have been returned in shop currency.
Presentment current total tax	The total of all taxes applied to the order minus the taxes for line items that have been returned in presentment currency.
Shop current total tax	The total of all taxes applied to the order minus the taxes for line items that have been returned in shop currency.
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.
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 or not.
Email	Email address provided by the customer.
Fulfillable	Whether there are items that can be fulfilled. After an order is completely fulfilled (or completely refunded without any fulfillments) then this field returns false.
Fully paid	Whether the order has been paid in full.
Has timeline comment	Whether the merchant added timeline comments to the order.
Merchant editable	Whether the order can be edited or not.
Presentment net payment	Net payment for the order, based on the total amount received - total amount refunded in presentment currency.
Shop net payment	Net payment for the order, based on the total amount received - total amount refunded in shop currency.
Note	Contents of the note associated with the order.
Presentment original total duties	Total amount of duties prior to any applied edits for the order in presentment currency. If duties are not applicable, then this value is null.
Shop original total duties	Total amount of duties prior to any applied edits for the order in shop currency. If duties are not applicable, then this value is null.
Presentment original total price	Total price of the order prior to any applied edits in presentment currency.
Shop original total price	Total price of the order prior to any applied edits in shop currency.
Payment gateways	List of all payment gateways used for the order. For example, authorize_net and Cash on Delivery (COD).
Phone	Phone number provided by the customer.
Presentment currency	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.
Presentment refund discrepancy	The difference between suggested and actual refund amounts in presentment currency. A positive value indicates a difference in the merchants favor and a negative value indicates a difference in the customers favor.
Shop original refund discrepancy	The difference between suggested and actual refund amounts in shop currency. A positive value indicates a difference in the merchants favor and a negative value indicates a difference in the customers favor.
Refundable	Whether the order can be refunded.
Requires shipping	Whether any line item in the order requires physical shipping.
Restockable	Whether 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.
Presentment subtotal price	Subtotal of the line items and their discounts (does not contain shipping costs and shipping discounts) in presentment currency.
Shop subtotal price	Subtotal of the line items and their discounts (does not contain shipping costs and shipping discounts) in shop currency.
Tags	A comma separated list of tags that have been added to 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.
Presentment total capturable	Amount authorized for the order, that is uncaptured or undercaptured in presentment currency.
Shop total capturable	Amount authorized for the order, that is uncaptured or undercaptured in shop currency.
Presentment total discounts	Total amount discounted from the order (includes order-level and line item discounts) in presentment currency.
Shop total discounts	Total amount discounted from the order (includes order-level and line item discounts) in shop currency.
Presentment total outstanding	Total amount of money not yet authorized for the order in presentment currency.
Shop total outstanding	Total amount of money not yet authorized for the order in shop currency.
Presentment total price	Total amount of the order (includes taxes and discounts) in presentment currency.
Shop total price	Total amount of the order (includes taxes and discounts) in shop currency.
Presentment total received	Total amount received by the customer for the order in presentment currency.
Shop total received	Total amount received by the customer for the order in shop currency.
Presentment total refunded	Total amount refunded for the order in presentment currency.
Shop total refunded	Total amount refunded for the order in shop currency.
Presentment total refunded shipping	Total amount refunded for shipping in presentment currency.
Shop total refunded shipping	Total amount refunded for shipping in shop currency.
Presentment total shipping price	Total amount charged for shipping the order in presentment currency.
Shop total shipping price	Total amount charged for shipping the order in shop currency.
Presentment total tax	Total of all taxes applied to the order in presentment currency.
Shop total tax	Total of all taxes applied to the order in shop currency.
Total tip received	Total tip amount received for the order.
Total weight	Total weight (grams) of the order.
Unpaid	Whether no payments have been made for the order. If no payments have been made for the order, then this returns true.
Updated at	Date and time when the order was last modified.

Expand

title	Customers / Metafields

A list of the resource-related metafields.

Field	Description
ID	Globally unique identifier.
Created at	The date and time when the metafield was created.
Description	The description of a metafield.
Key	The key name for a metafield.
Namespace	The namespace for a metafield.
Owner type	Owner type of a metafield visible to the Storefront API.
Updated at	The date and time when the metafield was updated.
Value	The value of a metafield.
Value type	Represents the metafield value type.

Expand

title	Customers / Last order

The customer's last order.

Field	Description
ID	Globally unique identifier.
Name	Unique identifier for the order that appears on the order. For example, #1000 or _Store1001. This value is not unique across multiple stores.
Billing address matches the shipping address	Whether the billing address matches the shipping address.
Can marked as paid	Whether the order can be manually marked as paid.
Can notify customer	Whether notifications can be sent to the customer or not.
Cancel reason	Reason the order was canceled. Returns null if the order wasn't canceled.
Cancelled at	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 is 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 is null.
Current subtotal line items quantity	The sum of the quantities for the line items that contribute to the order's subtotal.
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.
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 or not.
Email	Email address provided by the customer.
Fulfillable	Whether there are items that can be fulfilled. After an order is completely fulfilled (or completely refunded without any fulfillments) then this field returns false.
Fully paid	Whether the order has been paid in full.
Has timeline comment	Whether the merchant added timeline comments to the order.
Merchant editable	Whether the order can be edited or not.
Note	Contents of the note associated with the order.
Phone	Phone number provided by the customer.
Presentment currency	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 in the order requires physical shipping.
Restockable	Whether 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.
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.
Total weight	Total weight (grams) of the order.
Unpaid	Whether no payments have been made for the order. If no payments have been made for the order, then this returns true.
Updated at	Date and time when the order was last modified.

Expand

title	Customers / Orders

A list of the customer's orders.

Field	Description
ID	Globally unique identifier.
Name	Unique identifier for the order that appears on the order. For example, #1000 or _Store1001. This value is not unique across multiple stores.
Billing address matches the shipping address	Whether the billing address matches the shipping address.
Can marked as paid	Whether the order can be manually marked as paid.
Can notify customer	Whether notifications can be sent to the customer or not.
Cancel reason	Reason the order was canceled. Returns null if the order wasn't canceled.
Cancelled at	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.
Presentment cart discount	Amount of the order-level discount (does not contain any line item discounts) in presentment currency.
Shop cart discount	Amount of the order-level discount (does not contain any line item discounts) in shop currency.
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 is 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 is null.
Presentment current cart discount	The amount of the order-level discount minus the amounts for line items that have been returned in presentment currency. This doesn't include line item discounts.
Shop current cart discount	The amount of the order-level discount minus the amounts for line items that have been returned in shop currency. This doesn't include line item discounts.
Current subtotal line items quantity	The sum of the quantities for the line items that contribute to the order's subtotal.
Presentment current subtotal price	The subtotal of line items and their discounts minus the line items that have been returned in presentment currency. This includes order-level discounts, unless the argument with_cart_discount is set to false. This doesn't include shipping costs and shipping discounts. Taxes are not included unless the order is a taxes-included order.
Shop current subtotal price	The subtotal of line items and their discounts minus the line items that have been returned in shop currency. This includes order-level discounts, unless the argument with_cart_discount is set to false. This doesn't include shipping costs and shipping discounts. Taxes are not included unless the order is a taxes-included order.
Presentment current total discounts	The total amount discounted from the order (including order-level and line item discounts) minus the amounts for items that have been returned in presentment currency.
Shop current total discounts	The total amount discounted from the order (including order-level and line item discounts) minus the amounts for items that have been returned in shop currency.
Presentment current total duties	Total amount of duties for the order in presentment currency. If duties are not applicable, then this value is null.
Shop current total duties	Total amount of duties for the order in shop currency. If duties are not applicable, then this value is null.
Presentment current total price	The total amount of the order (including taxes and discounts) minus the amounts for line items that have been returned in presentment currency.
Shop current total price	The total amount of the order (including taxes and discounts) minus the amounts for line items that have been returned in shop currency.
Presentment current total tax	The total of all taxes applied to the order minus the taxes for line items that have been returned in presentment currency.
Shop current total tax	The total of all taxes applied to the order minus the taxes for line items that have been returned in shop currency.
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.
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 or not.
Email	Email address provided by the customer.
Fulfillable	Whether there are items that can be fulfilled. After an order is completely fulfilled (or completely refunded without any fulfillments) then this field returns false.
Fully paid	Whether the order has been paid in full.
Has timeline comment	Whether the merchant added timeline comments to the order.
Merchant editable	Whether the order can be edited or not.
Presentment net payment	Net payment for the order, based on the total amount received - total amount refunded in presentment currency.
Shop net payment	Net payment for the order, based on the total amount received - total amount refunded in shop currency.
Note	Contents of the note associated with the order.
Presentment original total duties	Total amount of duties prior to any applied edits for the order in presentment currency. If duties are not applicable, then this value is null.
Shop original total duties	Total amount of duties prior to any applied edits for the order in shop currency. If duties are not applicable, then this value is null.
Presentment original total price	Total price of the order prior to any applied edits in presentment currency.
Shop original total price	Total price of the order prior to any applied edits in shop currency.
Payment gateways	List of all payment gateways used for the order. For example, authorize_net and Cash on Delivery (COD).
Phone	Phone number provided by the customer.
Presentment currency	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.
Presentment refund discrepancy	The difference between suggested and actual refund amounts in presentment currency. A positive value indicates a difference in the merchants favor and a negative value indicates a difference in the customers favor.
Shop original refund discrepancy	The difference between suggested and actual refund amounts in shop currency. A positive value indicates a difference in the merchants favor and a negative value indicates a difference in the customers favor.
Refundable	Whether the order can be refunded.
Requires shipping	Whether any line item in the order requires physical shipping.
Restockable	Whether 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.
Presentment subtotal price	Subtotal of the line items and their discounts (does not contain shipping costs and shipping discounts) in presentment currency.
Shop subtotal price	Subtotal of the line items and their discounts (does not contain shipping costs and shipping discounts) in shop currency.
Tags	A comma separated list of tags that have been added to 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.
Presentment total capturable	Amount authorized for the order, that is uncaptured or undercaptured in presentment currency.
Shop total capturable	Amount authorized for the order, that is uncaptured or undercaptured in shop currency.
Presentment total discounts	Total amount discounted from the order (includes order-level and line item discounts) in presentment currency.
Shop total discounts	Total amount discounted from the order (includes order-level and line item discounts) in shop currency.
Presentment total outstanding	Total amount of money not yet authorized for the order in presentment currency.
Shop total outstanding	Total amount of money not yet authorized for the order in shop currency.
Presentment total price	Total amount of the order (includes taxes and discounts) in presentment currency.
Shop total price	Total amount of the order (includes taxes and discounts) in shop currency.
Presentment total received	Total amount received by the customer for the order in presentment currency.
Shop total received	Total amount received by the customer for the order in shop currency.
Presentment total refunded	Total amount refunded for the order in presentment currency.
Shop total refunded	Total amount refunded for the order in shop currency.
Presentment total refunded shipping	Total amount refunded for shipping in presentment currency.
Shop total refunded shipping	Total amount refunded for shipping in shop currency.
Presentment total shipping price	Total amount charged for shipping the order in presentment currency.
Shop total shipping price	Total amount charged for shipping the order in shop currency.
Presentment total tax	Total of all taxes applied to the order in presentment currency.
Shop total tax	Total of all taxes applied to the order in shop currency.
Total tip received	Total tip amount received for the order.
Total weight	Total weight (grams) of the order.
Unpaid	Whether no payments have been made for the order. If no payments have been made for the order, then this returns true.
Updated at	Date and time when the order was last modified.

Expand

title	Orders / Physical location

If the order was processed using Shopify POS, then this is its location as provided by the merchant.

Field	Description
ID	Globally unique identifier.
Name	The name of the location.
Activatable	Whether this location can be reactivated.
Address verified	Whether the location address has been verified.
Deactivatable	Whether this location can be deactivated.
Deactivated at	Date and time the location was deactivated (null if location is still active). Following UTC ISO8601 format, e.g.: "2019-04-24T13:42:24Z".
Deletable	Whether this location can be deleted.
Fulfills online orders	Indicates whether this location can fulfill online orders.
Has active inventory	Indicates whether or not this location has active inventory.
Has unfulfilled orders	Indicates whether or not this location has unfulfilled orders.
Is active	Whether the location is active.
Ships inventory	Indicates whether or not this location is used for calculating shipping rates.

Expand

title	Orders / Shipping lines

List of line items that contains the shipping costs.

Field	Description
ID	Globally unique identifier.
Carrier identifier	A reference to the carrier service that provided the rate. Present when the rate was computed by a third-party carrier service.
Code	A reference to the shipping method.
Custom	Whether the shipping line is custom or not.
Delivery category	The general classification of the delivery method.
Presentment discounted price	The pre-tax shipping price with discounts applied in presentment currency.
Shop discounted price	The pre-tax shipping price with discounts applied in shop currency.
Presentment original price	The pre-tax shipping price without any discounts applied in presentment currency.
Shop original price	The pre-tax shipping price without any discounts applied in shop currency.
Phone	The phone number at the shipping address.
Shipping rate handle	A unique identifier for the shipping rate. The format can change without notice and is not meant to be shown to users.
Source	Returns the rate source for the shipping line.
Title	Returns the title of the shipping line.

Expand

title	Orders / Publication / App

The app associated with the publication.

Field	Description
ID	Globally unique identifier.
API key	A unique application API identifier.
App store app URL	App store page URL of the app.
App store developer URL	App store page URL of the developer who created the app.
Description	Description of the app.
Developer name	App's developer name.
Embedded	Whether the app uses the Embedded App SDK.
Handle	Handle of the app.
Install URL	Webpage where you can install the app.
Pricing details	Detailed information about the app pricing.
Pricing details summary	Summary of the app pricing details.
Privacy policy URL	Link to app privacy policy.
Published	Whether the app is published.
Shopify developed	Whether the app was developed by Shopify.
Title	Name of the app.
Uninstall message	Message that appears when the app is uninstalled.

Expand

title	Orders / Transactions

List of all transactions associated with the order.

Field	Description
ID	Globally unique identifier.
Account number	The masked account number associated with the payment method.
Presentment amount	The amount and currency of the transaction in presentment currency.
Shop amount	The amount and currency of the transaction in shop currency.
Authorization code	Authorization code associated with the transaction.
Created at	Date and time when the transaction was created.
Error code	A standardized error code, independent of the payment provider.
Formatted gateway	The human-readable payment gateway name used to process the transaction.
Gateway	The payment gateway used to process the transaction.
Kind	The kind of transaction.
Manually capturable	Whether the transaction can be manually captured.
Maximum refundable	Specifies the available amount with currency to refund on the gateway. Only available within SuggestedRefund.
Payment method	Specifies the credit card company used to pay for this transaction.
Payment icon alt text	A word or phrase to share the nature or contents of the payment icon to display for this transaction.
Original payment icon URL	The location of the original payment icon to display for this transaction.
Transformed payment icon URL	The location of the transformed payment icon to display for this transaction.
Processed at	Date and time when the transaction was processed.
Settlement currency	The settlement currency.
Settlement currency rate	The rate used when converting the transaction amount to settlement currency.
Status	The status of this transaction.
Test	Whether the transaction is a test transaction.
Presentment total unsettled	Specifies the available amount with currency to capture on the gateway in presentment currency. Only available when an amount is capturable or manually mark as paid.
Shop total unsettled	Specifies the available amount with currency to capture on the gateway in shop currency. Only available when an amount is capturable or manually mark as paid.

Expand

title	Orders / Transactions / Fees

The transaction fees charged on the order transaction. Only present for Shopify Payments transactions.

Field	Description
ID	Globally unique identifier.
Amount	Amount of the fee.
Flat fee	Flat rate charge for a transaction.
Flat fee name	Name of the credit card flat fee.
Rate	Percentage charge.
Rate name	Name of the credit card rate.
Tax amount	Tax amount charged on the fee.
Type	Name of the type of fee.

Expand

title	Orders / Disputes

Summary of each dispute associated with the order.

Field	Description
ID	Globally unique identifier.
Initiated as	The type that the dispute was initiated as.
Status	The current status of the dispute.

Expand

title	Orders / Refunds

List of refunds that have been applied to the order.

Field	Description
ID	Globally unique identifier.
Created at	When the refund was created.
Note	Note associated with the refund.
Presentment total refunded	Total amount refunded across all the transactions for this refund in presentment currency.
Shop total refunded	Total amount refunded across all the transactions for this refund in shop currency.
Updated at	When the refund was last updated.

Expand

title	Orders / Current tax lines

The taxes charged for the order minus the taxes for line items that have been returned.

Field	Description
Presentment price	The amount of tax to be charged in presentment currency.
Shop price	The amount of tax to be charged in shop currency.
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.

Expand

title	Orders / Metafields

Represents custom metadata attached to a resource.

Field	Description
ID	Globally unique identifier.
Created at	The date and time when the metafield was created.
Description	The description of a metafield.
Key	The key name for a metafield.
Namespace	The namespace for a metafield.
Owner type	Owner type of a metafield visible to the Storefront API.
Updated at	The date and time when the metafield was updated.
Value	The value of a metafield.
Value type	Represents the metafield value type.

Expand

title	Orders / Fulfillment orders

List of fulfillment orders.

Field	Description
ID	Globally unique identifier.
Request status	The request status of the fulfillment order.
Status	The status of the fulfillment order.

Expand

title	Orders / Risks

The order risks associated with this order.

Field	Description
Display	Whether the risk level is shown in the Shopify admin. If false, then this order risk is ignored when Shopify determines the overall risk level for the order.
Level	The likelihood that an order is fraudulent, based on this order risk. The level can be set by Shopify risk analysis or by an app.
Message	The risk message that's shown to the merchant in the Shopify admin.

Expand

title	Orders / Display address

Primary address of the customer, which is shown on the order.

Field	Description
ID	Globally unique identifier.
First line	The first line of the address. Typically the street address or PO Box number.
Second line	The second line of the address. Typically the number of the apartment, suite, or unit.
Full address	The first and the second line of the address.
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.
First name	The first name of the customer.
Formatted	A comma-separated list of the values for city, province, and country.
Formatted area	A formatted version of the address, customized by the provided arguments.
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 the first and last name.
Phone	A unique phone number for the customer.
Province	The region of the address, such as the province, state, or district.
Province code	The two-letter code for the region.
Zip	The zip or postal code of the address.

Expand

title	Orders

An order represents an agreement to do business between a customer and a merchant.

Field	Description
ID	Globally unique identifier.
Name	Unique identifier for the order that appears on the order. For example, #1000 or _Store1001. This value is not unique across multiple stores.
Billing address matches the shipping address	Whether the billing address matches the shipping address.
Can marked as paid	Whether the order can be manually marked as paid.
Can notify customer	Whether notifications can be sent to the customer or not.
Cancel reason	Reason the order was canceled. Returns null if the order wasn't canceled.
Cancelled at	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.
Presentment cart discount	Amount of the order-level discount (does not contain any line item discounts) in presentment currency.
Shop cart discount	Amount of the order-level discount (does not contain any line item discounts) in shop currency.
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 is 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 is null.
Presentment current cart discount	The amount of the order-level discount minus the amounts for line items that have been returned in presentment currency. This doesn't include line item discounts.
Shop current cart discount	The amount of the order-level discount minus the amounts for line items that have been returned in shop currency. This doesn't include line item discounts.
Current subtotal line items quantity	The sum of the quantities for the line items that contribute to the order's subtotal.
Presentment current subtotal price	The subtotal of line items and their discounts minus the line items that have been returned in presentment currency. This includes order-level discounts, unless the argument with_cart_discount is set to false. This doesn't include shipping costs and shipping discounts. Taxes are not included unless the order is a taxes-included order.
Shop current subtotal price	The subtotal of line items and their discounts minus the line items that have been returned in shop currency. This includes order-level discounts, unless the argument with_cart_discount is set to false. This doesn't include shipping costs and shipping discounts. Taxes are not included unless the order is a taxes-included order.
Presentment current total discounts	The total amount discounted from the order (including order-level and line item discounts) minus the amounts for items that have been returned in presentment currency.
Shop current total discounts	The total amount discounted from the order (including order-level and line item discounts) minus the amounts for items that have been returned in shop currency.
Presentment current total duties	Total amount of duties for the order in presentment currency. If duties are not applicable, then this value is null.
Shop current total duties	Total amount of duties for the order in shop currency. If duties are not applicable, then this value is null.
Presentment current total price	The total amount of the order (including taxes and discounts) minus the amounts for line items that have been returned in presentment currency.
Shop current total price	The total amount of the order (including taxes and discounts) minus the amounts for line items that have been returned in shop currency.
Presentment current total tax	The total of all taxes applied to the order minus the taxes for line items that have been returned in presentment currency.
Shop current total tax	The total of all taxes applied to the order minus the taxes for line items that have been returned in shop currency.
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.
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 or not.
Email	Email address provided by the customer.
Fulfillable	Whether there are items that can be fulfilled. After an order is completely fulfilled (or completely refunded without any fulfillments) then this field returns false.
Fully paid	Whether the order has been paid in full.
Has timeline comment	Whether the merchant added timeline comments to the order.
Merchant editable	Whether the order can be edited or not.
Presentment net payment	Net payment for the order, based on the total amount received - total amount refunded in presentment currency.
Shop net payment	Net payment for the order, based on the total amount received - total amount refunded in shop currency.
Note	Contents of the note associated with the order.
Presentment original total duties	Total amount of duties prior to any applied edits for the order in presentment currency. If duties are not applicable, then this value is null.
Shop original total duties	Total amount of duties prior to any applied edits for the order in shop currency. If duties are not applicable, then this value is null.
Presentment original total price	Total price of the order prior to any applied edits in presentment currency.
Shop original total price	Total price of the order prior to any applied edits in shop currency.
Payment gateways	List of all payment gateways used for the order. For example, authorize_net and Cash on Delivery (COD).
Phone	Phone number provided by the customer.
Presentment currency	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.
Presentment refund discrepancy	The difference between suggested and actual refund amounts in presentment currency. A positive value indicates a difference in the merchants favor and a negative value indicates a difference in the customers favor.
Shop original refund discrepancy	The difference between suggested and actual refund amounts in shop currency. A positive value indicates a difference in the merchants favor and a negative value indicates a difference in the customers favor.
Refundable	Whether the order can be refunded.
Requires shipping	Whether any line item in the order requires physical shipping.
Restockable	Whether 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.
Presentment subtotal price	Subtotal of the line items and their discounts (does not contain shipping costs and shipping discounts) in presentment currency.
Shop subtotal price	Subtotal of the line items and their discounts (does not contain shipping costs and shipping discounts) in shop currency.
Tags	A comma separated list of tags that have been added to 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.
Presentment total capturable	Amount authorized for the order, that is uncaptured or undercaptured in presentment currency.
Shop total capturable	Amount authorized for the order, that is uncaptured or undercaptured in shop currency.
Presentment total discounts	Total amount discounted from the order (includes order-level and line item discounts) in presentment currency.
Shop total discounts	Total amount discounted from the order (includes order-level and line item discounts) in shop currency.
Presentment total outstanding	Total amount of money not yet authorized for the order in presentment currency.
Shop total outstanding	Total amount of money not yet authorized for the order in shop currency.
Presentment total price	Total amount of the order (includes taxes and discounts) in presentment currency.
Shop total price	Total amount of the order (includes taxes and discounts) in shop currency.
Presentment total received	Total amount received by the customer for the order in presentment currency.
Shop total received	Total amount received by the customer for the order in shop currency.
Presentment total refunded	Total amount refunded for the order in presentment currency.
Shop total refunded	Total amount refunded for the order in shop currency.
Presentment total refunded shipping	Total amount refunded for shipping in presentment currency.
Shop total refunded shipping	Total amount refunded for shipping in shop currency.
Presentment total shipping price	Total amount charged for shipping the order in presentment currency.
Shop total shipping price	Total amount charged for shipping the order in shop currency.
Presentment total tax	Total of all taxes applied to the order in presentment currency.
Shop total tax	Total of all taxes applied to the order in shop currency.
Total tip received	Total tip amount received for the order.
Total weight	Total weight (grams) of the order.
Unpaid	Whether no payments have been made for the order. If no payments have been made for the order, then this returns true.
Updated at	Date and time when the order was last modified.

Expand

title	Orders / Publication

Publication that created the order.

Field	Description
ID	Globally unique identifier.
Name	Name of the publication.
Supports future publishing	Whether or not this publication supports future publishing.

Expand

title	Orders / Shipping address

Mailing address for shipping provided by the customer.

Field	Description
ID	Globally unique identifier.
First line	The first line of the address. Typically the street address or PO Box number.
Second line	The second line of the address. Typically the number of the apartment, suite, or unit.
Full address	The first and the second line of the address.
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.
First name	The first name of the customer.
Formatted	A comma-separated list of the values for city, province, and country.
Formatted area	A formatted version of the address, customized by the provided arguments.
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 the first and last name.
Phone	A unique phone number for the customer.
Province	The region of the address, such as the province, state, or district.
Province code	The two-letter code for the region.
Zip	The zip or postal code of the address.

Expand

title	Orders / Billing address

A list of mailing addresses provided by the customers.

Field	Description
ID	Globally unique identifier.
First line	The first line of the address. Typically the street address or PO Box number.
Second line	The second line of the address. Typically the number of the apartment, suite, or unit.
Full address	The first and the second line of the address.
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.
First name	The first name of the customer.
Formatted	A comma-separated list of the values for city, province, and country.
Formatted area	A formatted version of the address, customized by the provided arguments.
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 the first and last name.
Phone	A unique phone number for the customer.
Province	The region of the address, such as the province, state, or district.
Province code	The two-letter code for the region.
Zip	The zip or postal code of the address.

Expand

title	Orders / Customer

Customer who placed the order. Not all orders have customers associated with them.

Field	Description
ID	Globally unique identifier.
Display name	The full name of the customer, based on the first and last name values. If the first and last name are not available, then this falls back to the customer's email address, and if that is not available, the customer's phone number.
Accepts marketing	Whether the customer has agreed to receive marketing materials.
Accepts marketing updated at	The date and time when the customer consented or objected to receiving marketing material by email.
Average order amount	The average amount that the customer spent per order.
Can delete	Whether the merchant can delete the customer from their store.
Created at	The date and time when the customer was added to the store.
Email	The customer's email address.
First name	The customer's first name.
Has note	Whether the customer has a note associated with them.
Has timeline comment	Whether the merchant has added timeline comments about the customer on the customer's page.
Image alt text	A word or phrase to share the nature or contents of an image associated with the customer.
Original image URL	The location of the original image associated with the customer as a URL.
Transformed image URL	The location of the transformed image associated with the customer as a URL.
Last name	The customer's last name.
Lifetime duration	The amount of time since the customer was first added to the store.
Locale	The customer's locale.
Marketing opt-in level	The marketing subscription opt-in level (as described by the M3AAWG best practices guideline) that the customer gave when they consented to receive marketing material by email. If the customer does not accept email marketing, then this property will be null.
Multipass identifier	A unique identifier for the customer that's used with Multipass login.
Note	A note about the customer.
Orders count	The number of orders that the customer has made at the store in their lifetime.
Phone	The customer's phone number.
State	The state of the customer's account with the shop.
Tax exempt	Whether the customer is exempt from being charged taxes on their orders.
Total spent	The total amount that the customer has spent on orders in their lifetime.
Updated at	The date and time when the customer was last updated.
Valid email address	Whether the email address is formatted correctly. This does not guarantee that the email address actually exists.
Verified email	Whether the customer has verified their email address.

Expand

title	Orders / Custom attributes

Custom information added to the order by your customer (Also referred to as note attributes).

Field	Description
Key	Key or name of the attribute.
Value	Value of the attribute.

Expand

title	Orders / Customer journey / Moments

The events preceding a customer order, such as shop sessions.

Field	Description
ID	Globally unique identifier.
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.

Expand

title	Orders / Customer journey

Description of the customer's experience with the store leading up to the order.

Field	Description
Customer order index	The position of the current order within the customer's order history.
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.
Moments count	The total number of customer moments associated with this order. Returns null if the order is still in the process of being attributed.
Ready	Whether or not the attributed sessions for the order have been created yet.

Expand

title	Orders / Customer journey / Last visit

The last session before an order is made.

Field	Description
ID	Globally unique identifier.
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.

Expand

title	Orders / Customer journey / First visit

The customer's first session going into the shop.

Field	Description
ID	Globally unique identifier.
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.

Expand

title	Orders / Line items

List of the order's line items.

Field	Description
ID	Globally unique identifier.
Name	Name of the product.
Presentment discounted total	The total line price after discounts in presentment currency.
Shop discounted total	The total line price after discounts in shop currency.
Presentment discounted unit price	The price of a single variant unit after line item discounts in presentment currency.
Shop discounted unit price	The price of a single variant unit after line item discounts in shop currency.
Fulfillable quantity	The total number of units to fulfill.
Fulfillment status	The line item's fulfillment status. Returns 'fulfilled' if fulfillableQuantity >= quantity, 'partial' if fulfillableQuantity > 0, and 'unfulfilled' otherwise.
Merchant editable	Whether the line item can be edited or not.
Non fulfillable quantity	A count of the number of line items that cannot be fulfilled.
Presentment original total	Total price (without discounts) of the line item, based on the original unit price of the variant x quantity in presentment currency.
Shop original total	Total price (without discounts) of the line item, based on the original unit price of the variant x quantity in shop currency.
Presentment original unit price	Variant price without any discounts in presentment currency.
Shop original unit price	Variant price without any discounts in shop currency.
Quantity	Number of variant items ordered.
Refundable quantity	The line item's quantity minus its refunded quantity.
Requires shipping	Whether physical shipping is required for the variant.
Restockable	Whether the line item's variant has an ID and inventory is managed by Shopify.
SKU	Variant SKU number.
Taxable	Whether the variant is taxable.
Title	Title of the product or variant (this field only applies to custom line items).
Presentment total discount	The sum of all applied discounts on this line item in presentment currency.
Shop total discount	The sum of all applied discounts on this line item in shop currency.
Presentment unfulfilled discounted total	The total discounted value of unfulfilled units in presentment currency.
Shop unfulfilled discounted total	The total discounted value of unfulfilled units in shop currency.
Unfulfilled quantity	The number of units not yet fulfilled.
Variant title	Name of the variant.
Vendor	Name of the vendor who made the variant.

Expand

title	Orders / Line items / Variant

The Variant object associated with the line item.

Field	Description
ID	Globally unique identifier.
Title	The title of the product variant.
Available for sale	Whether the product variant is available for sale.
Barcode	The value of the barcode associated with the product.
Compare-at price	The compare-at price of the variant in the default shop currency.
Created at	The date and time when the variant was created.
Display name	Display name of the variant, based on product's title + variant's title.
Inventory policy	Whether customers are allowed to place an order for the product variant when it's out of stock.
Inventory quantity	The total sellable quantity of the variant.
Position	The order of the product variant in the list of product variants. The first position in the list is 1.
Price	The price of the product variant in the default shop currency.
SKU	An identifier for the product variant in the shop.
Storefront ID	The storefront ID of the product variant.
Tax code	The tax code for the product variant.
Taxable	Whether a tax is charged when the product variant is sold.
Updated at	The date and time (ISO 8601 format) when the product variant was last modified.
Weight	The weight of the product variant in the unit system specified with weight_unit.
Weight unit	The unit of measurement that applies to the product variant's weight.

Expand

title	Orders / Line items / Tax lines

The Tax Line object connected to the line item.

Field	Description
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.

Expand

title	Orders / Line items / Product

The Product object associated with the line item's variant.

Field	Description
ID	Globally unique identifier.
Handle	A unique human-friendly string of the product's title.
Created at	The date and time (ISO 8601 format) when the product was created.
Description	A stripped description of the product, single line with HTML tags removed.
Description HTML	The description of the product, complete with HTML formatting.
Gift card template suffix	The theme template used when viewing the gift card in a store.
Has only default variant	Whether the product has only a single variant with the default option and value.
Has out of stock variants	Whether the product has out of stock variants.
Is gift card	Whether the product is a gift card.
Media count	Total count of media belonging to a product.
Online store preview URL	The online store preview URL.
Online store URL	The online store URL for the product. A value of null indicates that the product is not published to the Online Store sales channel.
Options	A list of custom product options (maximum of 3 per product).
Product type	The product type specified by the merchant.
Published at	The date and time (ISO 8601 format) when the product was published to the Online Store.
Status	The product status.
Storefront ID	The storefront ID of the product.
Tags	A comma separated list of tags associated with the product.
Theme template	The theme template used when viewing the product in a store.
Title	The title of the product.
Total inventory	The quantity of inventory in stock.
Total variants	The number of variants that are associated with the product.
Tracks inventory	Whether inventory tracking has been enabled for the product.
Updated at	The date and time (ISO 8601 format) when the product was last modified.
Vendor	The name of the product's vendor.

Expand

title	Orders / Line items / Discount allocations

The discounts that have been allocated onto the line item by discount applications.

Field	Description
Presentment allocated amount	Money amount allocated by the discount application in presentment currency.
Shop allocated amount	Money amount allocated by the discount application in shop currency.
Discount application allocation method	The method by which the discount's value is allocated to its entitled items.
Discount application index	An ordered index that can be used to identify the discount application and indicate the precedence of the discount application for calculations.
Discount application target selection	How the discount amount is distributed on the discounted lines.
Discount application target type	Whether the discount is applied on line items or shipping lines.

Expand

title	Orders / Line items / Fulfillment service

Service provider who fulfilled the order.

Field	Description
ID	Globally unique identifier.
Handle	Human-readable unique identifier for this fulfillment service.
Callback URL	The callback URL the fulfillment service has registered for requests.
Fulfillment orders opt-in	Whether the fulfillment service has opted into fulfillment order based requests.
Inventory management	Whether the fulfillment service tracks product inventory and provides updates to Shopify.
Product based	Whether the fulfillment service supports local deliveries.
Service name	The name of the fulfillment service as seen by merchants.
Type	Type associated with the fulfillment service.

Expand

title	Orders / Line items / Custom attributes

List of additional information (metafields) about the line item.

Field	Description
Key	Key or name of the attribute.
Value	Value of the attribute.

Expand

title	Orders / Fulfillments / Service

Fulfillment service associated with the fulfillment.

Field	Description
ID	Globally unique identifier.
Handle	Human-readable unique identifier for this fulfillment service.
Callback URL	The callback URL the fulfillment service has registered for requests.
Fulfillment orders opt-in	Whether the fulfillment service has opted into fulfillment order based requests.
Inventory management	Whether the fulfillment service tracks product inventory and provides updates to Shopify.
Product based	Whether the fulfillment service supports local deliveries.
Service name	The name of the fulfillment service as seen by merchants.
Type	Type associated with the fulfillment service.

Expand

title	Orders / Fulfillments

List of shipments for the order.

Field	Description
ID	Globally unique identifier.
Name	Human readable reference identifier for this fulfillment.
Created at	The date and time when the fulfillment was created.
Delivered at	The date that this fulfillment was delivered.
Display status	Human readable display status for this fulfillment.
Estimated delivery at	The estimated date that this fulfillment will arrive.
In transit at	The date and time when the fulfillment went into transit.
Requires shipping	Whether any of the line items in the fulfillment require shipping.
Status	The status of the fulfillment.
Total quantity	Sum of all line item quantities for the fulfillment.
Updated at	The date and time when the fulfillment was last modified.

Expand

title	Orders / Fulfillments / Location

The location that the fulfillment was processed at.

Field	Description
ID	Globally unique identifier.
Name	The name of the location.
Activatable	Whether this location can be reactivated.
Address verified	Whether the location address has been verified.
Deactivatable	Whether this location can be deactivated.
Deactivatad at	Date and time the location was deactivated (null if location is still active).
Deletable	Whether this location can be deleted.
Fulfills online orders	Indicates whether this location can fulfill online orders.
Has active inventory	Indicates whether or not this location has active inventory.
Has unfulfilled orders	Indicates whether or not this location has unfulfilled orders.
Is active	Whether the location is active.
Ships inventory	Indicates whether or not this location is used for calculating shipping rates.

Expand

title	Orders / Fulfillments / Tracking info

Tracking information associated with the fulfillment, such as the tracking company, tracking number, and tracking URL.

Field	Description
Company	The name of the tracking company.
Number	The tracking number of the fulfillment.
URL	The URLs to track the fulfillment.

Expand

title	Inventory items

Represents the goods available to be shipped to a customer. It holds essential information about the goods, including SKU and whether it is tracked.

Field	Description
ID	Globally unique identifier.
SKU	Inventory item SKU.
Country code of origin	The ISO code of the country of origin.
Created at	The date and time when the inventory item was created.
Duplicate SKU count	The number of inventory items that share the same SKU with this item.
Harmonized system code	The harmonized system code of the item.
Inventory history URL	URL for inventory history web page.
Locations count	The number of locations where this inventory item is stocked.
Province code of origin	The ISO code of the province of origin.
Requires shipping	Whether the item requires shipping or not.
Tracked	Whether the inventory quantities of inventory levels for the item are tracked or not.
Tracked editable locked	Whether changes to the inventory item tracked attribute is locked for editing.
Tracked editable reason	The reason the inventory item tracked attribute is locked for editing.
Unit cost	Unit cost associated with the inventory item.
Updated at	The date and time when the inventory item was updated.

Expand

title	Inventory items / Inventory levels

List of inventory levels for each location that the inventory item is stocked at.

Field	Description
ID	Globally unique identifier.
Available	Quantity of items available at the location.
Can deactivate	Whether Inventory deactivate is allowed for this inventory level.
Created at	The date and time when the inventory level was created.
Deactivation alert	Reason why Can deactivate is false, or impact of deactivating the inventory level.
Deactivation alert HTML	Reason why Can deactivate is false with URLs linked in HTML, or impact of deactivating the inventory level.
Incoming	Quantity of items incoming to the location.
Updated at	The date and time when the inventory level was updated.

Expand

title	Inventory items / Inventory levels / Location

Location associated with the inventory level.

Field	Description
ID	Globally unique identifier.
Name	The name of the location.
Activatable	Whether this location can be reactivated.
Address verified	Whether the location address has been verified.
Deactivatable	Whether this location can be deactivated.
Deactivated at	Date and time the location was deactivated (null if location is still active). Following UTC ISO8601 format, e.g.: "2019-04-24T13:42:24Z".
Deletable	Whether this location can be deleted.
Fulfills online orders	Indicates whether this location can fulfill online orders.
Has active inventory	Indicates whether or not this location has active inventory.
Has unfulfilled orders	Indicates whether or not this location has unfulfilled orders.
Is active	Whether the location is active.
Ships inventory	Indicates whether or not this location is used for calculating shipping rates.

Expand

title	Inventory items / Variant

The variant that owns this inventory item.

Field	Description
ID	Globally unique identifier.
Title	The title of the product variant.
Available for sale	Whether the product variant is available for sale.
Barcode	The value of the barcode associated with the product.
Compare-at price	The compare-at price of the variant in the default shop currency.
Created at	The date and time when the variant was created.
Display name	Display name of the variant, based on product's title + variant's title.
Image alt text	A word or phrase to share the nature or contents of the featured image for the variant.
Original image URL	The location of the original featured image for the variant as a URL.
Transformed image URL	The location of the transformed featured image for the variant as a URL.
Inventory policy	Whether customers are allowed to place an order for the product variant when it's out of stock.
Inventory quantity	The total sellable quantity of the variant.
Position	The order of the product variant in the list of product variants. The first position in the list is 1.
Price	The price of the product variant in the default shop currency.
SKU	An identifier for the product variant in the shop.
Storefront ID	The storefront ID of the product variant.
Tax code	The tax code for the product variant.
Taxable	Whether a tax is charged when the product variant is sold.
Updated at	The date and time (ISO 8601 format) when the product variant was last modified.
Weight	The weight of the product variant in the unit system specified with weight_unit.
Weight unit	The unit of measurement that applies to the product variant's weight.

Expand

title	Product variants

List of the product variants.

Field	Description
ID	Globally unique identifier.
Title	The title of the product variant.
Available for sale	Whether the product variant is available for sale.
Barcode	The value of the barcode associated with the product.
Compare-at price	The compare-at price of the variant in the default shop currency.
Created at	The date and time when the variant was created.
Display name	Display name of the variant, based on product's title + variant's title.
Image ID	A unique identifier of the featured image for the variant.
Image alt text	A word or phrase to share the nature or contents of the featured image for the variant.
Original image URL	The location of the original featured image for the variant as a URL.
Transformed image URL	The location of the transformed featured image for the variant as a URL.
Inventory policy	Whether customers are allowed to place an order for the product variant when it's out of stock.
Inventory quantity	The total sellable quantity of the variant.
Position	The order of the product variant in the list of product variants. The first position in the list is 1.
Price	The price of the product variant in the default shop currency.
SKU	An identifier for the product variant in the shop. Required in order to connect to a fulfillment service.
Storefront ID	The storefront ID of the product variant.
Tax code	The tax code for the product variant.
Taxable	Whether a tax is charged when the product variant is sold.
Updated at	The date and time (ISO 8601 format) when the product variant was last modified.
Weight	The weight of the product variant in the unit system specified with weight_unit.
Weight unit	The unit of measurement that applies to the product variant's weight.

Expand

title	Product variants / Delivery profile

A profile for multi-location, per-product delivery.

Field	Description
ID	Globally unique identifier.
Name	The name of the delivery profile.
Active method definitions count	The number of active shipping rates for the profile.
Default	Whether this is the default profile.
Legacy mode	Whether this shop has enabled legacy compatibility mode for delivery profiles.
Locations without rates count	The number of locations without rates defined.
Origin location count	The number of active origin locations for the profile.
Product variants count capped	If the product variants count in this profile has reached the cap of 500.
Product variants count	How many product variants are in this profile.
Zone country count	The number of countries with active rates to deliver to.

Expand

title	Product variants / Fulfillment service

Represents a fulfillment service. A fulfillment service is a third-party service that prepares and ships orders on behalf of the store owner.

Field	Description
ID	Globally unique identifier.
Handle	Human-readable unique identifier for this fulfillment service.
Callback URL	The callback URL the fulfillment service has registered for requests.
Fulfillment orders opt-in	Whether the fulfillment service has opted into fulfillment order based requests.
Inventory management	Whether the fulfillment service tracks product inventory and provides updates to Shopify.
Product based	Whether the fulfillment service supports local deliveries.
Service name	The name of the fulfillment service as seen by merchants.
Type	Type associated with the fulfillment service.

Expand

title	Product variants / Inventory item

The inventory item, which is used to query for inventory information.

Field	Description
ID	Globally unique identifier.
SKU	Inventory item SKU.
Country code of origin	The ISO code of the country of origin.
Created at	The date and time when the inventory item was created.
Duplicate SKU count	The number of inventory items that share the same SKU with this item.
Harmonized system code	The harmonized system code of the item.
Inventory history URL	URL for inventory history web page.
Locations count	The number of locations where this inventory item is stocked.
Province code of origin	The ISO code of the province of origin.
Requires shipping	Whether the item requires shipping or not.
Tracked	Whether the inventory quantities of inventory levels for the item are tracked or not.
Tracked editable locked	Whether changes to the inventory item tracked attribute is locked for editing.
Tracked editable reason	The reason the inventory item tracked attribute is locked for editing.
Unit cost	Unit cost associated with the inventory item.
Updated at	The date and time when the inventory item was updated.

Expand

title	Product variants / Product

The product that this variant belongs to.

Field	Description
ID	Globally unique identifier.
Handle	A unique human-friendly string of the product's title.
Created at	The date and time (ISO 8601 format) when the product was created.
Description	A stripped description of the product, single line with HTML tags removed.
Description HTML	The description of the product, complete with HTML formatting.
Gift card template suffix	The theme template used when viewing the gift card in a store.
Has only default variant	Whether the product has only a single variant with the default option and value.
Has out of stock variants	Whether the product has out of stock variants.
Is gift card	Whether the product is a gift card.
Media count	Total count of media belonging to a product.
Online store preview URL	The online store preview URL.
Online store URL	The online store URL for the product. A value of null indicates that the product is not published to the Online Store sales channel.
Options	A list of custom product options (maximum of 3 per product).
Highest variant's price	The highest variant's price of the product formatted as decimals.
Lowest variant's price	The lowest variant's price of the product formatted as decimals.
Product type	The product type specified by the merchant.
Published at	The date and time (ISO 8601 format) when the product was published to the Online Store.
SEO title	SEO information title of the product.
SEO description	SEO information description of the product.
Status	The product status.
Storefront ID	The storefront ID of the product.
Tags	A comma separated list of tags associated with the product.
Theme template	The theme template used when viewing the product in a store.
Title	The title of the product.
Total inventory	The quantity of inventory in stock.
Total variants	The number of variants that are associated with the product.
Tracks inventory	Whether inventory tracking has been enabled for the product.
Updated at	The date and time (ISO 8601 format) when the product was last modified.
Vendor	The name of the product's vendor.

Expand

title	Product variants / Presentment prices

List of prices and compare-at prices in the presentment currencies for this shop.

Field	Description
Compare at price	The compare-at price of the variant with associated currency.
Price	The price of the variant with associated currency.

Expand

title	Product variants / Selected options

List of product options applied to the variant.

Field	Description
Name	The product option’s name.
Value	The product option’s value.

Expand

title	Product variants / Metafields

Represents custom metadata attached to a resource.

Field	Description
ID	Globally unique identifier.
Created at	The date and time when the metafield was created.
Description	The description of a metafield.
Key	The key name for a metafield.
Namespace	The namespace for a metafield.
Owner type	Owner type of a metafield visible to the Storefront API.
Updated at	The date and time when the metafield was updated.
Value	The value of a metafield.
Value type	Represents the metafield value type.

Expand

title	Draft orders / Metafields

Represents custom metadata attached to a resource.

Field	Description
ID	Globally unique identifier.
Created at	The date and time when the metafield was created.
Description	The description of a metafield.
Key	The key name for a metafield.
Namespace	The namespace for a metafield.
Owner type	Owner type of a metafield visible to the Storefront API.
Updated at	The date and time when the metafield was updated.
Value	The value of a metafield.
Value type	Represents the metafield value type.

Expand

title	Draft orders

List of the draft orders.

Field	Description
ID	Globally unique identifier.
Name	Unique identifier for the draft order, which is unique within the store. For example, #D1223.
Completed at	Date and time when the draft order converted to a new order, and the draft order's status changed to Completed.
Created at	Date and time when the draft order was created in Shopify.
Currency code	Three letter code for the currency of the store at the time that the invoice is sent.
Email	Email address of the customer, which is used to send notifications to.
Has timeline comment	Whether the merchant has added timeline comments to the draft order.
Invoice sent at	Date and time when the invoice was last emailed to the customer.
Invoice URL	Link to the checkout, which is sent to your customer in the invoice email.
Note	Text from an optional note attached to the draft order.
Ready	Whether or not the Draft Order is ready and can be completed. Draft Orders may have asynchronous operations that can take time to finish.
Status	Status of the draft order.
Subtotal price	Subtotal of the line items and their discounts (does not contain shipping charges or shipping discounts, or taxes).
Tags	A comma separated list of tags associated with the draft order.
Tax exempt	Whether the draft order is tax exempt.
Taxes included	Whether the line item prices include taxes.
Total price	Total amount of the draft order (includes taxes, shipping charges, and discounts).
Total shipping price	Total shipping charge for the draft order.
Total tax	Total amount of taxes for the draft order.
Total weight	Total weight (grams) of the draft order.
Updated at	Date and time when the draft order was last changed. The format is YYYY-MM-DD HH:mm:ss (for example, 2016-02-05 17:04:01).

Expand

title	Draft orders / Shipping address

The shipping address of the customer.

Field	Description
ID	Globally unique identifier.
First line	The first line of the address. Typically the street address or PO Box number.
Second line	The second line of the address. Typically the number of the apartment, suite, or unit.
Full address	The first and the second line of the address.
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.
First name	The first name of the customer.
Formatted	A comma-separated list of the values for city, province, and country.
Formatted area	A formatted version of the address, customized by the provided arguments.
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 the first and last name.
Phone	A unique phone number for the customer.
Province	The region of the address, such as the province, state, or district.
Province code	The two-letter code for the region.
Zip	The zip or postal code of the address.

Expand

title	Draft orders / Applied discount

Order-level discount applied to the draft order.

Field	Description
Amount	Amount of money discounted.
Description	Description of the order-level discount.
Title	Name of the order-level discount.
Value	Amount of the order level discount (when Value type is percentage, the value in this field is the percentage discount).
Value type	Type of the order-level discount.

Expand

title	Draft orders / Billing address

The billing address of the customer.

Field	Description
ID	Globally unique identifier.
First line	The first line of the address. Typically the street address or PO Box number.
Second line	The second line of the address. Typically the number of the apartment, suite, or unit.
Full address	The first and the second line of the address.
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.
First name	The first name of the customer.
Formatted	A comma-separated list of the values for city, province, and country.
Formatted area	A formatted version of the address, customized by the provided arguments.
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 the first and last name.
Phone	A unique phone number for the customer.
Province	The region of the address, such as the province, state, or district.
Province code	The two-letter code for the region.
Zip	The zip or postal code of the address.

Expand

title	Draft orders / Tax lines

Total amount of taxes charged for each line item and shipping line.

Field	Description
Presentment price	The amount of tax to be charged in presentment currency.
Shop price	The amount of tax to be charged in shop currency.
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.

Expand

title	Draft orders / Shipping line

List of line items that contains the shipping costs.

Field	Description
ID	Globally unique identifier.
Carrier identifier	A reference to the carrier service that provided the rate. Present when the rate was computed by a third-party carrier service.
Code	A reference to the shipping method.
Custom	Whether the shipping line is custom or not.
Delivery category	The general classification of the delivery method.
Presentment discounted price	The pre-tax shipping price with discounts applied in presentment currency.
Shop discounted price	The pre-tax shipping price with discounts applied in shop currency.
Presentment original price	The pre-tax shipping price without any discounts applied in presentment currency.
Shop original price	The pre-tax shipping price without any discounts applied in shop currency.
Phone	The phone number at the shipping address.
Shipping rate handle	A unique identifier for the shipping rate. The format can change without notice and is not meant to be shown to users.
Source	Returns the rate source for the shipping line.
Title	Returns the title of the shipping line.

Expand

title	Draft orders / Order

Order that was created from this draft order.

Field	Description
ID	Globally unique identifier.
Name	Unique identifier for the order that appears on the order. For example, #1000 or _Store1001. This value is not unique across multiple stores.
Billing address matches the shipping address	Whether the billing address matches the shipping address.
Can marked as paid	Whether the order can be manually marked as paid.
Can notify customer	Whether notifications can be sent to the customer or not.
Cancel reason	Reason the order was canceled. Returns null if the order wasn't canceled.
Cancelled at	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.
Presentment cart discount	Amount of the order-level discount (does not contain any line item discounts) in presentment currency.
Shop cart discount	Amount of the order-level discount (does not contain any line item discounts) in shop currency.
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 is 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 is null.
Presentment current cart discount	The amount of the order-level discount minus the amounts for line items that have been returned in presentment currency. This doesn't include line item discounts.
Shop current cart discount	The amount of the order-level discount minus the amounts for line items that have been returned in shop currency. This doesn't include line item discounts.
Current subtotal line items quantity	The sum of the quantities for the line items that contribute to the order's subtotal.
Presentment current subtotal price	The subtotal of line items and their discounts minus the line items that have been returned in presentment currency. This includes order-level discounts, unless the argument with_cart_discount is set to false. This doesn't include shipping costs and shipping discounts. Taxes are not included unless the order is a taxes-included order.
Shop current subtotal price	The subtotal of line items and their discounts minus the line items that have been returned in shop currency. This includes order-level discounts, unless the argument with_cart_discount is set to false. This doesn't include shipping costs and shipping discounts. Taxes are not included unless the order is a taxes-included order.
Presentment current total discounts	The total amount discounted from the order (including order-level and line item discounts) minus the amounts for items that have been returned in presentment currency.
Shop current total discounts	The total amount discounted from the order (including order-level and line item discounts) minus the amounts for items that have been returned in shop currency.
Presentment current total duties	Total amount of duties for the order in presentment currency. If duties are not applicable, then this value is null.
Shop current total duties	Total amount of duties for the order in shop currency. If duties are not applicable, then this value is null.
Presentment current total price	The total amount of the order (including taxes and discounts) minus the amounts for line items that have been returned in presentment currency.
Shop current total price	The total amount of the order (including taxes and discounts) minus the amounts for line items that have been returned in shop currency.
Presentment current total tax	The total of all taxes applied to the order minus the taxes for line items that have been returned in presentment currency.
Shop current total tax	The total of all taxes applied to the order minus the taxes for line items that have been returned in shop currency.
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.
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 or not.
Email	Email address provided by the customer.
Fulfillable	Whether there are items that can be fulfilled. After an order is completely fulfilled (or completely refunded without any fulfillments) then this field returns false.
Fully paid	Whether the order has been paid in full.
Has timeline comment	Whether the merchant added timeline comments to the order.
Merchant editable	Whether the order can be edited or not.
Presentment net payment	Net payment for the order, based on the total amount received - total amount refunded in presentment currency.
Shop net payment	Net payment for the order, based on the total amount received - total amount refunded in shop currency.
Note	Contents of the note associated with the order.
Presentment original total duties	Total amount of duties prior to any applied edits for the order in presentment currency. If duties are not applicable, then this value is null.
Shop original total duties	Total amount of duties prior to any applied edits for the order in shop currency. If duties are not applicable, then this value is null.
Presentment original total price	Total price of the order prior to any applied edits in presentment currency.
Shop original total price	Total price of the order prior to any applied edits in shop currency.
Payment gateways	List of all payment gateways used for the order. For example, authorize_net and Cash on Delivery (COD).
Phone	Phone number provided by the customer.
Presentment currency	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.
Presentment refund discrepancy	The difference between suggested and actual refund amounts in presentment currency. A positive value indicates a difference in the merchants favor and a negative value indicates a difference in the customers favor.
Shop original refund discrepancy	The difference between suggested and actual refund amounts in shop currency. A positive value indicates a difference in the merchants favor and a negative value indicates a difference in the customers favor.
Refundable	Whether the order can be refunded.
Requires shipping	Whether any line item in the order requires physical shipping.
Restockable	Whether 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.
Presentment subtotal price	Subtotal of the line items and their discounts (does not contain shipping costs and shipping discounts) in presentment currency.
Shop subtotal price	Subtotal of the line items and their discounts (does not contain shipping costs and shipping discounts) in shop currency.
Tags	A comma separated list of tags that have been added to 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.
Presentment total capturable	Amount authorized for the order, that is uncaptured or undercaptured in presentment currency.
Shop total capturable	Amount authorized for the order, that is uncaptured or undercaptured in shop currency.
Presentment total discounts	Total amount discounted from the order (includes order-level and line item discounts) in presentment currency.
Shop total discounts	Total amount discounted from the order (includes order-level and line item discounts) in shop currency.
Presentment total outstanding	Total amount of money not yet authorized for the order in presentment currency.
Shop total outstanding	Total amount of money not yet authorized for the order in shop currency.
Presentment total price	Total amount of the order (includes taxes and discounts) in presentment currency.
Shop total price	Total amount of the order (includes taxes and discounts) in shop currency.
Presentment total received	Total amount received by the customer for the order in presentment currency.
Shop total received	Total amount received by the customer for the order in shop currency.
Presentment total refunded	Total amount refunded for the order in presentment currency.
Shop total refunded	Total amount refunded for the order in shop currency.
Presentment total refunded shipping	Total amount refunded for shipping in presentment currency.
Shop total refunded shipping	Total amount refunded for shipping in shop currency.
Presentment total shipping price	Total amount charged for shipping the order in presentment currency.
Shop total shipping price	Total amount charged for shipping the order in shop currency.
Presentment total tax	Total of all taxes applied to the order in presentment currency.
Shop total tax	Total of all taxes applied to the order in shop currency.
Total tip received	Total tip amount received for the order.
Total weight	Total weight (grams) of the order.
Unpaid	Whether no payments have been made for the order. If no payments have been made for the order, then this returns true.
Updated at	Date and time when the order was last modified.

Expand

title	Draft orders / Customer

Customer who will be sent an invoice for the draft order, if there is one.

Field	Description
ID	Globally unique identifier.
Display name	The full name of the customer, based on the values for the first and last name. If the the first and last name are not available, then this falls back to the customer's email address, and if that is not available, the customer's phone number.
Accepts marketing	Whether the customer has agreed to receive marketing materials.
Accepts marketing updated at	The date and time when the customer consented or objected to receiving marketing material by email.
Average order amount	The average amount that the customer spent per order.
Can delete	Whether the merchant can delete the customer from their store.
Created at	The date and time when the customer was added to the store.
Email	The customer's email address.
First name	The customer's first name.
Has note	Whether the customer has a note associated with them.
Has timeline comment	Whether the merchant has added timeline comments about the customer on the customer's page.
Image alt text	A word or phrase to share the nature or contents of an image associated with the customer.
Original image URL	The location of the original image associated with the customer as a URL.
Transformed image URL	The location of the transformed image associated with the customer as a URL.
Last name	The customer's last name.
Lifetime duration	The amount of time since the customer was first added to the store.
Locale	The customer's locale.
Marketing opt-in level	The marketing subscription opt-in level (as described by the M3AAWG best practices guideline) that the customer gave when they consented to receive marketing material by email. If the customer does not accept email marketing, then this property will be null.
Multipass identifier	A unique identifier for the customer that's used with Multipass login.
Note	A note about the customer.
Orders count	The number of orders that the customer has made at the store in their lifetime.
Phone	The customer's phone number.
State	The state of the customer's account with the shop.
Tax exempt	Whether the customer is exempt from being charged taxes on their orders.
Total spent	The total amount that the customer has spent on orders in their lifetime.
Updated at	The date and time when the customer was last updated.
Valid email address	Whether the email address is formatted correctly. This does not guarantee that the email address actually exists.
Verified email	Whether the customer has verified their email address.

Expand

title	Draft orders / Custom attributes

Custom information added to the draft order on behalf of your customer.

Field	Description
Key	Key or name of the attribute.
Value	Value of the attribute.

Expand

title	Draft orders / Line items

List of the line items in the draft order.

Field	Description
ID	Globally unique identifier.
Name	Name of the product.
Custom	Whether this is a product variant line item, or a custom line item. If set to true indicates a custom line item. If set to false indicates a product variant line item.
Discounted total	Line item price after discounts are applied.
Discounted unit price	The discountedTotal divided by quantity, resulting in the value of the discount per unit.
Image alt text	A word or phrase to share the nature or contents of the image associated with the draft order line item.
Original image URL	The location of the original image associated with the draft order line item as a URL.
Transformed image URL	The location of the transformed image associated with the draft order line item as a URL.
Is gift card	Whether the line item represents the puchase of a gift card.
Original total	Total price (without discounts) of the line item, based on the original unit price of the variant x quantity.
Original unit price	Variant price without any discounts applied.
Quantity	Number of variant items requested in the draft order.
Requires shipping	Whether physical shipping is required for the variant.
SKU	Variant SKU number.
Taxable	Whether the variant is taxable.
Title	Title of the product or variant (this field only applies to custom line items).
Total discount	Total value of the discount applied to the line item.
Variant title	Name of the variant.
Vendor	Name of the vendor who made the variant.
Weight	Weight value for a draft order line item.
Weight unit	Weight unit for a draft order line item.

Expand

title	Draft orders / Line items / Variant

The Variant object associated with the line item.

Field	Description
ID	Globally unique identifier.
Title	The title of the product variant.
Available for sale	Whether the product variant is available for sale.
Barcode	The value of the barcode associated with the product.
Compare-at price	The compare-at price of the variant in the default shop currency.
Created at	The date and time when the variant was created.
Display name	Display name of the variant, based on product's title + variant's title.
Inventory policy	Whether customers are allowed to place an order for the product variant when it's out of stock.
Inventory quantity	The total sellable quantity of the variant.
Position	The order of the product variant in the list of product variants. The first position in the list is 1.
Price	The price of the product variant in the default shop currency.
SKU	An identifier for the product variant in the shop.
Storefront ID	The storefront ID of the product variant.
Tax code	The tax code for the product variant.
Taxable	Whether a tax is charged when the product variant is sold.
Updated at	The date and time (ISO 8601 format) when the product variant was last modified.
Weight	The weight of the product variant in the unit system specified with weight_unit.
Weight unit	The unit of measurement that applies to the product variant's weight.

Expand

title	Draft orders / Line items / Tax lines

The TaxLine object connected to the line item.

Field	Description
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.

Expand

title	Draft orders / Line items / Product

The product corresponding to the line item’s product variant.

Field	Description
ID	Globally unique identifier.
Handle	A unique human-friendly string of the product's title.
Created at	The date and time (ISO 8601 format) when the product was created.
Description	A stripped description of the product, single line with HTML tags removed.
Description HTML	The description of the product, complete with HTML formatting.
Gift card template suffix	The theme template used when viewing the gift card in a store.
Has only default variant	Whether the product has only a single variant with the default option and value.
Has out of stock variants	Whether the product has out of stock variants.
Is gift card	Whether the product is a gift card.
Media count	Total count of media belonging to a product.
Online store preview URL	The online store preview URL.
Online store URL	The online store URL for the product. A value of null indicates that the product is not published to the Online Store sales channel.
Options	A list of custom product options (maximum of 3 per product).
Product type	The product type specified by the merchant.
Published at	The date and time (ISO 8601 format) when the product was published to the Online Store.
Status	The product status.
Storefront ID	The storefront ID of the product.
Tags	A comma separated list of tags associated with the product.
Theme template	The theme template used when viewing the product in a store.
Title	The title of the product.
Total inventory	The quantity of inventory in stock.
Total variants	The number of variants that are associated with the product.
Tracks inventory	Whether inventory tracking has been enabled for the product.
Updated at	The date and time (ISO 8601 format) when the product was last modified.
Vendor	The name of the product's vendor.

Expand

title	Draft orders / Line items / Applied discount

Discount which will be applied to the line item or the overall order.

Field	Description
Amount	Amount of money discounted.
Description	Description of the order-level discount.
Title	Name of the order-level discount.
Value	Amount of the order level discount (when Value type is percentage, the value in this field is the percentage discount).
Value type	Type of the order-level discount.

Expand

title	Draft orders / Line items / Fulfillment service

Name of the service provider who fulfilled the order.

Field	Description
ID	Globally unique identifier.
Handle	Human-readable unique identifier for this fulfillment service.
Callback URL	The callback URL the fulfillment service has registered for requests.
Fulfillment orders opt-in	Whether the fulfillment service has opted into fulfillment order based requests.
Inventory management	Whether the fulfillment service tracks product inventory and provides updates to Shopify.
Product based	Whether the fulfillment service supports local deliveries.
Service name	The name of the fulfillment service as seen by merchants.
Type	Type associated with the fulfillment service.

Expand

title	Draft orders / Line items / Custom attributes

List of additional information (metafields) about the line item.

Field	Description
Key	Key or name of the attribute.
Value	Value of the attribute.

Expand

title	Tender transactions

List of tender transactions associated with the Shop. A tender transaction represents a transaction which modifies the shop's balance.

Field	Description
ID	Globally unique identifier.
Amount	The amount and currency of the tender transaction.
Payment method	Information about the payment method used for this transaction.
Processed at	Date and time when the transaction was processed.
Remote reference	The remote gateway reference associated with the tender transaction.
Test	Whether the transaction is a test transaction.

Expand

title	Tender transactions / Transaction details

Information about the payment instrument used for transaction.

Field	Description
Credit card company	The name of the company that issued the customer's credit card.
Credit card number	The customer's credit card number, with most of the leading digits redacted.

Expand

title	Bank Accounts

All bank accounts configured for the Shopify Payments account.

Field	Description
ID	Globally unique identifier.
Account number last digits	The last digits of the account number (the rest is redacted).
Bank name	The name of the bank.
Country	The country of the bank.
Created at	The date that the bank account was created.
Currency	The currency of the bank account.
Status	The status of the bank account.

Expand

title	Bank accounts / Payouts

All current and previous payouts made between the account and the bank account.

Field	Description
ID	Globally unique identifier.
Issued at	The exact time when the payout was issued. The payout only contains balance transactions that were available at this time.
Net	The total amount and currency of the payout.
Status	The transfer status of the payout.
Transaction type	The direction of the payout.

Expand

title	Disputes

All disputes related to the Shopify Payments account.

Field	Description
ID	Globally unique identifier.
Amount	The total amount disputed by the cardholder.
Evidence due by	The deadline for evidence submission.
Evidence sent on	The date when evidence was sent. Returns null if evidence has not yet been sent.
Finalized on	The date when this dispute was resolved. Returns null if the dispute is not yet resolved.
Initiated at	The date when this dispute was initiated.
Status	The current state of the dispute.
Type	Indicates if this dispute is still in the inquiry phase or has turned into a chargeback.

Expand

title	Disputes / Reason details

The reason of the dispute.

Field	Description
Network reason code	The raw code provided by the payment network.
Reason	The reason for the dispute provided by the cardholder's banks.

Expand

title	Disputes / Order

The order that contains the charge that is under dispute.

Field	Description
ID	Globally unique identifier.
Name	Unique identifier for the order that appears on the order. For example, #1000 or _Store1001. This value is not unique across multiple stores.
Billing address matches the shipping address	Whether the billing address matches the shipping address.
Can marked as paid	Whether the order can be manually marked as paid.
Can notify customer	Whether notifications can be sent to the customer or not.
Cancel reason	Reason the order was canceled. Returns null if the order wasn't canceled.
Cancelled at	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.
Presentment cart discount	Amount of the order-level discount (does not contain any line item discounts) in presentment currency.
Shop cart discount	Amount of the order-level discount (does not contain any line item discounts) in shop currency.
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 is 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 is null.
Presentment current cart discount	The amount of the order-level discount minus the amounts for line items that have been returned in presentment currency. This doesn't include line item discounts.
Shop current cart discount	The amount of the order-level discount minus the amounts for line items that have been returned in shop currency. This doesn't include line item discounts.
Current subtotal line items quantity	The sum of the quantities for the line items that contribute to the order's subtotal.
Presentment current subtotal price	The subtotal of line items and their discounts minus the line items that have been returned in presentment currency. This includes order-level discounts, unless the argument with_cart_discount is set to false. This doesn't include shipping costs and shipping discounts. Taxes are not included unless the order is a taxes-included order.
Shop current subtotal price	The subtotal of line items and their discounts minus the line items that have been returned in shop currency. This includes order-level discounts, unless the argument with_cart_discount is set to false. This doesn't include shipping costs and shipping discounts. Taxes are not included unless the order is a taxes-included order.
Presentment current total discounts	The total amount discounted from the order (including order-level and line item discounts) minus the amounts for items that have been returned in presentment currency.
Shop current total discounts	The total amount discounted from the order (including order-level and line item discounts) minus the amounts for items that have been returned in shop currency.
Presentment current total duties	Total amount of duties for the order in presentment currency. If duties are not applicable, then this value is null.
Shop current total duties	Total amount of duties for the order in shop currency. If duties are not applicable, then this value is null.
Presentment current total price	The total amount of the order (including taxes and discounts) minus the amounts for line items that have been returned in presentment currency.
Shop current total price	The total amount of the order (including taxes and discounts) minus the amounts for line items that have been returned in shop currency.
Presentment current total tax	The total of all taxes applied to the order minus the taxes for line items that have been returned in presentment currency.
Shop current total tax	The total of all taxes applied to the order minus the taxes for line items that have been returned in shop currency.
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.
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 or not.
Email	Email address provided by the customer.
Fulfillable	Whether there are items that can be fulfilled. After an order is completely fulfilled (or completely refunded without any fulfillments) then this field returns false.
Fully paid	Whether the order has been paid in full.
Has timeline comment	Whether the merchant added timeline comments to the order.
Merchant editable	Whether the order can be edited or not.
Presentment net payment	Net payment for the order, based on the total amount received - total amount refunded in presentment currency.
Shop net payment	Net payment for the order, based on the total amount received - total amount refunded in shop currency.
Note	Contents of the note associated with the order.
Presentment original total duties	Total amount of duties prior to any applied edits for the order in presentment currency. If duties are not applicable, then this value is null.
Shop original total duties	Total amount of duties prior to any applied edits for the order in shop currency. If duties are not applicable, then this value is null.
Presentment original total price	Total price of the order prior to any applied edits in presentment currency.
Shop original total price	Total price of the order prior to any applied edits in shop currency.
Payment gateways	List of all payment gateways used for the order. For example, authorize_net and Cash on Delivery (COD).
Phone	Phone number provided by the customer.
Presentment currency	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.
Presentment refund discrepancy	The difference between suggested and actual refund amounts in presentment currency. A positive value indicates a difference in the merchants favor and a negative value indicates a difference in the customers favor.
Shop original refund discrepancy	The difference between suggested and actual refund amounts in shop currency. A positive value indicates a difference in the merchants favor and a negative value indicates a difference in the customers favor.
Refundable	Whether the order can be refunded.
Requires shipping	Whether any line item in the order requires physical shipping.
Restockable	Whether 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.
Presentment subtotal price	Subtotal of the line items and their discounts (does not contain shipping costs and shipping discounts) in presentment currency.
Shop subtotal price	Subtotal of the line items and their discounts (does not contain shipping costs and shipping discounts) in shop currency.
Tags	A comma separated list of tags that have been added to 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.
Presentment total capturable	Amount authorized for the order, that is uncaptured or undercaptured in presentment currency.
Shop total capturable	Amount authorized for the order, that is uncaptured or undercaptured in shop currency.
Presentment total discounts	Total amount discounted from the order (includes order-level and line item discounts) in presentment currency.
Shop total discounts	Total amount discounted from the order (includes order-level and line item discounts) in shop currency.
Presentment total outstanding	Total amount of money not yet authorized for the order in presentment currency.
Shop total outstanding	Total amount of money not yet authorized for the order in shop currency.
Presentment total price	Total amount of the order (includes taxes and discounts) in presentment currency.
Shop total price	Total amount of the order (includes taxes and discounts) in shop currency.
Presentment total received	Total amount received by the customer for the order in presentment currency.
Shop total received	Total amount received by the customer for the order in shop currency.
Presentment total refunded	Total amount refunded for the order in presentment currency.
Shop total refunded	Total amount refunded for the order in shop currency.
Presentment total refunded shipping	Total amount refunded for shipping in presentment currency.
Shop total refunded shipping	Total amount refunded for shipping in shop currency.
Presentment total shipping price	Total amount charged for shipping the order in presentment currency.
Shop total shipping price	Total amount charged for shipping the order in shop currency.
Presentment total tax	Total of all taxes applied to the order in presentment currency.
Shop total tax	Total of all taxes applied to the order in shop currency.
Total tip received	Total tip amount received for the order.
Total weight	Total weight (grams) of the order.
Unpaid	Whether no payments have been made for the order. If no payments have been made for the order, then this returns true.
Updated at	Date and time when the order was last modified.

Expand

title	Payouts

All current and previous payouts made between the account and the bank account. Payouts represent the movement of money between a merchant's Shopify Payments balance and their bank account.

Field	Description
ID	Globally unique identifier.
Issued at	The exact time when the payout was issued. The payout only contains balance transactions that were available at this time.
Net	The total amount and currency of the payout.
Status	The transfer status of the payout.
Transaction type	The direction of the payout.

Expand

title	Payouts / Bank account

The bank account for the payout.

Field	Description
ID	Globally unique identifier.
Account number last digits	The last digits of the account number (the rest is redacted).
Bank name	The name of the bank.
Country	The country of the bank.
Created at	The date that the bank account was created.
Currency	The currency of the bank account.
Status	The status of the bank account.

Expand

title	Collections

List of product collections.

Field	Description
ID	Globally unique identifier.
Title	The title of the collection.
Description	The stripped description of the collection, in a single line with HTML tags removed.
Description HTML	The description of the collection, complete with HTML formatting.
Feedback summary	Information about the collection that's provided through resource feedback.
Handle	A unique human-friendly string for the collection. Automatically generated from the collection's title.
Image ID	A unique identifier for the image associated with the collection.
Image alt text	A word or phrase to share the nature or contents of an image associated with the collection.
Original image URL	The location of the original image associated with the collection as a URL.
Transformed image URL	The location of the transformed image associated with the collection as a URL.
Products count	The number of products included in the collection.
SEO description	SEO description for the collection.
SEO title	SEO title for the collection.
Sort order	The order in which the collection's products are sorted.
Storefront ID	The storefront ID of the collection.
Template suffix	The theme template used when viewing this collection in a store.
Updated at	The date and time when the collection was last modified.

Expand

title	Collections / Rule set

The set of rules that are used to determine which products are included in the collection. This applies only to smart collections.

Field	Description
Applied disjunctively	Whether products must match any or all of the rules to be included in the collection. If true, then products must match one or more of the rules to be included in the collection. If false, then products must match all of the rules to be included in the collection.

Expand

title	Collections / Products

A list of metafields that belong to the resource.

Field	Description
ID	Globally unique identifier.
Handle	A unique human-friendly string of the product's title.
Created at	The date and time (ISO 8601 format) when the product was created.
Description	A stripped description of the product, single line with HTML tags removed.
Description HTML	The description of the product, complete with HTML formatting.
Gift card template suffix	The theme template used when viewing the gift card in a store.
Has only default variant	Whether the product has only a single variant with the default option and value.
Has out of stock variants	Whether the product has out of stock variants.
Is gift card	Whether the product is a gift card.
Media count	Total count of media belonging to a product.
Online store preview URL	The online store preview URL.
Online store URL	The online store URL for the product. A value of null indicates that the product is not published to the Online Store sales channel.
Options	A list of custom product options (maximum of 3 per product).
Highest variant's price	The highest variant's price of the product formatted as decimals.
Lowest variant's price	The lowest variant's price of the product formatted as decimals.
Product type	The product type specified by the merchant.
Published at	The date and time (ISO 8601 format) when the product was published to the Online Store.
SEO title	SEO information title of the product.
SEO description	SEO information description of the product.
Status	The product status.
Storefront ID	The storefront ID of the product.
Tags	A comma separated list of tags associated with the product.
Theme template	The theme template used when viewing the product in a store.
Title	The title of the product.
Total inventory	The quantity of inventory in stock.
Total variants	The number of variants that are associated with the product.
Tracks inventory	Whether inventory tracking has been enabled for the product.
Updated at	The date and time (ISO 8601 format) when the product was last modified.
Vendor	The name of the product's vendor.

Expand

title	Collections / Products / Variants

A list of variants associated with the product.

Field	Description
ID	Globally unique identifier.
Title	The title of the product variant.
Available for sale	Whether the product variant is available for sale.
Barcode	The value of the barcode associated with the product.
Compare-at price	The compare-at price of the variant in the default shop currency.
Created at	The date and time when the variant was created.
Display name	Display name of the variant, based on product's title + variant's title.
Image alt text	A word or phrase to share the nature or contents of the featured image for the variant.
Original image URL	The location of the original featured image for the variant as a URL.
Transformed image URL	The location of the transformed featured image for the variant as a URL.
Inventory policy	Whether customers are allowed to place an order for the product variant when it's out of stock.
Inventory quantity	The total sellable quantity of the variant.
Position	The order of the product variant in the list of product variants. The first position in the list is 1.
Price	The price of the product variant in the default shop currency.
SKU	An identifier for the product variant in the shop.
Storefront ID	The storefront ID of the product variant.
Tax code	The tax code for the product variant.
Taxable	Whether a tax is charged when the product variant is sold.
Updated at	The date and time (ISO 8601 format) when the product variant was last modified.
Weight	The weight of the product variant in the unit system specified with weight_unit.
Weight unit	The unit of measurement that applies to the product variant's weight.

Expand

title	Collections / Metafields

A list of metafields that belong to the resource.

Field	Description
ID	Globally unique identifier.
Created at	The date and time when the metafield was created.
Description	The description of a metafield.
Key	The key name for a metafield.
Namespace	The namespace for a metafield.
Owner type	Owner type of a metafield visible to the Storefront API.
Updated at	The date and time when the metafield was updated.
Value	The value of a metafield.
Value type	Represents the metafield value type.

Expand

title	Gift Cards

Returns a list of gift cards.

Field	Description
ID	Globally unique identifier.
Created at	The date and time at which the gift card was created.
Balance	The gift card's remaining balance.
Disabled at	The date and time at which the gift card was disabled.
Enabled	Whether the gift card is enabled.
Expires on	The date at which the gift card will expire.
Initial value	The initial value of the gift card.
Last characters	The final four characters of the gift card code.
Masked code	The gift card code. Everything but the final four characters is masked.
Note	The note associated with the gift card, which is not visible to the customer.

Expand

title	Gift Cards / Order

The order associated with the gift card. This value is null if the gift card was issued manually.

Field	Description
ID	Globally unique identifier.
Name	Unique identifier for the order that appears on the order. For example, #1000 or _Store1001. This value is not unique across multiple stores.
Billing address matches the shipping address	Whether the billing address matches the shipping address.
Can marked as paid	Whether the order can be manually marked as paid.
Can notify customer	Whether notifications can be sent to the customer or not.
Cancel reason	Reason the order was canceled. Returns null if the order wasn't canceled.
Cancelled at	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.
Presentment cart discount	Amount of the order-level discount (does not contain any line item discounts) in presentment currency.
Shop cart discount	Amount of the order-level discount (does not contain any line item discounts) in shop currency.
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 is 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 is null.
Presentment current cart discount	The amount of the order-level discount minus the amounts for line items that have been returned in presentment currency. This doesn't include line item discounts.
Shop current cart discount	The amount of the order-level discount minus the amounts for line items that have been returned in shop currency. This doesn't include line item discounts.
Current subtotal line items quantity	The sum of the quantities for the line items that contribute to the order's subtotal.
Presentment current subtotal price	The subtotal of line items and their discounts minus the line items that have been returned in presentment currency. This includes order-level discounts, unless the argument with_cart_discount is set to false. This doesn't include shipping costs and shipping discounts. Taxes are not included unless the order is a taxes-included order.
Shop current subtotal price	The subtotal of line items and their discounts minus the line items that have been returned in shop currency. This includes order-level discounts, unless the argument with_cart_discount is set to false. This doesn't include shipping costs and shipping discounts. Taxes are not included unless the order is a taxes-included order.
Presentment current total discounts	The total amount discounted from the order (including order-level and line item discounts) minus the amounts for items that have been returned in presentment currency.
Shop current total discounts	The total amount discounted from the order (including order-level and line item discounts) minus the amounts for items that have been returned in shop currency.
Presentment current total duties	Total amount of duties for the order in presentment currency. If duties are not applicable, then this value is null.
Shop current total duties	Total amount of duties for the order in shop currency. If duties are not applicable, then this value is null.
Presentment current total price	The total amount of the order (including taxes and discounts) minus the amounts for line items that have been returned in presentment currency.
Shop current total price	The total amount of the order (including taxes and discounts) minus the amounts for line items that have been returned in shop currency.
Presentment current total tax	The total of all taxes applied to the order minus the taxes for line items that have been returned in presentment currency.
Shop current total tax	The total of all taxes applied to the order minus the taxes for line items that have been returned in shop currency.
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.
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 or not.
Email	Email address provided by the customer.
Fulfillable	Whether there are items that can be fulfilled. After an order is completely fulfilled (or completely refunded without any fulfillments) then this field returns false.
Fully paid	Whether the order has been paid in full.
Has timeline comment	Whether the merchant added timeline comments to the order.
Merchant editable	Whether the order can be edited or not.
Presentment net payment	Net payment for the order, based on the total amount received - total amount refunded in presentment currency.
Shop net payment	Net payment for the order, based on the total amount received - total amount refunded in shop currency.
Note	Contents of the note associated with the order.
Presentment original total duties	Total amount of duties prior to any applied edits for the order in presentment currency. If duties are not applicable, then this value is null.
Shop original total duties	Total amount of duties prior to any applied edits for the order in shop currency. If duties are not applicable, then this value is null.
Presentment original total price	Total price of the order prior to any applied edits in presentment currency.
Shop original total price	Total price of the order prior to any applied edits in shop currency.
Payment gateways	List of all payment gateways used for the order. For example, authorize_net and Cash on Delivery (COD).
Phone	Phone number provided by the customer.
Presentment currency	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.
Presentment refund discrepancy	The difference between suggested and actual refund amounts in presentment currency. A positive value indicates a difference in the merchants favor and a negative value indicates a difference in the customers favor.
Shop original refund discrepancy	The difference between suggested and actual refund amounts in shop currency. A positive value indicates a difference in the merchants favor and a negative value indicates a difference in the customers favor.
Refundable	Whether the order can be refunded.
Requires shipping	Whether any line item in the order requires physical shipping.
Restockable	Whether 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.
Presentment subtotal price	Subtotal of the line items and their discounts (does not contain shipping costs and shipping discounts) in presentment currency.
Shop subtotal price	Subtotal of the line items and their discounts (does not contain shipping costs and shipping discounts) in shop currency.
Tags	A comma separated list of tags that have been added to 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.
Presentment total capturable	Amount authorized for the order, that is uncaptured or undercaptured in presentment currency.
Shop total capturable	Amount authorized for the order, that is uncaptured or undercaptured in shop currency.
Presentment total discounts	Total amount discounted from the order (includes order-level and line item discounts) in presentment currency.
Shop total discounts	Total amount discounted from the order (includes order-level and line item discounts) in shop currency.
Presentment total outstanding	Total amount of money not yet authorized for the order in presentment currency.
Shop total outstanding	Total amount of money not yet authorized for the order in shop currency.
Presentment total price	Total amount of the order (includes taxes and discounts) in presentment currency.
Shop total price	Total amount of the order (includes taxes and discounts) in shop currency.
Presentment total received	Total amount received by the customer for the order in presentment currency.
Shop total received	Total amount received by the customer for the order in shop currency.
Presentment total refunded	Total amount refunded for the order in presentment currency.
Shop total refunded	Total amount refunded for the order in shop currency.
Presentment total refunded shipping	Total amount refunded for shipping in presentment currency.
Shop total refunded shipping	Total amount refunded for shipping in shop currency.
Presentment total shipping price	Total amount charged for shipping the order in presentment currency.
Shop total shipping price	Total amount charged for shipping the order in shop currency.
Presentment total tax	Total of all taxes applied to the order in presentment currency.
Shop total tax	Total of all taxes applied to the order in shop currency.
Total tip received	Total tip amount received for the order.
Total weight	Total weight (grams) of the order.
Unpaid	Whether no payments have been made for the order. If no payments have been made for the order, then this returns true.
Updated at	Date and time when the order was last modified.

Expand

title	Gift Cards / Customer

The customer who will receive the gift card.

Field	Description
ID	Globally unique identifier.
Display name	The full name of the customer, based on the first and last name values. If the first and last name are not available, then this falls back to the customer's email address, and if that is not available, the customer's phone number.
Accepts marketing	Whether the customer has agreed to receive marketing materials.
Accepts marketing updated at	The date and time when the customer consented or objected to receiving marketing material by email.
Average order amount	The average amount that the customer spent per order.
Can delete	Whether the merchant can delete the customer from their store.
Created at	The date and time when the customer was added to the store.
Email	The customer's email address.
First name	The customer's first name.
Has note	Whether the customer has a note associated with them.
Has timeline comment	Whether the merchant has added timeline comments about the customer on the customer's page.
Image alt text	A word or phrase to share the nature or contents of an image associated with the customer.
Original image URL	The location of the original image associated with the customer as a URL.
Transformed image URL	The location of the transformed image associated with the customer as a URL.
Last name	The customer's last name.
Lifetime duration	The amount of time since the customer was first added to the store.
Locale	The customer's locale.
Marketing opt-in level	The marketing subscription opt-in level (as described by the M3AAWG best practices guideline) that the customer gave when they consented to receive marketing material by email. If the customer does not accept email marketing, then this property will be null.
Multipass identifier	A unique identifier for the customer that's used with Multipass login.
Note	A note about the customer.
Orders count	The number of orders that the customer has made at the store in their lifetime.
Phone	The customer's phone number.
State	The state of the customer's account with the shop.
Tax exempt	Whether the customer is exempt from being charged taxes on their orders.
Total spent	The total amount that the customer has spent on orders in their lifetime.
Updated at	The date and time when the customer was last updated.
Valid email address	Whether the email address is formatted correctly. This does not guarantee that the email address actually exists.
Verified email	Whether the customer has verified their email address.

Visit the https://aserve.atlassian.net/l/c/GS5hAcYQ page, if you have a question or need any kind of assistance.

Versions Compared

Old Version 49

New Version 50

Key

Table of contents

Fields, sorted by the data types

Products

Customers

Orders

Inventory Items

Product variants

Draft Orders

Tender transactions

Bank accounts

Disputes

Payouts

Collections

Gift Cards (Shopify plus plan only)