GET Get Customer by ID

Introduction

Retrieves detailed information for a specific customer by its unique identifier. This endpoint returns comprehensive customer data including name, code, status, company code, yard access, and contact information. Used by operations staff to view customer details, by appointment systems to verify customer information, and by customer-facing applications to display account information.

API Request

GET /customer/{customerId}

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

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

POST Update Customer POST Search Customer with Paging