API documentation
Method list
Test your request
Changelog


getInventoryWarehouseLocationTypes
The method allows you to retrieve the list of warehouse location types. The returned list is sorted alphabetically by name.


Input parameters



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_typesarrayAn array of location types containing the fields listed below.
| - location_type_idintLocation type identifier. Use this value as location_type_id when calling addInventoryWarehouseLocation (create or update), addInventoryWarehouseLocationType (update) or deleteInventoryWarehouseLocationType.
| - namevarchar(50)Location type name.
| - max_quantityintMaximum number of products allowed at a single location of this type. 0 means no limit.
| - max_weightfloatMaximum total weight (in kilograms) allowed at a single location of this type. 0 means no limit.
| - widthfloatWidth of a single location of this type, in centimeters. 0 means not set.
| - heightfloatHeight of a single location of this type, in centimeters. 0 means not set.
| - depthfloatDepth of a single location of this type, in centimeters. 0 means not set.
| - is_transfer_binboolWhether locations of this type are used as transfer bins.
| - is_defaultboolWhether this is the user's default location type. The default type is assigned automatically to new locations created without an explicit location_type_id and cannot be deleted.



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