Shop Minis API

The Shop Minis API is a GraphQL API that powers the in-app user experience for Shop Minis. It allows your Shop Mini to fetch products and other Shop data. Explore the Shop Minis API or see the schema reference below for more detailed information.

Table of Contents

• Query
• Objects
  • BuyerAttributes
  • CategoryAffinity
  • Domain
  • ExternalVideo
  • GenderAffinity
  • Image
  • ImageConnection
  • ImageEdge
  • MediaConnection
  • MediaEdge
  • MediaImage
  • Metafield
  • MetafieldReferenceConnection
  • MetafieldReferenceEdge
  • Metaobject
  • MetaobjectField
  • Model3d
  • Model3dSource
  • Money
  • PageInfo
  • Product
  • ProductOption
  • ProductPriceRange
  • ProductVariant
  • ProductVariantConnection
  • ProductVariantEdge
  • SelectedOption
  • Shop
  • Video
  • VideoSource
• Inputs
  • ImageTransformInput
  • SelectedOptionInput
• Enums
  • CountryCode
  • CropRegion
  • CurrencyCode
  • ImageContent
  • MediaContent
• Scalars
  • Boolean
  • Decimal
  • Float
  • ID
  • Int
  • String
  • URL
• Interfaces
  • HasMetafields
  • Media
• Unions
  • MetafieldReference

Query

Field	Argument	Type	Description
buyerAttributes		BuyerAttributes	Fetches attributes about the buyer for the current user.
recommendedProductIds		[ID!]	Fetches a list of recommended product IDs for the current user.
shop		Shop	Fetches a specific Shop by one of its unique attributes.
id		ID	The ID of the Shop.
domain		String	The permanent domain of the Shop.

Objects

BuyerAttributes

Attributes about a buyer. Note that not all buyers will have attributes. Alpha: only available in development and can change at any time.

Field	Argument	Type	Description
categoryAffinities		[CategoryAffinity!]!	The category affinities of the buyer. The presence of a category says that the buyer has some affinity, and absense means that the buyer does not or we do not know if the buyer has affinity for that category.
genderAffinity		GenderAffinity	The gender that the buyer has the most affinity to. Is null if the buyer does not have a clear affinity.

CategoryAffinity

A ShopifyTaxonomyNode and a score of how much the buyer has affinity to it.

Field	Argument	Type	Description
affinityScore		Float!	A score representing how much affinity the buyer has for this category from 0 to 1, higher representing more affinity.
productTaxonomyId		ID!	A ShopifyTaxonomyNode gid.

Domain

Represents an web address.

Field	Argument	Type	Description
host		String!	The host name of the domain (eg: example.com).
sslEnabled		Boolean!	Whether SSL is enabled or not.
url		URL!	The URL of the domain (eg: https://example.com).

ExternalVideo

Represents a video hosted outside of Shopify.

Field	Argument	Type	Description
alt		String	A word or phrase to share the nature or contents of a media.
embedUrl		URL!	The embed URL of the video for the respective host.
id		ID!	A globally-unique identifier.
mediaContentType		MediaContent!	The media content type.
previewImage		Image	The preview image for the media.

GenderAffinity

A gender and a score of how much the buyer has affinity for that gender.

Field	Argument	Type	Description
affinityScore ⚠️		Float!	A score representing how much affinity the buyer has for this gender, from 0 to 1, higher representing more affinity. ⚠️ DEPRECATED No longer used.
gender		String!	The gender that the buyer has affinity for. Maybe "male", "female" or "neutral".

Image

Represents an image resource.

Field	Argument	Type	Description
altText		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 is not hosted by Shopify.
id		ID	A unique identifier for the image.
url		URL!	The location of the image as a URL.
transform		ImageTransformInput	A set of options to transform the original image.
width		Int	The original width of the image in pixels. Returns null if the image is not hosted by Shopify.

ImageConnection

The connection type for Image.

Field	Argument	Type	Description
edges		[ImageEdge!]!	A list of edges.
nodes		[Image!]!	A list of nodes.
pageInfo		PageInfo!	Information to aid in pagination.

ImageEdge

An edge in a connection.

Field	Argument	Type	Description
cursor		String!	A cursor for use in pagination.
node		Image	The item at the end of the edge.

MediaConnection

The connection type for Media.

Field	Argument	Type	Description
edges		[MediaEdge!]!	A list of edges.
nodes		[Media!]!	A list of nodes.
pageInfo		PageInfo!	Information to aid in pagination.

MediaEdge

An edge in a connection.

Field	Argument	Type	Description
cursor		String!	A cursor for use in pagination.
node		Media	The item at the end of the edge.

MediaImage

Represents a Shopify hosted image.

Field	Argument	Type	Description
alt		String	A word or phrase to share the nature or contents of a media.
id		ID!	A globally-unique identifier.
image		Image	The image for the media.
mediaContentType		MediaContent!	The media content type.
previewImage		Image	The preview image for the media.

Metafield

Metafields represent custom metadata attached to a resource. Metafields can be sorted into namespaces and are comprised of keys, values, and value types.

Field	Argument	Type	Description
id		ID!	A unique identifier for the image.
key		String!	The key name for a metafield.
namespace		String!	The namespace for a metafield.
reference		MetafieldReference	Returns a reference object if the metafield definition's type is a resource reference.
references		MetafieldReferenceConnection	Returns a list references if the metafield definition's type is resource references.
after		String	Returns the elements in the list that come after the specified cursor.
before		String	Returns the elements in the list that come before the specified cursor.
first		Int	Returns the first n elements from the list.
last		Int	Returns the last n elements from the list.
type		String!	The type name of the metafield.
value		String!	The value of a metafield.

MetafieldReferenceConnection

The connection type for MetafieldReference.

Field	Argument	Type	Description
edges		[MetafieldReferenceEdge!]!	A list of edges.
nodes		[MetafieldReference!]!	A list of nodes.
pageInfo		PageInfo!	Information to aid in pagination.

MetafieldReferenceEdge

An edge in a connection.

Field	Argument	Type	Description
cursor		String!	A cursor for use in pagination.
node		MetafieldReference	The item at the end of the edge.

Metaobject

An instance of a user-defined model based on a MetaobjectDefinition.

Field	Argument	Type	Description
field		MetaobjectField	Accesses a field of the object by key.
key		String!	The field key.
fields		[MetaobjectField!]!	All object fields with defined values. Omitted object keys can be assumed null, and no guarantees are made about field order.
handle		String!	The unique handle of the metaobject. Useful as a custom ID.
id		ID!	A globally-unique identifier.
type		String!	The type of the metaobject. Defines the namespace of its associated metafields.

MetaobjectField

Provides the value of a Metaobject field.

Field	Argument	Type	Description
key		String!	The field key.
reference		MetafieldReference	A referenced object if the field type is a resource reference.
references		MetafieldReferenceConnection	A list of referenced objects if the field type is a resource reference list.
after		String	Returns the elements in the list that come after the specified cursor.
before		String	Returns the elements in the list that come before the specified cursor.
first		Int	Returns the first n elements from the list.
last		Int	Returns the last n elements from the list.
type		String!	The type name of the field.
value		String	The field value.

Model3d

Represents a Shopify hosted 3D model.

Field	Argument	Type	Description
alt		String	A word or phrase to share the nature or contents of a media.
id		ID!	A globally-unique identifier.
mediaContentType		MediaContent!	The media content type.
previewImage		Image	The preview image for the media.
sources		[Model3dSource!]!	The sources for a 3d model.

Model3dSource

Represents a source for a Shopify hosted 3d model.

Field	Argument	Type	Description
filesize		Int!	The filesize of the 3d model.
format		String!	The format of the 3d model.
mimeType		String!	The MIME type of the 3d model.
url		URL!	The URL of the 3d model.

Money

A monetary value with currency.

Field	Argument	Type	Description
amount		Decimal!	Decimal money amount.
currencyCode		CurrencyCode!	Currency of the money.

PageInfo

Information about pagination in a connection.

Field	Argument	Type	Description
endCursor		String	When paginating forwards, the cursor to continue.
hasNextPage		Boolean!	When paginating forwards, are there more items?
hasPreviousPage		Boolean!	When paginating backwards, are there more items?
startCursor		String	When paginating backwards, the cursor to continue.

Product

A product represents an individual item for sale in a Shopify store.

Field	Argument	Type	Description
availableForSale		Boolean!	Indicates if at least one product variant is available for sale.
compareAtPriceRange		ProductPriceRange!	The compare at price of the product across all variants.
defaultVariant		ProductVariant!	The default variant that represents this product. This is useful for determining which variant to show for a product when no variant is explicitly selected.
description		String!	Stripped description of the product, single line with HTML tags removed.
featuredImage		Image	The featured image for the product.
handle		String!	A human-friendly unique string for the Product automatically generated from its title.
id		ID!	A globally-unique identifier.
images		ImageConnection!	List of images associated with the product.
after		String	Returns the elements in the list that come after the specified cursor.
before		String	Returns the elements in the list that come before the specified cursor.
first		Int	Returns the first n elements from the list.
last		Int	Returns the last n elements from the list.
media		MediaConnection!	The media associated with the product.
after		String	Returns the elements in the list that come after the specified cursor.
before		String	Returns the elements in the list that come before the specified cursor.
first		Int	Returns the first n elements from the list.
last		Int	Returns the last n elements from the list.
metafield		Metafield	Returns a metafield found by namespace and key.
namespace		String!	A container for a set of metafields.
key		String!	The identifier for the metafield.
onlineStoreUrl		URL	The URL used for viewing the resource on the shop's Online Store. Returns null if the resource is currently not published to the Online Store sales channel.
options		[ProductOption!]!	List of product options.
priceRange		ProductPriceRange!	The price range.
productType		String!	A categorization that a product can be tagged with, commonly used for filtering and searching.
reviewsAverageRating		Float	The average rating of the product.
reviewsCount		Int	The number of reviews for the product.
tags		[String!]!	A comma separated list of tags that have been added to the product.
title		String!	The product’s title.
totalInventory		Int	The total quantity of inventory in stock for this Product.
variantBySelectedOptions		ProductVariant	Find a product’s variant based on its selected options. This is useful for converting a user’s selection of product options into a single matching variant. If there is not a variant for the selected options, null will be returned.
selectedOptions		[SelectedOptionInput!]!	The input fields used for a selected option.
variants		ProductVariantConnection!	List of the product’s variants.
after		String	Returns the elements in the list that come after the specified cursor.
before		String	Returns the elements in the list that come before the specified cursor.
first		Int	Returns the first n elements from the list.
last		Int	Returns the last n elements from the list.
vendor		String!	The product’s vendor name.

ProductOption

Product property names like Size, Color, and Material that the customers can select. Variants are selected based on permutations of these options. 255 characters limit each.

Field	Argument	Type	Description
id		ID!	A globally-unique identifier.
name		String!	The product option’s name.
values		[String!]!	The corresponding value to the product option name.

ProductPriceRange

The price range of the product.

Field	Argument	Type	Description
maxVariantPrice		Money!	The highest variant's price.
minVariantPrice		Money!	The lowest variant's price.

ProductVariant

A product variant represents a different version of a product, such as differing sizes or differing colors.

Field	Argument	Type	Description
availableForSale		Boolean!	Indicates if the product variant is available for sale.
compareAtPrice		Money	The compare at price of the variant. This can be used to mark a variant as on sale, when compareAtPrice is higher than price.
currentlyNotInStock		Boolean!	Whether a product is out of stock but still available for purchase (used for backorders).
id		ID!	A globally-unique identifier.
image		Image	Image associated with the product variant. This field falls back to the product image if no image is available.
isFavorited		Boolean!	Whether the product variant is favorited by the current user.
price		Money!	The product variant’s price.
quantityAvailable		Int	The total sellable quantity of the variant for online sales channels.
selectedOptions		[SelectedOption!]!	List of product options applied to the variant.
title		String!	The product variant’s title.

ProductVariantConnection

The connection type for ProductVariant.

Field	Argument	Type	Description
edges		[ProductVariantEdge!]!	A list of edges.
nodes		[ProductVariant!]!	A list of nodes.
pageInfo		PageInfo!	Information to aid in pagination.

ProductVariantEdge

An edge in a connection.

Field	Argument	Type	Description
cursor		String!	A cursor for use in pagination.
node		ProductVariant	The item at the end of the edge.

SelectedOption

Properties used by customers to select a product variant. Products can have multiple options, like different sizes or colors.

Field	Argument	Type	Description
name		String!	The product option’s name.
value		String!	The product option’s value.

Shop

A shop represents a collection of the general settings and information about the shop.

Field	Argument	Type	Description
description		String	A description of the shop.
id		ID!	A globally-unique identifier.
isFollowing		Boolean!	Whether the shop is followed by the current user.
logoImage		Image	The shop’s logo image.
metafield		Metafield	Returns a metafield found by namespace and key.
namespace		String!	A container for a set of metafields.
key		String!	The identifier for the metafield.
name		String!	The name of the shop.
permanentDomain		Domain!	The shop’s permanent domain.
primaryDomain		Domain!	The shop’s primary domain.
product		Product	Fetches a specific Product by its ID.
id		ID!	The ID of the Product.
productsByIds		[Product]!	Fetches a list of Product nodes by their IDs.
ids		[ID!]!	The IDs of the Product nodes to fetch.
reviewsAverageRating		Float	The average rating of products in the shop.
reviewsCount		Int	The total number of reviews for products in the shop.
shareUrl		URL	A Shop-attributed deep link URL used for sharing the shop.
shipsToCountries		[CountryCode!]!	The countries that the shop ships to.

Video

Represents a Shopify hosted video.

Field	Argument	Type	Description
alt		String	A word or phrase to share the nature or contents of a media.
id		ID!	A globally-unique identifier.
mediaContentType		MediaContent!	The media content type.
previewImage		Image	The preview image for the media.
sources		[VideoSource!]!	The sources for a 3d model.

VideoSource

Represents a source for a Shopify hosted video.

Field	Argument	Type	Description
format		String!	The format of the video.
height		Int!	The height of the video.
mimeType		String!	The MIME type of the video.
url		URL!	The URL of the video.
width		Int!	The width of the video.

Inputs

ImageTransformInput

The available options for transforming an image.

Field		Type	Description
crop		CropRegion	Crop the image according to the specified region.
maxHeight		Int	Image height in pixels between 1 and 5760.
maxWidth		Int	Image width in pixels between 1 and 5760.
preferredContentType		ImageContent	Convert the source image into the preferred content type. Supported conversions: any file type to .jpg, and any file type to .webp.
scale		Int	Image size multiplier for high-resolution retina displays. Must be within 1..3.

SelectedOptionInput

The input fields used for a selected option.

Field		Type	Description
name		String!	The product option’s name..
value		String!	The product option’s value.

Enums

CountryCode

The code designating a country/region, which generally follows ISO 3166-1 alpha-2 guidelines. If a territory doesn't have a country code value in the CountryCode enum, it might be considered a subdivision of another country. For example, the territories associated with Spain are represented by the country code ES, and the territories associated with the United States of America are represented by the country code US.

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

CropRegion

The part of the image that should remain after cropping.

Value	Description
BOTTOM	Keep the bottom of the image.
CENTER	Keep the center of the image.
LEFT	Keep the left of the image.
RIGHT	Keep the right of the image.
TOP	Keep the top of the image.

CurrencyCode

The three-letter currency codes that represent the world currencies used in stores. These include standard ISO 4217 codes, legacy codes, and non-standard codes.

Value	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).
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).

ImageContent

List of supported image content types.

Value	Description
JPG	A JPG image.
WEBP	A WEBP image.

MediaContent

The possible content types for a media object.

Value	Description
EXTERNAL_VIDEO	An externally hosted video.
IMAGE	A Shopify hosted image.
MODEL_3D	A 3d model.
VIDEO	A Shopify hosted video.

Scalars

Boolean

Represents true or false values.

Decimal

A signed decimal number serialized as a string. Example value: "29.99".

Float

Represents signed double-precision fractional values as specified by IEEE 754.

ID

Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "VXNlci0xMA==") or integer (such as 4) input value will be accepted as an ID.

Int

Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

String

Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.

URL

Represents an RFC 3986 and RFC 3987-compliant URI string.

For example, "https://johns-apparel.myshopify.com" is a valid URL. It includes a scheme (https) and a host (johns-apparel.myshopify.com).

Interfaces

HasMetafields

Represents information about the metafields associated to the specified resource.

Field	Argument	Type	Description
metafield		Metafield	Returns a metafield found by namespace and key.
namespace		String!	A container for a set of metafields.
key		String!	The identifier for the metafield.

Media

Represents a media interface.

Field	Argument	Type	Description
alt		String	A word or phrase to share the nature or contents of a media.
mediaContentType		MediaContent!	The media content type.
previewImage		Image	The preview image for the media.

Unions

MetafieldReference

Returns the resource which is being referred to by a metafield.

Type	Description
MediaImage	Represents a Shopify hosted image.
Metaobject	An instance of a user-defined model based on a MetaobjectDefinition.
Product	A product represents an individual item for sale in a Shopify store.
ProductVariant	A product variant represents a different version of a product, such as differing sizes or differing colors.
Video	Represents a Shopify hosted video.