Skip to navigation

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, and availableForBackorder on both the Aggregated and AggregatedInventory types.
    • Inventory settings: showQuantityOnBackorder, showQuantityOnHand, showBackorderMessage, showBackorderAvailabilityPrompt, backorderAvailabilityPrompt, showDefaultShippingExpectationPrompt, and defaultShippingExpectationPrompt on InventorySettings, plus backorderMessage on InventoryByLocations.
    • Cart items: stockPosition on CartDigitalItem and CartPhysicalItem.
    • Orders: backorderShippingExpectationMessage on the BaseOrder interface (and therefore on Order and OrderWithPayments), plus backorderedQuantity and backorderMessage on OrderPhysicalLineItem.

Admin GraphQL

  • Backorder message management: a new inventory field on the Store and Mutation types exposes backorder messages.
    • Query: Store.inventory.backorderMessages returns the store’s backorder messages, filterable by ID or name through GetBackorderMessagesFiltersInput.
    • Mutations: Mutation.inventory provides createBackorderMessages, updateBackorderMessages, and deleteBackorderMessages.
    • Type: the new BackorderMessage type exposes id, name, message, isDefault, createdAt, and updatedAt.
  • Product backorder inventory fields: new backorderLimit and qtyBackordered fields on the AggregatedProductInventory and AggregatedProductVariantInventory types.
  • New currency code: the CurrencyCode enum adds XCG (Caribbean guilder).

Account GraphQL

  • New currency code: the CurrencyCode enum adds XCG (Caribbean guilder).

For schema details, browse the Storefront GraphQL API reference, Admin GraphQL API reference, and Account GraphQL API reference.