Products in Inventory Management Document: Overview of Methods
The methods catalog.document.element.* add, modify, or remove product items in inventory management documents. You can specify the quantity and purchase price of the product, as well as the warehouse for receipt or write-off.
Quick navigation: all methods
Connection with Other Objects
Inventory Management Documents. Specify the document ID in the docId field to process:
- product receipt to the warehouse,
- stock adjustment of the product,
- transfer of the product between warehouses,
- product return,
- write-off of the product from the warehouse.
To obtain the document ID, use the catalog.document.list method. Changes to the list of product items can only be made in a document that has not yet been processed.
Catalog Products. Specify the ID of the simple product or variation in the elementId field.
Services are not supported in inventory management.
To obtain product IDs, use the methods:
- catalog.product.list for simple products,
- catalog.product.offer.list for variations.
Warehouses. Specify the ID of the receipt warehouse in the storeTo field or the write-off warehouse in the storeFrom field. Choose the field depending on the type of inventory management document:
- receipt —
storeTo, - stock adjustment —
storeTo, - transfer —
storeToandstoreFrom, - return —
storeFrom, - write-off —
storeFrom.
To obtain warehouse IDs, use the catalog.store.list method.
Overview of Methods
Scope:
catalogWho can perform the methods: depending on the method
|
Method |
Description |
|
Adds a product item to the inventory management document |
|
|
Modifies an existing product item in the inventory management document |
|
|
Returns product items of documents by filter |
|
|
Removes a product item from the document before processing |
|
|
Returns the description of product fields from the inventory management document |