Update a modifier
curl --request PATCH \
--url https://server.chataigne.ai/v1/locations/{location_id}/catalogs/{catalog_id}/modifier_groups/{modifier_group_id}/modifiers/{modifier_id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"image_url": "<string>",
"disabled": true,
"out_of_stock": true,
"restrictions": [
{
"days_of_week": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
],
"start_time": "18:00",
"end_time": "22:00",
"start_date": "2023-11-07T05:31:56Z",
"end_date": "2023-11-07T05:31:56Z",
"service_types": [
"delivery",
"collection"
]
}
],
"price_overrides": [
{
"price": {
"amount": 12.9,
"currency": "EUR"
},
"conditions": {
"days_of_week": [],
"start_time": "18:00",
"end_time": "22:00"
}
}
]
}
'import requests
url = "https://server.chataigne.ai/v1/locations/{location_id}/catalogs/{catalog_id}/modifier_groups/{modifier_group_id}/modifiers/{modifier_id}"
payload = {
"name": "<string>",
"image_url": "<string>",
"disabled": True,
"out_of_stock": True,
"restrictions": [
{
"days_of_week": ["monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday"],
"start_time": "18:00",
"end_time": "22:00",
"start_date": "2023-11-07T05:31:56Z",
"end_date": "2023-11-07T05:31:56Z",
"service_types": ["delivery", "collection"]
}
],
"price_overrides": [
{
"price": {
"amount": 12.9,
"currency": "EUR"
},
"conditions": {
"days_of_week": [],
"start_time": "18:00",
"end_time": "22:00"
}
}
]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
image_url: '<string>',
disabled: true,
out_of_stock: true,
restrictions: [
{
days_of_week: ['monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday', 'sunday'],
start_time: '18:00',
end_time: '22:00',
start_date: '2023-11-07T05:31:56Z',
end_date: '2023-11-07T05:31:56Z',
service_types: ['delivery', 'collection']
}
],
price_overrides: [
{
price: {amount: 12.9, currency: 'EUR'},
conditions: {days_of_week: [], start_time: '18:00', end_time: '22:00'}
}
]
})
};
fetch('https://server.chataigne.ai/v1/locations/{location_id}/catalogs/{catalog_id}/modifier_groups/{modifier_group_id}/modifiers/{modifier_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://server.chataigne.ai/v1/locations/{location_id}/catalogs/{catalog_id}/modifier_groups/{modifier_group_id}/modifiers/{modifier_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'image_url' => '<string>',
'disabled' => true,
'out_of_stock' => true,
'restrictions' => [
[
'days_of_week' => [
'monday',
'tuesday',
'wednesday',
'thursday',
'friday',
'saturday',
'sunday'
],
'start_time' => '18:00',
'end_time' => '22:00',
'start_date' => '2023-11-07T05:31:56Z',
'end_date' => '2023-11-07T05:31:56Z',
'service_types' => [
'delivery',
'collection'
]
]
],
'price_overrides' => [
[
'price' => [
'amount' => 12.9,
'currency' => 'EUR'
],
'conditions' => [
'days_of_week' => [
],
'start_time' => '18:00',
'end_time' => '22:00'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://server.chataigne.ai/v1/locations/{location_id}/catalogs/{catalog_id}/modifier_groups/{modifier_group_id}/modifiers/{modifier_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"image_url\": \"<string>\",\n \"disabled\": true,\n \"out_of_stock\": true,\n \"restrictions\": [\n {\n \"days_of_week\": [\n \"monday\",\n \"tuesday\",\n \"wednesday\",\n \"thursday\",\n \"friday\",\n \"saturday\",\n \"sunday\"\n ],\n \"start_time\": \"18:00\",\n \"end_time\": \"22:00\",\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"service_types\": [\n \"delivery\",\n \"collection\"\n ]\n }\n ],\n \"price_overrides\": [\n {\n \"price\": {\n \"amount\": 12.9,\n \"currency\": \"EUR\"\n },\n \"conditions\": {\n \"days_of_week\": [],\n \"start_time\": \"18:00\",\n \"end_time\": \"22:00\"\n }\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://server.chataigne.ai/v1/locations/{location_id}/catalogs/{catalog_id}/modifier_groups/{modifier_group_id}/modifiers/{modifier_id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"image_url\": \"<string>\",\n \"disabled\": true,\n \"out_of_stock\": true,\n \"restrictions\": [\n {\n \"days_of_week\": [\n \"monday\",\n \"tuesday\",\n \"wednesday\",\n \"thursday\",\n \"friday\",\n \"saturday\",\n \"sunday\"\n ],\n \"start_time\": \"18:00\",\n \"end_time\": \"22:00\",\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"service_types\": [\n \"delivery\",\n \"collection\"\n ]\n }\n ],\n \"price_overrides\": [\n {\n \"price\": {\n \"amount\": 12.9,\n \"currency\": \"EUR\"\n },\n \"conditions\": {\n \"days_of_week\": [],\n \"start_time\": \"18:00\",\n \"end_time\": \"22:00\"\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://server.chataigne.ai/v1/locations/{location_id}/catalogs/{catalog_id}/modifier_groups/{modifier_group_id}/modifiers/{modifier_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"image_url\": \"<string>\",\n \"disabled\": true,\n \"out_of_stock\": true,\n \"restrictions\": [\n {\n \"days_of_week\": [\n \"monday\",\n \"tuesday\",\n \"wednesday\",\n \"thursday\",\n \"friday\",\n \"saturday\",\n \"sunday\"\n ],\n \"start_time\": \"18:00\",\n \"end_time\": \"22:00\",\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"service_types\": [\n \"delivery\",\n \"collection\"\n ]\n }\n ],\n \"price_overrides\": [\n {\n \"price\": {\n \"amount\": 12.9,\n \"currency\": \"EUR\"\n },\n \"conditions\": {\n \"days_of_week\": [],\n \"start_time\": \"18:00\",\n \"end_time\": \"22:00\"\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "bacon",
"name": "Bacon",
"price": {
"amount": 12.9,
"currency": "EUR"
},
"disabled": false,
"out_of_stock": false,
"restrictions": [],
"price_overrides": [],
"object": "modifier",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"image_url": "<string>"
}{
"error": {
"type": "invalid_request_error",
"code": "resource_missing",
"message": "<string>",
"request_id": "req_8f2c…",
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request_error",
"code": "resource_missing",
"message": "<string>",
"request_id": "req_8f2c…",
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request_error",
"code": "resource_missing",
"message": "<string>",
"request_id": "req_8f2c…",
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request_error",
"code": "resource_missing",
"message": "<string>",
"request_id": "req_8f2c…",
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request_error",
"code": "resource_missing",
"message": "<string>",
"request_id": "req_8f2c…",
"param": "<string>",
"details": {}
}
}Catalog modifiers
Update a modifier
PATCH
/
v1
/
locations
/
{location_id}
/
catalogs
/
{catalog_id}
/
modifier_groups
/
{modifier_group_id}
/
modifiers
/
{modifier_id}
Update a modifier
curl --request PATCH \
--url https://server.chataigne.ai/v1/locations/{location_id}/catalogs/{catalog_id}/modifier_groups/{modifier_group_id}/modifiers/{modifier_id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"image_url": "<string>",
"disabled": true,
"out_of_stock": true,
"restrictions": [
{
"days_of_week": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
],
"start_time": "18:00",
"end_time": "22:00",
"start_date": "2023-11-07T05:31:56Z",
"end_date": "2023-11-07T05:31:56Z",
"service_types": [
"delivery",
"collection"
]
}
],
"price_overrides": [
{
"price": {
"amount": 12.9,
"currency": "EUR"
},
"conditions": {
"days_of_week": [],
"start_time": "18:00",
"end_time": "22:00"
}
}
]
}
'import requests
url = "https://server.chataigne.ai/v1/locations/{location_id}/catalogs/{catalog_id}/modifier_groups/{modifier_group_id}/modifiers/{modifier_id}"
payload = {
"name": "<string>",
"image_url": "<string>",
"disabled": True,
"out_of_stock": True,
"restrictions": [
{
"days_of_week": ["monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday"],
"start_time": "18:00",
"end_time": "22:00",
"start_date": "2023-11-07T05:31:56Z",
"end_date": "2023-11-07T05:31:56Z",
"service_types": ["delivery", "collection"]
}
],
"price_overrides": [
{
"price": {
"amount": 12.9,
"currency": "EUR"
},
"conditions": {
"days_of_week": [],
"start_time": "18:00",
"end_time": "22:00"
}
}
]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
image_url: '<string>',
disabled: true,
out_of_stock: true,
restrictions: [
{
days_of_week: ['monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday', 'sunday'],
start_time: '18:00',
end_time: '22:00',
start_date: '2023-11-07T05:31:56Z',
end_date: '2023-11-07T05:31:56Z',
service_types: ['delivery', 'collection']
}
],
price_overrides: [
{
price: {amount: 12.9, currency: 'EUR'},
conditions: {days_of_week: [], start_time: '18:00', end_time: '22:00'}
}
]
})
};
fetch('https://server.chataigne.ai/v1/locations/{location_id}/catalogs/{catalog_id}/modifier_groups/{modifier_group_id}/modifiers/{modifier_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://server.chataigne.ai/v1/locations/{location_id}/catalogs/{catalog_id}/modifier_groups/{modifier_group_id}/modifiers/{modifier_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'image_url' => '<string>',
'disabled' => true,
'out_of_stock' => true,
'restrictions' => [
[
'days_of_week' => [
'monday',
'tuesday',
'wednesday',
'thursday',
'friday',
'saturday',
'sunday'
],
'start_time' => '18:00',
'end_time' => '22:00',
'start_date' => '2023-11-07T05:31:56Z',
'end_date' => '2023-11-07T05:31:56Z',
'service_types' => [
'delivery',
'collection'
]
]
],
'price_overrides' => [
[
'price' => [
'amount' => 12.9,
'currency' => 'EUR'
],
'conditions' => [
'days_of_week' => [
],
'start_time' => '18:00',
'end_time' => '22:00'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://server.chataigne.ai/v1/locations/{location_id}/catalogs/{catalog_id}/modifier_groups/{modifier_group_id}/modifiers/{modifier_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"image_url\": \"<string>\",\n \"disabled\": true,\n \"out_of_stock\": true,\n \"restrictions\": [\n {\n \"days_of_week\": [\n \"monday\",\n \"tuesday\",\n \"wednesday\",\n \"thursday\",\n \"friday\",\n \"saturday\",\n \"sunday\"\n ],\n \"start_time\": \"18:00\",\n \"end_time\": \"22:00\",\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"service_types\": [\n \"delivery\",\n \"collection\"\n ]\n }\n ],\n \"price_overrides\": [\n {\n \"price\": {\n \"amount\": 12.9,\n \"currency\": \"EUR\"\n },\n \"conditions\": {\n \"days_of_week\": [],\n \"start_time\": \"18:00\",\n \"end_time\": \"22:00\"\n }\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://server.chataigne.ai/v1/locations/{location_id}/catalogs/{catalog_id}/modifier_groups/{modifier_group_id}/modifiers/{modifier_id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"image_url\": \"<string>\",\n \"disabled\": true,\n \"out_of_stock\": true,\n \"restrictions\": [\n {\n \"days_of_week\": [\n \"monday\",\n \"tuesday\",\n \"wednesday\",\n \"thursday\",\n \"friday\",\n \"saturday\",\n \"sunday\"\n ],\n \"start_time\": \"18:00\",\n \"end_time\": \"22:00\",\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"service_types\": [\n \"delivery\",\n \"collection\"\n ]\n }\n ],\n \"price_overrides\": [\n {\n \"price\": {\n \"amount\": 12.9,\n \"currency\": \"EUR\"\n },\n \"conditions\": {\n \"days_of_week\": [],\n \"start_time\": \"18:00\",\n \"end_time\": \"22:00\"\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://server.chataigne.ai/v1/locations/{location_id}/catalogs/{catalog_id}/modifier_groups/{modifier_group_id}/modifiers/{modifier_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"image_url\": \"<string>\",\n \"disabled\": true,\n \"out_of_stock\": true,\n \"restrictions\": [\n {\n \"days_of_week\": [\n \"monday\",\n \"tuesday\",\n \"wednesday\",\n \"thursday\",\n \"friday\",\n \"saturday\",\n \"sunday\"\n ],\n \"start_time\": \"18:00\",\n \"end_time\": \"22:00\",\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"service_types\": [\n \"delivery\",\n \"collection\"\n ]\n }\n ],\n \"price_overrides\": [\n {\n \"price\": {\n \"amount\": 12.9,\n \"currency\": \"EUR\"\n },\n \"conditions\": {\n \"days_of_week\": [],\n \"start_time\": \"18:00\",\n \"end_time\": \"22:00\"\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "bacon",
"name": "Bacon",
"price": {
"amount": 12.9,
"currency": "EUR"
},
"disabled": false,
"out_of_stock": false,
"restrictions": [],
"price_overrides": [],
"object": "modifier",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"image_url": "<string>"
}{
"error": {
"type": "invalid_request_error",
"code": "resource_missing",
"message": "<string>",
"request_id": "req_8f2c…",
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request_error",
"code": "resource_missing",
"message": "<string>",
"request_id": "req_8f2c…",
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request_error",
"code": "resource_missing",
"message": "<string>",
"request_id": "req_8f2c…",
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request_error",
"code": "resource_missing",
"message": "<string>",
"request_id": "req_8f2c…",
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request_error",
"code": "resource_missing",
"message": "<string>",
"request_id": "req_8f2c…",
"param": "<string>",
"details": {}
}
}Authorizations
Location/organization API key.
Path Parameters
Body
application/json
Show child attributes
Show child attributes
Whether the resource is hidden and cannot be ordered.
Whether the resource is temporarily unavailable while remaining visible.
Availability windows. The resource is available when any restriction matches.
Maximum array length:
100Show child attributes
Show child attributes
Conditional prices. The matching override with the most specific conditions wins.
Maximum array length:
100Show child attributes
Show child attributes
Response
The updated modifier.
Pattern:
^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$Example:
"bacon"
Example:
"Bacon"
Show child attributes
Show child attributes
Whether the resource is hidden and cannot be ordered.
Whether the resource is temporarily unavailable while remaining visible.
Availability windows. The resource is available when any restriction matches.
Maximum array length:
100Show child attributes
Show child attributes
Conditional prices. The matching override with the most specific conditions wins.
Maximum array length:
100Show child attributes
Show child attributes
Available options:
modifier