Currency
The currency codes that represent the world currencies throughout the Admin API. Currency codes include standard ISO 4217 codes, legacy codes, non-standard codes, digital currency codes.
Anchor to Valid valuesValid values
United Arab Emirates Dirham (AED).
Afghan Afghani (AFN).
Albanian Lek (ALL).
Armenian Dram (AMD).
Netherlands Antillean Guilder.
Angolan Kwanza (AOA).
Argentine Pesos (ARS).
Australian Dollars (AUD).
Aruban Florin (AWG).
Azerbaijani Manat (AZN).
Bosnia and Herzegovina Convertible Mark (BAM).
Barbadian Dollar (BBD).
Bangladesh Taka (BDT).
Bulgarian Lev (BGN).
Bahraini Dinar (BHD).
Burundian Franc (BIF).
Bermudian Dollar (BMD).
Brunei Dollar (BND).
Bolivian Boliviano (BOB).
Brazilian Real (BRL).
Bahamian Dollar (BSD).
Bhutanese Ngultrum (BTN).
Botswana Pula (BWP).
Belarusian Ruble (BYN).
Belize Dollar (BZD).
Canadian Dollars (CAD).
Congolese franc (CDF).
Swiss Francs (CHF).
Chilean Peso (CLP).
Chinese Yuan Renminbi (CNY).
Colombian Peso (COP).
Costa Rican Colones (CRC).
Cape Verdean escudo (CVE).
Czech Koruny (CZK).
Djiboutian Franc (DJF).
Danish Kroner (DKK).
Dominican Peso (DOP).
Algerian Dinar (DZD).
Egyptian Pound (EGP).
Eritrean Nakfa (ERN).
Ethiopian Birr (ETB).
Euro (EUR).
Fijian Dollars (FJD).
Falkland Islands Pounds (FKP).
United Kingdom Pounds (GBP).
Georgian Lari (GEL).
Ghanaian Cedi (GHS).
Gibraltar Pounds (GIP).
Gambian Dalasi (GMD).
Guinean Franc (GNF).
Guatemalan Quetzal (GTQ).
Guyanese Dollar (GYD).
Hong Kong Dollars (HKD).
Honduran Lempira (HNL).
Croatian Kuna (HRK).
Haitian Gourde (HTG).
Hungarian Forint (HUF).
Indonesian Rupiah (IDR).
Israeli New Shekel (NIS).
Indian Rupees (INR).
Iraqi Dinar (IQD).
Iranian Rial (IRR).
Icelandic Kronur (ISK).
Jersey Pound.
Jamaican Dollars (JMD).
Jordanian Dinar (JOD).
Japanese Yen (JPY).
Kenyan Shilling (KES).
Kyrgyzstani Som (KGS).
Cambodian Riel.
Kiribati Dollar (KID).
Comorian Franc (KMF).
South Korean Won (KRW).
Kuwaiti Dinar (KWD).
Cayman Dollars (KYD).
Kazakhstani Tenge (KZT).
Laotian Kip (LAK).
Lebanese Pounds (LBP).
Sri Lankan Rupees (LKR).
Liberian Dollar (LRD).
Lesotho Loti (LSL).
Lithuanian Litai (LTL).
Latvian Lati (LVL).
Libyan Dinar (LYD).
Moroccan Dirham.
Moldovan Leu (MDL).
Malagasy Ariary (MGA).
Macedonia Denar (MKD).
Burmese Kyat (MMK).
Mongolian Tugrik.
Macanese Pataca (MOP).
Mauritanian Ouguiya (MRU).
Mauritian Rupee (MUR).
Maldivian Rufiyaa (MVR).
Malawian Kwacha (MWK).
Mexican Pesos (MXN).
Malaysian Ringgits (MYR).
Mozambican Metical.
Namibian Dollar.
Nigerian Naira (NGN).
Nicaraguan Córdoba (NIO).
Norwegian Kroner (NOK).
Nepalese Rupee (NPR).
New Zealand Dollars (NZD).
Omani Rial (OMR).
Panamian Balboa (PAB).
Peruvian Nuevo Sol (PEN).
Papua New Guinean Kina (PGK).
Philippine Peso (PHP).
Pakistani Rupee (PKR).
Polish Zlotych (PLN).
Paraguayan Guarani (PYG).
Qatari Rial (QAR).
Romanian Lei (RON).
Serbian dinar (RSD).
Russian Rubles (RUB).
Rwandan Franc (RWF).
Saudi Riyal (SAR).
Solomon Islands Dollar (SBD).
Seychellois Rupee (SCR).
Sudanese Pound (SDG).
Swedish Kronor (SEK).
Singapore Dollars (SGD).
Saint Helena Pounds (SHP).
Sierra Leonean Leone (SLL).
Somali Shilling (SOS).
Surinamese Dollar (SRD).
South Sudanese Pound (SSP).
Sao Tome And Principe Dobra (STN).
Syrian Pound (SYP).
Swazi Lilangeni (SZL).
Thai baht (THB).
Tajikistani Somoni (TJS).
Turkmenistani Manat (TMT).
Tunisian Dinar (TND).
Tongan Pa'anga (TOP).
Turkish Lira (TRY).
Trinidad and Tobago Dollars (TTD).
Taiwan Dollars (TWD).
Tanzanian Shilling (TZS).
Ukrainian Hryvnia (UAH).
Ugandan Shilling (UGX).
United States Dollars (USD).
- Anchor to USDCUSDC
United States Dollars Coin (USDC).
Uruguayan Pesos (UYU).
Uzbekistan som (UZS).
Venezuelan Bolivares (VED).
Venezuelan Bolivares Soberanos (VES).
Vietnamese đồng (VND).
Vanuatu Vatu (VUV).
Samoan Tala (WST).
Central African CFA Franc (XAF).
East Caribbean Dollar (XCD).
West African CFA franc (XOF).
CFP Franc (XPF).
Unrecognized currency.
Yemeni Rial (YER).
South African Rand (ZAR).
Zambian Kwacha (ZMW).
Deprecated valid values
- •Deprecated
- •Deprecated
- •Deprecated
Anchor to FieldsFields
- •OBJECT
The calculated fields for a draft order.
- •OBJECT
The calculated fields for a draft order.
- •OBJECT
A location or branch of a company that's a customer of the shop. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location.
- •OBJECT
A setting for a presentment currency.
- •OBJECT
An order that a merchant creates on behalf of a customer. Draft orders are useful for merchants that need to do the following tasks:
- Create new orders for sales made by phone, in person, by chat, or elsewhere. When a merchant accepts payment for a draft order, an order is created.
- Send invoices to customers to pay with a secure checkout link.
- Use custom items to represent additional costs or products that aren't displayed in a shop's inventory.
- Re-create orders manually from active sales channels.
- Sell products at discount or wholesale rates.
- Take pre-orders.
For draft orders in multiple currencies
is the source of truth for what a customer is going to be charged andis an estimate of what the merchant might receive in their shop currency.Caution: Only use this data if it's required for your app's functionality. Shopify will restrict access to scopes for apps that don't have a legitimate use for the associated data.
Draft orders created on or after April 1, 2025 will be automatically purged after one year of inactivity.
- •OBJECT
An order that a merchant creates on behalf of a customer. Draft orders are useful for merchants that need to do the following tasks:
- Create new orders for sales made by phone, in person, by chat, or elsewhere. When a merchant accepts payment for a draft order, an order is created.
- Send invoices to customers to pay with a secure checkout link.
- Use custom items to represent additional costs or products that aren't displayed in a shop's inventory.
- Re-create orders manually from active sales channels.
- Sell products at discount or wholesale rates.
- Take pre-orders.
For draft orders in multiple currencies
is the source of truth for what a customer is going to be charged andis an estimate of what the merchant might receive in their shop currency.Caution: Only use this data if it's required for your app's functionality. Shopify will restrict access to scopes for apps that don't have a legitimate use for the associated data.
Draft orders created on or after April 1, 2025 will be automatically purged after one year of inactivity.
- •INPUT OBJECT
The input fields used to create or update a draft order.
- Anchor to MarketCurrencySettingsUpdateInput.baseCurrencyMarket•INPUT OBJECT
Currency Settings Update Input. base Currency The input fields used to update the currency settings of a market.
- •INPUT OBJECT
The input fields for a monetary value with currency.
- •OBJECT
A precise monetary value and its associated currency. For example, 12.99 USD.
- •OBJECT
The
Orderobject represents a customer's request to purchase one or more products from a store. Use theOrderobject to handle the complete purchase lifecycle from checkout to fulfillment.Use the
Orderobject when you need to:- Display order details on customer account pages or admin dashboards.
- Create orders for phone sales, wholesale customers, or subscription services.
- Update order information like shipping addresses, notes, or fulfillment status.
- Process returns, exchanges, and partial refunds.
- Generate invoices, receipts, and shipping labels.
The
Orderobject serves as the central hub connecting customer information, product details, payment processing, and fulfillment data within the GraphQL Admin API schema.NoteOnly the last 60 days' worth of orders from a store are accessible from the
Orderobject by default. If you want to access older records, then you need to request access to all orders. If your app is granted access, then you can add the,, andscopes.CautionOnly use orders data if it's required for your app's functionality. Shopify will restrict access to scopes for apps that don't have a legitimate use for the associated data.
Learn more about building apps for orders and fulfillment.
- •OBJECT
The
Orderobject represents a customer's request to purchase one or more products from a store. Use theOrderobject to handle the complete purchase lifecycle from checkout to fulfillment.Use the
Orderobject when you need to:- Display order details on customer account pages or admin dashboards.
- Create orders for phone sales, wholesale customers, or subscription services.
- Update order information like shipping addresses, notes, or fulfillment status.
- Process returns, exchanges, and partial refunds.
- Generate invoices, receipts, and shipping labels.
The
Orderobject serves as the central hub connecting customer information, product details, payment processing, and fulfillment data within the GraphQL Admin API schema.NoteOnly the last 60 days' worth of orders from a store are accessible from the
Orderobject by default. If you want to access older records, then you need to request access to all orders. If your app is granted access, then you can add the,, andscopes.CautionOnly use orders data if it's required for your app's functionality. Shopify will restrict access to scopes for apps that don't have a legitimate use for the associated data.
Learn more about building apps for orders and fulfillment.
- •INPUT OBJECT
The input fields for the authorized transaction to capture and the total amount to capture from it.
- •INPUT OBJECT
The input fields for creating an order.
- •INPUT OBJECT
The input fields for creating an order.
- •OBJECT
The
object represents a payment transaction that's associated with an order. An order transaction is a specific action or event that happens within the context of an order, such as a customer paying for a purchase or receiving a refund, or other payment-related activity.Use the
object to capture the complete lifecycle of a payment, from initial authorization to final settlement, including refunds and currency exchanges. Common use cases for using theobject include:- Processing new payments for orders
- Managing payment authorizations and captures
- Processing refunds for returned items
- Tracking payment status and errors
- Managing multi-currency transactions
- Handling payment gateway integrations
Each
object has akindthat defines the type of transaction and astatusthat indicates the current state of the transaction. The object stores detailed information about payment methods, gateway processing, and settlement details.Learn more about payment processing and payment gateway integrations.
- •OBJECT
Represents a price list, including information about related prices and eligibility rules. You can use price lists to specify either fixed prices or adjusted relative prices that override initial product variant prices. Price lists are applied to customers using context rules, which determine price list eligibility.
For more information on price lists, refer to Support different pricing models.
- •INPUT OBJECT
The input fields to create a price list.
- •INPUT OBJECT
The input fields used to update a price list.
- •ARGUMENT
The
object represents a version of a product that comes in more than one option, such as size or color. For example, if a merchant sells t-shirts with options for size and color, then a small, blue t-shirt would be one product variant and a large, blue t-shirt would be another.Use the
object to manage the full lifecycle and configuration of a product's variants. Common use cases for using theobject include:- Tracking inventory for each variant
- Setting unique prices for each variant
- Assigning barcodes and SKUs to connect variants to fulfillment services
- Attaching variant-specific images and media
- Setting delivery and tax requirements
- Supporting product bundles, subscriptions, and selling plans
A
is associated with a parentProductobject.serves as the central link between a product's merchandising configuration, inventory, pricing, fulfillment, and sales channels within the GraphQL Admin API schema. Each variant can reference other GraphQL types such as:: Used for inventory trackingImage: Used for variant-specific images: Used for subscriptions and selling plans
Learn more about Shopify's product model.
- •INPUT OBJECT
The input fields to create a refund.
- •OBJECT
Represents a collection of general settings and information about the shop.
- •OBJECT
Represents a collection of general settings and information about the shop.
- •OBJECT
Billing preferences for the shop.
- •OBJECT
Balance and payout information for a Shopify Payments account. Balance includes all balances for the currencies supported by the shop. You can also query for a list of payouts, where each payout includes the corresponding currencyCode field.
- •OBJECT
A bank account that can receive payouts.
- Anchor to SubscriptionBillingCycleEditedContract.currencyCodeSubscription•OBJECT
Billing Cycle Edited Contract. currency Code Represents a subscription contract with billing cycles.
- •OBJECT
Represents a Subscription Contract.
- Anchor to SubscriptionContractAtomicCreateInput.currencyCodeSubscription•INPUT OBJECT
Contract Atomic Create Input. currency Code The input fields required to create a Subscription Contract.
- •INTERFACE
Represents subscription contract common fields.
- •INPUT OBJECT
The input fields required to create a Subscription Contract.
- •OBJECT
The
object represents a draft version of a subscription contract before it's committed. It serves as a staging area for making changes to an existing subscription or creating a new one. The draft allows you to preview and modify various aspects of a subscription before applying the changes.Use the
object to:- Add, remove, or modify subscription lines and their quantities
- Manage discounts (add, remove, or update manual and code-based discounts)
- Configure delivery options and shipping methods
- Set up billing and delivery policies
- Manage customer payment methods
- Add custom attributes and notes to generated orders
- Configure billing cycles and next billing dates
- Preview the projected state of the subscription
Each
object maintains a projected state that shows how the subscription will look after the changes are committed. This allows you to preview the impact of your modifications before applying them. The draft can be associated with an existing subscription contract (for modifications) or used to create a new subscription.The draft remains in a draft state until it's committed, at which point the changes are applied to the subscription contract and the draft is no longer accessible.
Learn more about how subscription contracts work and how to build, update, and combine subscription contracts.