Stock lots

List stock lots with their storage locations and serial numbers, optionally filtered by available attributes. Stock lots with nothing available and nothing booked are left out unless the request narrows to them, and cancelled stock lots are left out unless the request filters by lot_id, code or status.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params

Database ID of the stock lot. One value or a list, for example ?lot_id=5 or ?lot_id[]=5&lot_id[]=6. Empty and cancelled stock lots are returned when this filter is given.

integer | null

Database ID of the stock item. If Matrix BOM is turned on, this is unique for each variation.

integer | null

Database product ID. If Matrix BOM is turned on, product_id is the same at all variations of the stock item.

integer | null

ID of the product group.

integer | null

ID of site where this stock lot is located.

integer | null

ID of purchase order if this stock lot was purchased.

integer | null

ID of manufacturing order if this stock lot was produced.

integer | null

ID of transfer order if this stock lot was transferred from one site to another.

integer | null

ID of RMA order if this stock lot was received through RMA. Empty stock lots are returned when this filter is given.

string | null

A unique number to identify the stock lot. Partial match. Empty and cancelled stock lots are returned when this filter is given.

string | null

A unique number to identify the stock item. Partial match.

string | null

Name of the stock item. Partial match.

string | null

A unique number to identify the product group. Partial match.

string | null

Name of the product group. Partial match.

string | null

Revision of the stock lot. Partial match.

string | null

Number of purchase order if this stock lot was purchased. Partial match.

string | null

Number of manufacturing order if this stock lot was produced. Partial match.

string | null

Number of transfer order if this stock lot was transferred from one site to another. Partial match.

string | null

Number of RMA order if this stock lot was received through RMA. Partial match. Empty stock lots are returned when this filter is given.

enum

Status of the stock lot. One value or a list, for example ?status=10 or ?status[]=10&status[]=20. Empty and cancelled stock lots are returned when this filter is given.


  • 5 - Requested
  • 10 - Planned
  • 15 - On hold
  • 20 - Received
  • 25 - Rejected
  • 30 - Cancelled
  • 100 - RMA waiting for inspection
  • 105 - RMA waiting for repair
  • 110 - RMA ready for shipment
  • 115 - RMA returned
integer | null
enum

Source type of the stock lot.

  • 10 - Manual lot
  • 20 - Manufacturing order
  • 30 - Purchase order
  • 40 - Transfer order
  • 50 - RMA order
Allowed:
string | null

Minimum initial quantity of stock lot. Empty stock lots are returned when this filter is given.

string | null

Maximum initial quantity of stock lot.

string | null

Minimum quantity of stock items that are available for booking. Empty stock lots are returned when this filter is given.

string | null

Maximum quantity of stock items that are available for booking.

string | null

Minimum quantity of stock items that are booked. Empty stock lots are returned when this filter is given.

string | null

Maximum quantity of stock items that are booked.

string | null

Minimum cost per one stock item.

string | null

Maximum cost per one stock item.

string | null

Minimum total cost of stock lot.

string | null

Maximum total cost of stock lot.

integer | null

Minimum creation timestamp (UNIX timestamp).

integer | null

Maximum creation timestamp (UNIX timestamp). The whole of that day is covered.

integer | null

Minimum availability timestamp (UNIX timestamp).

integer | null

Maximum availability timestamp (UNIX timestamp). The whole of that day is covered.

integer | null

Minimum expiry date as UNIX timestamp.

integer | null

Maximum expiry date as UNIX timestamp. The whole of that day is covered.

custom_values
array of objects | null

Conditions on custom fields of the stock lot or of its product. All of them must hold. Example for a text field: ?custom_values[0][field_id]=1&custom_values[0][value]=abc. Replace 1 with your custom field ID; use indices 0, 1, etc. for separate conditions.

custom_values
integer

Maximum number of records to return (1–1000).

integer

Number of records to skip for pagination.

Responses

401

Unauthorized

413

Content Too Large - please use smaller ´limit´

429

Too many requests

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json