API Reference
  1. MRPeasy REST API
  2. Serial numbers

List serial numbers

get
https://api.mrpeasy.com/rest/v1/serials
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Serial number.

integer

Database ID of the serial number.

integer

Database ID of the stock item.

If Matrix BOM is turned on, this is unique for each variation.

integer

Database product ID.

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

string

A unique number to identify the stock item. Internally mapped to product_code.

string

Name of the stock item. Internally mapped to product_title.

integer

ID of the product group.

string

A unique number to identify the product group. Internally mapped to article_group_code.

string

Name of the product group. Internally mapped to article_group_title.

status
array of objects

Status of serial number.

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

Arrays are supported, for example ?status[]=10&status[]=20.

status
integer

ID of serial number's stock lot.

string

Unique code of serial number's stock lot.

integer

If the item with this serial number has been shipped, show the database ID of the customer.

string

If the item with this serial number has been shipped, show the customer number.

string

If the item with this serial number has been shipped, show the customer name.

integer

ID of site where this serial number is located.

integer

If the item with this serial number has been shipped, show the database ID of the customer order.

string

If the item with this serial number has been shipped, show the customer order number.

integer

If the item with this serial number was received in RMA order, show the database ID of the RMA order.

string

If the item with this serial number was received in RMA order, show the RMA order number.

integer

Minimum customer order creation timestamp (Unix timestamp).

integer

Maximum customer order creation timestamp (Unix timestamp).

number

Minimum stock item price.

number

Maximum stock item price.

Headers
string

Pagination range (e.g., items=0-99, items=200-249)

Responses

429

Rate limited - another request is running

Updated 4 months ago

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

Updated 4 months ago

Did this page help you?