POST Search Customers with Paging
Introduction
Searches customers with pagination support and advanced filtering capabilities. This endpoint allows querying customers by multiple criteria including customer ID, name, code, status, company code, and yard associations. Returns paginated results with configurable page size and sorting options. Used by operations dashboards to display customer lists, by appointment systems for customer selection, and by reporting tools for customer analytics.
API Request
POST /customer/search-by-paging
Body Request Parameters
{
"currentPage": 0,
"pageSize": 0,
"sortingFields": [
{
"field": "string",
"orderBy": "NONE"
}
],
"customerId": "string",
"customerIds": [
"string"
],
"customerNames": [
"string"
],
"customerName": "string",
"customerCode": "string",
"companyCode": "UT,UF,CUBEWORK",
"customerStatus": "ACTIVE",
"yardId": "YARD-01"
}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 | CustomerQuery | No | none |
Response Example
200 Response
{
"code": 0,
"msg": "",
"success": false,
"data": {
"list": [
{
"customerId": "",
"customerName": "",
"customerCode": "",
"customerStatus": "",
"companyCode": "",
"yardIds": [
"YARD-01",
"YARD-02"
],
"yardNames": [
"Yard A",
"Yard B"
],
"mainContact": "",
"mainEmail": "",
"altContact": "",
"altEmail": "",
"createdTime": "",
"createdBy": "",
"updatedTime": "",
"updatedBy": ""
}
],
"totalCount": 0,
"currentPage": 0,
"pageSize": 0,
"totalPage": 0
}
}Response
| Status Code | Definition | Description | Data Model |
|---|---|---|---|
| 200 | OK (opens in a new tab) | none | RPageResultCustomerView |