# Set per-outlet modifier option override

> 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/modifier-options/option-id/outlets/outlet-id/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/modifier-options/option-id/outlets/outlet-id/llms-full.txt.

PUT http://localhost:8080/api/v1/menus/{menuId}/sections/{sectionId}/items/{itemCode}/modifier-options/{optionId}/outlets/{outletId}
Content-Type: application/json

Set a per-outlet override for a modifier option on an item in a section.
Supports disabling the option and/or overriding the additional price per order type.
When this override exists, it is written to the live per-outlet modifier option table
during publish.

**Price overrides:** Each order type (base, eat-in, delivery) can have an independent
price override. Pass `null` or omit a price field to clear that override (falls back
to the catalog price). Pass `0` to explicitly set a zero surcharge.

**Publish behavior:** Overrides are written to the live modifier option availability
table. Options without overrides remain enabled with catalog prices by default.


Reference: https://apidocs.cata.sg/pos-integration-service-api/api/v-1/menus/menu-id/sections/section-id/items/item-code/modifier-options/option-id/outlets/outlet-id/set-per-outlet-modifier-option-override

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: collection
  version: 1.0.0
paths:
  /api/v1/menus/{menuId}/sections/{sectionId}/items/{itemCode}/modifier-options/{optionId}/outlets/{outletId}:
    put:
      operationId: set-per-outlet-modifier-option-override
      summary: Set per-outlet modifier option override
      description: >
        Set a per-outlet override for a modifier option on an item in a section.

        Supports disabling the option and/or overriding the additional price per
        order type.

        When this override exists, it is written to the live per-outlet modifier
        option table

        during publish.


        **Price overrides:** Each order type (base, eat-in, delivery) can have
        an independent

        price override. Pass `null` or omit a price field to clear that override
        (falls back

        to the catalog price). Pass `0` to explicitly set a zero surcharge.


        **Publish behavior:** Overrides are written to the live modifier option
        availability

        table. Options without overrides remain enabled with catalog prices by
        default.
      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/modifierOptions.subpackage_api/v1/menus/menuId/sections/sectionId/items/itemCode/modifierOptions/optionId.subpackage_api/v1/menus/menuId/sections/sectionId/items/itemCode/modifierOptions/optionId/outlets.subpackage_api/v1/menus/menuId/sections/sectionId/items/itemCode/modifierOptions/optionId/outlets/outletId
      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: optionId
          in: path
          description: Modifier option ID
          required: true
          schema:
            type: string
        - 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
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/api_v1_menus_{menuId}_sections_{sectionId}_items_{itemCode}_modifier-options_{optionId}_outlets_{outletId}_Set
                  per-outlet modifier option override_Response_200
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PutApiV1MenusMenuidSectionsSectionidItemsItemcodeModifier-optionsOptionidOutletsOutletidRequestNotFoundError
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                isDisabled:
                  type: boolean
                additionalPrice:
                  type: number
                  format: double
                additionalPriceEatin:
                  type: integer
                additionalPriceDelivery:
                  type: number
                  format: double
              required:
                - isDisabled
                - additionalPrice
                - additionalPriceEatin
                - additionalPriceDelivery
servers:
  - url: http://localhost:8080
components:
  schemas:
    api_v1_menus_{menuId}_sections_{sectionId}_items_{itemCode}_modifier-options_{optionId}_outlets_{outletId}_Set per-outlet modifier option override_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}_modifier-options_{optionId}_outlets_{outletId}_Set
        per-outlet modifier option override_Response_200
    ApiV1MenusMenuIdSectionsSectionIdItemsItemCodeModifierOptionsOptionIdOutletsOutletIdPutResponsesContentApplicationJsonSchemaError:
      type: object
      properties:
        code:
          type: integer
        message:
          type: string
        details:
          type: string
        field:
          type: string
      required:
        - code
        - message
        - details
        - field
      title: >-
        ApiV1MenusMenuIdSectionsSectionIdItemsItemCodeModifierOptionsOptionIdOutletsOutletIdPutResponsesContentApplicationJsonSchemaError
    PutApiV1MenusMenuidSectionsSectionidItemsItemcodeModifier-optionsOptionidOutletsOutletidRequestNotFoundError:
      type: object
      properties:
        error:
          $ref: >-
            #/components/schemas/ApiV1MenusMenuIdSectionsSectionIdItemsItemCodeModifierOptionsOptionIdOutletsOutletIdPutResponsesContentApplicationJsonSchemaError
      required:
        - error
      title: >-
        PutApiV1MenusMenuidSectionsSectionidItemsItemcodeModifier-optionsOptionidOutletsOutletidRequestNotFoundError
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key

```

## SDK Code Examples

```python api_v1_menus_{menuId}_sections_{sectionId}_items_{itemCode}_modifier-options_{optionId}_outlets_{outletId}_Set per-outlet modifier option override_example
import requests

url = "http://localhost:8080/api/v1/menus/string/sections/string/items/string/modifier-options/1514/outlets/string"

payload = {
    "isDisabled": False,
    "additionalPrice": 1.5,
    "additionalPriceEatin": 2,
    "additionalPriceDelivery": 2.5
}
headers = {
    "X-Tenant-ID": "string",
    "X-Api-Key": "<apiKey>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript api_v1_menus_{menuId}_sections_{sectionId}_items_{itemCode}_modifier-options_{optionId}_outlets_{outletId}_Set per-outlet modifier option override_example
const url = 'http://localhost:8080/api/v1/menus/string/sections/string/items/string/modifier-options/1514/outlets/string';
const options = {
  method: 'PUT',
  headers: {
    'X-Tenant-ID': 'string',
    'X-Api-Key': '<apiKey>',
    'Content-Type': 'application/json'
  },
  body: '{"isDisabled":false,"additionalPrice":1.5,"additionalPriceEatin":2,"additionalPriceDelivery":2.5}'
};

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}_modifier-options_{optionId}_outlets_{outletId}_Set per-outlet modifier option override_example
package main

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

func main() {

	url := "http://localhost:8080/api/v1/menus/string/sections/string/items/string/modifier-options/1514/outlets/string"

	payload := strings.NewReader("{\n  \"isDisabled\": false,\n  \"additionalPrice\": 1.5,\n  \"additionalPriceEatin\": 2,\n  \"additionalPriceDelivery\": 2.5\n}")

	req, _ := http.NewRequest("PUT", 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}_modifier-options_{optionId}_outlets_{outletId}_Set per-outlet modifier option override_example
require 'uri'
require 'net/http'

url = URI("http://localhost:8080/api/v1/menus/string/sections/string/items/string/modifier-options/1514/outlets/string")

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

request = Net::HTTP::Put.new(url)
request["X-Tenant-ID"] = 'string'
request["X-Api-Key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"isDisabled\": false,\n  \"additionalPrice\": 1.5,\n  \"additionalPriceEatin\": 2,\n  \"additionalPriceDelivery\": 2.5\n}"

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

```java api_v1_menus_{menuId}_sections_{sectionId}_items_{itemCode}_modifier-options_{optionId}_outlets_{outletId}_Set per-outlet modifier option override_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.put("http://localhost:8080/api/v1/menus/string/sections/string/items/string/modifier-options/1514/outlets/string")
  .header("X-Tenant-ID", "string")
  .header("X-Api-Key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"isDisabled\": false,\n  \"additionalPrice\": 1.5,\n  \"additionalPriceEatin\": 2,\n  \"additionalPriceDelivery\": 2.5\n}")
  .asString();
```

```php api_v1_menus_{menuId}_sections_{sectionId}_items_{itemCode}_modifier-options_{optionId}_outlets_{outletId}_Set per-outlet modifier option override_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'http://localhost:8080/api/v1/menus/string/sections/string/items/string/modifier-options/1514/outlets/string', [
  'body' => '{
  "isDisabled": false,
  "additionalPrice": 1.5,
  "additionalPriceEatin": 2,
  "additionalPriceDelivery": 2.5
}',
  '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}_modifier-options_{optionId}_outlets_{outletId}_Set per-outlet modifier option override_example
using RestSharp;

var client = new RestClient("http://localhost:8080/api/v1/menus/string/sections/string/items/string/modifier-options/1514/outlets/string");
var request = new RestRequest(Method.PUT);
request.AddHeader("X-Tenant-ID", "string");
request.AddHeader("X-Api-Key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"isDisabled\": false,\n  \"additionalPrice\": 1.5,\n  \"additionalPriceEatin\": 2,\n  \"additionalPriceDelivery\": 2.5\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift api_v1_menus_{menuId}_sections_{sectionId}_items_{itemCode}_modifier-options_{optionId}_outlets_{outletId}_Set per-outlet modifier option override_example
import Foundation

let headers = [
  "X-Tenant-ID": "string",
  "X-Api-Key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [
  "isDisabled": false,
  "additionalPrice": 1.5,
  "additionalPriceEatin": 2,
  "additionalPriceDelivery": 2.5
] 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/modifier-options/1514/outlets/string")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
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()
```