API Docs
YMS API
Task Management
POST Cancel

POST Cancel

Introduction

Cancels a yard task associated with a specific entry ticket, removing it from the active task queue without completion. This API is used when a task is no longer needed due to changes in plans, entry cancellation, or operational adjustments. The task status is marked as cancelled, and it will not affect performance metrics or completion statistics.

API Request

POST /general-task/entry/{entryId}/{taskId}/cancel

Request Parameters

NameLocationTypeRequiredDescription
taskIdpathstringYesnone
entryIdpathstringYesnone
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