2 augustus 2024
Get list of stocks
GET
https://api.pack.cloud/v1/organizations/{organizationId}/stocks
Request
Path parameters
organizationIdstring
Query parameters
filter[product_id]string
filter[warehouse_id]string
includearray
Allowed values:locatableproductwarehouse
Response
OK
Body
idstring
ID of the stock
warehouse_idstring
ID of the warehouse that manages the stock
locatable_idstringnull
ID of the locatable
locatable_typestringnull
Type of the locatable
Allowed values:binpickliststock_location
product_idstring
ID of the product
quantity_allocatedinteger
Quantity allocated to fulfillments
quantity_on_handinteger
Quantity currently on hand
quantity_availableinteger
Quantity available
expiry_datestringnull
Expire date of perishable products
lot_numberstringnull
Lot number perishable products
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
prevstringnull
Link to previous page
nextstringnull
Link to next page
per_pageinteger
Item count per page
Example:25
OK
Body
idstring
ID of the stock
warehouse_idstring
ID of the warehouse that manages the stock
locatable_idstringnull
ID of the locatable
locatable_typestringnull
Type of the locatable
Allowed values:binpickliststock_location
product_idstring
ID of the product
quantity_allocatedinteger
Quantity allocated to fulfillments
quantity_on_handinteger
Quantity currently on hand
quantity_availableinteger
Quantity available
expiry_datestringnull
Expire date of perishable products
lot_numberstringnull
Lot number perishable products
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
prevstringnull
Link to previous page
nextstringnull
Link to next page
per_pageinteger
Item count per page
Example:25
OK
Body
idstring
ID of the stock
warehouse_idstring
ID of the warehouse that manages the stock
locatable_idstringnull
ID of the locatable
locatable_typestringnull
Type of the locatable
Allowed values:binpickliststock_location
product_idstring
ID of the product
quantity_allocatedinteger
Quantity allocated to fulfillments
quantity_on_handinteger
Quantity currently on hand
quantity_availableinteger
Quantity available
expiry_datestringnull
Expire date of perishable products
lot_numberstringnull
Lot number perishable products
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
prevstringnull
Link to previous page
nextstringnull
Link to next page
per_pageinteger
Item count per page
Example:25
OK
Body
idstring
ID of the stock
warehouse_idstring
ID of the warehouse that manages the stock
locatable_idstringnull
ID of the locatable
locatable_typestringnull
Type of the locatable
Allowed values:binpickliststock_location
product_idstring
ID of the product
quantity_allocatedinteger
Quantity allocated to fulfillments
quantity_on_handinteger
Quantity currently on hand
quantity_availableinteger
Quantity available
expiry_datestringnull
Expire date of perishable products
lot_numberstringnull
Lot number perishable products
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
prevstringnull
Link to previous page
nextstringnull
Link to next page
per_pageinteger
Item count per page
Example:25
OK
Body
idstring
ID of the stock
warehouse_idstring
ID of the warehouse that manages the stock
locatable_idstringnull
ID of the locatable
locatable_typestringnull
Type of the locatable
Allowed values:binpickliststock_location
product_idstring
ID of the product
quantity_allocatedinteger
Quantity allocated to fulfillments
quantity_on_handinteger
Quantity currently on hand
quantity_availableinteger
Quantity available
expiry_datestringnull
Expire date of perishable products
lot_numberstringnull
Lot number perishable products
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
prevstringnull
Link to previous page
nextstringnull
Link to next page
per_pageinteger
Item count per page
Example:25