Deprecate Market Currency Update, Add Detailed Errors and Mandate Types

8/23/2025, 12:01:09 AM

The mutation marketCurrencySettingsUpdate has been deprecated and will be removed in a future release; developers should now use marketCreate for creating a market and marketUpdate for updating its currency settings. A new error type CollectionReorderProductsUserError replaces the generic UserError in the CollectionReorderProductsPayload, providing a more specific error code TOO_MANY_ATTEMPTS_TO_REORDER_PRODUCTS. The CustomerPaymentMethod type now includes a resourceId and a resourceType (MandateResourceType enum) to represent the specific resource the payment method was created for (e.g., Order, Subscriptions). The MandateResourceType enum lists supported resource types: CARD_ON_FILE, CHECKOUT, DRAFT_ORDER, ORDER, and SUBSCRIPTIONS. The MarketUserErrorCode enum gains three new values – PROVINCE_DOES_NOT_EXIST, MISSING_PROVINCE_CODE, and INVALID_PROVINCE_FORMAT – to signal province‑related validation issues. The SubscriptionBillingAttemptErrorCode enum is extended with PAYMENT_METHOD_NOT_SPECIFIED to indicate missing payment methods during billing attempts. Existing queries remain unchanged, but developers should adjust mutations and error handling to align with these new types and deprecations.

Mutation Changes

🔄 Modified Mutations (1)

marketCurrencySettingsUpdate

Updates currency settings of a market.

⚠️ Deprecated: This will be removed in a future version. Use `marketCreate` and `marketUpdate` for creating and updating market currency settings, respectively.

Type Changes

➕ Added Types (3)

🏗️CollectionReorderProductsUserError➕ AddedOBJECT

Errors related to order customer removal.

Fields: code, field, message
📋CollectionReorderProductsUserErrorCode➕ AddedENUM

Possible error codes that can be returned by CollectionReorderProductsUserError.

Values: TOO_MANY_ATTEMPTS_TO_REORDER_PRODUCTS
📋MandateResourceType➕ AddedENUM

The type of resource a payment mandate can be used for.

Values: CARD_ON_FILE, CHECKOUT, DRAFT_ORDER, ORDER, SUBSCRIPTIONS

🔄 Modified Types (4)

🏗️CollectionReorderProductsPayload🔄 Modified
🔄 Field modified: userErrors
🏗️CustomerPaymentMethod🔄 Modified
Field added: resourceId

The ID of the resource that this payment method was created for.

Field added: resourceType

The resource type that this payment method was created for (e.g., Order, Subscriptions).

🏗️MarketUserErrorCode🔄 Modified
Enum value added: PROVINCE_DOES_NOT_EXIST
Enum value added: MISSING_PROVINCE_CODE
Enum value added: INVALID_PROVINCE_FORMAT
🏗️SubscriptionBillingAttemptErrorCode🔄 Modified
Enum value added: PAYMENT_METHOD_NOT_SPECIFIED