Overview

The PIM (Product Information Management) module is the canonical product catalog for every tenant on VINC Commerce Suite. It stores the full lifecycle of a product — from initial draft to published catalog entry, with all of its attributes, media, pricing, and channel-specific overrides.

Data model

PIM entities are persisted in tenant-scoped storage. You never address storage directly — you only talk to the REST surface below. Document fields use snake_case. The top-level PIM resources are:

Top-level PIM resources

Field	Type	Required	Description
`products`	`resource`	Optional	Products — the core PIM entity.
`categories`	`resource`	Optional	Tree-shaped taxonomy.
`collections`	`resource`	Optional	Curated product sets.
`brands`	`resource`	Optional	Manufacturer brands.
`tags`	`resource`	Optional	Free-form labels.
`product types`	`resource`	Optional	Typed product schemas.
`technical specifications`	`resource`	Optional	Reusable attribute definitions.
`jobs`	`resource`	Optional	Background import / sync / bulk jobs.

Authentication

Every PIM endpoint is tenant-scoped and authenticated. Three credentials are accepted — the server resolves whichever is present:

Field	Type	Required	Description
`Session cookie`	`browser`	Optional	Set by the B2B portal login flow. Used by first-party UI calls.
`Bearer JWT`	`header`	Optional	Authorization: Bearer <token> — issued to mobile and service clients.
`API key`	`header`	Optional	x-api-key-id / x-api-key-secret — long-lived tenant credentials.

Response envelope

Every successful PIM endpoint returns a JSON object with domain-specific keys (e.g. products, pagination) at the top level. Errors use the conventional envelope:

Error response (any 4xx/5xx)

{ "error": "Human-readable message" }

Pagination

List endpoints paginate server-side with page and limit query params and echo a pagination object back:

Example list response

{
"products": [ ... ],
"pagination": {
  "page": 1,
  "limit": 50,
  "total": 234,
  "pages": 5
}
}