API documentation
Method list
Test your request
Changelog


getInventoryDocumentItems
This method allows you to retrieve document items for specific or for all inventory documents in BaseLinker. In case of a large number of items, pagination is possible.


Input parameters
document_idintInventory document ID.
pageint(optional) Page number of the results if there are many items in a document (100 items per page).



Output data
The method returns the data in JSON format.
statusvarchar(30)SUCCESS - request executed correctly
ERROR - an error occurred during an API request. Error details will be described in 2 additional returned fields: error_message and error_code
itemsarrayList of document items. Each element in the array has the fields below.
| - document_idintThe ID of the document to which this item belongs.
| - item_idintThe main identifier of the document item.
| - positionintThe line item number within the document.
| - product_idintThe product ID.
| - product_namevarchar(200)The product name as copied at the time of document creation.
| - product_eanvarchar(32)The product EAN.
| - product_skuvarchar(50)The product SKU.
| - quantityintThe quantity of this line item in the document.
| - pricedecimal(10,2)The unit price.
| - total_pricedecimal(10,2)The total value of the item.
| - inventory_idintThe catalog ID, if applicable.
| - location_namevarchar(255)The location (location column).
| - expiry_datedateThe expiry date, if relevant. Date format YYYY-MM-DD (ISO 8601)
| - batchvarchar(128)The product batch.
| - serial_novarchar(128)The product serial number.



Sample
Input data:
Output data:
A sample request in PHP: