InventoryProduct stock

Get Many Product Stocks

Get multiple product stock records with filtering and pagination

GET
/shipos/product-stock
x-access-token<token>

In: header

Query Parameters

page?number

Page number for pagination (starting from 0)

Formatdouble
Default0
limit?number

Number of items per page

Formatdouble
Default20
search?string

Search term to filter by product name, SKU, location name, or lot code

Default""
order_by?string

Field to order results by

Default"created_at"

Value in

  • "created_at"
  • "updated_at"
  • "on_hand"
  • "expiration_date"
order?string

Order direction

Value in

  • "asc"
  • "desc"
warehouse_id?string

Filter by warehouse IDs (comma-separated for multiple)

Default""
product_id?string

Filter by product IDs (comma-separated for multiple)

Default""
location_id?string

Filter by location IDs (comma-separated for multiple)

Default""
product_type?string

Filter by product types (comma-separated for multiple)

Default""
on_hand_min?number

Filter for items with on_hand greater than or equal to this value

Formatdouble
Defaultnull
on_hand_max?number

Filter for items with on_hand less than or equal to this value

Formatdouble
Defaultnull

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/shipos/product-stock"
{  "data": [    {      "uom_label": "string",      "uom_multiplier_to_eaches": 0,      "uom_profile_id": "string",      "location_kind": "STATIC",      "location_pickable": true,      "location_sellable": true,      "parent_location_name": "string",      "location_name": "string",      "product_type": "STANDARD",      "image_url": "string",      "sku": "string",      "name": "string",      "warehouse_name": "string",      "warehouse_id": "string",      "team_id": "string",      "merchant_team_id": "string",      "fulfiller_team_id": "string",      "location_id": "string",      "product_id": "string",      "created_at": "2019-08-24T14:15:22Z",      "received_at": "2019-08-24T14:15:22Z",      "expiration_date": "2019-08-24T14:15:22Z",      "lot_code": "string",      "updated_at": "2019-08-24T14:15:22Z",      "on_hand": 0.1,      "id": "string",      "supported_actions": [        {          "action": "VIEW_PRODUCT"        }      ]    }  ],  "meta": {    "page": 0.1,    "page_size": 0.1,    "has_next_page": true,    "has_previous_page": true,    "start_index": 0.1,    "end_index": 0.1  }}