Skip to main content

Location Type Codes

Standardized location type codes for categorizing different types of locations within supply chain operations.

The ref_location_type_codes Object

Location type codes collection provides standardized categories for different types of physical locations and facilities used in supply chain tracking and management.

Field NameTypeDescription
codestringPrimary key. Unique identifier code for the location type (e.g., "WAREHOUSE", "RETAIL_STORE").
statusstringRecord status. Default: "draft". Values: "draft", "published".
user_createdobjectUser who created the location type record. Read-only. Links to directus_users.
date_createddatetimeTimestamp in ISO 8601 when the location type record was created. Read-only.
user_updatedobjectUser who last updated the location type record. Read-only. Links to directus_users.
date_updateddatetimeTimestamp in ISO 8601 when the location type record was last updated. Read-only.
location_typestringHuman-readable description of the location type.
backgroundstringBackground color for UI display purposes.
foregroundstringForeground color for UI display purposes.

List Location Type Codes

List existing location type codes.

GET /items/ref_location_type_codes

Query Parameters

Supports all global query parameters.

Returns

An array of up to limit location type codes objects. If no items are available, data will be an empty array.


Retrieve a Location Type Code

Retrieve a specific location type code by code.

GET /items/ref_location_type_codes/:code

Returns

Returns a location type codes object if a valid code was provided.


Create a Location Type Code

Create a new location type code.

POST /items/ref_location_type_codes

{
"code": "CUSTOM_FACILITY",
"location_type": "Custom Facility Type",
"status": "draft",
"background": "#E3F2FD",
"foreground": "#1976D2"
}

Query Parameters

Supports all global query parameters.

Request Body

A partial location type codes object.

Returns

Returns the location type codes object for the created location type code.


Update a Location Type Code

Update an existing location type code.

PATCH /items/ref_location_type_codes/:code

{
"location_type": "Updated Facility Type",
"status": "published"
}

Query Parameters

Supports all global query parameters.

Request Body

A partial location type codes object.

Returns

Returns the location type codes object for the updated location type code.


Delete a Location Type Code

Delete an existing location type code.

DELETE /items/ref_location_type_codes/:code

Returns

Empty body.


Sample Data

CodeLocation TypeStatus
ACCOUNTS_DEPARTMENTAccounts Departmentdraft
AGED_CARE_SERVICEAged Care Servicedraft
AIRCRAFTAircraftdraft
AIRPORTAirportdraft
AIRPORT_GATEAirport Gatedraft