GraphQL Schema Updates
Inventory and backorder capabilities expand across the Storefront and Admin GraphQL schemas.
Storefront GraphQL
- Inventory and backorder fields: the inventory and order types now expose inventory and backorder details.
- Product inventory:
availableOnHand,unlimitedBackorder, andavailableForBackorderon both theAggregatedandAggregatedInventorytypes. - Inventory settings:
showQuantityOnBackorder,showQuantityOnHand,showBackorderMessage,showBackorderAvailabilityPrompt,backorderAvailabilityPrompt,showDefaultShippingExpectationPrompt, anddefaultShippingExpectationPromptonInventorySettings, plusbackorderMessageonInventoryByLocations. - Cart items:
stockPositiononCartDigitalItemandCartPhysicalItem. - Orders:
backorderShippingExpectationMessageon theBaseOrderinterface (and therefore onOrderandOrderWithPayments), plusbackorderedQuantityandbackorderMessageonOrderPhysicalLineItem.
- Product inventory:
Admin GraphQL
- Backorder message management: a new
inventoryfield on theStoreandMutationtypes exposes backorder messages.- Query:
Store.inventory.backorderMessagesreturns the store’s backorder messages, filterable by ID or name throughGetBackorderMessagesFiltersInput. - Mutations:
Mutation.inventoryprovidescreateBackorderMessages,updateBackorderMessages, anddeleteBackorderMessages. - Type: the new
BackorderMessagetype exposesid,name,message,isDefault,createdAt, andupdatedAt.
- Query:
- Product backorder inventory fields: new
backorderLimitandqtyBackorderedfields on theAggregatedProductInventoryandAggregatedProductVariantInventorytypes. - New currency code: the
CurrencyCodeenum addsXCG(Caribbean guilder).
Account GraphQL
- New currency code: the
CurrencyCodeenum addsXCG(Caribbean guilder).
For schema details, browse the Storefront GraphQL API reference, Admin GraphQL API reference, and Account GraphQL API reference.