GuidesAPI Reference
Log In
API Reference

List Product Lots

get
https://api.warehance.com/v1/product-lots

Required permission: read_products

Get a list of product lots for your organization or client. Filter by product_id to get the lots of one product, or by lot_number to look up a lot. Results use cursor-based pagination only. Product lots must be enabled for the organization.

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

Specifies the field by which to sort the returned product lots:

  • created_at: Sort by the creation date of the product lot.
  • updated_at: Sort by the last updated date of the product lot.
Allowed:
integer
1 to 100
Defaults to 25

The maximum number of items to return in the response. Used for pagination. Must be between 1 and 100.

string
enum
Defaults to asc

Specifies the sort direction of the returned items:

  • asc: Ascending order. For dates, this means from oldest to newest. For numbers, this means from smallest to largest.
  • desc: Descending order. For dates, this means from newest to oldest. For numbers, this means from largest to smallest.
Allowed:
integer
≥ 1

Only applicable for organizations. Filters items by the specified client_id, provided the client_id belongs to the organization. Note: API keys can belong to either client level or organization level.

string

A cursor for pagination. Omit it for the first page, then pass the next_cursor value from the previous response to fetch the next page. Keep the same filters and sort on every page. See Pagination.

integer
≥ 1

Only return lots of this product. UOM variant products share the lots of their base product, so filter by the base product's ID.

string
length ≥ 1

Only return lots with this exact lot number.

Responses

Updated about 5 hours ago

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

Updated about 5 hours ago

Did this page help you?