# Snooze / unsnooze items for an outlet

> 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/outlets/outlet-id/items/snooze/llms.txt.
> For full documentation content, see https://apidocs.cata.sg/pos-integration-service-api/api/v-1/outlets/outlet-id/items/snooze/llms-full.txt.

POST http://localhost:8080/api/v1/outlets/{outletId}/items/snooze
Content-Type: application/json

Temporarily disable or re-enable items for a specific outlet.

**Item matching:** Items are matched by `itemCode` → `items.item_code`.

**Snooze (disable until a time):**
- Send `snoozeEnd` with a RFC 3339 datetime → sets `item_store.disabled_until`
- Item is unavailable until that time, then automatically available again
```json
{
  "items": [
    { "itemCode": "DIM-001", "snoozeEnd": "2026-03-13T22:00:00Z" },
    { "itemCode": "WOK-003", "snoozeEnd": "2026-03-13T14:00:00Z" }
  ]
}
```

**Unsnooze (re-enable immediately):**
- Omit `snoozeEnd` or send `null` → clears `item_store.disabled_until`
```json
{
  "items": [
    { "itemCode": "DIM-001", "snoozeEnd": null }
  ]
}
```

**Important:**
- `sell_available` is NOT modified — snooze is a time-bounded pause, not a permanent toggle


Reference: https://apidocs.cata.sg/pos-integration-service-api/api/v-1/outlets/outlet-id/items/snooze/snooze-unsnooze-items-for-an-outlet

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: collection
  version: 1.0.0
paths:
  /api/v1/outlets/{outletId}/items/snooze:
    post:
      operationId: snooze-unsnooze-items-for-an-outlet
      summary: Snooze / unsnooze items for an outlet
      description: >
        Temporarily disable or re-enable items for a specific outlet.


        **Item matching:** Items are matched by `itemCode` → `items.item_code`.


        **Snooze (disable until a time):**

        - Send `snoozeEnd` with a RFC 3339 datetime → sets
        `item_store.disabled_until`

        - Item is unavailable until that time, then automatically available
        again

        ```json

        {
          "items": [
            { "itemCode": "DIM-001", "snoozeEnd": "2026-03-13T22:00:00Z" },
            { "itemCode": "WOK-003", "snoozeEnd": "2026-03-13T14:00:00Z" }
          ]
        }

        ```


        **Unsnooze (re-enable immediately):**

        - Omit `snoozeEnd` or send `null` → clears `item_store.disabled_until`

        ```json

        {
          "items": [
            { "itemCode": "DIM-001", "snoozeEnd": null }
          ]
        }

        ```


        **Important:**

        - `sell_available` is NOT modified — snooze is a time-bounded pause, not
        a permanent toggle
      tags:
        - >-
          subpackage_api.subpackage_api/v1.subpackage_api/v1/outlets.subpackage_api/v1/outlets/outletId.subpackage_api/v1/outlets/outletId/items.subpackage_api/v1/outlets/outletId/items/snooze
      parameters:
        - name: outletId
          in: path
          description: Outlet UUID
          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
        - name: X-Provider
          in: header
          description: POS provider name (validated against tenant settings)
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/api_v1_outlets_{outletId}_items_snooze_Snooze
                  / unsnooze items for an outlet_Response_200
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PostApiV1OutletsOutletidItemsSnoozeRequestBadRequestError
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                description: Any type
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                description: Any type
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                items:
                  type: array
                  items:
                    $ref: >-
                      #/components/schemas/ApiV1OutletsOutletIdItemsSnoozePostRequestBodyContentApplicationJsonSchemaItemsItems
              required:
                - items
servers:
  - url: http://localhost:8080
components:
  schemas:
    ApiV1OutletsOutletIdItemsSnoozePostRequestBodyContentApplicationJsonSchemaItemsItems:
      type: object
      properties:
        itemCode:
          type: string
        snoozeEnd:
          type: string
          format: date-time
      required:
        - itemCode
        - snoozeEnd
      title: >-
        ApiV1OutletsOutletIdItemsSnoozePostRequestBodyContentApplicationJsonSchemaItemsItems
    api_v1_outlets_{outletId}_items_snooze_Snooze / unsnooze items for an outlet_Response_200:
      type: object
      properties:
        status:
          type: string
        itemsUpdated:
          type: integer
        modifierOptionsUpdated:
          type: integer
      required:
        - status
        - itemsUpdated
        - modifierOptionsUpdated
      title: >-
        api_v1_outlets_{outletId}_items_snooze_Snooze / unsnooze items for an
        outlet_Response_200
    ApiV1OutletsOutletIdItemsSnoozePostResponsesContentApplicationJsonSchemaError:
      type: object
      properties:
        code:
          type: integer
        message:
          type: string
        details:
          type: string
        field:
          type: string
      required:
        - code
        - message
        - details
        - field
      title: >-
        ApiV1OutletsOutletIdItemsSnoozePostResponsesContentApplicationJsonSchemaError
    PostApiV1OutletsOutletidItemsSnoozeRequestBadRequestError:
      type: object
      properties:
        error:
          $ref: >-
            #/components/schemas/ApiV1OutletsOutletIdItemsSnoozePostResponsesContentApplicationJsonSchemaError
      required:
        - error
      title: PostApiV1OutletsOutletidItemsSnoozeRequestBadRequestError
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key

```

## SDK Code Examples

```python api_v1_outlets_{outletId}_items_snooze_Snooze / unsnooze items for an outlet_example
import requests

url = "http://localhost:8080/api/v1/outlets/string/items/snooze"

payload = { "items": [
        {
            "itemCode": "DIM-001",
            "snoozeEnd": "2026-03-13T22:00:00Z"
        },
        {
            "itemCode": "DIM-001",
            "snoozeEnd": "2026-03-13T22:00:00Z"
        }
    ] }
headers = {
    "X-Tenant-ID": "string",
    "X-Provider": "cata",
    "X-Api-Key": "<apiKey>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript api_v1_outlets_{outletId}_items_snooze_Snooze / unsnooze items for an outlet_example
const url = 'http://localhost:8080/api/v1/outlets/string/items/snooze';
const options = {
  method: 'POST',
  headers: {
    'X-Tenant-ID': 'string',
    'X-Provider': 'cata',
    'X-Api-Key': '<apiKey>',
    'Content-Type': 'application/json'
  },
  body: '{"items":[{"itemCode":"DIM-001","snoozeEnd":"2026-03-13T22:00:00Z"},{"itemCode":"DIM-001","snoozeEnd":"2026-03-13T22:00:00Z"}]}'
};

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

```go api_v1_outlets_{outletId}_items_snooze_Snooze / unsnooze items for an outlet_example
package main

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

func main() {

	url := "http://localhost:8080/api/v1/outlets/string/items/snooze"

	payload := strings.NewReader("{\n  \"items\": [\n    {\n      \"itemCode\": \"DIM-001\",\n      \"snoozeEnd\": \"2026-03-13T22:00:00Z\"\n    },\n    {\n      \"itemCode\": \"DIM-001\",\n      \"snoozeEnd\": \"2026-03-13T22:00:00Z\"\n    }\n  ]\n}")

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

	req.Header.Add("X-Tenant-ID", "string")
	req.Header.Add("X-Provider", "cata")
	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_outlets_{outletId}_items_snooze_Snooze / unsnooze items for an outlet_example
require 'uri'
require 'net/http'

url = URI("http://localhost:8080/api/v1/outlets/string/items/snooze")

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

request = Net::HTTP::Post.new(url)
request["X-Tenant-ID"] = 'string'
request["X-Provider"] = 'cata'
request["X-Api-Key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"items\": [\n    {\n      \"itemCode\": \"DIM-001\",\n      \"snoozeEnd\": \"2026-03-13T22:00:00Z\"\n    },\n    {\n      \"itemCode\": \"DIM-001\",\n      \"snoozeEnd\": \"2026-03-13T22:00:00Z\"\n    }\n  ]\n}"

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

```java api_v1_outlets_{outletId}_items_snooze_Snooze / unsnooze items for an outlet_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("http://localhost:8080/api/v1/outlets/string/items/snooze")
  .header("X-Tenant-ID", "string")
  .header("X-Provider", "cata")
  .header("X-Api-Key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"items\": [\n    {\n      \"itemCode\": \"DIM-001\",\n      \"snoozeEnd\": \"2026-03-13T22:00:00Z\"\n    },\n    {\n      \"itemCode\": \"DIM-001\",\n      \"snoozeEnd\": \"2026-03-13T22:00:00Z\"\n    }\n  ]\n}")
  .asString();
```

```php api_v1_outlets_{outletId}_items_snooze_Snooze / unsnooze items for an outlet_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'http://localhost:8080/api/v1/outlets/string/items/snooze', [
  'body' => '{
  "items": [
    {
      "itemCode": "DIM-001",
      "snoozeEnd": "2026-03-13T22:00:00Z"
    },
    {
      "itemCode": "DIM-001",
      "snoozeEnd": "2026-03-13T22:00:00Z"
    }
  ]
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'X-Api-Key' => '<apiKey>',
    'X-Provider' => 'cata',
    'X-Tenant-ID' => 'string',
  ],
]);

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

```csharp api_v1_outlets_{outletId}_items_snooze_Snooze / unsnooze items for an outlet_example
using RestSharp;

var client = new RestClient("http://localhost:8080/api/v1/outlets/string/items/snooze");
var request = new RestRequest(Method.POST);
request.AddHeader("X-Tenant-ID", "string");
request.AddHeader("X-Provider", "cata");
request.AddHeader("X-Api-Key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"items\": [\n    {\n      \"itemCode\": \"DIM-001\",\n      \"snoozeEnd\": \"2026-03-13T22:00:00Z\"\n    },\n    {\n      \"itemCode\": \"DIM-001\",\n      \"snoozeEnd\": \"2026-03-13T22:00:00Z\"\n    }\n  ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift api_v1_outlets_{outletId}_items_snooze_Snooze / unsnooze items for an outlet_example
import Foundation

let headers = [
  "X-Tenant-ID": "string",
  "X-Provider": "cata",
  "X-Api-Key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = ["items": [
    [
      "itemCode": "DIM-001",
      "snoozeEnd": "2026-03-13T22:00:00Z"
    ],
    [
      "itemCode": "DIM-001",
      "snoozeEnd": "2026-03-13T22:00:00Z"
    ]
  ]] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:8080/api/v1/outlets/string/items/snooze")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
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()
```