List all order variables
Table of contents 32 min
- Shop
- Settings
- DiscountCode
- ShippingMethod
- Order
- MailingAddress
- Customer
- Attribute
- TaxLine
- ShippingLine
- DiscountAllocation
- Image
- ProductVariant
- Product
- PaymentSchedule
- PaymentTerms
- LineItem
- Metafield
- DraftOrderLineItem
- Fulfillment
- Refund
- RefundLineItem
- DraftOrder
- OrderTransaction
- MoneyV2
- WeightUnit
- OrderDisplayFinancialStatus
- OrderDisplayFulfillmentStatus
- CurrencyCode
- CountryCode
- FulfillmentStatus
- FulfillmentDisplayStatus
- PaymentTermsType
- OrderTransactionKind
- OrderTransactionStatus
This tutorial requires the technical skills, including Liquid. If you have difficulty doing this, please contact us.
Shop
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
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
title | String! | The code of the discount. |
ShippingMethod
title | String! | The title of shipping method of the order. |
Order
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. |
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. |
id | UnsignedInt64! | The ID of the corresponding resource in the REST Admin API. |
po_number | String | The PO number associated with the order. |
created_at | DateTime! | Date and time when the order was created in Shopify. |
date | DateTime! | Date and time when the order was created in Shopify. |
updated_at | DateTime! | The date and time when the order was modified last. |
processed_at | DateTime! | The date and time 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 when the order was canceled. Returns `null` if the order wasn't canceled. |
closed_at | DateTime | The date and time when the order was closed. Returns `null` if the order isn't closed. |
billing_address | MailingAddress | The billing address of the customer. |
shipping_address | MailingAddress | The mailing address of the customer. |
shipping_line | ShippingLine | The latest shipping line of the order. |
shipping_lines | ShippingLine | A list of the order's shipping lines. |
customer | Customer | The customer that placed the order. |
customer_locale | String | A two-letter or three-letter language code, optionally followed by a region modifier. |
String | The email address associated with the customer. | |
financial_status | OrderDisplayFinancialStatus | The financial status of the order that can be shown to the merchant. This field doesn't capture all the details of an order's financial state. It should only be used for display summary purposes. |
fulfillment_status | OrderDisplayFulfillmentStatus! | The fulfillment status for the order that can be shown to the merchant. This field does not capture all the details of an order's fulfillment state. It should only be used for display summary purposes. For a more granular view of the fulfillment status, refer to the [FulfillmentOrder](https://shopify.dev/api/admin-graphql/latest/objects/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 sum of the quantities for all line items that contribute to the order's current subtotal price. |
item_count | Int! | The sum of the quantities for all line items that contribute to the order's current subtotal price. |
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. |
currency | CurrencyCode! | The shop currency when the order was placed. |
subtotal_price | MoneyBag! | The sum of the prices for all line items after discounts and returns, in shop and presentment currencies. If `taxesIncluded` is `true`, then the subtotal also includes tax. |
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 amount before discounts and returns, in shop and presentment currencies. |
total_discounts | MoneyBag! | The total amount discounted on the order after returns, 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, in shop and presentment currencies. This includes both order and line level discounts. |
total_due | MoneyBag | The total amount of duties after returns, in shop and presentment currencies. Returns `null` if duties aren't applicable. |
total_due_amount | MoneyBag! | The total amount received from the customer before returns, in shop and presentment currencies. |
duties_price | MoneyBag | The total amount of duties after returns, in shop and presentment currencies. Returns `null` if duties aren't applicable. |
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, 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, in shop and presentment currencies. |
note | String | The contents of the note associated with the order. |
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](https://shopify.dev/api/admin-graphql/latest/mutations/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. |
payment_terms | PaymentTerms | The payment terms associated with the order. |
fulfillments | [Fulfillment!]! | List of shipments for the order. |
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. |
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]! | List of metafields that belong to the resource. |
MailingAddress
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. Formatted using E.164 standard. For example, _+16135551111_. |
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 two-letter 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
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]! | List of metafields that belong to the resource. |
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. |
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
key | String! | Key or name of the attribute. |
value | String | Value of the attribute. |
TaxLine
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
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
allocated_amount_set | MoneyBag! | The money amount that's allocated to a line based on the associated discount application in shop and presentment currencies. |
allocated_amount | MoneyV2! | The money amount that's allocated to a line based on the associated discount application. |
Image
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](https://graphql.org/learn/queries/#aliases). |
width | Int | The original width of the image in pixels. Returns `null` if the image isn't hosted by Shopify. |
ProductVariant
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. |
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`. |
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. |
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
id | ID! | A globally-unique ID. |
title | String! | The title of the product. |
product_type | String! | The product type specified by the merchant. |
vendor | String! | The name of the product's vendor. |
handle | String! | A unique human-friendly string of the product's title. |
tags | [String!]! | A comma separated list of tags associated with the product. Updating `tags` overwrites any existing tags that were previously added to the product. To add new tags without overwriting existing tags, use the [tagsAdd](https://shopify.dev/api/admin-graphql/latest/mutations/tagsadd) mutation. |
options | [ProductOption!]! | A list of product options. The limit is specified by Shop.resourceLimits.maxProductOptions. |
featured_image | Image | The featured image for the product. |
variants | [ProductVariant]! | A list of variants associated with the product. |
url | URL | The online store URL for the product. A value of `null` indicates that the product isn't published to the Online Store sales channel. |
metafields | [Metafield!]! | List of metafields that belong to the resource. |
PaymentSchedule
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
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
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. |
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 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 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
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
id | ID! | A globally-unique ID. |
name | String! | The name of the product. |
title | String! | The name of the product. |
quantity | Int! | The number of product variants that are requested in the draft order. |
fulfillable_quantity | Int! | The number of product variants that are requested in the draft order. |
price_amount | Decimal! | The price of the draft order line item. |
original_price | MoneyBag! | The variant price without any discounts applied. |
original_price_amount | Decimal! | The original price of the draft order line item. |
line_price | MoneyBag! | The line item price after discounts are applied. |
total_discounts | MoneyBag! | The total value of the discount that's applied to the line item. |
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 for a draft order line item. |
grams | Weight | The weight unit and value for a draft order line item. |
total_weight | Float | The total weight of the draft order line item, calculating by weight * quantity. |
variant | ProductVariant | The associated variant for the line item. |
product | Product | The product corresponding to the line item’s product variant. |
image | String | The product URL of the draft order line item. |
Fulfillment
date | 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. |
Refund
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
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
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 that contains the shipping costs. |
customer | Customer | The customer who will be sent an invoice for the draft order, if there is one. |
line_items | [DraftOrderLineItem!]! | The list of the line items in the draft order. |
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 of the line items and their discounts. The subtotal doesn't include shipping charges, shipping discounts, or taxes. |
total_price | MoneyBag! | The total amount of the draft order including taxes, shipping charges, and discounts. |
order_currency | CurrencyCode! | The three letter code for the currency of the store at the time of the most recent update to the draft order. |
currency | CurrencyCode! | The three letter code for the currency of the store at the time of the most recent update to the draft order. |
tags | [String!]! | A 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](https://shopify.dev/api/admin-graphql/latest/mutations/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!]! | List of metafields that belong to the resource. |
OrderTransaction
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
amount | Decimal! | Decimal money amount. |
currency_code | CurrencyCode! | Currency of the money. |
WeightUnit
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
AUTHORIZED | Displayed as **Authorized**. |
EXPIRED | Displayed as **Expired**. |
PAID | Displayed as **Paid**. |
PARTIALLY_PAID | Displayed as **Partially paid**. |
PARTIALLY_REFUNDED | Displayed as **Partially refunded**. |
PENDING | Displayed as **Pending**. |
REFUNDED | Displayed as **Refunded**. |
VOIDED | Displayed as **Voided**. |
OrderDisplayFulfillmentStatus
FULFILLED | Displayed as **Fulfilled**. All the items in the order have been fulfilled. |
IN_PROGRESS | Displayed as **In progress**. Some of the items in the order have been fulfilled, or a request for fulfillment has been sent to the fulfillment service. |
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. |
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
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). |
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
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
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
ATTEMPTED_DELIVERY | Displayed as **Attempted delivery**. |
CANCELED | Displayed as **Canceled**. |
CONFIRMED | Displayed as **Confirmed**. |
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
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
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
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. |
I hope this tutorial may help you to design your layout. If you have any issues relating to this, please contact us to get help.
Andrew Doan
Founder at Doran
Hey! I'm Andrew Doan. I'm a founder at Doran. Let me help you.