Inventory - Weevio Cloud

Read and query PIMS inventory items. All endpoints require the standard PIMS Open API authentication and a teamID parameter. Inventory fields use raw PIMS column names (for example PART_CODE, BARCODE).

Get a single inventory item

GET /tenant/api/pims/v1/inventory/single

Retrieves one inventory item by PIMS Part Code.

Parameter	Required	Description
`teamID`	Yes	Your tenant identifier.
`partCode`	Yes	The PIMS `PART_CODE` to look up.

curl -s -u 'YOUR_API_ID:YOUR_API_SECRET' \
  'https://cloud.weevio.co/tenant/api/pims/v1/inventory/single' \
  --get \
  --data-urlencode 'teamID=<YOUR-TEAM-ID>' \
  --data-urlencode 'partCode=MDVQ4LL/A'

Note:

The fields shown below are representative — the exact set returned depends on your PIMS configuration. The status / data / subRecords envelope is always present.

{
  "status": "success",
  "data": {
    "PART_CODE": "MDVQ4LL/A",
    "PART_DESCRIPTION": "iPhone 14 Pro",
    "BARCODE": "190199000000",
    "QTY_ONHAND": "45",
    "QTY_AVAILABLE": "42"
  },
  "subRecords": null
}

Query a list of inventory items

POST /tenant/api/pims/v1/inventory/query

Returns inventory items matching a set of filters. The request body is an array of filter objects.

Parameter	Required	Description
`teamID`	Yes	Your tenant identifier (query param).
`maxReturn`	No	Maximum number of records to return (query param), for example `10`.

Each filter object:

Field	Required	Description
`field`	Yes	A PIMS inventory field name to match against (see below).
`value`	Yes	The value to match.
`contains`	No	`true` for a substring match, `false` (default) for an exact match.
`conjunction`	No	`"AND"` or `"OR"` — how this filter combines with the previous one. Omit on the first filter.

Common queryable inventory fields include PART_CODE, PART_DESCRIPTION, BARCODE. Any PIMS INVENTORY table field name may be used.

curl -s -u 'YOUR_API_ID:YOUR_API_SECRET' \
  'https://cloud.weevio.co/tenant/api/pims/v1/inventory/query?teamID=<YOUR-TEAM-ID>&maxReturn=10' \
  -H 'Content-Type: application/json' \
  --data '[
    { "field": "PART_CODE", "value": "MDVQ4LL/A", "contains": false },
    { "field": "BARCODE", "value": "190199000000", "contains": false, "conjunction": "AND" }
  ]'

{
  "status": "success",
  "data": [
    { "PART_CODE": "MDVQ4LL/A", "PART_DESCRIPTION": "iPhone 14 Pro", "QTY_ONHAND": "45" }
  ],
  "subRecords": null
}

The data array is empty when nothing matches.

Errors

Status	When
`400`	The `teamID` parameter is missing, or PIMS rejected the request (the body carries the underlying message).
`401`	The API ID or API Secret is missing or invalid.

Need Help?

For assistance, please send a message to our Support page.

Customers Orders