---
title: "Hide product at outlets"
method: POST
path: "/v1/workflows/visibility/product/{productId}/hide"
tags: ["Catalog visibility"]
---

# Hide product at outlets

`POST /v1/workflows/visibility/product/{productId}/hide`

## 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/workflows/visibility/product/{productId}/hide`
- Auth: API key in header `x-api-key`

Adds the (productId, outletId) tuple to the sparse hide-list for each outlet provided. Idempotent — re-posting the same outlets returns `affected: 0`. The whole product (and all its variants) becomes hidden at those outlets.

## Path parameters

- `productId` string, required

## Request body

- object
  - `outletIds` string[], required

## Response `200`

Number of hide-list rows affected by the operation.

- object
  - `affected` number, required

## Other responses

- `400`: Validation failed (invalid id or empty outletIds).
- `401`: Missing or invalid API key.
- `404`: Product, variant, or outlet not found for this company.

---

[API](https://skmtc.dev/finalpos/apis/final-pos-public-api.md) · [All operations](https://skmtc.dev/finalpos/apis/final-pos-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/finalpos/apis/final-pos-public-api/revisions/6a6842dcb479?raw)
