Shopify SDK for Unity
Namespaces | Classes | Enumerations
Shopify.Unity Namespace Reference

Classes

class  NoMatchingVariantException
 This exception is thrown when interacting with a cart to add, update, or delete line items and no matching variant could be found. More...
 
struct  ShippingFields
 Wraps around a shipping address and shipping identifier. Used for sending the final checkout fields in one GraphQL query. More...
 
struct  ShopMetadata
 Data struct containing metadata associated with a Shop. More...
 
class  Cart
 Manages line items for an order. Can also be used to generate a web checkout link to check out in browser. More...
 
class  CartState
 Internal state class for a Cart. More...
 
class  ApiVersion
 A version of the API. More...
 
class  AppliedGiftCard
 Details about the gift card used on the checkout. More...
 
class  Article
 An article in an online store blog. More...
 
class  ArticleAuthor
 The author of an article. More...
 
class  ArticleConnection
 An auto-generated type for paginating through multiple Articles. . ArticleConnection can be cast to List<Article>. More...
 
class  ArticleEdge
 An auto-generated type which holds one Article and a cursor during pagination. More...
 
class  Attribute
 Represents a generic custom attribute. More...
 
class  AttributeInput
 Specifies the input fields required for an attribute. More...
 
class  AutomaticDiscountApplication
 Automatic discount applications capture the intentions of a discount that was automatically applied. More...
 
class  AvailableShippingRates
 A collection of available shipping rates for a checkout. More...
 
class  Blog
 An online store blog. More...
 
class  BlogConnection
 An auto-generated type for paginating through multiple Blogs. . BlogConnection can be cast to List<Blog>. More...
 
class  BlogEdge
 An auto-generated type which holds one Blog and a cursor during pagination. More...
 
class  Checkout
 A container for all the information required to checkout items and pay. More...
 
class  CheckoutAttributesUpdateInput
 Specifies the fields required to update a checkout's attributes. More...
 
class  CheckoutAttributesUpdatePayload
 Return type for checkoutAttributesUpdate mutation. More...
 
class  CheckoutAttributesUpdateV2input
 Specifies the fields required to update a checkout's attributes. More...
 
class  CheckoutAttributesUpdateV2payload
 Return type for checkoutAttributesUpdateV2 mutation. More...
 
class  CheckoutCompleteFreePayload
 Return type for checkoutCompleteFree mutation. More...
 
class  CheckoutCompleteWithCreditCardPayload
 Return type for checkoutCompleteWithCreditCard mutation. More...
 
class  CheckoutCompleteWithCreditCardV2payload
 Return type for checkoutCompleteWithCreditCardV2 mutation. More...
 
class  CheckoutCompleteWithTokenizedPaymentPayload
 Return type for checkoutCompleteWithTokenizedPayment mutation. More...
 
class  CheckoutCompleteWithTokenizedPaymentV2payload
 Return type for checkoutCompleteWithTokenizedPaymentV2 mutation. More...
 
class  CheckoutCreateInput
 Specifies the fields required to create a checkout. More...
 
class  CheckoutCreatePayload
 Return type for checkoutCreate mutation. More...
 
class  CheckoutCustomerAssociatePayload
 Return type for checkoutCustomerAssociate mutation. More...
 
class  CheckoutCustomerAssociateV2payload
 Return type for checkoutCustomerAssociateV2 mutation. More...
 
class  CheckoutCustomerDisassociatePayload
 Return type for checkoutCustomerDisassociate mutation. More...
 
class  CheckoutCustomerDisassociateV2payload
 Return type for checkoutCustomerDisassociateV2 mutation. More...
 
class  CheckoutDiscountCodeApplyPayload
 Return type for checkoutDiscountCodeApply mutation. More...
 
class  CheckoutDiscountCodeApplyV2payload
 Return type for checkoutDiscountCodeApplyV2 mutation. More...
 
class  CheckoutDiscountCodeRemovePayload
 Return type for checkoutDiscountCodeRemove mutation. More...
 
class  CheckoutEmailUpdatePayload
 Return type for checkoutEmailUpdate mutation. More...
 
class  CheckoutEmailUpdateV2payload
 Return type for checkoutEmailUpdateV2 mutation. More...
 
class  CheckoutGiftCardApplyPayload
 Return type for checkoutGiftCardApply mutation. More...
 
class  CheckoutGiftCardRemovePayload
 Return type for checkoutGiftCardRemove mutation. More...
 
class  CheckoutGiftCardRemoveV2payload
 Return type for checkoutGiftCardRemoveV2 mutation. More...
 
class  CheckoutGiftCardsAppendPayload
 Return type for checkoutGiftCardsAppend mutation. More...
 
class  CheckoutLineItem
 A single line item in the checkout, grouped by variant and attributes. More...
 
class  CheckoutLineItemConnection
 An auto-generated type for paginating through multiple CheckoutLineItems. . CheckoutLineItemConnection can be cast to List<CheckoutLineItem>. More...
 
class  CheckoutLineItemEdge
 An auto-generated type which holds one CheckoutLineItem and a cursor during pagination. More...
 
class  CheckoutLineItemInput
 Specifies the input fields to create a line item on a checkout. More...
 
class  CheckoutLineItemsAddPayload
 Return type for checkoutLineItemsAdd mutation. More...
 
class  CheckoutLineItemsRemovePayload
 Return type for checkoutLineItemsRemove mutation. More...
 
class  CheckoutLineItemsReplacePayload
 Return type for checkoutLineItemsReplace mutation. More...
 
class  CheckoutLineItemsUpdatePayload
 Return type for checkoutLineItemsUpdate mutation. More...
 
class  CheckoutLineItemUpdateInput
 Specifies the input fields to update a line item on the checkout. More...
 
class  CheckoutShippingAddressUpdatePayload
 Return type for checkoutShippingAddressUpdate mutation. More...
 
class  CheckoutShippingAddressUpdateV2payload
 Return type for checkoutShippingAddressUpdateV2 mutation. More...
 
class  CheckoutShippingLineUpdatePayload
 Return type for checkoutShippingLineUpdate mutation. More...
 
class  CheckoutUserError
 Represents an error that happens during execution of a checkout mutation. More...
 
class  Collection
 A collection represents a grouping of products that a shop owner can create to organize them or make their shops easier to browse. More...
 
class  CollectionConnection
 An auto-generated type for paginating through multiple Collections. . CollectionConnection can be cast to List<Collection>. More...
 
class  CollectionEdge
 An auto-generated type which holds one Collection and a cursor during pagination. More...
 
class  Comment
 A comment on an article. More...
 
class  CommentAuthor
 The author of a comment. More...
 
class  CommentConnection
 An auto-generated type for paginating through multiple Comments. . CommentConnection can be cast to List<Comment>. More...
 
class  CommentEdge
 An auto-generated type which holds one Comment and a cursor during pagination. More...
 
class  CreditCard
 Credit card information used for a payment. More...
 
class  CreditCardPaymentInput
 Specifies the fields required to complete a checkout with a Shopify vaulted credit card payment. More...
 
class  CreditCardPaymentInputV2
 Specifies the fields required to complete a checkout with a Shopify vaulted credit card payment. More...
 
class  Customer
 A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout. More...
 
class  CustomerAccessToken
 A CustomerAccessToken represents the unique token required to make modifications to the customer object. More...
 
class  CustomerAccessTokenCreateInput
 Specifies the input fields required to create a customer access token. More...
 
class  CustomerAccessTokenCreatePayload
 Return type for customerAccessTokenCreate mutation. More...
 
class  CustomerAccessTokenDeletePayload
 Return type for customerAccessTokenDelete mutation. More...
 
class  CustomerAccessTokenRenewPayload
 Return type for customerAccessTokenRenew mutation. More...
 
class  CustomerActivateInput
 Specifies the input fields required to activate a customer. More...
 
class  CustomerActivatePayload
 Return type for customerActivate mutation. More...
 
class  CustomerAddressCreatePayload
 Return type for customerAddressCreate mutation. More...
 
class  CustomerAddressDeletePayload
 Return type for customerAddressDelete mutation. More...
 
class  CustomerAddressUpdatePayload
 Return type for customerAddressUpdate mutation. More...
 
class  CustomerCreateInput
 Specifies the fields required to create a new customer. More...
 
class  CustomerCreatePayload
 Return type for customerCreate mutation. More...
 
class  CustomerDefaultAddressUpdatePayload
 Return type for customerDefaultAddressUpdate mutation. More...
 
class  CustomerRecoverPayload
 Return type for customerRecover mutation. More...
 
class  CustomerResetByUrlPayload
 Return type for customerResetByUrl mutation. More...
 
class  CustomerResetInput
 Specifies the fields required to reset a customer’s password. More...
 
class  CustomerResetPayload
 Return type for customerReset mutation. More...
 
class  CustomerUpdateInput
 Specifies the fields required to update the Customer information. More...
 
class  CustomerUpdatePayload
 Return type for customerUpdate mutation. More...
 
class  CustomerUserError
 Represents an error that happens during execution of a customer mutation. More...
 
class  DiscountAllocation
 An amount discounting the line that has been allocated by a discount. More...
 
interface  DiscountApplication
 Discount applications capture the intentions of a discount source at the time of application. More...
 
class  UnknownDiscountApplication
 UnknownDiscountApplication is a response object. With UnknownDiscountApplication.Create you'll be able instantiate objects implementing DiscountApplication. UnknownDiscountApplication.Create will return one of the following types:

More...
 
class  DiscountApplicationConnection
 An auto-generated type for paginating through multiple DiscountApplications. . DiscountApplicationConnection can be cast to List<DiscountApplication>. More...
 
class  DiscountApplicationEdge
 An auto-generated type which holds one DiscountApplication and a cursor during pagination. More...
 
class  DiscountCodeApplication
 Discount code applications capture the intentions of a discount code at the time that it is applied. More...
 
interface  DisplayableError
 Represents an error in the input of a mutation. More...
 
class  UnknownDisplayableError
 UnknownDisplayableError is a response object. With UnknownDisplayableError.Create you'll be able instantiate objects implementing DisplayableError. UnknownDisplayableError.Create will return one of the following types:

More...
 
class  Domain
 Represents a web address. More...
 
class  ExternalVideo
 Represents a video hosted outside of Shopify. More...
 
class  Fulfillment
 Represents a single fulfillment in an order. More...
 
class  FulfillmentLineItem
 Represents a single line item in a fulfillment. There is at most one fulfillment line item for each order line item. More...
 
class  FulfillmentLineItemConnection
 An auto-generated type for paginating through multiple FulfillmentLineItems. . FulfillmentLineItemConnection can be cast to List<FulfillmentLineItem>. More...
 
class  FulfillmentLineItemEdge
 An auto-generated type which holds one FulfillmentLineItem and a cursor during pagination. More...
 
class  FulfillmentTrackingInfo
 Tracking information associated with the fulfillment. More...
 
interface  HasMetafields
 Represents information about the metafields associated to the specified resource. More...
 
class  UnknownHasMetafields
 UnknownHasMetafields is a response object. With UnknownHasMetafields.Create you'll be able instantiate objects implementing HasMetafields. UnknownHasMetafields.Create will return one of the following types:

More...
 
class  Image
 Represents an image resource. More...
 
class  ImageConnection
 An auto-generated type for paginating through multiple Images. . ImageConnection can be cast to List<Image>. More...
 
class  ImageEdge
 An auto-generated type which holds one Image and a cursor during pagination. More...
 
class  MailingAddress
 Represents a mailing address for customers and shipping. More...
 
class  MailingAddressConnection
 An auto-generated type for paginating through multiple MailingAddresses. . MailingAddressConnection can be cast to List<MailingAddress>. More...
 
class  MailingAddressEdge
 An auto-generated type which holds one MailingAddress and a cursor during pagination. More...
 
class  MailingAddressInput
 Specifies the fields accepted to create or update a mailing address. More...
 
class  ManualDiscountApplication
 Manual discount applications capture the intentions of a discount that was manually created. More...
 
interface  Media
 Represents a media interface. More...
 
class  UnknownMedia
 UnknownMedia is a response object. With UnknownMedia.Create you'll be able instantiate objects implementing Media. UnknownMedia.Create will return one of the following types:

More...
 
class  MediaConnection
 An auto-generated type for paginating through multiple Media. . MediaConnection can be cast to List<Media>. More...
 
class  MediaEdge
 An auto-generated type which holds one Media and a cursor during pagination. More...
 
class  MediaImage
 Represents a Shopify hosted image. More...
 
class  Metafield
 Metafields represent custom metadata attached to a resource. Metafields can be sorted into namespaces and are comprised of keys, values, and value types. More...
 
class  MetafieldConnection
 An auto-generated type for paginating through multiple Metafields. . MetafieldConnection can be cast to List<Metafield>. More...
 
class  MetafieldEdge
 An auto-generated type which holds one Metafield and a cursor during pagination. More...
 
interface  MetafieldParentResource
 A resource that the metafield belongs to. More...
 
class  UnknownMetafieldParentResource
 A resource that the metafield belongs to. More...
 
class  Model3d
 Represents a Shopify hosted 3D model. More...
 
class  Model3dSource
 Represents a source for a Shopify hosted 3d model. More...
 
class  MoneyInput
 Specifies the fields for a monetary value with currency. More...
 
class  MoneyV2
 A monetary value with currency. More...
 
class  MoneyV2connection
 An auto-generated type for paginating through multiple MoneyV2s. . MoneyV2connection can be cast to List<MoneyV2>. More...
 
class  MoneyV2edge
 An auto-generated type which holds one MoneyV2 and a cursor during pagination. More...
 
class  Mutation
 The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. More...
 
interface  Node
 An object with an ID to support global identification. More...
 
class  UnknownNode
 UnknownNode is a response object. With UnknownNode.Create you'll be able instantiate objects implementing Node. UnknownNode.Create will return one of the following types:

More...
 
class  Order
 An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. More...
 
class  OrderConnection
 An auto-generated type for paginating through multiple Orders. . OrderConnection can be cast to List<Order>. More...
 
class  OrderEdge
 An auto-generated type which holds one Order and a cursor during pagination. More...
 
class  OrderLineItem
 Represents a single line in an order. There is one line item for each distinct product variant. More...
 
class  OrderLineItemConnection
 An auto-generated type for paginating through multiple OrderLineItems. . OrderLineItemConnection can be cast to List<OrderLineItem>. More...
 
class  OrderLineItemEdge
 An auto-generated type which holds one OrderLineItem and a cursor during pagination. More...
 
class  Page
 Shopify merchants can create pages to hold static HTML content. Each Page object represents a custom page on the online store. More...
 
class  PageConnection
 An auto-generated type for paginating through multiple Pages. . PageConnection can be cast to List<Page>. More...
 
class  PageEdge
 An auto-generated type which holds one Page and a cursor during pagination. More...
 
class  PageInfo
 Information about pagination in a connection. More...
 
class  Payment
 A payment applied to a checkout. More...
 
class  PaymentSettings
 Settings related to payments. More...
 
class  PricingPercentageValue
 The value of the percentage pricing object. More...
 
interface  PricingValue
 The price value (fixed or percentage) for a discount application. More...
 
class  UnknownPricingValue
 The price value (fixed or percentage) for a discount application. More...
 
class  Product
 A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. For example, a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty). More...
 
class  ProductConnection
 An auto-generated type for paginating through multiple Products. . ProductConnection can be cast to List<Product>. More...
 
class  ProductEdge
 An auto-generated type which holds one Product and a cursor during pagination. More...
 
class  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. More...
 
class  ProductPriceRange
 The price range of the product. More...
 
class  ProductPriceRangeConnection
 An auto-generated type for paginating through multiple ProductPriceRanges. . ProductPriceRangeConnection can be cast to List<ProductPriceRange>. More...
 
class  ProductPriceRangeEdge
 An auto-generated type which holds one ProductPriceRange and a cursor during pagination. More...
 
class  ProductVariant
 A product variant represents a different version of a product, such as differing sizes or differing colors. More...
 
class  ProductVariantConnection
 An auto-generated type for paginating through multiple ProductVariants. . ProductVariantConnection can be cast to List<ProductVariant>. More...
 
class  ProductVariantEdge
 An auto-generated type which holds one ProductVariant and a cursor during pagination. More...
 
class  ProductVariantPricePair
 The compare-at price and price of a variant sharing a currency. More...
 
class  ProductVariantPricePairConnection
 An auto-generated type for paginating through multiple ProductVariantPricePairs. . ProductVariantPricePairConnection can be cast to List<ProductVariantPricePair>. More...
 
class  ProductVariantPricePairEdge
 An auto-generated type which holds one ProductVariantPricePair and a cursor during pagination. More...
 
class  QueryRoot
 The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. More...
 
class  ScriptDiscountApplication
 Script discount applications capture the intentions of a discount that was created by a Shopify Script. More...
 
class  SelectedOption
 Properties used by customers to select a product variant. Products can have multiple options, like different sizes or colors. More...
 
class  SelectedOptionInput
 Specifies the input fields required for a selected option. More...
 
class  Seo
 SEO information. More...
 
class  ShippingRate
 A shipping rate to be applied to a checkout. More...
 
class  Shop
 Shop represents a collection of the general settings and information about the shop. More...
 
class  ShopPolicy
 Policy that a merchant has configured for their store, such as their refund or privacy policy. More...
 
class  StringConnection
 An auto-generated type for paginating through multiple Strings. . StringConnection can be cast to List<String>. More...
 
class  StringEdge
 An auto-generated type which holds one String and a cursor during pagination. More...
 
class  TokenizedPaymentInput
 Specifies the fields required to complete a checkout with a tokenized payment. More...
 
class  TokenizedPaymentInputV2
 Specifies the fields required to complete a checkout with a tokenized payment. More...
 
class  Transaction
 An object representing exchange of money for a product or service. More...
 
class  UnitPriceMeasurement
 The measurement used to calculate a unit price for a product variant (e.g. $9.99 / 100ml). More...
 
class  UserError
 Represents an error in the input of a mutation. More...
 
class  VersionInformation
 
class  Video
 Represents a Shopify hosted video. More...
 
class  VideoSource
 Represents a source for a Shopify hosted video. More...
 
class  ShopifyBuy
 Is the main entry point for the Shopify SDK for Unity. Using you'll create a client which can create queries on the Storefront API. ShopifyClient can also be used to create a Cart . More...
 
class  ShopifyClient
 ShopifyClient is the entry point to communicate with the Shopify Storefront API. ShopifyClient also has functionality to easily generate and send queries to receive information about products, collections, and has the ability to create checkouts. More...
 
class  ShopifyError
 A class describing an error that has occurred within the SDK. More...
 

Enumerations

enum class  ArticleSortKeys {
  UNKNOWN , AUTHOR , BLOG_TITLE , ID ,
  PUBLISHED_AT , RELEVANCE , TITLE , UPDATED_AT
}
 The set of valid sort keys for the Article query. More...
 
enum class  BlogSortKeys {
  UNKNOWN , HANDLE , ID , RELEVANCE ,
  TITLE
}
 The set of valid sort keys for the Blog query. More...
 
enum class  CardBrand {
  UNKNOWN , AMERICAN_EXPRESS , DINERS_CLUB , DISCOVER ,
  JCB , MASTERCARD , VISA
}
 Card brand, such as Visa or Mastercard, which can be used for payments. More...
 
enum class  CheckoutErrorCode {
  UNKNOWN , ALREADY_COMPLETED , BAD_DOMAIN , BLANK ,
  CART_DOES_NOT_MEET_DISCOUNT_REQUIREMENTS_NOTICE , CUSTOMER_ALREADY_USED_ONCE_PER_CUSTOMER_DISCOUNT_NOTICE , DISCOUNT_DISABLED , DISCOUNT_EXPIRED ,
  DISCOUNT_LIMIT_REACHED , DISCOUNT_NOT_FOUND , EMPTY , GIFT_CARD_ALREADY_APPLIED ,
  GIFT_CARD_CODE_INVALID , GIFT_CARD_CURRENCY_MISMATCH , GIFT_CARD_DEPLETED , GIFT_CARD_DISABLED ,
  GIFT_CARD_EXPIRED , GIFT_CARD_NOT_FOUND , GIFT_CARD_UNUSABLE , GREATER_THAN_OR_EQUAL_TO ,
  INVALID , INVALID_FOR_COUNTRY , INVALID_FOR_COUNTRY_AND_PROVINCE , INVALID_PROVINCE_IN_COUNTRY ,
  INVALID_REGION_IN_COUNTRY , INVALID_STATE_IN_COUNTRY , LESS_THAN , LESS_THAN_OR_EQUAL_TO ,
  LINE_ITEM_NOT_FOUND , LOCKED , MISSING_PAYMENT_INPUT , NOT_ENOUGH_IN_STOCK ,
  NOT_SUPPORTED , PRESENT , SHIPPING_RATE_EXPIRED , TOO_LONG ,
  TOTAL_PRICE_MISMATCH , UNABLE_TO_APPLY
}
 Possible error codes that could be returned by CheckoutUserError. More...
 
enum class  CollectionSortKeys {
  UNKNOWN , ID , RELEVANCE , TITLE ,
  UPDATED_AT
}
 The set of valid sort keys for the Collection query. More...
 
enum class  CountryCode {
  UNKNOWN , AD , AE , AF ,
  AG , AI , AL , AM ,
  AN , AO , AR , AT ,
  AU , AW , AX , AZ ,
  BA , BB , BD , BE ,
  BF , BG , BH , BI ,
  BJ , BL , BM , BN ,
  BO , BQ , BR , BS ,
  BT , BV , BW , BY ,
  BZ , CA , CC , CD ,
  CF , CG , CH , CI ,
  CK , CL , CM , CN ,
  CO , CR , CU , CV ,
  CW , CX , CY , CZ ,
  DE , DJ , DK , DM ,
  DO , DZ , EC , EE ,
  EG , EH , ER , ES ,
  ET , FI , FJ , FK ,
  FO , FR , GA , GB ,
  GD , GE , GF , GG ,
  GH , GI , GL , GM ,
  GN , GP , GQ , GR ,
  GS , GT , GW , GY ,
  HK , HM , HN , HR ,
  HT , HU , ID , IE ,
  IL , IM , IN , IO ,
  IQ , IR , IS , IT ,
  JE , JM , JO , JP ,
  KE , KG , KH , KI ,
  KM , KN , KP , KR ,
  KW , KY , KZ , LA ,
  LB , LC , LI , LK ,
  LR , LS , LT , LU ,
  LV , LY , MA , MC ,
  MD , ME , MF , MG ,
  MK , ML , MM , MN ,
  MO , MQ , MR , MS ,
  MT , MU , MV , MW ,
  MX , MY , MZ , NA ,
  NC , NE , NF , NG ,
  NI , NL , NO , NP ,
  NR , NU , NZ , OM ,
  PA , PE , PF , PG ,
  PH , PK , PL , PM ,
  PN , PS , PT , PY ,
  QA , RE , RO , RS ,
  RU , RW , SA , SB ,
  SC , SD , SE , SG ,
  SH , SI , SJ , SK ,
  SL , SM , SN , SO ,
  SR , SS , ST , SV ,
  SX , SY , SZ , TC ,
  TD , TF , TG , TH ,
  TJ , TK , TL , TM ,
  TN , TO , TR , TT ,
  TV , TW , TZ , UA ,
  UG , UM , US , UY ,
  UZ , VA , VC , VE ,
  VG , VN , VU , WF ,
  WS , XK , YE , YT ,
  ZA , ZM , ZW
}
 ISO 3166-1 alpha-2 country codes with some differences. More...
 
enum class  CropRegion {
  UNKNOWN , BOTTOM , CENTER , LEFT ,
  RIGHT , TOP
}
 The part of the image that should remain after cropping. More...
 
enum class  CurrencyCode {
  UNKNOWN , AED , AFN , ALL ,
  AMD , ANG , AOA , ARS ,
  AUD , AWG , AZN , BAM ,
  BBD , BDT , BGN , BHD ,
  BIF , BMD , BND , BOB ,
  BRL , BSD , BTN , BWP ,
  BZD , CAD , CDF , CHF ,
  CLP , CNY , COP , CRC ,
  CVE , CZK , DJF , DKK ,
  DOP , DZD , EGP , ETB ,
  EUR , FJD , FKP , GBP ,
  GEL , GHS , GIP , GMD ,
  GNF , GTQ , GYD , HKD ,
  HNL , HRK , HTG , HUF ,
  IDR , ILS , INR , IQD ,
  IRR , ISK , JEP , JMD ,
  JOD , JPY , KES , KGS ,
  KHR , KMF , KRW , KWD ,
  KYD , KZT , LAK , LBP ,
  LKR , LRD , LSL , LTL ,
  LVL , LYD , MAD , MDL ,
  MGA , MKD , MMK , MNT ,
  MOP , MUR , MVR , MWK ,
  MXN , MYR , MZN , NAD ,
  NGN , NIO , NOK , NPR ,
  NZD , OMR , PAB , PEN ,
  PGK , PHP , PKR , PLN ,
  PYG , QAR , RON , RSD ,
  RUB , RWF , SAR , SBD ,
  SCR , SDG , SEK , SGD ,
  SHP , SLL , SRD , SSP ,
  STD , SYP , SZL , THB ,
  TJS , TMT , TND , TOP ,
  TRY , TTD , TWD , TZS ,
  UAH , UGX , USD , UYU ,
  UZS , VND , VUV , WST ,
  XAF , XCD , XOF , XPF ,
  YER , ZAR , ZMW
}
 Currency codes. More...
 
enum class  CustomerErrorCode {
  UNKNOWN , ALREADY_ENABLED , BLANK , CONTAINS_HTML_TAGS ,
  CONTAINS_URL , CUSTOMER_DISABLED , INVALID , NOT_FOUND ,
  PASSWORD_STARTS_OR_ENDS_WITH_WHITESPACE , TAKEN , TOKEN_INVALID , TOO_LONG ,
  TOO_SHORT , UNIDENTIFIED_CUSTOMER
}
 Possible error codes that could be returned by CustomerUserError. More...
 
enum class  DigitalWallet {
  UNKNOWN , ANDROID_PAY , APPLE_PAY , GOOGLE_PAY ,
  SHOPIFY_PAY
}
 Digital wallet, such as Apple Pay, which can be used for accelerated checkouts. More...
 
enum class  DiscountApplicationAllocationMethod { UNKNOWN , ACROSS , EACH }
 The method by which the discount's value is allocated onto its entitled lines. More...
 
enum class  DiscountApplicationTargetSelection { UNKNOWN , ALL , ENTITLED , EXPLICIT }
 Which lines on the order that the discount is allocated over, of the type defined by the Discount Application's target_type. More...
 
enum class  DiscountApplicationTargetType { UNKNOWN , LINE_ITEM , SHIPPING_LINE }
 The type of line (i.e. line item or shipping line) on an order that the discount is applicable towards. More...
 
enum class  ImageContentType { UNKNOWN , JPG , PNG , WEBP }
 List of supported image content types. More...
 
enum class  MediaContentType {
  UNKNOWN , EXTERNAL_VIDEO , IMAGE , MODEL_3D ,
  VIDEO
}
 The possible content types for a media object. More...
 
enum class  MetafieldValueType { UNKNOWN , INTEGER , JSON_STRING , STRING }
 Metafield value types. More...
 
enum class  OrderSortKeys {
  UNKNOWN , ID , PROCESSED_AT , RELEVANCE ,
  TOTAL_PRICE
}
 The set of valid sort keys for the Order query. More...
 
enum class  PageSortKeys {
  UNKNOWN , ID , RELEVANCE , TITLE ,
  UPDATED_AT
}
 The set of valid sort keys for the Page query. More...
 
enum class  ProductCollectionSortKeys {
  UNKNOWN , BEST_SELLING , COLLECTION_DEFAULT , CREATED ,
  ID , MANUAL , PRICE , RELEVANCE ,
  TITLE
}
 The set of valid sort keys for the ProductCollection query. More...
 
enum class  ProductImageSortKeys {
  UNKNOWN , CREATED_AT , ID , POSITION ,
  RELEVANCE
}
 The set of valid sort keys for the ProductImage query. More...
 
enum class  ProductSortKeys {
  UNKNOWN , BEST_SELLING , CREATED_AT , ID ,
  PRICE , PRODUCT_TYPE , RELEVANCE , TITLE ,
  UPDATED_AT , VENDOR
}
 The set of valid sort keys for the Product query. More...
 
enum class  ProductVariantSortKeys {
  UNKNOWN , ID , POSITION , RELEVANCE ,
  SKU , TITLE
}
 The set of valid sort keys for the ProductVariant query. More...
 
enum class  TransactionKind {
  UNKNOWN , AUTHORIZATION , CAPTURE , CHANGE ,
  EMV_AUTHORIZATION , SALE
}
 The different kinds of order transactions. More...
 
enum class  TransactionStatus {
  UNKNOWN , ERROR , FAILURE , PENDING ,
  SUCCESS
}
 Transaction statuses describe the status of a transaction. More...
 
enum class  UnitPriceMeasurementMeasuredType {
  UNKNOWN , AREA , LENGTH , VOLUME ,
  WEIGHT
}
 The accepted types of unit of measurement. More...
 
enum class  UnitPriceMeasurementMeasuredUnit {
  UNKNOWN , CL , CM , G ,
  KG , L , M , M2 ,
  M3 , MG , ML , MM
}
 The valid units of measurement for a unit price measurement. More...
 
enum class  WeightUnit {
  UNKNOWN , GRAMS , KILOGRAMS , OUNCES ,
  POUNDS
}
 Units of measurement for weight. More...
 

Enumeration Type Documentation

◆ ArticleSortKeys

The set of valid sort keys for the Article query.

Enumerator
UNKNOWN 

If the SDK is not up to date with the schema in the Storefront API, it is possible to have enum values returned that are unknown to the SDK. In this case the value will actually be UNKNOWN.

AUTHOR 

Sort by the author value.

BLOG_TITLE 

Sort by the blog_title value.

ID 

Sort by the id value.

PUBLISHED_AT 

Sort by the published_at value.

RELEVANCE 

During a search (i.e. when the query parameter has been specified on the connection) this sorts the results by relevance to the search term(s). When no search query is specified, this sort key is not deterministic and should not be used.

TITLE 

Sort by the title value.

UPDATED_AT 

Sort by the updated_at value.

◆ BlogSortKeys

The set of valid sort keys for the Blog query.

Enumerator
UNKNOWN 

If the SDK is not up to date with the schema in the Storefront API, it is possible to have enum values returned that are unknown to the SDK. In this case the value will actually be UNKNOWN.

HANDLE 

Sort by the handle value.

ID 

Sort by the id value.

RELEVANCE 

During a search (i.e. when the query parameter has been specified on the connection) this sorts the results by relevance to the search term(s). When no search query is specified, this sort key is not deterministic and should not be used.

TITLE 

Sort by the title value.

◆ CardBrand

Card brand, such as Visa or Mastercard, which can be used for payments.

Enumerator
UNKNOWN 

If the SDK is not up to date with the schema in the Storefront API, it is possible to have enum values returned that are unknown to the SDK. In this case the value will actually be UNKNOWN.

AMERICAN_EXPRESS 

American Express

DINERS_CLUB 

Diners Club

DISCOVER 

Discover

JCB 

JCB

MASTERCARD 

Mastercard

VISA 

Visa

◆ CheckoutErrorCode

Possible error codes that could be returned by CheckoutUserError.

Enumerator
UNKNOWN 

If the SDK is not up to date with the schema in the Storefront API, it is possible to have enum values returned that are unknown to the SDK. In this case the value will actually be UNKNOWN.

ALREADY_COMPLETED 

Checkout is already completed.

BAD_DOMAIN 

Input email contains an invalid domain name.

BLANK 

Input value is blank.

CART_DOES_NOT_MEET_DISCOUNT_REQUIREMENTS_NOTICE 

Cart does not meet discount requirements notice.

CUSTOMER_ALREADY_USED_ONCE_PER_CUSTOMER_DISCOUNT_NOTICE 

Customer already used once per customer discount notice.

DISCOUNT_DISABLED 

Discount disabled.

DISCOUNT_EXPIRED 

Discount expired.

DISCOUNT_LIMIT_REACHED 

Discount limit reached.

DISCOUNT_NOT_FOUND 

Discount not found.

EMPTY 

Checkout is already completed.

GIFT_CARD_ALREADY_APPLIED 

Gift card has already been applied.

GIFT_CARD_CODE_INVALID 

Gift card code is invalid.

GIFT_CARD_CURRENCY_MISMATCH 

Gift card currency does not match checkout currency.

GIFT_CARD_DEPLETED 

Gift card has no funds left.

GIFT_CARD_DISABLED 

Gift card is disabled.

GIFT_CARD_EXPIRED 

Gift card is expired.

GIFT_CARD_NOT_FOUND 

Gift card was not found.

GIFT_CARD_UNUSABLE 

Gift card cannot be applied to a checkout that contains a gift card.

GREATER_THAN_OR_EQUAL_TO 

Input value should be greater than or equal to minimum allowed value.

INVALID 

Input value is invalid.

INVALID_FOR_COUNTRY 

Input Zip is invalid for country provided.

INVALID_FOR_COUNTRY_AND_PROVINCE 

Input Zip is invalid for country and province provided.

INVALID_PROVINCE_IN_COUNTRY 

Invalid province in country.

INVALID_REGION_IN_COUNTRY 

Invalid region in country.

INVALID_STATE_IN_COUNTRY 

Invalid state in country.

LESS_THAN 

Input value should be less than maximum allowed value.

LESS_THAN_OR_EQUAL_TO 

Input value should be less or equal to maximum allowed value.

LINE_ITEM_NOT_FOUND 

Line item was not found in checkout.

LOCKED 

Checkout is locked.

MISSING_PAYMENT_INPUT 

Missing payment input.

NOT_ENOUGH_IN_STOCK 

Not enough in stock.

NOT_SUPPORTED 

Input value is not supported.

PRESENT 

Input value is not present.

SHIPPING_RATE_EXPIRED 

Shipping rate expired.

TOO_LONG 

Input value is too long.

TOTAL_PRICE_MISMATCH 

The amount of the payment does not match the value to be paid.

UNABLE_TO_APPLY 

Unable to apply discount.

◆ CollectionSortKeys

The set of valid sort keys for the Collection query.

Enumerator
UNKNOWN 

If the SDK is not up to date with the schema in the Storefront API, it is possible to have enum values returned that are unknown to the SDK. In this case the value will actually be UNKNOWN.

ID 

Sort by the id value.

RELEVANCE 

During a search (i.e. when the query parameter has been specified on the connection) this sorts the results by relevance to the search term(s). When no search query is specified, this sort key is not deterministic and should not be used.

TITLE 

Sort by the title value.

UPDATED_AT 

Sort by the updated_at value.

◆ CountryCode

ISO 3166-1 alpha-2 country codes with some differences.

Enumerator
UNKNOWN 

If the SDK is not up to date with the schema in the Storefront API, it is possible to have enum values returned that are unknown to the SDK. In this case the value will actually be UNKNOWN.

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.

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 

Turkey.

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.

◆ CropRegion

The part of the image that should remain after cropping.

Enumerator
UNKNOWN 

If the SDK is not up to date with the schema in the Storefront API, it is possible to have enum values returned that are unknown to the SDK. In this case the value will actually be UNKNOWN.

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

Currency codes.

Enumerator
UNKNOWN 

If the SDK is not up to date with the schema in the Storefront API, it is possible to have enum values returned that are unknown to the SDK. In this case the value will actually be UNKNOWN.

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

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

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.

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

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

SRD 

Surinamese Dollar (SRD).

SSP 

South Sudanese Pound (SSP).

STD 

Sao Tome And Principe Dobra (STD).

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

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

YER 

Yemeni Rial (YER).

ZAR 

South African Rand (ZAR).

ZMW 

Zambian Kwacha (ZMW).

◆ CustomerErrorCode

Possible error codes that could be returned by CustomerUserError.

Enumerator
UNKNOWN 

If the SDK is not up to date with the schema in the Storefront API, it is possible to have enum values returned that are unknown to the SDK. In this case the value will actually be UNKNOWN.

ALREADY_ENABLED 

Customer already enabled.

BLANK 

Input value is blank.

CONTAINS_HTML_TAGS 

Input contains HTML tags.

CONTAINS_URL 

Input contains URL.

CUSTOMER_DISABLED 

Customer is disabled.

INVALID 

Input value is invalid.

NOT_FOUND 

Address does not exist.

PASSWORD_STARTS_OR_ENDS_WITH_WHITESPACE 

Input password starts or ends with whitespace.

TAKEN 

Input value is already taken.

TOKEN_INVALID 

Invalid activation token.

TOO_LONG 

Input value is too long.

TOO_SHORT 

Input value is too short.

UNIDENTIFIED_CUSTOMER 

Unidentified customer.

◆ DigitalWallet

Digital wallet, such as Apple Pay, which can be used for accelerated checkouts.

Enumerator
UNKNOWN 

If the SDK is not up to date with the schema in the Storefront API, it is possible to have enum values returned that are unknown to the SDK. In this case the value will actually be UNKNOWN.

ANDROID_PAY 

Android Pay.

APPLE_PAY 

Apple Pay.

GOOGLE_PAY 

Google Pay.

SHOPIFY_PAY 

Shopify Pay.

◆ DiscountApplicationAllocationMethod

The method by which the discount's value is allocated onto its entitled lines.

Enumerator
UNKNOWN 

If the SDK is not up to date with the schema in the Storefront API, it is possible to have enum values returned that are unknown to the SDK. In this case the value will actually be UNKNOWN.

ACROSS 

The value is spread across all entitled lines.

EACH 

The value is applied onto every entitled line.

◆ DiscountApplicationTargetSelection

Which lines on the order that the discount is allocated over, of the type defined by the Discount Application's target_type.

Enumerator
UNKNOWN 

If the SDK is not up to date with the schema in the Storefront API, it is possible to have enum values returned that are unknown to the SDK. In this case the value will actually be UNKNOWN.

ALL 

The discount is allocated onto all the lines.

ENTITLED 

The discount is allocated onto only the lines it is entitled for.

EXPLICIT 

The discount is allocated onto explicitly chosen lines.

◆ DiscountApplicationTargetType

The type of line (i.e. line item or shipping line) on an order that the discount is applicable towards.

Enumerator
UNKNOWN 

If the SDK is not up to date with the schema in the Storefront API, it is possible to have enum values returned that are unknown to the SDK. In this case the value will actually be UNKNOWN.

LINE_ITEM 

The discount applies onto line items.

SHIPPING_LINE 

The discount applies onto shipping lines.

◆ ImageContentType

List of supported image content types.

Enumerator
UNKNOWN 

If the SDK is not up to date with the schema in the Storefront API, it is possible to have enum values returned that are unknown to the SDK. In this case the value will actually be UNKNOWN.

JPG 

A JPG image.

PNG 

A PNG image.

WEBP 

A WEBP image.

◆ MediaContentType

The possible content types for a media object.

Enumerator
UNKNOWN 

If the SDK is not up to date with the schema in the Storefront API, it is possible to have enum values returned that are unknown to the SDK. In this case the value will actually be UNKNOWN.

EXTERNAL_VIDEO 

An externally hosted video.

IMAGE 

A Shopify hosted image.

MODEL_3D 

A 3d model.

VIDEO 

A Shopify hosted video.

◆ MetafieldValueType

Metafield value types.

Enumerator
UNKNOWN 

If the SDK is not up to date with the schema in the Storefront API, it is possible to have enum values returned that are unknown to the SDK. In this case the value will actually be UNKNOWN.

INTEGER 

An integer metafield.

JSON_STRING 

A json string metafield.

STRING 

A string metafield.

◆ OrderSortKeys

The set of valid sort keys for the Order query.

Enumerator
UNKNOWN 

If the SDK is not up to date with the schema in the Storefront API, it is possible to have enum values returned that are unknown to the SDK. In this case the value will actually be UNKNOWN.

ID 

Sort by the id value.

PROCESSED_AT 

Sort by the processed_at value.

RELEVANCE 

During a search (i.e. when the query parameter has been specified on the connection) this sorts the results by relevance to the search term(s). When no search query is specified, this sort key is not deterministic and should not be used.

TOTAL_PRICE 

Sort by the total_price value.

◆ PageSortKeys

The set of valid sort keys for the Page query.

Enumerator
UNKNOWN 

If the SDK is not up to date with the schema in the Storefront API, it is possible to have enum values returned that are unknown to the SDK. In this case the value will actually be UNKNOWN.

ID 

Sort by the id value.

RELEVANCE 

During a search (i.e. when the query parameter has been specified on the connection) this sorts the results by relevance to the search term(s). When no search query is specified, this sort key is not deterministic and should not be used.

TITLE 

Sort by the title value.

UPDATED_AT 

Sort by the updated_at value.

◆ ProductCollectionSortKeys

The set of valid sort keys for the ProductCollection query.

Enumerator
UNKNOWN 

If the SDK is not up to date with the schema in the Storefront API, it is possible to have enum values returned that are unknown to the SDK. In this case the value will actually be UNKNOWN.

BEST_SELLING 

Sort by the best-selling value.

COLLECTION_DEFAULT 

Sort by the collection-default value.

CREATED 

Sort by the created value.

ID 

Sort by the id value.

MANUAL 

Sort by the manual value.

PRICE 

Sort by the price value.

RELEVANCE 

During a search (i.e. when the query parameter has been specified on the connection) this sorts the results by relevance to the search term(s). When no search query is specified, this sort key is not deterministic and should not be used.

TITLE 

Sort by the title value.

◆ ProductImageSortKeys

The set of valid sort keys for the ProductImage query.

Enumerator
UNKNOWN 

If the SDK is not up to date with the schema in the Storefront API, it is possible to have enum values returned that are unknown to the SDK. In this case the value will actually be UNKNOWN.

CREATED_AT 

Sort by the created_at value.

ID 

Sort by the id value.

POSITION 

Sort by the position value.

RELEVANCE 

During a search (i.e. when the query parameter has been specified on the connection) this sorts the results by relevance to the search term(s). When no search query is specified, this sort key is not deterministic and should not be used.

◆ ProductSortKeys

The set of valid sort keys for the Product query.

Enumerator
UNKNOWN 

If the SDK is not up to date with the schema in the Storefront API, it is possible to have enum values returned that are unknown to the SDK. In this case the value will actually be UNKNOWN.

BEST_SELLING 

Sort by the best_selling value.

CREATED_AT 

Sort by the created_at value.

ID 

Sort by the id value.

PRICE 

Sort by the price value.

PRODUCT_TYPE 

Sort by the product_type value.

RELEVANCE 

During a search (i.e. when the query parameter has been specified on the connection) this sorts the results by relevance to the search term(s). When no search query is specified, this sort key is not deterministic and should not be used.

TITLE 

Sort by the title value.

UPDATED_AT 

Sort by the updated_at value.

VENDOR 

Sort by the vendor value.

◆ ProductVariantSortKeys

The set of valid sort keys for the ProductVariant query.

Enumerator
UNKNOWN 

If the SDK is not up to date with the schema in the Storefront API, it is possible to have enum values returned that are unknown to the SDK. In this case the value will actually be UNKNOWN.

ID 

Sort by the id value.

POSITION 

Sort by the position value.

RELEVANCE 

During a search (i.e. when the query parameter has been specified on the connection) this sorts the results by relevance to the search term(s). When no search query is specified, this sort key is not deterministic and should not be used.

SKU 

Sort by the sku value.

TITLE 

Sort by the title value.

◆ TransactionKind

The different kinds of order transactions.

Enumerator
UNKNOWN 

If the SDK is not up to date with the schema in the Storefront API, it is possible to have enum values returned that are unknown to the SDK. In this case the value will actually be UNKNOWN.

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 during the authorization stage.

CHANGE 

Money returned to the customer when they have paid too much.

EMV_AUTHORIZATION 

An authorization for a payment taken with an EMV credit card reader.

SALE 

An authorization and capture performed together in a single step.

◆ TransactionStatus

Transaction statuses describe the status of a transaction.

Enumerator
UNKNOWN 

If the SDK is not up to date with the schema in the Storefront API, it is possible to have enum values returned that are unknown to the SDK. In this case the value will actually be UNKNOWN.

ERROR 

There was an error while processing the transaction.

FAILURE 

The transaction failed.

PENDING 

The transaction is pending.

SUCCESS 

The transaction succeeded.

◆ UnitPriceMeasurementMeasuredType

The accepted types of unit of measurement.

Enumerator
UNKNOWN 

If the SDK is not up to date with the schema in the Storefront API, it is possible to have enum values returned that are unknown to the SDK. In this case the value will actually be UNKNOWN.

AREA 

Unit of measurements representing areas.

LENGTH 

Unit of measurements representing lengths.

VOLUME 

Unit of measurements representing volumes.

WEIGHT 

Unit of measurements representing weights.

◆ UnitPriceMeasurementMeasuredUnit

The valid units of measurement for a unit price measurement.

Enumerator
UNKNOWN 

If the SDK is not up to date with the schema in the Storefront API, it is possible to have enum values returned that are unknown to the SDK. In this case the value will actually be UNKNOWN.

CL 

100 centiliters equals 1 liter.

CM 

100 centimeters equals 1 meter.

Metric system unit of weight.

KG 

1 kilogram equals 1000 grams.

Metric system unit of volume.

Metric system unit of length.

M2 

Metric system unit of area.

M3 

1 cubic meter equals 1000 liters.

MG 

1000 milligrams equals 1 gram.

ML 

1000 milliliters equals 1 liter.

MM 

1000 millimeters equals 1 meter.

◆ WeightUnit

Units of measurement for weight.

Enumerator
UNKNOWN 

If the SDK is not up to date with the schema in the Storefront API, it is possible to have enum values returned that are unknown to the SDK. In this case the value will actually be UNKNOWN.

GRAMS 

Metric system unit of mass.

KILOGRAMS 

1 kilogram equals 1000 grams.

OUNCES 

Imperial system unit of mass.

POUNDS 

1 pound equals 16 ounces.