Update a product

curl --request PATCH \
  --url https://server.chataigne.ai/v1/locations/{location_id}/catalogs/{catalog_id}/products/{product_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "category_id": "<string>",
  "description": "<string>",
  "image_url": "<string>",
  "modifier_group_ids": [
    "<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"
      }
    }
  ],
  "bundle_only": true,
  "order": 1
}
'

import requests

url = "https://server.chataigne.ai/v1/locations/{location_id}/catalogs/{catalog_id}/products/{product_id}"

payload = {
    "name": "<string>",
    "category_id": "<string>",
    "description": "<string>",
    "image_url": "<string>",
    "modifier_group_ids": ["<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"
            }
        }
    ],
    "bundle_only": True,
    "order": 1
}
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>',
    category_id: '<string>',
    description: '<string>',
    image_url: '<string>',
    modifier_group_ids: ['<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'}
      }
    ],
    bundle_only: true,
    order: 1
  })
};

fetch('https://server.chataigne.ai/v1/locations/{location_id}/catalogs/{catalog_id}/products/{product_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}/products/{product_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>',
    'category_id' => '<string>',
    'description' => '<string>',
    'image_url' => '<string>',
    'modifier_group_ids' => [
        '<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'
                ]
        ]
    ],
    'bundle_only' => true,
    'order' => 1
  ]),
  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}/products/{product_id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"category_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"image_url\": \"<string>\",\n  \"modifier_group_ids\": [\n    \"<string>\"\n  ],\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  \"bundle_only\": true,\n  \"order\": 1\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}/products/{product_id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"category_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"image_url\": \"<string>\",\n  \"modifier_group_ids\": [\n    \"<string>\"\n  ],\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  \"bundle_only\": true,\n  \"order\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://server.chataigne.ai/v1/locations/{location_id}/catalogs/{catalog_id}/products/{product_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  \"category_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"image_url\": \"<string>\",\n  \"modifier_group_ids\": [\n    \"<string>\"\n  ],\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  \"bundle_only\": true,\n  \"order\": 1\n}"

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

{
  "id": "burger-classic",
  "name": "Classic Burger",
  "category_id": "burgers",
  "price": {
    "amount": 12.9,
    "currency": "EUR"
  },
  "modifier_group_ids": [
    "<string>"
  ],
  "disabled": false,
  "out_of_stock": false,
  "restrictions": [],
  "price_overrides": [],
  "bundle_only": false,
  "order": 1,
  "object": "product",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "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": {}
  }
}

PATCH

locations

{location_id}

catalogs

{catalog_id}

products

{product_id}

Update a product

curl --request PATCH \
  --url https://server.chataigne.ai/v1/locations/{location_id}/catalogs/{catalog_id}/products/{product_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "category_id": "<string>",
  "description": "<string>",
  "image_url": "<string>",
  "modifier_group_ids": [
    "<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"
      }
    }
  ],
  "bundle_only": true,
  "order": 1
}
'

import requests

url = "https://server.chataigne.ai/v1/locations/{location_id}/catalogs/{catalog_id}/products/{product_id}"

payload = {
    "name": "<string>",
    "category_id": "<string>",
    "description": "<string>",
    "image_url": "<string>",
    "modifier_group_ids": ["<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"
            }
        }
    ],
    "bundle_only": True,
    "order": 1
}
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>',
    category_id: '<string>',
    description: '<string>',
    image_url: '<string>',
    modifier_group_ids: ['<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'}
      }
    ],
    bundle_only: true,
    order: 1
  })
};

fetch('https://server.chataigne.ai/v1/locations/{location_id}/catalogs/{catalog_id}/products/{product_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}/products/{product_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>',
    'category_id' => '<string>',
    'description' => '<string>',
    'image_url' => '<string>',
    'modifier_group_ids' => [
        '<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'
                ]
        ]
    ],
    'bundle_only' => true,
    'order' => 1
  ]),
  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}/products/{product_id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"category_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"image_url\": \"<string>\",\n  \"modifier_group_ids\": [\n    \"<string>\"\n  ],\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  \"bundle_only\": true,\n  \"order\": 1\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}/products/{product_id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"category_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"image_url\": \"<string>\",\n  \"modifier_group_ids\": [\n    \"<string>\"\n  ],\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  \"bundle_only\": true,\n  \"order\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://server.chataigne.ai/v1/locations/{location_id}/catalogs/{catalog_id}/products/{product_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  \"category_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"image_url\": \"<string>\",\n  \"modifier_group_ids\": [\n    \"<string>\"\n  ],\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  \"bundle_only\": true,\n  \"order\": 1\n}"

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

{
  "id": "burger-classic",
  "name": "Classic Burger",
  "category_id": "burgers",
  "price": {
    "amount": 12.9,
    "currency": "EUR"
  },
  "modifier_group_ids": [
    "<string>"
  ],
  "disabled": false,
  "out_of_stock": false,
  "restrictions": [],
  "price_overrides": [],
  "bundle_only": false,
  "order": 1,
  "object": "product",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "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

x-api-key

string

header

required

Location/organization API key.

Path Parameters

location_id

string

required

catalog_id

string

required

product_id

string

required

Body

application/json

name

string

category_id

string

description

string | null

image_url

string<uri> | null

price

object

Show child attributes

modifier_group_ids

string[]

disabled

boolean

Whether the resource is hidden and cannot be ordered.

out_of_stock

boolean

Whether the resource is temporarily unavailable while remaining visible.

restrictions

object[]

Availability windows. The resource is available when any restriction matches.

Maximum array length: 100

Show child attributes

price_overrides

object[]

Conditional prices. The matching override with the most specific conditions wins.

Maximum array length: 100

Show child attributes

bundle_only

boolean

order

integer

Required range: x >= 0

Response

The updated product.

A sellable product. Internal SKU details are never exposed.

string

required

Pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$

Example:

"burger-classic"

name

string

required

Example:

"Classic Burger"

category_id

string

required

Example:

"burgers"

price

object

required

Show child attributes

modifier_group_ids

string[]

required

disabled

boolean

default:false

required

Whether the resource is hidden and cannot be ordered.

out_of_stock

boolean

default:false

required

Whether the resource is temporarily unavailable while remaining visible.

restrictions

object[]

required

Availability windows. The resource is available when any restriction matches.

Maximum array length: 100

Show child attributes

price_overrides

object[]

required

Conditional prices. The matching override with the most specific conditions wins.

Maximum array length: 100

Show child attributes

bundle_only

boolean

default:false

required

Whether the product can only be selected inside a bundle.

order

integer

required

Optional sort order. Omitted products are placed after explicitly ordered products in their category.

Required range: x >= 0

object

enum<string>

required

Available options:

product

created_at

string<date-time>

required

updated_at

string<date-time>

required

description

string | null

image_url

string<uri> | null