Important

This feature is currently in Early Availability (EA) status. For more information, see GraphQL API policy.

Inventory

The GraphQL API supports an Inventory system that can track the stock of an edition of a physical product.

The product provider can use Inventory mutations to push inventory information about a product edition to the marketplace. This Inventory information is associated with the matching product edition through the edition code. Marketplace owners can configure the marketplace to verify the amount of a product edition that is currently in stock whenever a buyer attempts to place a new order for that edition, and to specify whether the order should be blocked if there are not enough units in stock to fill the order.

Inventory for a physical product edition is optional: physical products on a marketplace are not required to have an associated Inventory.

Prerequisites

To use the Inventory APIs, you must meet the following prerequisites:

• You must have shipping enabled on your marketplace.

  If you do not have shipping enabled on your marketplace, contact your AppDirect technical representative.

• A product that has an Inventory must be a physical product that is configured for shipping and for purchase fulfillment.

  For more information, see the topics on configuring shipping and fulfilling purchases.

• The product provider must have an API client with Developer access.

  This allows the product provider to use the updateInventory mutation to keep the Inventory up to date.