Inventory commands and pipelines

Version: 10.3

The following table describes the inventory commands and pipelines:

Command/Pipeline

Description

AssociateSellableItemToInventorySetCommand

AssociateSellableItemToInventorySetPipeline

Associates a sellable item to a specified inventory set.

Parameters:

  • sellableItemId: identifier of the sellable item

  • variationId: identifier of the sellable item variant

  • inventorySetId: identifier for the inventory set

  • entityView: entity view

CreateInventorySetCommand

CreateInventorySetPipeline

Creates a new instance of an inventory set.

Parameters:

  • name: name of the inventory set

  • displayName: display name of the inventory set

  • description: description of the inventory set

DisassociateSellableItemFromInventorySetCommand

DisassociateSellableItemFromInventorySetPipeline

Removes the association between a sellable item and an inventory set.

Parameters:

  • sellableItemId: identifier of the sellable item

  • variationId: identifier of the sellable item variant

  • inventorySetId: identifier for the inventory set

EditInventoryInformationCommand

EditInventoryInformationPipeline

Modifies the inventory information for a sellable item.

Parameters:

  • sellableItemId: identifier of the sellable item

  • variationId: identifier of the sellable item variant

  • inventorySetId: identifier for the inventory set

  • entityView: entity view

EditInventorySetCommand

EditInventorySetPipeline

Modifies the information for a specific inventory set.

Parameters:

  • inventorySet: name of the inventory set

  • displayName: new display name of the inventory set

  • description: new description of the inventory set

GetInventorySetCommand

Retrieves a specific inventory set.

Parameters:

  • inventorySetId: identifier of the inventory set

GetInventorySetsCommand

Retrieves all inventory sets in the system.

Parameters: none

TransferInventoryCommand

TransferInventoryPipeline

Moves the association of a sellable item from one inventory set to another inventory set.

Parameters:

  • sourceInventorySetId: identifier for the inventory set from which the sellable item is being moved

  • targetInventorySetId: identifier for the inventory set to which the sellable item is being moved

  • sellableItemId: identifier for the sellable item

  • variationId: identifier for the sellable item variant

  • quantity: the number of sellable items to move to the target inventory set

Do you have some feedback for us?

If you have suggestions for improving this article,