List all order variables

This tutorial requires the technical skills, including Liquid. If you have difficulty doing this, please contact us.

Shop

Name	Type	Description
name	String	Name of the shop
address1	String	First address where the shop is located
address2	String	Second address where the shop is located
city	String	City where the shop is located
contact_email	String!	Primary contact email for the shop
sale_email	String	Sales contact email for the shop
country	String	Country code where the shop is located
currency	String	Default currency of the shop
website	String	Website URL of the shop
phone	String	Contact phone number of the shop
register_number	String	Registration number of the shop
vat	String	VAT identification number of the shop
zip	String	Postal code of the shop location
facebook_url	String	Facebook page URL of the shop
instagram_url	String	Instagram profile URL of the shop
pinterest_url	String	Pinterest page URL of the shop
twitter_url	String	Twitter handle URL of the shop
youtube_url	String	YouTube channel URL of the shop
logo	String	URL to the shop's logo image

Settings

Name	Type	Description
logo_size	UnsignedInt64!	The size logo using in the template.
primary_color	String!	The primary color of the template.
accent_color	String!	The accent color of the template.
is_logo	Boolean!	Display/hidden shop's logo
font_size	UnsignedInt64!	Font size in percentage
font_family	String!	Font family of the template's text

DiscountCode

Name	Type	Description
title	String!	The code of the discount.

ShippingMethod

Name	Type	Description
title	String!	The title of shipping method of the order.

Order

Name	Type	Description
order_name	String!	The unique identifier for the order that appears on the order page in the Shopify admin and the Order status page. For example, "#1001", "EN1001", or "1001-A". This value isn't unique across multiple stores. Use this field to identify orders in the Shopify admin and for order tracking.
name	String!	The unique identifier for the order that appears on the order page in the Shopify admin and the Order status page. For example, "#1001", "EN1001", or "1001-A". This value isn't unique across multiple stores. Use this field to identify orders in the Shopify admin and for order tracking.
id	UnsignedInt64!	The ID of the corresponding resource in the REST Admin API.
po_number	String	The purchase order (PO) number that's associated with an order. This is typically provided by business customers who require a PO number for their procurement.
created_at	DateTime!	The date and time in ISO 8601 format when an order was created. This timestamp is set when the customer completes checkout and remains unchanged throughout an order's lifecycle.
date	DateTime!	The date and time in ISO 8601 format when an order was created. This timestamp is set when the customer completes checkout and remains unchanged throughout an order's lifecycle.
updated_at	DateTime!	The date and time in ISO 8601 format when the order was last modified.
processed_at	DateTime!	The date and time in ISO 8601 format when the order was processed. This date and time might not match the date and time when the order was created.
cancelled_at	DateTime	The date and time in ISO 8601 format when an order was canceled. Returns `null` if the order hasn't been canceled.
closed_at	DateTime	The date and time ISO 8601 format when an order was closed. Shopify automatically records this timestamp when all items have been fulfilled or canceled, and all financial transactions are complete. Returns `null` if the order isn't closed.
billing_address	MailingAddress	The billing address associated with the payment method selected by the customer for an order. Returns `null` if no billing address was provided during checkout.
shipping_address	MailingAddress	The shipping address where the order will be delivered. Contains the customer's delivery location for fulfillment and shipping label generation. Returns `null` for digital orders or orders that don't require shipping.
shipping_line	ShippingLine	The latest shipping line of the order.
shipping_lines	ShippingLine	The shipping methods applied to the order. Each shipping line represents a shipping option chosen during checkout, including the carrier, service level, and cost. Use this to understand shipping charges and delivery options for the order.
customer	Customer	The customer who placed an order. Returns `null` if an order was created through a checkout without customer authentication, such as a guest checkout. Learn more about customer accounts.
customer_locale	String	The customer's language and region preference at the time of purchase. For example, "en" for English, "fr-CA" for French (Canada), or "es-MX" for Spanish (Mexico). Use this to provide localized customer service and targeted marketing in the customer's preferred language.
email	String	The email address associated with the customer for this order. Used for sending order confirmations, shipping notifications, and other order-related communications. Returns `null` if no email address was provided during checkout.
financial_status	OrderDisplayFinancialStatus	An order's financial status for display in the Shopify admin.
fulfillment_status	OrderDisplayFulfillmentStatus!	The order's fulfillment status that displays in the Shopify admin to merchants. For example, an order might be unfulfilled or scheduled. For detailed processing, use the `FulfillmentOrder` object.
discounts_amount	MoneyBag!	The total price of the order, after returns, in shop and presentment currencies. This includes taxes and discounts.
payment_methods	[String!]!	A list of the names of all payment gateways used for the order. For example, "Shopify Payments" and "Cash on Delivery (COD)".
payment_method	String	The list of payment methods, separating by a comma.
gateways	[String!]!	A list of the names of all payment gateways used for the order. For example, "Shopify Payments" and "Cash on Delivery (COD)".
gateway	String	The list of all gateways, separating by a comma.
total_items	Int!	The current sum of the quantities for all line items that contribute to the order's subtotal price, after returns, refunds, order edits, and cancellations.
item_count	Int!	The current sum of the quantities for all line items that contribute to the order's subtotal price, after returns, refunds, order edits, and cancellations.
total_weight	UnsignedInt64	The total weight of the order before returns, in grams.
shipping_method	ShippingMethod	The shipping method including title of the order.
order_currency	CurrencyCode!	The shop currency when the order was placed. For example, "USD" or "CAD".
currency	CurrencyCode!	The shop currency when the order was placed. For example, "USD" or "CAD".
subtotal_price	MoneyBag!	The total price of the order, after returns and refunds, in shop and presentment currencies. This includes taxes and discounts.
total_price	MoneyBag!	The total price of the order, after returns, in shop and presentment currencies. This includes taxes and discounts.
total_refunds	MoneyBag!	The total amount that was refunded, in shop and presentment currencies.
total_refunds_amount	Decimal!	The total amount that was refunded, in shop and presentment currencies.
total_paid_amount	Decimal!	The total amount received from the customer before returns, in shop and presentment currencies.
total_paid	MoneyBag!	The total amount received from the customer before returns, in shop and presentment currencies.
shipping_price	MoneyBag!	The total shipping costs returned to the customer, in shop and presentment currencies. This includes fees and any related discounts that were refunded.
total_discounts	MoneyBag!	The total amount discounted on the order after returns and refunds, in shop and presentment currencies. This includes both order and line level discounts.
current_total_discounts	MoneyBag!	The total amount discounted on the order after returns and refunds, in shop and presentment currencies. This includes both order and line level discounts.
total_due	MoneyBag	The current total duties amount for an order, after any returns or modifications. Modifications include returns, refunds, order edits, and cancellations.
total_due_amount	MoneyBag!	The total amount received from the customer before returns, in shop and presentment currencies.
duties_price	MoneyBag	The current total duties amount for an order, after any returns or modifications. Modifications include returns, refunds, order edits, and cancellations.
total_tax	MoneyBag	The total tax amount before returns, in shop and presentment currencies.
tax_price	MoneyBag!	The sum of the prices of all tax lines applied to line items on the order, after returns and refunds, in shop and presentment currencies.
current_total_tax	MoneyBag!	The sum of the prices of all tax lines applied to line items on the order, after returns and refunds, in shop and presentment currencies.
note	String	The note associated with the order. Contains additional information or instructions added by merchants or customers during the order process. Commonly used for special delivery instructions, gift messages, or internal processing notes.
tags	[String!]!	A comma separated list of tags associated with the order. Updating `tags` overwrites any existing tags that were previously added to the order. To add new tags without overwriting existing tags, use the tagsAdd mutation.
products	[Product!]!	List of products of the order.
variants	[Product!]!	List of variants of the order.
line_items	[LineItem]!	A list of the order's line items. Line items represent the individual products and quantities that make up the order.
payment_terms	PaymentTerms	The payment terms associated with the order, such as net payment due dates or early payment discounts. Payment terms define when and how an order should be paid. Returns `null` if no specific payment terms were set for the order.
fulfillments	[Fulfillment!]!	A list of shipments for the order. Fulfillments represent the physical shipment of products to customers.
fulfillment	Fulfillment	The latest fulfillment of the order.
transactions	[OrderTransaction]	A list of transactions associated with the order.
refunds	[Refund]	A list of refunds that have been applied to the order. Refunds represent money returned to customers for returned items, cancellations, or adjustments.
latest_refund	Refund	The latest refund of the order.
payment_transactions	[OrderTransaction]!	The list of payment transactions of the order.
refund_transactions	[OrderTransaction]!	The list of refunds transactions of the order.
tax_lines	[TaxLine!]!	A list of all tax lines applied to line items on the order, before returns. Tax line prices represent the total price for all tax lines with the same `rate` and `title`.
latest_fulfillment	Fulfillment	The latest fulfillment of the order.
discounts	DiscountCode	The list of discount codes of the order.
metafields	[Metafield]!	A list of custom fields that a merchant associates with a Shopify resource.

MailingAddress

Name	Type	Description
address1	String	The first line of the address. Typically the street address or PO Box number.
address2	String	The second line of the address. Typically the number of the apartment, suite, or unit.
city	String	The name of the city, district, village, or town.
company	String	The name of the customer's company or organization.
country	String	The name of the country.
first_name	String	The first name of the customer.
last_name	String	The last name of the customer.
phone	String	A unique phone number for the customer.
province	String	The region of the address, such as the province, state, or district.
zip	String	The zip or postal code of the address.
name	String	The full name of the customer, based on firstName and lastName.
province_code	String	The alphanumeric code for the region. For example, ON.
country_code	CountryCode	The two-letter code for the country of the address. For example, US.
latitude	Float	The latitude coordinate of the customer address.
longitude	Float	The longitude coordinate of the customer address.
name_unformatted	String	The full name of the customer, based on firstName and lastName.
first_name_unformatted	String	The first name of the customer.
last_name_unformatted	String	The last name of the customer.

Customer

Name	Type	Description
id	ID!	A globally-unique ID.
total_spent	MoneyV2	The total amount that the customer has spent on orders in their lifetime.
customer_metafields	[Metafield]!	A list of custom fields that a merchant associates with a Shopify resource.
email	String	The customer's email address.
email_marketing_consent	CustomerEmailMarketingConsentState	The current email marketing state for the customer. If the customer doesn't have an email address, then this property is `null`.
created_at	DateTime!	The date and time when the customer was added to the store.
updated_at	DateTime!	The date and time when the customer was last updated.
first_name	String	The customer's first name.
last_name	String	The customer's last name.
number_of_orders	UnsignedInt64!	The number of orders that the customer has made at the store in their lifetime.
state	CustomerState!	The state of the customer's account with the shop. Please note that this only meaningful when Classic Customer Accounts is active.
amount_spent	MoneyV2!	The total amount that the customer has spent on orders in their lifetime.
note	String	A note about the customer.
verified_email	Boolean!	Whether the customer has verified their email address. Defaults to `true` if the customer is created through the Shopify admin or API.
multipass_identifier	String	A unique identifier for the customer that's used with Multipass login.
tax_exempt	Boolean!	Whether the customer is exempt from being charged taxes on their orders.
tax_exemptions	[TaxExemption!]!	The list of tax exemptions applied to the customer.
phone	String	The customer's phone number.
tags	[String!]!	A comma separated list of tags that have been added to the customer.
default_address	MailingAddress	The default address associated with the customer.

Attribute

Name	Type	Description
key	String!	The key or name of the attribute. For example, `"customer_first_order"`.
value	String	The value of the attribute. For example, `"true"`.

TaxLine

Name	Type	Description
title	String!	The name of the tax.
price_set	MoneyBag!	The amount of tax, in shop and presentment currencies, after discounts and before returns.
price_amount	Decimal!	The amount of tax, in shop and presentment currencies, after discounts and before returns.
price	MoneyBag!	The amount of tax, in shop and presentment currencies, after discounts and before returns.
rate	Float	The proportion of the line item price that the tax represents as a decimal.

ShippingLine

Name	Type	Description
title	String!	Returns the title of the shipping line.
price	MoneyBag!	The pre-tax shipping price without any discounts applied.
code	String	A reference to the shipping method.

DiscountAllocation

Name	Type	Description
amount	MoneyBag!	The money amount that's allocated to a line based on the associated discount application in shop and presentment currencies.

Image

Name	Type	Description
alt_text	String	A word or phrase to share the nature or contents of an image.
height	Int	The original height of the image in pixels. Returns `null` if the image isn't hosted by Shopify.
id	ID	A unique ID for the image.
url	URL!	The location of the image as a URL. If no transform options are specified, then the original image will be preserved including any pre-applied transforms. All transformation options are considered "best-effort". Any transformation that the original image type doesn't support will be ignored. If you need multiple variations of the same image, then you can use GraphQL aliases.
width	Int	The original width of the image in pixels. Returns `null` if the image isn't hosted by Shopify.

ProductVariant

Name	Type	Description
title	String!	The title of the product variant.
price	Money!	The price of the product variant in the default shop currency.
compare_at_price	Money	The compare-at price of the variant in the default shop currency.
inventory_quantity	Int	The total sellable quantity of the variant.
sku	String	A case-sensitive identifier for the product variant in the shop. Required in order to connect to a fulfillment service.
barcode	String	The value of the barcode associated with the product.
image	Image	The featured image for the variant.
option1	String	The first option of the variant.
option2	String	The second option of the variant.
option3	String	The third option of the variant.

Product

Name	Type	Description
id	ID!	A globally-unique ID.
title	String!	The name for the product that displays to customers. The title is used to construct the product's handle. For example, if a product is titled "Black Sunglasses", then the handle is `black-sunglasses`.
product_type	String!	The product type that merchants define.
vendor	String!	The name of the product's vendor.
handle	String!	A unique, human-readable string of the product's title. A handle can contain letters, hyphens (`-`), and numbers, but no spaces. The handle is used in the online store URL for the product.
tags	[String!]!	A comma-separated list of searchable keywords that are associated with the product. For example, a merchant might apply the `sports` and `summer` tags to products that are associated with sportwear for summer. Updating `tags` overwrites any existing tags that were previously added to the product. To add new tags without overwriting existing tags, use the `tagsAdd` mutation.
options	[ProductOption!]!	A list of product options. The limit is defined by the shop's resource limits for product options (`Shop.resourceLimits.maxProductOptions`).
featured_image	Image	The featured image for the product.
variants	[ProductVariant]!	A list of variants associated with the product. If querying a single product at the root, you can fetch up to 2048 variants.
url	URL	The product's URL on the online store. If `null`, then the product isn't published to the online store sales channel.
metafields	[Metafield!]!	A list of custom fields that a merchant associates with a Shopify resource.

PaymentSchedule

Name	Type	Description
amount	Decimal!	Amount owed for this payment schedule.
currency	CurrencyCode!	The currency of payment schedule.
issued_at	DateTime	Date and time when the invoice is sent.
due_at	DateTime	Date and time when the payment schedule is due.
completed_at	DateTime	Date and time when the payment schedule is paid or fulfilled.

PaymentTerms

Name	Type	Description
overdue	Boolean!	Whether the payment terms have overdue payment schedules.
payment_terms_name	String!	The name of the payment terms template used to create the payment terms.
payment_terms_type	PaymentTermsType!	The payment terms template type used to create the payment terms.
due_in_days	Int	Duration of payment terms in days based on the payment terms template used to create the payment terms.
payment_schedules	[PaymentSchedule]!	List of schedules for the payment terms.
payment_schedule	PaymentSchedule	The latest payment schedule of the payment terms.

LineItem

Name	Type	Description
id	ID!	A globally-unique ID.
name	String!	The title of the product, optionally appended with the title of the variant (if applicable).
title	String!	The title of the product at time of order creation.
product_title	String!	The title of the product at time of order creation.
quantity	Int!	The number of units ordered, including refunded and removed units.
refunded_quantity	Int!	The number of units ordered, excluding refunded units and removed units.
fulfillable_quantity	Int!	The number of units ordered, including refunded and removed units.
price	MoneyBag!	The approximate unit price of the line item in shop and presentment currencies. This value includes line-level discounts and discounts applied to refunded and removed quantities. It doesn't include order-level or code-based discounts.
price_amount	Decimal!	The approximate unit price of the line item in shop and presentment currencies. This value includes line-level discounts and discounts applied to refunded and removed quantities. It doesn't include order-level or code-based discounts.
original_price	MoneyBag!	In shop and presentment currencies, the unit price of the line item when the order was created. This value doesn't include discounts.
original_price_amount	Decimal!	In shop and presentment currencies, the unit price of the line item when the order was created. This value doesn't include discounts.
line_price	MoneyBag!	The total discounted price of the line item in shop and presentment currencies, including refunded and removed quantities. This value doesn't include order-level discounts. Code-based discounts aren't included by default.
total_discounts	MoneyBag!	The total discount allocated to the line item in shop and presentment currencies, including the total allocated to refunded and removed quantities. This value doesn't include order-level discounts.
total_discounts_amount	Decimal!	The total discount allocated to the line item in shop and presentment currencies, including the total allocated to refunded and removed quantities. This value doesn't include order-level discounts.
discount_per_item	Decimal!	The discounted price per item.
discount_allocations	[DiscountAllocation!]!	The discounts that have been allocated to the line item by discount applications, including discounts allocated to refunded and removed quantities.
sku	String	The variant SKU number.
vendor	String	The name of the vendor who made the variant.
weight	Float	The weight of the product variant in the unit system specified with weight_unit.
grams	Float	The weight of the product variant in the unit system specified with weight_unit.
weight_unit	WeightUnit	The unit of measurement that applies to the product variant's weight. If you don't specify a value for weight_unit, then the shop's default unit of measurement is applied. Valid values: `g`, `kg`, `oz`, `lb`.
total_weight	Float	The weight of all products in the unit system specified with weight_unit.
current_quantity	Int!	The number of units ordered, excluding refunded and removed units.
variant	ProductVariant	The Variant object associated with this line item.
product	Product	The Product object associated with this line item's variant.
image	String	The product image url of the line item.

Metafield

Name	Type	Description
id	ID!	A globally-unique ID.
value	String!	The data stored in the metafield. Always stored as a string, regardless of the metafield's type.

DraftOrderLineItem

Name	Type	Description
id	ID!	A globally-unique ID.
name	String!	The name of the product.
title	String!	The name of the product.
quantity	Int!	The quantity of items. For a bundle item, this is the quantity of bundles, not the quantity of items contained in the bundles themselves.
fulfillable_quantity	Int!	The quantity of items. For a bundle item, this is the quantity of bundles, not the quantity of items contained in the bundles themselves.
price_amount	Decimal!	The price of the draft order line item.
original_price	MoneyBag!	The price without any discounts applied.
original_price_amount	Decimal!	The original price of the draft order line item.
line_price	MoneyBag!	The total price with discounts applied.
total_discounts	MoneyBag!	The total discount amount.
total_discounts_amount	Decimal!	The total discount of the draft order line item.
discount_per_item	Decimal!	The discount price per draft order line item.
properties	[Attribute!]!	A list of attributes that represent custom features or special requests.
sku	String	The SKU number of the product variant.
vendor	String	The name of the vendor who created the product variant.
weight	Weight	The weight unit and value.
grams	Weight	The weight unit and value.
total_weight	Float	The total weight of the draft order line item, calculating by weight * quantity.
variant	ProductVariant	The product variant for the line item.
product	Product	The product for the line item.
image	String	The product URL of the draft order line item.

Fulfillment

Name	Type	Description
date	DateTime!	The date and time when the fulfillment was created.
created_at	DateTime!	The date and time when the fulfillment was created.
tracking_company	String	The name of the tracking company.
tracking_number	String	The tracking number of the fulfillment.
line_items	[FulfillmentLineItem!]!	List of the fulfillment's line items.

FulfillmentLineItem

Name	Type	Description
id	ID!	A globally-unique ID.
discounted_total_set	MoneyBag!	The total price after discounts are applied in shop and presentment currencies. This value doesn't include order-level discounts.
original_total_set	MoneyBag!	The total price before discounts are applied in shop and presentment currencies.
quantity	Int	Number of line items in the fulfillment.

Refund

Name	Type	Description
created_at	DateTime	The date and time when the refund was created.
date	DateTime	The date and time when the refund was created.
note	String	The optional note associated with the refund.
restock	Boolean!	Whether any line item on the order can be restocked.
payment_method	String!	A list of the names of all payment gateways used for the order.
total	MoneyBag!	The total amount across all transactions for the refund, in shop and presentment currencies.
total_amount	Decimal!	The total amount of the refund.
subtotal	Float!	The subtotal price of the refund.
total_tax	Float!	The total tax price of the refund.
refund_line_items	[RefundLineItem!]!	The `RefundLineItem` resources attached to the refund.
transactions	[OrderTransaction!]!	The transactions associated with the refund.

RefundLineItem

Name	Type	Description
quantity	Int!	The quantity of a refunded line item.
subtotal	MoneyBag!	The subtotal price of a refunded line item in shop and presentment currencies.
total_tax	MoneyBag!	The total tax charged on a refunded line item in shop and presentment currencies.
line_item	LineItem!	The `LineItem` resource associated to the refunded line item.

DraftOrder

Name	Type	Description
id	UnsignedInt64!	The ID of the corresponding resource in the REST Admin API.
order_name	String!	The identifier for the draft order, which is unique within the store. For example, #D1223.
name	String!	The identifier for the draft order, which is unique within the store. For example, #D1223.
po_number	String	The purchase order number.
created_at	DateTime!	The date and time when the draft order was created in Shopify.
date	DateTime!	The date and time when the draft order was created in Shopify.
updated_at	DateTime!	The 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.
billing_address	MailingAddress	The billing address of the customer.
shipping_address	MailingAddress	The shipping address of the customer.
shipping_line	ShippingLine	The line item containing the shipping information and costs.
customer	Customer	The customer who will be sent an invoice.
line_items	[DraftOrderLineItem!]!	The list of the line items in the draft order.
email	String	The email address of the customer, which is used to send notifications.
total_weight	UnsignedInt64!	The total weight in grams of the draft order.
shipping_method	ShippingMethod	The shipping method including title of the draft order.
subtotal_price	Money!	The subtotal, in shop currency, of the line items and their discounts, excluding shipping charges, shipping discounts, and taxes.
total_price	MoneyBag!	The total price, includes taxes, shipping charges, and discounts.
order_currency	CurrencyCode!	The shop currency used for calculation.
currency	CurrencyCode!	The shop currency used for calculation.
tags	[String!]!	The comma separated list of tags associated with the draft order. Updating `tags` overwrites any existing tags that were previously added to the draft order. To add new tags without overwriting existing tags, use the tagsAdd mutation.
attributes	[Attribute!]!	The custom information added to the draft order on behalf of the customer.
payment_terms	PaymentTerms	The associated payment terms for this draft order.
payment_transactions	[OrderTransaction!]!	The list of transactions of order relating to the draft order.
products	[Product!]!	The list of products of draft order.
variants	[ProductVariant!]!	The list of product variants of draft order.
metafields	[Metafield!]!	A list of custom fields that a merchant associates with a Shopify resource.

OrderTransaction

Name	Type	Description
amount	MoneyBag!	The amount and currency of the transaction in shop and presentment currencies.
authorization	String	Authorization code associated with the transaction.
date	DateTime!	Date and time when the transaction was created.
created_at	DateTime!	Date and time when the transaction was created.
gateway	String	The payment gateway used to process the transaction.
payment_method_gateway	String	The human-readable payment gateway name used to process the transaction.
kind	OrderTransactionKind!	The kind of transaction.
status	OrderTransactionStatus!	The status of this transaction.
payment_transactions	PaymentDetails	The payment details for the transaction.

MoneyV2

Name	Type	Description
amount	Decimal!	A monetary value in decimal format, allowing for precise representation of cents or fractional currency. For example, 12.99.
currency_code	CurrencyCode!	The three-letter currency code that represents a world currency used in a store. Currency codes include standard standard ISO 4217 codes, legacy codes, and non-standard codes. For example, USD.

WeightUnit

Name	Description
GRAMS	Metric system unit of mass.
KILOGRAMS	1 kilogram equals 1000 grams.
OUNCES	Imperial system unit of mass.
POUNDS	1 pound equals 16 ounces.

OrderDisplayFinancialStatus

Name	Description
AUTHORIZED	Displayed as Authorized. The payment provider has validated the customer's payment information. This status appears only for manual payment capture and indicates payments should be captured before the authorization period expires.
EXPIRED	Displayed as Expired. Payment wasn't captured before the payment provider's deadline on an authorized order. Some payment providers use this status to indicate failed payment processing.
PAID	Displayed as Paid. Payment was automatically or manually captured, or the order was marked as paid.
PARTIALLY_PAID	Displayed as Partially paid. A payment was manually captured for the order with an amount less than the full order value.
PARTIALLY_REFUNDED	Displayed as Partially refunded. The amount refunded to a customer is less than the full amount paid for an order.
PENDING	Displayed as Pending. Orders have this status when the payment provider needs time to complete the payment, or when manual payment methods are being used.
REFUNDED	Displayed as Refunded. The full amount paid for an order was refunded to the customer.
VOIDED	Displayed as Voided. An unpaid (payment authorized but not captured) order was manually
canceled.

OrderDisplayFulfillmentStatus

Name	Description
FULFILLED	Displayed as Fulfilled. All the items in the order have been fulfilled.
IN_PROGRESS	Displayed as In progress. All of the items in the order have had a request for fulfillment sent to the fulfillment service or all of the items have been marked as in progress.
ON_HOLD	Displayed as On hold. All of the unfulfilled items in this order are on hold.
OPEN	Displayed as Open. None of the items in the order have been fulfilled. Replaced by "UNFULFILLED" status.
PARTIALLY_FULFILLED	Displayed as Partially fulfilled. Some of the items in the order have been fulfilled.
PENDING_FULFILLMENT	Displayed as Pending fulfillment. A request for fulfillment of some items awaits a response from the fulfillment service. Replaced by the "IN_PROGRESS" status.
REQUEST_DECLINED	Displayed as Request declined. Some of the items in the order have been rejected for fulfillment by the fulfillment service.
RESTOCKED	Displayed as Restocked. All the items in the order have been restocked. Replaced by the "UNFULFILLED" status.
SCHEDULED	Displayed as Scheduled. All of the unfulfilled items in this order are scheduled for fulfillment at later time.
UNFULFILLED	Displayed as Unfulfilled. None of the items in the order have been fulfilled.

CurrencyCode

Name	Description
AED	United Arab Emirates Dirham (AED).
AFN	Afghan Afghani (AFN).
ALL	Albanian Lek (ALL).
AMD	Armenian Dram (AMD).
ANG	Netherlands Antillean Guilder.
AOA	Angolan Kwanza (AOA).
ARS	Argentine Pesos (ARS).
AUD	Australian Dollars (AUD).
AWG	Aruban Florin (AWG).
AZN	Azerbaijani Manat (AZN).
BAM	Bosnia and Herzegovina Convertible Mark (BAM).
BBD	Barbadian Dollar (BBD).
BDT	Bangladesh Taka (BDT).
BGN	Bulgarian Lev (BGN).
BHD	Bahraini Dinar (BHD).
BIF	Burundian Franc (BIF).
BMD	Bermudian Dollar (BMD).
BND	Brunei Dollar (BND).
BOB	Bolivian Boliviano (BOB).
BRL	Brazilian Real (BRL).
BSD	Bahamian Dollar (BSD).
BTN	Bhutanese Ngultrum (BTN).
BWP	Botswana Pula (BWP).
BYN	Belarusian Ruble (BYN).
BYR	Belarusian Ruble (BYR).
BZD	Belize Dollar (BZD).
CAD	Canadian Dollars (CAD).
CDF	Congolese franc (CDF).
CHF	Swiss Francs (CHF).
CLP	Chilean Peso (CLP).
CNY	Chinese Yuan Renminbi (CNY).
COP	Colombian Peso (COP).
CRC	Costa Rican Colones (CRC).
CVE	Cape Verdean escudo (CVE).
CZK	Czech Koruny (CZK).
DJF	Djiboutian Franc (DJF).
DKK	Danish Kroner (DKK).
DOP	Dominican Peso (DOP).
DZD	Algerian Dinar (DZD).
EGP	Egyptian Pound (EGP).
ERN	Eritrean Nakfa (ERN).
ETB	Ethiopian Birr (ETB).
EUR	Euro (EUR).
FJD	Fijian Dollars (FJD).
FKP	Falkland Islands Pounds (FKP).
GBP	United Kingdom Pounds (GBP).
GEL	Georgian Lari (GEL).
GHS	Ghanaian Cedi (GHS).
GIP	Gibraltar Pounds (GIP).
GMD	Gambian Dalasi (GMD).
GNF	Guinean Franc (GNF).
GTQ	Guatemalan Quetzal (GTQ).
GYD	Guyanese Dollar (GYD).
HKD	Hong Kong Dollars (HKD).
HNL	Honduran Lempira (HNL).
HRK	Croatian Kuna (HRK).
HTG	Haitian Gourde (HTG).
HUF	Hungarian Forint (HUF).
IDR	Indonesian Rupiah (IDR).
ILS	Israeli New Shekel (NIS).
INR	Indian Rupees (INR).
IQD	Iraqi Dinar (IQD).
IRR	Iranian Rial (IRR).
ISK	Icelandic Kronur (ISK).
JEP	Jersey Pound.
JMD	Jamaican Dollars (JMD).
JOD	Jordanian Dinar (JOD).
JPY	Japanese Yen (JPY).
KES	Kenyan Shilling (KES).
KGS	Kyrgyzstani Som (KGS).
KHR	Cambodian Riel.
KID	Kiribati Dollar (KID).
KMF	Comorian Franc (KMF).
KRW	South Korean Won (KRW).
KWD	Kuwaiti Dinar (KWD).
KYD	Cayman Dollars (KYD).
KZT	Kazakhstani Tenge (KZT).
LAK	Laotian Kip (LAK).
LBP	Lebanese Pounds (LBP).
LKR	Sri Lankan Rupees (LKR).
LRD	Liberian Dollar (LRD).
LSL	Lesotho Loti (LSL).
LTL	Lithuanian Litai (LTL).
LVL	Latvian Lati (LVL).
LYD	Libyan Dinar (LYD).
MAD	Moroccan Dirham.
MDL	Moldovan Leu (MDL).
MGA	Malagasy Ariary (MGA).
MKD	Macedonia Denar (MKD).
MMK	Burmese Kyat (MMK).
MNT	Mongolian Tugrik.
MOP	Macanese Pataca (MOP).
MRU	Mauritanian Ouguiya (MRU).
MUR	Mauritian Rupee (MUR).
MVR	Maldivian Rufiyaa (MVR).
MWK	Malawian Kwacha (MWK).
MXN	Mexican Pesos (MXN).
MYR	Malaysian Ringgits (MYR).
MZN	Mozambican Metical.
NAD	Namibian Dollar.
NGN	Nigerian Naira (NGN).
NIO	Nicaraguan Córdoba (NIO).
NOK	Norwegian Kroner (NOK).
NPR	Nepalese Rupee (NPR).
NZD	New Zealand Dollars (NZD).
OMR	Omani Rial (OMR).
PAB	Panamian Balboa (PAB).
PEN	Peruvian Nuevo Sol (PEN).
PGK	Papua New Guinean Kina (PGK).
PHP	Philippine Peso (PHP).
PKR	Pakistani Rupee (PKR).
PLN	Polish Zlotych (PLN).
PYG	Paraguayan Guarani (PYG).
QAR	Qatari Rial (QAR).
RON	Romanian Lei (RON).
RSD	Serbian dinar (RSD).
RUB	Russian Rubles (RUB).
RWF	Rwandan Franc (RWF).
SAR	Saudi Riyal (SAR).
SBD	Solomon Islands Dollar (SBD).
SCR	Seychellois Rupee (SCR).
SDG	Sudanese Pound (SDG).
SEK	Swedish Kronor (SEK).
SGD	Singapore Dollars (SGD).
SHP	Saint Helena Pounds (SHP).
SLL	Sierra Leonean Leone (SLL).
SOS	Somali Shilling (SOS).
SRD	Surinamese Dollar (SRD).
SSP	South Sudanese Pound (SSP).
STD	Sao Tome And Principe Dobra (STD).
STN	Sao Tome And Principe Dobra (STN).
SYP	Syrian Pound (SYP).
SZL	Swazi Lilangeni (SZL).
THB	Thai baht (THB).
TJS	Tajikistani Somoni (TJS).
TMT	Turkmenistani Manat (TMT).
TND	Tunisian Dinar (TND).
TOP	Tongan Pa'anga (TOP).
TRY	Turkish Lira (TRY).
TTD	Trinidad and Tobago Dollars (TTD).
TWD	Taiwan Dollars (TWD).
TZS	Tanzanian Shilling (TZS).
UAH	Ukrainian Hryvnia (UAH).
UGX	Ugandan Shilling (UGX).
USD	United States Dollars (USD).
USDC	United States Dollars Coin (USDC).
UYU	Uruguayan Pesos (UYU).
UZS	Uzbekistan som (UZS).
VED	Venezuelan Bolivares (VED).
VEF	Venezuelan Bolivares (VEF).
VES	Venezuelan Bolivares Soberanos (VES).
VND	Vietnamese đồng (VND).
VUV	Vanuatu Vatu (VUV).
WST	Samoan Tala (WST).
XAF	Central African CFA Franc (XAF).
XCD	East Caribbean Dollar (XCD).
XOF	West African CFA franc (XOF).
XPF	CFP Franc (XPF).
XXX	Unrecognized currency.
YER	Yemeni Rial (YER).
ZAR	South African Rand (ZAR).
ZMW	Zambian Kwacha (ZMW).

CountryCode

Name	Description
AC	Ascension Island.
AD	Andorra.
AE	United Arab Emirates.
AF	Afghanistan.
AG	Antigua & Barbuda.
AI	Anguilla.
AL	Albania.
AM	Armenia.
AN	Netherlands Antilles.
AO	Angola.
AR	Argentina.
AT	Austria.
AU	Australia.
AW	Aruba.
AX	Åland Islands.
AZ	Azerbaijan.
BA	Bosnia & Herzegovina.
BB	Barbados.
BD	Bangladesh.
BE	Belgium.
BF	Burkina Faso.
BG	Bulgaria.
BH	Bahrain.
BI	Burundi.
BJ	Benin.
BL	St. Barthélemy.
BM	Bermuda.
BN	Brunei.
BO	Bolivia.
BQ	Caribbean Netherlands.
BR	Brazil.
BS	Bahamas.
BT	Bhutan.
BV	Bouvet Island.
BW	Botswana.
BY	Belarus.
BZ	Belize.
CA	Canada.
CC	Cocos (Keeling) Islands.
CD	Congo - Kinshasa.
CF	Central African Republic.
CG	Congo - Brazzaville.
CH	Switzerland.
CI	Côte d’Ivoire.
CK	Cook Islands.
CL	Chile.
CM	Cameroon.
CN	China.
CO	Colombia.
CR	Costa Rica.
CU	Cuba.
CV	Cape Verde.
CW	Curaçao.
CX	Christmas Island.
CY	Cyprus.
CZ	Czechia.
DE	Germany.
DJ	Djibouti.
DK	Denmark.
DM	Dominica.
DO	Dominican Republic.
DZ	Algeria.
EC	Ecuador.
EE	Estonia.
EG	Egypt.
EH	Western Sahara.
ER	Eritrea.
ES	Spain.
ET	Ethiopia.
FI	Finland.
FJ	Fiji.
FK	Falkland Islands.
FO	Faroe Islands.
FR	France.
GA	Gabon.
GB	United Kingdom.
GD	Grenada.
GE	Georgia.
GF	French Guiana.
GG	Guernsey.
GH	Ghana.
GI	Gibraltar.
GL	Greenland.
GM	Gambia.
GN	Guinea.
GP	Guadeloupe.
GQ	Equatorial Guinea.
GR	Greece.
GS	South Georgia & South Sandwich Islands.
GT	Guatemala.
GW	Guinea-Bissau.
GY	Guyana.
HK	Hong Kong SAR.
HM	Heard & McDonald Islands.
HN	Honduras.
HR	Croatia.
HT	Haiti.
HU	Hungary.
ID	Indonesia.
IE	Ireland.
IL	Israel.
IM	Isle of Man.
IN	India.
IO	British Indian Ocean Territory.
IQ	Iraq.
IR	Iran.
IS	Iceland.
IT	Italy.
JE	Jersey.
JM	Jamaica.
JO	Jordan.
JP	Japan.
KE	Kenya.
KG	Kyrgyzstan.
KH	Cambodia.
KI	Kiribati.
KM	Comoros.
KN	St. Kitts & Nevis.
KP	North Korea.
KR	South Korea.
KW	Kuwait.
KY	Cayman Islands.
KZ	Kazakhstan.
LA	Laos.
LB	Lebanon.
LC	St. Lucia.
LI	Liechtenstein.
LK	Sri Lanka.
LR	Liberia.
LS	Lesotho.
LT	Lithuania.
LU	Luxembourg.
LV	Latvia.
LY	Libya.
MA	Morocco.
MC	Monaco.
MD	Moldova.
ME	Montenegro.
MF	St. Martin.
MG	Madagascar.
MK	North Macedonia.
ML	Mali.
MM	Myanmar (Burma).
MN	Mongolia.
MO	Macao SAR.
MQ	Martinique.
MR	Mauritania.
MS	Montserrat.
MT	Malta.
MU	Mauritius.
MV	Maldives.
MW	Malawi.
MX	Mexico.
MY	Malaysia.
MZ	Mozambique.
NA	Namibia.
NC	New Caledonia.
NE	Niger.
NF	Norfolk Island.
NG	Nigeria.
NI	Nicaragua.
NL	Netherlands.
NO	Norway.
NP	Nepal.
NR	Nauru.
NU	Niue.
NZ	New Zealand.
OM	Oman.
PA	Panama.
PE	Peru.
PF	French Polynesia.
PG	Papua New Guinea.
PH	Philippines.
PK	Pakistan.
PL	Poland.
PM	St. Pierre & Miquelon.
PN	Pitcairn Islands.
PS	Palestinian Territories.
PT	Portugal.
PY	Paraguay.
QA	Qatar.
RE	Réunion.
RO	Romania.
RS	Serbia.
RU	Russia.
RW	Rwanda.
SA	Saudi Arabia.
SB	Solomon Islands.
SC	Seychelles.
SD	Sudan.
SE	Sweden.
SG	Singapore.
SH	St. Helena.
SI	Slovenia.
SJ	Svalbard & Jan Mayen.
SK	Slovakia.
SL	Sierra Leone.
SM	San Marino.
SN	Senegal.
SO	Somalia.
SR	Suriname.
SS	South Sudan.
ST	São Tomé & Príncipe.
SV	El Salvador.
SX	Sint Maarten.
SY	Syria.
SZ	Eswatini.
TA	Tristan da Cunha.
TC	Turks & Caicos Islands.
TD	Chad.
TF	French Southern Territories.
TG	Togo.
TH	Thailand.
TJ	Tajikistan.
TK	Tokelau.
TL	Timor-Leste.
TM	Turkmenistan.
TN	Tunisia.
TO	Tonga.
TR	Türkiye.
TT	Trinidad & Tobago.
TV	Tuvalu.
TW	Taiwan.
TZ	Tanzania.
UA	Ukraine.
UG	Uganda.
UM	U.S. Outlying Islands.
US	United States.
UY	Uruguay.
UZ	Uzbekistan.
VA	Vatican City.
VC	St. Vincent & Grenadines.
VE	Venezuela.
VG	British Virgin Islands.
VN	Vietnam.
VU	Vanuatu.
WF	Wallis & Futuna.
WS	Samoa.
XK	Kosovo.
YE	Yemen.
YT	Mayotte.
ZA	South Africa.
ZM	Zambia.
ZW	Zimbabwe.
ZZ	Unknown Region.

FulfillmentStatus

Name	Description
CANCELLED	The fulfillment was canceled.
ERROR	There was an error with the fulfillment request.
FAILURE	The fulfillment request failed.
OPEN	The third-party fulfillment service has acknowledged the fulfillment and is processing it.
PENDING	Shopify has created the fulfillment and is waiting for the third-party fulfillment service to transition it to `open` or `success`.
SUCCESS	The fulfillment was completed successfully.

FulfillmentDisplayStatus

Name	Description
ATTEMPTED_DELIVERY	Displayed as Attempted delivery.
CANCELED	Displayed as Canceled.
CARRIER_PICKED_UP	Displayed as Picked up by carrier.
CONFIRMED	Displayed as Confirmed.
DELAYED	Displayed as Delayed.
DELIVERED	Displayed as Delivered.
FAILURE	Displayed as Failure.
FULFILLED	Displayed as Fulfilled.
IN_TRANSIT	Displayed as In transit.
LABEL_PRINTED	Displayed as Label printed.
LABEL_PURCHASED	Displayed as Label purchased.
LABEL_VOIDED	Displayed as Label voided.
MARKED_AS_FULFILLED	Displayed as Marked as fulfilled.
NOT_DELIVERED	Displayed as Not delivered.
OUT_FOR_DELIVERY	Displayed as Out for delivery.
PICKED_UP	Displayed as Picked up.
READY_FOR_PICKUP	Displayed as Ready for pickup.
SUBMITTED	Displayed as Submitted.

PaymentTermsType

Name	Description
FIXED	The payment terms or payment terms template is a fixed type. It's due on a specified date.
FULFILLMENT	The payment terms or payment terms template is due on fulfillment.
NET	The payment terms or payment terms template is a net type. It's due a number of days after issue.
RECEIPT	The payment terms or payment terms template is due on receipt.
UNKNOWN	The type of the payment terms or payment terms template is unknown.

OrderTransactionKind

Name	Description
AUTHORIZATION	An amount reserved against the cardholder's funding source.
Money does not change hands until the authorization is captured.
CAPTURE	A transfer of the money that was reserved by an authorization.
CHANGE	The money returned to the customer when they've paid too much during a cash transaction.
EMV_AUTHORIZATION	An authorization for a payment taken with an EMV credit card reader.
REFUND	A partial or full return of captured funds to the cardholder.
A refund can happen only after a capture is processed.
SALE	An authorization and capture performed together in a single step.
SUGGESTED_REFUND	A suggested refund transaction that can be used to create a refund.
VOID	A cancelation of an authorization transaction.

OrderTransactionStatus

Name	Description
AWAITING_RESPONSE	Awaiting a response.
ERROR	There was an error while processing the transaction.
FAILURE	The transaction failed.
PENDING	The transaction is pending.
SUCCESS	The transaction succeeded.
UNKNOWN	The transaction status is unknown.

On this page