ShopifyApiVersion

Type

import { ShopifyApiVersion } from '@daffodil/driver/shopify'

A version of the Shopify API. Each version has a unique handle in date-based format (YYYY-MM) or unstable for the development version.

Shopify guarantees supported versions are stable. Unsupported versions include unstable and release candidate versions. Use the publicApiVersions query to retrieve all available versions. Learn more about Shopify API versioning.

interface ShopifyApiVersion {
  __typename: "ApiVersion"
  displayName: string
  handle: string
  supported: boolean
}

Properties

__typename `"ApiVersion"`

displayName `string`
The human-readable name of the version.

handle `string`
The unique identifier of an ApiVersion. All supported API versions have a date-based (YYYY-MM) or `unstable` handle.

supported `boolean`
Whether the version is actively supported by Shopify. Supported API versions are guaranteed to be stable. Unsupported API versions include unstable, release candidate, and end-of-life versions that are marked as unsupported. For more information, refer to Versioning.