API Docs
YMS API
Location/Level 1
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

NameLocationTypeRequiredDescription
locationIdpathstringYesnone
X-Tenant-IDheaderstringNonone
X-Yard-IDheaderstringNonone
Item-Time-ZoneheaderstringNonone
AuthorizationheaderstringNonone

Response Example

200 Response

{
  "code": 0,
  "msg": "",
  "success": false,
  "data": null
}

Response

Status CodeDefinitionDescriptionData Model
200OK (opens in a new tab)noneRVoid