POST Update Customer
Introduction
Updates an existing customer's information in the Yard Management System (YMS). This endpoint allows operations managers to modify customer details, status, yard access, contact information, and business unit assignments. Used when customer contracts change, contact persons are updated, yard access needs adjustment, or customer status requires modification (active, inactive, exception). All fields are required for full update.
API Request
POST /customer/{customerId}/update
Body Request Parameters
{
"customerName": "Acme Corp",
"customerCode": "string",
"customerStatus": "ACTIVE",
"companyCode": "UT",
"yardIds": "[\"YARD-01\", \"YARD-02\"]",
"mainContact": "Jane Smith",
"mainEmail": "jane.smith@example.com",
"altContact": "Bob Lee",
"altEmail": "bob.lee@example.com"
}Request Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| customerId | 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 |
| body | body | CustomerUpdateCmd | No | none |
Response Example
200 Response
{
"code": 0,
"msg": "",
"success": false,
"data": {
"customerId": "",
"customerName": "",
"customerCode": "",
"customerStatus": "",
"companyCode": "",
"yardIds": [
"YARD-01",
"YARD-02"
],
"yardNames": [
"Yard A",
"Yard B"
],
"mainContact": "",
"mainEmail": "",
"altContact": "",
"altEmail": "",
"createdTime": "",
"createdBy": "",
"updatedTime": "",
"updatedBy": ""
}
}Response
| Status Code | Definition | Description | Data Model |
|---|---|---|---|
| 200 | OK (opens in a new tab) | none | RCustomerView |