Location types

The location type endpoints specifies all the information about the location types that are currently in use.

The location type model

Properties

Name
id
Type
string
Readonly
readonly
Description
Name
code
Type
string
Description
The code of the location type
Name
name
Type
string
Description
The name of the location type
Name
transport
Type
boolean
Description
Whether this location type can be used as a transport
Name
pickable
Type
boolean
Description
Whether this location type is pickable

GET/wms/locationtypes/

List all location types

Retrieves a collection of location types

Optional attributes

Name
code
Type
string
Description
Code of the location type IE: T
Name
pickable
Type
boolean
Description
Only return pickable location types

Request

GET

/wms/locationtypes/

curl https://eu-dev.middleware.ewarehousing-solutions.com/wms/locationtypes/ \
-H 'Expand: administration_code'

Response

[
{
    "id": "d94770bc-b236-49ec-8e31-88af42f2c282",
    "code": "T",
    "name": "Transport (non-pick)",
    "transport": true,
    "pickable": false,
    "administration_code": "123"
},
{
    "id": "a299249a-b2cd-4666-a6e5-77d3e1156a22",
    "code": "Q",
    "name": "Quarantaine",
    "transport": false,
    "pickable": false,
    "administration_code": null
}
]

GET/wms/locationtype/:id/

Retrieve a location type

Retrieve a single location type

Request

GET

/wms/locationtype/:id/

curl https://eu-dev.middleware.ewarehousing-solutions.com/wms/locationtype/3c736990-6883-4513-851c-5ff64a1a4a95 \
-H 'Expand: administration_code'

Response

{
    "id": "3c736990-6883-4513-851c-5ff64a1a4a95",
    "code": "B",
    "name": "Bulk (non-pick)",
    "transport": false,
    "pickable": false,
    "administration_code": null
}