StockInfo
Was this helpful?
Was this helpful?
StockInfo
Get store specific information about a product.
StoreProductDetails contains accumulated values for all warehouses the store owns and has VIEW access to.
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to a Product.
^[A-Za-z0-9-_]+StoreProductResponseSchema
Store Product Response
Lists warehouses with available stock that the specified store has access to.
The list will only contain warehouses that the store has "VIEW" access to.
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to a Product.
^[A-Za-z0-9-_]+Reference to a specific page in a result set.
The number of items per page in a result set.
Defines which field the resource list is sorted by.
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
Filter by warehouse uid
Example response
Lists all stock on a warehouse. Use the Accept header to choose the response format
Available formats: json, PDF and spreadsheet (excel file).
Reference to a Warehouse.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a specific page in a result set.
The number of items per page in a result set.
Defines which field the resource list is sorted by.
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
Reference to a list of productGroup Ids.
Reference to a list of brand Ids.
Example response
Returns stock for a particular product in the specified warehouse.
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to a Warehouse.
^[A-Za-z0-9-_]+Reference to a Product.
^[A-Za-z0-9-_]+Example response
Get product stock for one or several products. The result can be limited to only specific stores and warehouses.
Usage:
productUids OR productSkus is required. An error is returned if both fields are present in request.
storeUids OR warehouseUids is required. An error is returned if both fields are present in request.
Returns stock records for all warehouses in request or all warehouses for all stores in request.
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a specific page in a result set.
The number of items per page in a result set.
Get stock records for a store.
If no warehouseUids in request, the response contains stock records for all warehouses the storeUid in url has VIEW access to.
Else, the storeUid in url MUST have VIEW access all warehosueUids in request.
Returns stock records for all warehouses a store has VIEW asscess to.
Reference to a Store.
^[A-Za-z0-9-_]+Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a specific page in a result set.
The number of items per page in a result set.
Searches for products based on criteria set in the request body.
Returns a response with the stores price and stock availablitity.
If productGroupUid is set, productGroupScopes is omitted.
StoreProductDetails contains accumulated values for all warehouses the store owns and has VIEW access to.
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to a specific page in a result set.
The number of items per page in a result set.
Defines which field the resource list is sorted by.
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
A list of product group UIDs that you want to include in the search
| ENUM | Description |
|---|---|
| SALE | Sale product scope. Default |
| SERVICE | Service product scope |
| NO_SEARCH | Not visible in search scope |
^[A-Za-z0-9-_]+A list of product UIDs to search for
Filter on product visibility
| ENUM | Description |
|---|---|
| STOCK | Price*quantity |
| NO_STOCK | No quantity |
| CONFIGURABLE | Master configurable product |
| FLOWGIFTCARD | Flow Giftcard product |
| NON_PHYSICAL | Non physical product |
| PACKAGE_FIXED | Packaged product with fixed content |
| PACKAGE_DYNAMIC | Packaged product with dynamic content |
If true, returns only products with stocklevel > 0
when true, only show products with allowPurchase = true
Product Store Search Response
The request contains two quantity fields quantity and changeQuantity.
Both may not be set in the same entry.
Use quantity to set a new total stock for the product.
Use changeQuantity to adjust the product's stock by a positive or negative number to
increase or decrease stock.
Use averageCost to perform new calculation of stock average cost.
At least one of these three fields must be set on each entry.
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to a Warehouse.
^[A-Za-z0-9-_]+Reference to a Product.
^[A-Za-z0-9-_]+set new average cost
set new stock quantity
make stock adjustment
Array of strings to identify serial numbers for the quantity in stock. Length of array must match the quantity value. This field is required when product has serialNoRequired = "ON_RECEIVE"
Example response