POST Delete Location by ID
POST Delete location by ID
Introduction
Deletes a location from the Yard Management System (YMS). This endpoint performs a soft delete, marking the location as deleted while preserving historical data. Used when decommissioning dock doors, removing obsolete parking spots, or cleaning up unused staging areas. The location must not be currently occupied or assigned to active appointments. Once deleted, the location will no longer appear in location searches or be available for new assignments, but historical records referencing this location remain intact for audit purposes.
API Request
POST /location/{locationId}/delete
Request Parameters
Name | Location | Type | Required | Description |
|---|---|---|---|---|
locationId | path | string | Yes | none |
X-Tenant-ID | header | string | No | none |
X-Yard-ID | header | string | No | none |
Item-Time-Zone | header | string | No | none |
Authorization | header | string | No | none |
Response Example
200 Response
Response
Status Code | Definition | Description | Data Model |
|---|---|---|---|
200 | OK | none | RVoid |