Inventory management in the Trade Catalog: Overview of Methods

Inventory management is a tool that allows you to track the available and reserved quantity of products in warehouses.

To add, move, or remove products from the inventory, use inventory management documents.

Quick navigation: all methods

User documentation:

Inventory Management Documents

The following types of documents are available in inventory management:

  • A – stock receipt of products,
  • S – stock adjustment of products,
  • M – transfer of products between warehouses,
  • R – return of products,
  • D – write-off of products.

Set access permissions for each type of document. If access permissions are not configured, an employee will see an error when trying to open inventory management documents and will not be able to work with them.

Connection of Inventory Management Documents with Other Objects

Products of the inventory management document. Specify products for the inventory management document using the methods catalog.document.element.*.

Warehouses. Specify the warehouse for which you are creating the inventory management document. Use the methods catalog.store.*.

Custom fields of inventory management documents. You can create additional fields for inventory management documents using the method userfieldconfig.add, where moduleId — catalog, and entityId — CAT_STORE_DOCUMENT_DocumentTypeIdentifier. To view additional fields or change their values, use the methods catalog.userfield.document.*.

Overview of Methods

Scope: catalog

Who can execute methods: administrator

Main

Method

Description

catalog.document.mode.status

Checks if inventory management is enabled

catalog.document.add

Adds an inventory management document

catalog.document.conduct

Conducts an inventory management document

catalog.document.conductList

Conducts a group of inventory management documents

catalog.document.cancel

Cancels the conduct of an inventory management document by its identifier

catalog.document.cancelList

Cancels the conduct of a group of inventory management documents

catalog.document.update

Modifies an inventory management document

catalog.document.list

Returns a list of inventory management documents

catalog.document.delete

Deletes an inventory management document

catalog.document.deleteList

Deletes a group of inventory management documents

catalog.document.getFields

Returns available fields of the inventory management document

Products of the Inventory Management Document

Method

Description

catalog.document.element.add

Adds a product to the inventory management document

catalog.document.element.update

Modifies a product in the inventory management document

catalog.document.element.list

Returns a list of products in the inventory management document

catalog.document.element.delete

Deletes a product from the inventory management document

catalog.document.element.getFields

Returns a list of available fields for products in the inventory management document