API documentation
Method list
Test your request
Changelog


addInventoryWarehouseLocationType
The method allows you to add or update a warehouse location type.


Input parameters
location_type_idint(optional) ID of the location type to update. Omit this parameter to create a new location type.
namevarchar(50)Location type name (e.g. "Pallet"). Required when creating a new location type, optional when updating. Maximum 50 characters, must be unique among the authenticated user's location types.
max_quantityint(optional) Maximum number of products allowed at a single location of this type. 0 means no limit. Range: 0 - 999999999. Default for new types: 0.
max_weightfloat(optional) Maximum total weight in kilograms allowed at a single location of this type. 0 means no limit. Range: 0 - 9999.99. Default for new types: 0.
widthfloat(optional) Width of a single location of this type, in centimeters. 0 means not set. Range: 0 - 9999.99. Default for new types: 0.
heightfloat(optional) Height of a single location of this type, in centimeters. 0 means not set. Range: 0 - 9999.99. Default for new types: 0.
depthfloat(optional) Depth of a single location of this type, in centimeters. 0 means not set. Range: 0 - 9999.99. Default for new types: 0.
is_transfer_binbool(optional) Whether locations of this type are used as transfer bins (intermediate locations during goods movements). Default for new types: false.



Output data
The method returns the data in JSON format.
statusvarchar(30)SUCCESS - request executed correctly
ERROR - an error occurred during an API request. Error details will be described in 2 additional returned fields: error_message and error_code
location_type_idintID of the created or updated location type.



Sample
Input data:
Output data:
A sample request in PHP: