Catalog visibility

Hide product at outlets

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.

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

Path parameters

productIdstring required

Product document id

Request body

outletIdsstring[] required

Example request

{
  "outletIds": [
    "507f1f77bcf86cd799439011"
  ]
}

Response

Number of hide-list rows affected by the operation.

affectednumber required

Example response

{
  "affected": 3
}

Changes

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