Enum ApiVersion 

pub enum ApiVersion {
    V2024_01,
    V2024_04,
    V2024_07,
    V2024_10,
    V2025_01,
    V2025_04,
    V2025_07,
    V2025_10,
    V2026_01,
    Unstable,
    Custom(String),
}

Shopify API version.

Shopify releases new API versions quarterly (January, April, July, October). This enum provides variants for known stable versions, plus an Unstable variant for development and a Custom variant for future versions.

Example

use shopify_sdk::ApiVersion;

// Use the latest stable version
let version = ApiVersion::latest();
assert!(version.is_stable());

// Parse from string
let version: ApiVersion = "2024-10".parse().unwrap();
assert_eq!(version, ApiVersion::V2024_10);

// Display as string
assert_eq!(format!("{}", ApiVersion::V2024_10), "2024-10");

Variants

V2024_01

API version 2024-01 (January 2024)

V2024_04

API version 2024-04 (April 2024)

V2024_07

API version 2024-07 (July 2024)

V2024_10

API version 2024-10 (October 2024)

V2025_01

API version 2025-01 (January 2025)

V2025_04

API version 2025-04 (April 2025)

V2025_07

API version 2025-07 (July 2025)

V2025_10

API version 2025-10 (October 2025)

V2026_01

API version 2026-01 (January 2026)

Unstable

Unstable API version for development and testing.

Custom(String)

Custom version string for future or unrecognized versions.

Implementations

impl ApiVersion

pub const fn latest() -> Self

Returns the latest stable API version.

This should be updated when new stable versions are released.

pub const fn is_stable(&self) -> bool

Returns true if this is a known stable API version.

Returns false for Unstable and Custom variants.

pub fn supported_versions() -> Vec<Self>

Returns all supported stable versions in chronological order.

This includes versions within Shopify’s approximately 12-month support window. Versions are ordered from oldest to newest.

Example

use shopify_api::ApiVersion;

let versions = ApiVersion::supported_versions();
assert!(!versions.is_empty());
assert!(versions.contains(&ApiVersion::latest()));

pub const fn minimum_supported() -> Self

Returns the oldest supported API version.

This represents the minimum version within Shopify’s support window (approximately 12 months). Versions older than this are considered deprecated and may stop working at any time.

Example

use shopify_api::ApiVersion;

let minimum = ApiVersion::minimum_supported();
assert!(minimum.is_supported());

pub fn is_supported(&self) -> bool

Returns true if this version is within Shopify’s support window.

Supported versions include:

• All stable versions from [minimum_supported()] onwards
• The Unstable version (always supported for development)
• Custom versions (assumed supported as they may be newer versions)

Example

use shopify_api::ApiVersion;

assert!(ApiVersion::V2025_10.is_supported());
assert!(ApiVersion::Unstable.is_supported());
assert!(!ApiVersion::V2024_01.is_supported());

pub fn is_deprecated(&self) -> bool

Returns true if this version is past Shopify’s support window.

Deprecated versions are older than [minimum_supported()] and may stop working at any time. You should upgrade to a supported version.

Note: Unstable and Custom versions are never considered deprecated.

Example

use shopify_api::ApiVersion;

assert!(ApiVersion::V2024_01.is_deprecated());
assert!(!ApiVersion::V2025_10.is_deprecated());
assert!(!ApiVersion::Unstable.is_deprecated());

Trait Implementations

impl Clone for ApiVersion

fn clone(&self) -> ApiVersion

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ApiVersion

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for ApiVersion

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromStr for ApiVersion

type Err = ConfigError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for ApiVersion

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ApiVersion

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ApiVersion

fn eq(&self, other: &ApiVersion) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ApiVersion

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for ApiVersion

impl StructuralPartialEq for ApiVersion