ApiVersion object

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

Fields

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

Types that return ApiVersion

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

Fields

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

Types that return ApiVersion

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

Fields

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

Types that return ApiVersion

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

Fields

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

Types that return ApiVersion

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

Fields

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

Types that return ApiVersion

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

Fields

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

Types that return ApiVersion