Developer documentation

Location types

Use the Location Types API to list and retrieve location types.

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

Response models

These response models describe the objects returned by this resource.

The location type model

FieldDescription
id
stringOptional
Read-only.
code
stringOptional
The code of the location type
name
stringOptional
The name of the location type
transport
booleanOptional
Whether this location type can be used as a transport
pickable
booleanOptional
Whether this location type is pickable

List all location types

GET/wms/locationtypes/

Retrieves a collection of location types

New to the Expand header? See how it works, available groups, and request examples: Expanding responses.

Try it

Send a live request against the development middleware using your current API test session.

GET

Request attributes

FieldDescription
code
stringOptional
Code of the location type IE: T
pickable
booleanOptional
Only return pickable location types.
limit
integerOptional
Limit the number of results. Default is 50.
page
integerOptional
The page number to retrieve.
Request examplecURL
curl https://eu-dev.middleware.ewarehousing-solutions.com/wms/locationtypes/ \
            -H 'Expand: administration_code'
Response exampleJSON
[
  {
    "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
  }
]

Retrieve a location type

GET/wms/locationtype/:id/

Retrieve a single location type

Try it

Send a live request against the development middleware using your current API test session.

GET

Path parameters

Request examplecURL
curl https://eu-dev.middleware.ewarehousing-solutions.com/wms/locationtype/3c736990-6883-4513-851c-5ff64a1a4a95 \
            -H 'Expand: administration_code'
Response exampleJSON
{
  "id": "3c736990-6883-4513-851c-5ff64a1a4a95",
  "code": "B",
  "name": "Bulk (non-pick)",
  "transport": false,
  "pickable": false,
  "administration_code": null
}