set-low-stock-level.md

Set or update low stock level

The following describes endpoints for setting or updating low stock threshold levels and stock alert settings for products and variants in a specific location.

Prerequisites

• Authorization setup with the correct scope, and a valid authorization token. See How inventories work.
• The location UUID for the target location. See Fetch inventory locations.
• The product/variant UUIDs for the products/variants to be updated. See Fetch products.

Update low stock level and alert for a product

Saves a low stock level and the low stock alerts setting for exactly one product/variant in a specific location. The product and variant UUIDs are defined in the request body.

You can enable stock alerts without setting a custom low stock level. To do this, the client can send a request without the lowStockLevel property, or with the property set to null or undefined.

PUT /custom-low-stock/locations/{locationUuid}

Example: This example updates the custom low stock level to 10 and sets stock alerts to true for product_uuid de71da94-5cb4-11ec-bf63-0242ac130002, and variant_uuid e58d826a-5cb4-11ec-bf63-0242ac130002, for location_uuid f2e4d45e-5cb4-11ec-bf63-0242ac130002.

Request

PUT /custom-low-stock/locations/f2e4d45e-5cb4-11ec-bf63-0242ac130002

{
  "productUuid": "de71da94-5cb4-11ec-bf63-0242ac130002",
  "variantUuid": "e58d826a-5cb4-11ec-bf63-0242ac130002",
  "lowStockLevel": 10
  "lowStockAlert": true
}

Response

No response body is returned, only a status code of 204 - No Content.

Note: The Zettle clients (apps and back office) use caching. Therefore, it can take some time until they sync with the backend to pick up changes made through the API.

Update low stock configuration for several products

This call updates multiple variants at the same time. This is convenient method to use if you have many updates to perform at the same time. The payload is essentially a list in the single update call. You can construct the payload in the same way you did for the single update call providing a list instead.

POST /custom-low-stock/locations/{locationUuid}

Example: This example updates the custom low stock level to 10 and the stock alerts to false for product_uuid de71da94-5cb4-11ec-bf63-0242ac130002 and variant_uuid e58d826a-5cb4-11ec-bf63-0242ac130002. Variant 9258b222-5cb9-11ec-bf63-0242ac130002 of the same product will be updated to have no custom low stock level, but will have stock alerts set to true. The entire update applies to location_uuid f2e4d45e-5cb4-11ec-bf63-0242ac130002.

Request

POST /custom-low-stock/locations/f2e4d45e-5cb4-11ec-bf63-0242ac130002

{
  "requests": [
    {
      "productUuid": "de71da94-5cb4-11ec-bf63-0242ac130002",
      "variantUuid": "e58d826a-5cb4-11ec-bf63-0242ac130002",
      "lowStockLevel": 10
      "lowStockAlert": false
    },
    {
      "productUuid": "de71da94-5cb4-11ec-bf63-0242ac130002",
      "variantUuid": "9258b222-5cb9-11ec-bf63-0242ac130002",
      "lowStockLevel": 8
      "lowStockAlert": true
    }
  ]
}

Response

No response body is returned only a status code of 204 - No Content.

Resetting the low stock configuration

The default values for a variant's low stock configuration are "lowStockLevel": null and "lowStockAlert": false. When fetching low stock configurations, only variants with settings that differ from the default are reported. Similarly, if the configuration of a variant is updated to the default values, then the saved configuration data is actually deleted.

Related tasks

• Delete low stock level
• Fetch low stock level