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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

clientId

integer

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

cursor

string

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

recordsPerPage

integer

1 to 1000

Defaults to 10

Number of products to return per page.

sortField

string

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

sortDirection

string

enum

Direction of sorting.

Allowed:

searchValue

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 fields to include in the response. Accepts camelCase for product fields (productId, productName, status, category, etc.) and exact names for identifiers (GTIN, SKU, NDC, UDI-DI, HIBC, MPN, Catalog Number, UNSPSC, HSN). When provided, each product in the response will contain only the requested fields - unrequested fields will be absent, not null. Identifier types filter the 'identifiers' array to only matching types. When omitted, all standard fields are returned.

selectedColumns

selectedIds

array of strings

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

selectedIds

Responses

200Paginated list of product mappings. Each product item contains all standard fields when selectedColumns is omitted, or only the requested fields when selectedColumns is provided.

400Bad request — invalid filter field, unsupported filterOperation, or malformed request body.

401Unauthorized — missing or invalid Bearer token.

403Forbidden — caller does not have access to the specified clientId.

404No products found for the given clientId and filter criteria.

500Internal server error.