10.3
  1. Availability service

Availability commands and pipelines

The Availability service does not have externally exposed Service APIs. Availability is supported by extending existing pipelines.

The following table describes the availability commands and pipelines:

Command/PipelineDescription
UpdateItemAvailabilityCommand

UpdateItemAvailabilityPipeline
Provides the ability to update availability on an item. This is performed during the sale of a product, through integration to reduce the inventory count in an external inventory system.

Parameters:

  • catalogName: name of the catalog of an item (string)
  • productid : the product identifier (string)
  • variantId: the product variant identifier (string)
  • deltaQuantity: the quantity to reduce the inventory by, or increase it in the event of a canceled order (decimal)
If you have suggestions for improving this article, let us know!