Edit Stock Item

Edits an existing stock item.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

Editing a PackageDescription object

This operation is allowed, but it will not convert existing stock (inventory) to the new unit or package size defined. You should only do this to correct mistakes. If your intention is to replace a package, disable the existing stock item and create a new one.

Partial updates

Only the fields you send are changed. Fields you leave out keep their current value, including the whole package_description object.

Updating GTINs

gtin_list replaces the whole list.

gtin behaves differently: the value you send is added in front of the GTINs the stock item already has, so sending gtin alone does not replace the list. Sending gtin: null removes only the first entry.

To set an exact set of GTINs, send gtin_list.

Path Params
string
required

A stock item ID.

Body Params
string
package_description
object
string

GTIN/EAN

boolean
Defaults to false

Whether the stock item defines a "piece" of the ingredient. Only one stock item in an ingredient can be a piece.

boolean
Defaults to true
boolean
Defaults to false
boolean
Defaults to false

Whether the package is returnable packaging: a crate, keg, CO2 cylinder, pallet or similar container that carries a deposit and goes back to the supplier. A marker only, it does not change how the package is ordered, counted or costed. Cannot be changed on a package that comes from an integrated supplier.

boolean
gtin_list
array of strings

List of GTIN/EAN values.

gtin_list
Responses

400

Validation error. For example: an invalid GTIN, both base_unit and unit_stock_item given, a weighted combination the model does not allow, or a returnable change on a package that comes from an integrated supplier.

404

Stock item not found, or belongs to a different library.

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json