stack

Home > @infiniteobjects/shopify-data-manager > AdminTypes > ApiVersion

AdminTypes.ApiVersion interface

A version of the API, as defined by [Shopify API versioning](https://shopify.dev/api/usage/versioning). Versions are commonly referred to by their handle (for example, 2021-10).

Signature:

export interface ApiVersion 

Properties

Property Modifiers Type Description
displayName   Scalars[‘String’][‘output’] The human-readable name of the version.
handle   Scalars[‘String’][‘output’] The unique identifier of an ApiVersion. All supported API versions have a date-based (YYYY-MM) or unstable handle.
supported   Scalars[‘Boolean’][‘output’] 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](https://shopify.dev/api/usage/versioning).