CatalogVisibility

Create a new catalogvisibility

Creates a new catalogvisibility record.

post/v1/catalog-visibility

Request

  • Base URL: https://api.finalpos.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.finalpos.com/v1/catalog-visibility
  • Auth: API key in header x-api-key

Request body

productIdstring required

Product ID hidden by this exception.

variantIdstring

Variant ID hidden by this exception. Omit to hide all variants of the product at the outlet.

outletIdstring required

Outlet ID where the product/variant is hidden.

Example request

{
  "productId": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "variantId": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "outletId": "o1p2q3r4s5t6u7v8w9x0y1z2"
}

Response

The catalogvisibility has been successfully created.

idstring

Unique identifier for the CatalogVisibility.

createdAtstring date-time

Timestamp when the CatalogVisibility was created.

updatedAtstring date-time

Timestamp when the CatalogVisibility was last updated.

companyIdstring

Company ID associated with the CatalogVisibility.

productIdstring

Product ID hidden by this exception.

variantIdstring

Variant ID hidden by this exception. Omit to hide all variants of the product at the outlet.

outletIdstring

Outlet ID where the product/variant is hidden.

Example response

{
  "id": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "createdAt": "2025-12-07T19:31:48.436+00:00",
  "updatedAt": "2025-12-07T19:35:48.436+00:00",
  "companyId": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "productId": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "variantId": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "outletId": "o1p2q3r4s5t6u7v8w9x0y1z2"
}

Changes

No recorded changes to this operation across all 1 revision of this API.