API Reference

Retrieve all product mappings

post
https://smartcategorization.vertexcloud.com/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 via selectedColumns. When selectedColumns is omitted, all standard product fields are returned. When selectedColumns is provided, only the requested fields are returned per product — unrequested fields are absent, not null. All field names in the request and response are camelCase.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer

The numeric identifier of the client whose products are being requested.

string

Opaque pagination cursor returned from the previous response. Omit or leave empty to start from the beginning.

integer
1 to 1000
Defaults to 10

Number of products to return per page.

string

Product field name to sort results by. Must be camelCase (e.g. 'productName', 'modifiedDate', 'status').

string
enum

Direction of sorting.

Allowed:
string

Free-text search applied across product name, description, and identifier fields.

filters
array of objects

List of filter conditions to apply. Multiple filters are combined with AND logic.

filters
selectedColumns
array of strings

Optional list of product field names (camelCase) to include in the response. When provided, each product in the response will contain only the requested fields — unrequested fields will be absent, not null. When omitted, all standard fields are returned. Valid values match the field names defined in ProductListResponse.

selectedColumns
selectedIds
array of strings

Optional list of product IDs to restrict the response to a specific subset.

selectedIds
Responses

Updated about 1 month ago

Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
application/json

Updated about 1 month ago