Retrieve all product mappings

Learn how to retrieve paginated product mappings for a client, including filtering, sorting, and field projection.

Endpoint

POST /public-api/allproduct/all-product-mappings

Returns a paginated list of all product mappings for the specified client. Supports filtering, sorting, free-text search, and column projection.

Authentication

All requests require a valid bearer token in the Authorization header.

Authorization: Bearer {ACCESS_TOKEN}

Request

{
  "clientId": 42,
  "recordsPerPage": 25,
  "sortField": "modifiedDate",
  "sortDirection": "desc",
  "selectedColumns": [
    "productId",
    "productName",
    "category",
    "status"
  ]
}

Property	Type	Required	Description
`clientId`	integer	Yes	The numeric identifier of the client whose products are being requested.
`cursor`	string	No	Opaque pagination cursor returned from the previous response.
`recordsPerPage`	integer	No	Number of products to return per page. Default is `10`.
`sortField`	string	No	Product field name to sort results by.
`sortDirection`	string	No	Sorting direction: `asc` or `desc`.
`searchValue`	string	No	Free-text search value.
`filters`	array	No	Filter conditions to apply.
`selectedColumns`	array	No	Optional list of fields to include in the response.
`selectedIds`	array	No	Optional list of product IDs to restrict the response to.

Example

curl --request POST \
  --url https://smartcategorization.vertexcloud.com/public-api/allproduct/all-product-mappings \
  --header "Authorization: Bearer {ACCESS_TOKEN}" \
  --header "Content-Type: application/json" \
  --data '{
    "clientId": 42,
    "recordsPerPage": 25,
    "sortField": "modifiedDate",
    "sortDirection": "desc",
    "selectedColumns": [
      "productId",
      "productName",
      "category",
      "status"
    ]
  }'

Response

{
  "cursor": "eyJwYWdlIjoyfQ==",
  "recordCount": 128,
  "productItems": [
    {
      "productId": "P-1001",
      "productName": "Wireless Mouse",
      "category": "Computer Accessories",
      "status": "approved"
    }
  ]
}

Errors

Status	Description
`400 Bad Request`	The request is invalid. Common reasons include an invalid filter field, unsupported filter operation, or malformed request body.
`401 Unauthorized`	The bearer token is missing, expired, or invalid.
`403 Forbidden`	The caller does not have access to the specified client.
`404 Not Found`	No products are found for the client and filter criteria.
`500 Internal Server Error`	The service encountered an unexpected error while processing the request.