POST Create Customer
Introduction
Creates a new customer record in the Yard Management System (YMS). This endpoint is typically used during customer onboarding when a new business client needs to be registered in the system for yard operations management. Supports multi-yard access configuration, contact information setup, and company code assignment for business unit segregation. The customer record enables appointment scheduling, location assignments, and operational tracking.
API Request
POST /customer/create
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 |
|---|---|---|---|---|
| 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 | CustomerCreateCmd | 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 |