Common APIs

Common Storefront API objects.

In this section

  • ApiVersion — A version of the API.

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

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

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

  • CurrencyCode — Currency codes.

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

  • Domain — Represents a web address.

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

  • Image — Represents an image resource.

  • ImageContentType — List of supported image content types.

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

  • MetafieldValueType — Metafield value types.

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

  • MoneyV2 — A monetary value with currency. To format currencies, combine this type’s amount and currencyCode fields with your client’s locale. For example, in JavaScript you could use Intl.NumberFormat: js new Intl.NumberFormat(locale, { style: ’currency’, currency: currencyCode }).format(amount); Other formatting libraries include: * iOS - NumberFormatter * Android - NumberFormat * PHP - NumberFormatter For a more general solution, the [Unicode CLDR number formatting database] is available with many implementations (such as TwitterCldr).

  • Node — An object with an ID to support global identification.

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

  • WeightUnit — Units of measurement for weight.