Inventory

List Inventory

List the caller's inventory rows. Filters are AND-combined.

get/v1/inventory/

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/v1/inventory/
  • Auth: HTTP bearer

Query parameters

status'owned' | 'wanted' | 'for_sale' | 'sold' | 'discarded'

Filter by lifecycle status.

product_idinteger nullable

Filter to rows linked to this Partle product.

projectstring nullable

Filter by project tag (exact match).

qstring nullable

Substring match on name and notes (case-insensitive).

limitinteger
offsetinteger

Headers

X-API-Keystring nullable

Response

Successful Response

idinteger required
user_idinteger required
product_idinteger nullable
status'owned' | 'wanted' | 'for_sale' | 'sold' | 'discarded' required
namestring nullable
quantitystring required
notesstring nullable
acquisition_pricestring nullable
acquisition_currencystring nullable
purchased_atstring date-time nullable
asking_pricestring nullable
asking_currencystring nullable
conditionstring nullable
external_linkstring nullable
external_idstring nullable
projectstring nullable
recipient_idinteger nullable
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.