Common APIs

Common Storefront API objects.

In this section

  • ApiVersion — A version of the API, as defined by Shopify API versioning. Versions are commonly referred to by their handle (for example, 2021-10).

  • Attribute — Represents a generic custom attribute.

  • AttributeInput — Specifies the input fields required for an attribute.

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

  • Country — A country.

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

  • CropRegion — The part of the image that should remain after cropping.

  • Currency — A currency.

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

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

  • Domain — Represents a web address.

  • Filter — A filter that is supported on the parent field.

  • FilterType — Denotes the type of data this filter group represents.

  • FilterValue — A selectable value within a filter.

  • HasMetafields — Represents information about the metafields associated to the specified resource.

  • Image — Represents an image resource.

  • ImageContentType — List of supported image content types.

  • ImageTransformInput — The available options for transforming an image. All transformation options are considered 'best-effort'. Any transformation that the original image type doesn’t support will be ignored.

  • Localization — Information about the localized experiences configured for the shop.

  • MailingAddress — Represents a mailing address for customers and shipping.

  • MailingAddressInput — Specifies the fields accepted to create or update a mailing address.

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

  • MetafieldParentResource — A resource that the metafield belongs to.

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

  • MetafieldValueType — Metafield value types.

  • MoneyInput — Specifies the fields for a monetary value with currency.

  • MoneyV2 — A monetary value with currency.

  • Node — An object with an ID field to support global identification, in accordance with the Relay specification. This interface is used by the node and nodes queries.

  • OnlineStorePublishable — Represents a resource that can be published to the Online Store sales channel.

  • QueryRoot — The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start.

  • SEO — SEO information.

  • UnitSystem — Systems of weights and measures.

  • WeightUnit — Units of measurement for weight.