# Toggle item visibility in section

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://apidocs.cata.sg/pos-integration-service-api/api/v-1/menus/menu-id/sections/section-id/items/item-code/visibility/llms.txt.
> For full documentation content, see https://apidocs.cata.sg/pos-integration-service-api/api/v-1/menus/menu-id/sections/section-id/items/item-code/visibility/llms-full.txt.

PATCH http://localhost:8080/api/v1/menus/{menuId}/sections/{sectionId}/items/{itemCode}/visibility
Content-Type: application/json

Toggle the default visibility of a single item within a section.
This sets the draft-level default visible flag — applies to all outlets
unless overridden by a per-outlet visibility override.


Reference: https://apidocs.cata.sg/pos-integration-service-api/api/v-1/menus/menu-id/sections/section-id/items/item-code/visibility/toggle-item-visibility-in-section

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: collection
  version: 1.0.0
paths:
  /api/v1/menus/{menuId}/sections/{sectionId}/items/{itemCode}/visibility:
    patch:
      operationId: toggle-item-visibility-in-section
      summary: Toggle item visibility in section
      description: |
        Toggle the default visibility of a single item within a section.
        This sets the draft-level default visible flag — applies to all outlets
        unless overridden by a per-outlet visibility override.
      tags:
        - >-
          subpackage_api.subpackage_api/v1.subpackage_api/v1/menus.subpackage_api/v1/menus/menuId.subpackage_api/v1/menus/menuId/sections.subpackage_api/v1/menus/menuId/sections/sectionId.subpackage_api/v1/menus/menuId/sections/sectionId/items.subpackage_api/v1/menus/menuId/sections/sectionId/items/itemCode.subpackage_api/v1/menus/menuId/sections/sectionId/items/itemCode/visibility
      parameters:
        - name: menuId
          in: path
          description: Menu UUID
          required: true
          schema:
            type: string
        - name: sectionId
          in: path
          description: Section UUID
          required: true
          schema:
            type: string
        - name: itemCode
          in: path
          description: Product item code (PLU)
          required: true
          schema:
            type: string
        - name: X-Api-Key
          in: header
          required: true
          schema:
            type: string
        - name: X-Tenant-ID
          in: header
          description: Tenant identifier
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/api_v1_menus_{menuId}_sections_{sectionId}_items_{itemCode}_visibility_Toggle
                  item visibility in section_Response_200
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PatchApiV1MenusMenuidSectionsSectionidItemsItemcodeVisibilityRequestNotFoundError
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                visible:
                  type: boolean
              required:
                - visible
servers:
  - url: http://localhost:8080
components:
  schemas:
    api_v1_menus_{menuId}_sections_{sectionId}_items_{itemCode}_visibility_Toggle item visibility in section_Response_200:
      type: object
      properties:
        code:
          type: integer
        isSuccess:
          type: boolean
        message:
          type: string
      required:
        - code
        - isSuccess
        - message
      title: >-
        api_v1_menus_{menuId}_sections_{sectionId}_items_{itemCode}_visibility_Toggle
        item visibility in section_Response_200
    ApiV1MenusMenuIdSectionsSectionIdItemsItemCodeVisibilityPatchResponsesContentApplicationJsonSchemaError:
      type: object
      properties:
        code:
          type: integer
        message:
          type: string
        details:
          type: string
        field:
          type: string
      required:
        - code
        - message
        - details
        - field
      title: >-
        ApiV1MenusMenuIdSectionsSectionIdItemsItemCodeVisibilityPatchResponsesContentApplicationJsonSchemaError
    PatchApiV1MenusMenuidSectionsSectionidItemsItemcodeVisibilityRequestNotFoundError:
      type: object
      properties:
        error:
          $ref: >-
            #/components/schemas/ApiV1MenusMenuIdSectionsSectionIdItemsItemCodeVisibilityPatchResponsesContentApplicationJsonSchemaError
      required:
        - error
      title: >-
        PatchApiV1MenusMenuidSectionsSectionidItemsItemcodeVisibilityRequestNotFoundError
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key

```

## SDK Code Examples

```python api_v1_menus_{menuId}_sections_{sectionId}_items_{itemCode}_visibility_Toggle item visibility in section_example
import requests

url = "http://localhost:8080/api/v1/menus/string/sections/string/items/string/visibility"

payload = { "visible": False }
headers = {
    "X-Tenant-ID": "string",
    "X-Api-Key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.json())
```

```javascript api_v1_menus_{menuId}_sections_{sectionId}_items_{itemCode}_visibility_Toggle item visibility in section_example
const url = 'http://localhost:8080/api/v1/menus/string/sections/string/items/string/visibility';
const options = {
  method: 'PATCH',
  headers: {
    'X-Tenant-ID': 'string',
    'X-Api-Key': '<apiKey>',
    'Content-Type': 'application/json'
  },
  body: '{"visible":false}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go api_v1_menus_{menuId}_sections_{sectionId}_items_{itemCode}_visibility_Toggle item visibility in section_example
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:8080/api/v1/menus/string/sections/string/items/string/visibility"

	payload := strings.NewReader("{\n  \"visible\": false\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-Tenant-ID", "string")
	req.Header.Add("X-Api-Key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby api_v1_menus_{menuId}_sections_{sectionId}_items_{itemCode}_visibility_Toggle item visibility in section_example
require 'uri'
require 'net/http'

url = URI("http://localhost:8080/api/v1/menus/string/sections/string/items/string/visibility")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Patch.new(url)
request["X-Tenant-ID"] = 'string'
request["X-Api-Key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"visible\": false\n}"

response = http.request(request)
puts response.read_body
```

```java api_v1_menus_{menuId}_sections_{sectionId}_items_{itemCode}_visibility_Toggle item visibility in section_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("http://localhost:8080/api/v1/menus/string/sections/string/items/string/visibility")
  .header("X-Tenant-ID", "string")
  .header("X-Api-Key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"visible\": false\n}")
  .asString();
```

```php api_v1_menus_{menuId}_sections_{sectionId}_items_{itemCode}_visibility_Toggle item visibility in section_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'http://localhost:8080/api/v1/menus/string/sections/string/items/string/visibility', [
  'body' => '{
  "visible": false
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'X-Api-Key' => '<apiKey>',
    'X-Tenant-ID' => 'string',
  ],
]);

echo $response->getBody();
```

```csharp api_v1_menus_{menuId}_sections_{sectionId}_items_{itemCode}_visibility_Toggle item visibility in section_example
using RestSharp;

var client = new RestClient("http://localhost:8080/api/v1/menus/string/sections/string/items/string/visibility");
var request = new RestRequest(Method.PATCH);
request.AddHeader("X-Tenant-ID", "string");
request.AddHeader("X-Api-Key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"visible\": false\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift api_v1_menus_{menuId}_sections_{sectionId}_items_{itemCode}_visibility_Toggle item visibility in section_example
import Foundation

let headers = [
  "X-Tenant-ID": "string",
  "X-Api-Key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = ["visible": false] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:8080/api/v1/menus/string/sections/string/items/string/visibility")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```