Breaking Changes

This page lists any backwards-incompatible changes made to the Horizon schema.

Change in registration input fields (Released on 27/10/2021)

The field “lastName” has been renamed as “surname” to make it compatible with the “surname” field returned from the “accountCreationForm” query.

Change in supersize variant (Released on 23/03/2022)

The supersize variants query has changed. The previous query has been deprecated and will be removed from the schema in 6 months. . See here

Change in add to basket mutation (Released on 13/05/2022)

There is a new mutation to add products to basket which allows adding multiple products to basket within one operation. The previous mutation has been deprecated and will be removed from the schema in 6 months. . See here

Change in addProductToBasket Basket mutation (Released on 25/05/2022)

The way Horizon calculates a product quantity inside a Basket has been changed. This means that Horizon now takes into account the quantity of a pre-existing product inside a Basket when clients attempt to add additional products using the addProductToBasket mutation. Now, given a basket containing a pre-existing product of quantity 1, calling the following mutation:

mutation AddToBasket {
    addProductToBasket(
        basketId: <BASKET ID>
        sku: <SKU OF PRE-EXISTING PRODUCT>
        quantity: 1
        settings: { currency: GBP, shippingDestination: GB }
    ) {...}
}

Will result in the basket now containing 1 product of quantity 2.

Change in product to cheapestVariantPrice field (Released on 19/07/2022)

The field cheapestVariantPrice is now deprecated and will be removed from the schema in 6 months. Please use the cheapestVariant field to access the cheapest variant price.

Deprecation of the paymentType and paymentCard fields on Order

The paymentType and paymentCard fields on the Order type have now been deprecated and will be removed from the schema in 6 months. As a replacement, we have introduced a new field, usedPaymentMethods. This field is of type List<UsedPaymentMethod>. Where UsedPaymentMethod will be defined as:

type UsedPaymentMethod {
    paymentType: String
    paymentCard: PaymentCard
    giftCard: GiftCard
    amountSpent: MoneyValue!
}

You will then be able to access the original paymentType and paymentCard fields here. Note that this will be a list of all payment methods used to purchase the respective order. So paymentType and paymentCard may be different for each payment method used. The amountSpent field will be a MoneyValue specifying how much money was used to contribute to the total cost of the product for the respective payment method.

If a Gift Card was used either partially or to fully purchase the product, then Gift Card information will be exposed via the giftCard field. Where the type GiftCard will be defined as:

type GiftCard {
cardUuid: String!
obfuscatedCardNumber: String!
}

Deprecation of the customerReturns field on Customer

The field customerReturns is now deprecated and will be removed from the schema in 6 months from 17/04/2023. It will be replaced by a paginated field called returns. This field will allow you to specify a limit and an offset which will help to speed up page load times when a user has a large number of customer returns they wish to view. Use of this field is outlined below.

type Customer {
    returns(offset: Int! = 0, limit: Int! = 10): CustomerReturns @authenticated @if(feature: ORDER_RETURNS)
}

type CustomerReturns @if(feature: ORDER_RETURNS) {
    customerReturns: [CustomerReturn!]!
    total: Int!
    hasMore: Boolean!
}