List serial numbers

List serial numbers with their component serial numbers, optionally filtered by available attributes.

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

Serial number. Partial match.

Database ID(s) of the serial number.

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.

string | null

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

string | null

Name of the stock item. Partial match.

integer | null

ID of the product group.

string | null

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

string | null

Name of the product group. Partial match.

enum

Status of serial number. One value or a list, for example ?status=10 or ?status[]=10&status[]=20.


  • 10 - Planned
  • 20 - Received
  • 30 - Consumed
  • 40 - Shipped
  • 50 - Written off
  • 60 - Returned
  • 70 - RMA
  • 80 - Rejected
integer | null

ID of serial number's stock lot.

string | null

Unique code of serial number's stock lot. Partial match.

integer | null

Database ID of the customer associated with the customer order or RMA order.

string | null

Customer number associated with the customer order or RMA order. Partial match.

string | null

Name of the customer associated with the customer order or RMA order. Partial match.

integer | null

ID of site where the serial number is located.

integer | null

Database ID of the customer order.

string | null

Customer order number. Partial match.

integer | null

Database ID of the RMA order the serial number's stock lot was received in.

string | null

Number of the RMA order the serial number's stock lot was received in. Partial match.

integer | null

Minimum customer order creation date as UNIX timestamp. The whole of that day is covered.

integer | null

Maximum customer order creation date as UNIX timestamp. The whole of that day is covered.

string | null

Minimum cost per unit of the serial number's stock lot.

string | null

Maximum cost per unit of the serial number's stock lot.

custom_values
array of objects | null

Conditions on custom fields of the serial number. 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