Synchronize a complete catalog snapshot
curl --request PUT \
--url https://server.chataigne.ai/v1/locations/{location_id}/catalogs/{catalog_id} \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "Delivery menu",
"categories": [
{
"id": "burgers",
"name": "Burgers",
"description": "<string>",
"image_url": "<string>"
}
],
"products": [
{
"id": "burger-classic",
"name": "Classic Burger",
"category_id": "burgers",
"price": {
"amount": 12.9,
"currency": "EUR"
},
"modifier_group_ids": [
"<string>"
],
"description": "<string>",
"image_url": "<string>",
"disabled": false,
"out_of_stock": false,
"restrictions": [],
"price_overrides": [],
"bundle_only": false,
"order": 1
}
],
"modifier_groups": [
{
"id": "sauces",
"name": "Choose a sauce",
"modifiers": [
{
"id": "bacon",
"name": "Bacon",
"image_url": "<string>",
"disabled": false,
"out_of_stock": false,
"restrictions": [],
"price_overrides": []
}
],
"min_selections": 0,
"max_selections": 1
}
],
"bundles": [
{
"id": "classic-meal",
"name": "Classic Meal",
"category_id": "meals",
"price": {
"amount": 12.9,
"currency": "EUR"
},
"lines": [
{
"id": "main",
"product_ids": [
"<string>"
],
"name": "<string>",
"min_selections": 1,
"max_selections": 1
}
],
"description": "<string>",
"image_url": "<string>",
"disabled": false,
"out_of_stock": false,
"restrictions": [],
"price_overrides": []
}
]
}
'import requests
url = "https://server.chataigne.ai/v1/locations/{location_id}/catalogs/{catalog_id}"
payload = {
"name": "Delivery menu",
"categories": [
{
"id": "burgers",
"name": "Burgers",
"description": "<string>",
"image_url": "<string>"
}
],
"products": [
{
"id": "burger-classic",
"name": "Classic Burger",
"category_id": "burgers",
"price": {
"amount": 12.9,
"currency": "EUR"
},
"modifier_group_ids": ["<string>"],
"description": "<string>",
"image_url": "<string>",
"disabled": False,
"out_of_stock": False,
"restrictions": [],
"price_overrides": [],
"bundle_only": False,
"order": 1
}
],
"modifier_groups": [
{
"id": "sauces",
"name": "Choose a sauce",
"modifiers": [
{
"id": "bacon",
"name": "Bacon",
"image_url": "<string>",
"disabled": False,
"out_of_stock": False,
"restrictions": [],
"price_overrides": []
}
],
"min_selections": 0,
"max_selections": 1
}
],
"bundles": [
{
"id": "classic-meal",
"name": "Classic Meal",
"category_id": "meals",
"price": {
"amount": 12.9,
"currency": "EUR"
},
"lines": [
{
"id": "main",
"product_ids": ["<string>"],
"name": "<string>",
"min_selections": 1,
"max_selections": 1
}
],
"description": "<string>",
"image_url": "<string>",
"disabled": False,
"out_of_stock": False,
"restrictions": [],
"price_overrides": []
}
]
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'Idempotency-Key': '<idempotency-key>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Delivery menu',
categories: [
{id: 'burgers', name: 'Burgers', description: '<string>', image_url: '<string>'}
],
products: [
{
id: 'burger-classic',
name: 'Classic Burger',
category_id: 'burgers',
price: {amount: 12.9, currency: 'EUR'},
modifier_group_ids: ['<string>'],
description: '<string>',
image_url: '<string>',
disabled: false,
out_of_stock: false,
restrictions: [],
price_overrides: [],
bundle_only: false,
order: 1
}
],
modifier_groups: [
{
id: 'sauces',
name: 'Choose a sauce',
modifiers: [
{
id: 'bacon',
name: 'Bacon',
image_url: '<string>',
disabled: false,
out_of_stock: false,
restrictions: [],
price_overrides: []
}
],
min_selections: 0,
max_selections: 1
}
],
bundles: [
{
id: 'classic-meal',
name: 'Classic Meal',
category_id: 'meals',
price: {amount: 12.9, currency: 'EUR'},
lines: [
{
id: 'main',
product_ids: ['<string>'],
name: '<string>',
min_selections: 1,
max_selections: 1
}
],
description: '<string>',
image_url: '<string>',
disabled: false,
out_of_stock: false,
restrictions: [],
price_overrides: []
}
]
})
};
fetch('https://server.chataigne.ai/v1/locations/{location_id}/catalogs/{catalog_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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Delivery menu',
'categories' => [
[
'id' => 'burgers',
'name' => 'Burgers',
'description' => '<string>',
'image_url' => '<string>'
]
],
'products' => [
[
'id' => 'burger-classic',
'name' => 'Classic Burger',
'category_id' => 'burgers',
'price' => [
'amount' => 12.9,
'currency' => 'EUR'
],
'modifier_group_ids' => [
'<string>'
],
'description' => '<string>',
'image_url' => '<string>',
'disabled' => false,
'out_of_stock' => false,
'restrictions' => [
],
'price_overrides' => [
],
'bundle_only' => false,
'order' => 1
]
],
'modifier_groups' => [
[
'id' => 'sauces',
'name' => 'Choose a sauce',
'modifiers' => [
[
'id' => 'bacon',
'name' => 'Bacon',
'image_url' => '<string>',
'disabled' => false,
'out_of_stock' => false,
'restrictions' => [
],
'price_overrides' => [
]
]
],
'min_selections' => 0,
'max_selections' => 1
]
],
'bundles' => [
[
'id' => 'classic-meal',
'name' => 'Classic Meal',
'category_id' => 'meals',
'price' => [
'amount' => 12.9,
'currency' => 'EUR'
],
'lines' => [
[
'id' => 'main',
'product_ids' => [
'<string>'
],
'name' => '<string>',
'min_selections' => 1,
'max_selections' => 1
]
],
'description' => '<string>',
'image_url' => '<string>',
'disabled' => false,
'out_of_stock' => false,
'restrictions' => [
],
'price_overrides' => [
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>",
"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}"
payload := strings.NewReader("{\n \"name\": \"Delivery menu\",\n \"categories\": [\n {\n \"id\": \"burgers\",\n \"name\": \"Burgers\",\n \"description\": \"<string>\",\n \"image_url\": \"<string>\"\n }\n ],\n \"products\": [\n {\n \"id\": \"burger-classic\",\n \"name\": \"Classic Burger\",\n \"category_id\": \"burgers\",\n \"price\": {\n \"amount\": 12.9,\n \"currency\": \"EUR\"\n },\n \"modifier_group_ids\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"image_url\": \"<string>\",\n \"disabled\": false,\n \"out_of_stock\": false,\n \"restrictions\": [],\n \"price_overrides\": [],\n \"bundle_only\": false,\n \"order\": 1\n }\n ],\n \"modifier_groups\": [\n {\n \"id\": \"sauces\",\n \"name\": \"Choose a sauce\",\n \"modifiers\": [\n {\n \"id\": \"bacon\",\n \"name\": \"Bacon\",\n \"image_url\": \"<string>\",\n \"disabled\": false,\n \"out_of_stock\": false,\n \"restrictions\": [],\n \"price_overrides\": []\n }\n ],\n \"min_selections\": 0,\n \"max_selections\": 1\n }\n ],\n \"bundles\": [\n {\n \"id\": \"classic-meal\",\n \"name\": \"Classic Meal\",\n \"category_id\": \"meals\",\n \"price\": {\n \"amount\": 12.9,\n \"currency\": \"EUR\"\n },\n \"lines\": [\n {\n \"id\": \"main\",\n \"product_ids\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"min_selections\": 1,\n \"max_selections\": 1\n }\n ],\n \"description\": \"<string>\",\n \"image_url\": \"<string>\",\n \"disabled\": false,\n \"out_of_stock\": false,\n \"restrictions\": [],\n \"price_overrides\": []\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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.put("https://server.chataigne.ai/v1/locations/{location_id}/catalogs/{catalog_id}")
.header("Idempotency-Key", "<idempotency-key>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Delivery menu\",\n \"categories\": [\n {\n \"id\": \"burgers\",\n \"name\": \"Burgers\",\n \"description\": \"<string>\",\n \"image_url\": \"<string>\"\n }\n ],\n \"products\": [\n {\n \"id\": \"burger-classic\",\n \"name\": \"Classic Burger\",\n \"category_id\": \"burgers\",\n \"price\": {\n \"amount\": 12.9,\n \"currency\": \"EUR\"\n },\n \"modifier_group_ids\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"image_url\": \"<string>\",\n \"disabled\": false,\n \"out_of_stock\": false,\n \"restrictions\": [],\n \"price_overrides\": [],\n \"bundle_only\": false,\n \"order\": 1\n }\n ],\n \"modifier_groups\": [\n {\n \"id\": \"sauces\",\n \"name\": \"Choose a sauce\",\n \"modifiers\": [\n {\n \"id\": \"bacon\",\n \"name\": \"Bacon\",\n \"image_url\": \"<string>\",\n \"disabled\": false,\n \"out_of_stock\": false,\n \"restrictions\": [],\n \"price_overrides\": []\n }\n ],\n \"min_selections\": 0,\n \"max_selections\": 1\n }\n ],\n \"bundles\": [\n {\n \"id\": \"classic-meal\",\n \"name\": \"Classic Meal\",\n \"category_id\": \"meals\",\n \"price\": {\n \"amount\": 12.9,\n \"currency\": \"EUR\"\n },\n \"lines\": [\n {\n \"id\": \"main\",\n \"product_ids\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"min_selections\": 1,\n \"max_selections\": 1\n }\n ],\n \"description\": \"<string>\",\n \"image_url\": \"<string>\",\n \"disabled\": false,\n \"out_of_stock\": false,\n \"restrictions\": [],\n \"price_overrides\": []\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://server.chataigne.ai/v1/locations/{location_id}/catalogs/{catalog_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Delivery menu\",\n \"categories\": [\n {\n \"id\": \"burgers\",\n \"name\": \"Burgers\",\n \"description\": \"<string>\",\n \"image_url\": \"<string>\"\n }\n ],\n \"products\": [\n {\n \"id\": \"burger-classic\",\n \"name\": \"Classic Burger\",\n \"category_id\": \"burgers\",\n \"price\": {\n \"amount\": 12.9,\n \"currency\": \"EUR\"\n },\n \"modifier_group_ids\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"image_url\": \"<string>\",\n \"disabled\": false,\n \"out_of_stock\": false,\n \"restrictions\": [],\n \"price_overrides\": [],\n \"bundle_only\": false,\n \"order\": 1\n }\n ],\n \"modifier_groups\": [\n {\n \"id\": \"sauces\",\n \"name\": \"Choose a sauce\",\n \"modifiers\": [\n {\n \"id\": \"bacon\",\n \"name\": \"Bacon\",\n \"image_url\": \"<string>\",\n \"disabled\": false,\n \"out_of_stock\": false,\n \"restrictions\": [],\n \"price_overrides\": []\n }\n ],\n \"min_selections\": 0,\n \"max_selections\": 1\n }\n ],\n \"bundles\": [\n {\n \"id\": \"classic-meal\",\n \"name\": \"Classic Meal\",\n \"category_id\": \"meals\",\n \"price\": {\n \"amount\": 12.9,\n \"currency\": \"EUR\"\n },\n \"lines\": [\n {\n \"id\": \"main\",\n \"product_ids\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"min_selections\": 1,\n \"max_selections\": 1\n }\n ],\n \"description\": \"<string>\",\n \"image_url\": \"<string>\",\n \"disabled\": false,\n \"out_of_stock\": false,\n \"restrictions\": [],\n \"price_overrides\": []\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "csync_123",
"object": "catalog_sync",
"catalog_id": "delivery-menu",
"status": "queued",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"error": {
"code": "<string>",
"message": "<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": {}
}
}Catalogs
Synchronize a complete catalog snapshot
PUT
/
v1
/
locations
/
{location_id}
/
catalogs
/
{catalog_id}
Synchronize a complete catalog snapshot
curl --request PUT \
--url https://server.chataigne.ai/v1/locations/{location_id}/catalogs/{catalog_id} \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "Delivery menu",
"categories": [
{
"id": "burgers",
"name": "Burgers",
"description": "<string>",
"image_url": "<string>"
}
],
"products": [
{
"id": "burger-classic",
"name": "Classic Burger",
"category_id": "burgers",
"price": {
"amount": 12.9,
"currency": "EUR"
},
"modifier_group_ids": [
"<string>"
],
"description": "<string>",
"image_url": "<string>",
"disabled": false,
"out_of_stock": false,
"restrictions": [],
"price_overrides": [],
"bundle_only": false,
"order": 1
}
],
"modifier_groups": [
{
"id": "sauces",
"name": "Choose a sauce",
"modifiers": [
{
"id": "bacon",
"name": "Bacon",
"image_url": "<string>",
"disabled": false,
"out_of_stock": false,
"restrictions": [],
"price_overrides": []
}
],
"min_selections": 0,
"max_selections": 1
}
],
"bundles": [
{
"id": "classic-meal",
"name": "Classic Meal",
"category_id": "meals",
"price": {
"amount": 12.9,
"currency": "EUR"
},
"lines": [
{
"id": "main",
"product_ids": [
"<string>"
],
"name": "<string>",
"min_selections": 1,
"max_selections": 1
}
],
"description": "<string>",
"image_url": "<string>",
"disabled": false,
"out_of_stock": false,
"restrictions": [],
"price_overrides": []
}
]
}
'import requests
url = "https://server.chataigne.ai/v1/locations/{location_id}/catalogs/{catalog_id}"
payload = {
"name": "Delivery menu",
"categories": [
{
"id": "burgers",
"name": "Burgers",
"description": "<string>",
"image_url": "<string>"
}
],
"products": [
{
"id": "burger-classic",
"name": "Classic Burger",
"category_id": "burgers",
"price": {
"amount": 12.9,
"currency": "EUR"
},
"modifier_group_ids": ["<string>"],
"description": "<string>",
"image_url": "<string>",
"disabled": False,
"out_of_stock": False,
"restrictions": [],
"price_overrides": [],
"bundle_only": False,
"order": 1
}
],
"modifier_groups": [
{
"id": "sauces",
"name": "Choose a sauce",
"modifiers": [
{
"id": "bacon",
"name": "Bacon",
"image_url": "<string>",
"disabled": False,
"out_of_stock": False,
"restrictions": [],
"price_overrides": []
}
],
"min_selections": 0,
"max_selections": 1
}
],
"bundles": [
{
"id": "classic-meal",
"name": "Classic Meal",
"category_id": "meals",
"price": {
"amount": 12.9,
"currency": "EUR"
},
"lines": [
{
"id": "main",
"product_ids": ["<string>"],
"name": "<string>",
"min_selections": 1,
"max_selections": 1
}
],
"description": "<string>",
"image_url": "<string>",
"disabled": False,
"out_of_stock": False,
"restrictions": [],
"price_overrides": []
}
]
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'Idempotency-Key': '<idempotency-key>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Delivery menu',
categories: [
{id: 'burgers', name: 'Burgers', description: '<string>', image_url: '<string>'}
],
products: [
{
id: 'burger-classic',
name: 'Classic Burger',
category_id: 'burgers',
price: {amount: 12.9, currency: 'EUR'},
modifier_group_ids: ['<string>'],
description: '<string>',
image_url: '<string>',
disabled: false,
out_of_stock: false,
restrictions: [],
price_overrides: [],
bundle_only: false,
order: 1
}
],
modifier_groups: [
{
id: 'sauces',
name: 'Choose a sauce',
modifiers: [
{
id: 'bacon',
name: 'Bacon',
image_url: '<string>',
disabled: false,
out_of_stock: false,
restrictions: [],
price_overrides: []
}
],
min_selections: 0,
max_selections: 1
}
],
bundles: [
{
id: 'classic-meal',
name: 'Classic Meal',
category_id: 'meals',
price: {amount: 12.9, currency: 'EUR'},
lines: [
{
id: 'main',
product_ids: ['<string>'],
name: '<string>',
min_selections: 1,
max_selections: 1
}
],
description: '<string>',
image_url: '<string>',
disabled: false,
out_of_stock: false,
restrictions: [],
price_overrides: []
}
]
})
};
fetch('https://server.chataigne.ai/v1/locations/{location_id}/catalogs/{catalog_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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Delivery menu',
'categories' => [
[
'id' => 'burgers',
'name' => 'Burgers',
'description' => '<string>',
'image_url' => '<string>'
]
],
'products' => [
[
'id' => 'burger-classic',
'name' => 'Classic Burger',
'category_id' => 'burgers',
'price' => [
'amount' => 12.9,
'currency' => 'EUR'
],
'modifier_group_ids' => [
'<string>'
],
'description' => '<string>',
'image_url' => '<string>',
'disabled' => false,
'out_of_stock' => false,
'restrictions' => [
],
'price_overrides' => [
],
'bundle_only' => false,
'order' => 1
]
],
'modifier_groups' => [
[
'id' => 'sauces',
'name' => 'Choose a sauce',
'modifiers' => [
[
'id' => 'bacon',
'name' => 'Bacon',
'image_url' => '<string>',
'disabled' => false,
'out_of_stock' => false,
'restrictions' => [
],
'price_overrides' => [
]
]
],
'min_selections' => 0,
'max_selections' => 1
]
],
'bundles' => [
[
'id' => 'classic-meal',
'name' => 'Classic Meal',
'category_id' => 'meals',
'price' => [
'amount' => 12.9,
'currency' => 'EUR'
],
'lines' => [
[
'id' => 'main',
'product_ids' => [
'<string>'
],
'name' => '<string>',
'min_selections' => 1,
'max_selections' => 1
]
],
'description' => '<string>',
'image_url' => '<string>',
'disabled' => false,
'out_of_stock' => false,
'restrictions' => [
],
'price_overrides' => [
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>",
"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}"
payload := strings.NewReader("{\n \"name\": \"Delivery menu\",\n \"categories\": [\n {\n \"id\": \"burgers\",\n \"name\": \"Burgers\",\n \"description\": \"<string>\",\n \"image_url\": \"<string>\"\n }\n ],\n \"products\": [\n {\n \"id\": \"burger-classic\",\n \"name\": \"Classic Burger\",\n \"category_id\": \"burgers\",\n \"price\": {\n \"amount\": 12.9,\n \"currency\": \"EUR\"\n },\n \"modifier_group_ids\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"image_url\": \"<string>\",\n \"disabled\": false,\n \"out_of_stock\": false,\n \"restrictions\": [],\n \"price_overrides\": [],\n \"bundle_only\": false,\n \"order\": 1\n }\n ],\n \"modifier_groups\": [\n {\n \"id\": \"sauces\",\n \"name\": \"Choose a sauce\",\n \"modifiers\": [\n {\n \"id\": \"bacon\",\n \"name\": \"Bacon\",\n \"image_url\": \"<string>\",\n \"disabled\": false,\n \"out_of_stock\": false,\n \"restrictions\": [],\n \"price_overrides\": []\n }\n ],\n \"min_selections\": 0,\n \"max_selections\": 1\n }\n ],\n \"bundles\": [\n {\n \"id\": \"classic-meal\",\n \"name\": \"Classic Meal\",\n \"category_id\": \"meals\",\n \"price\": {\n \"amount\": 12.9,\n \"currency\": \"EUR\"\n },\n \"lines\": [\n {\n \"id\": \"main\",\n \"product_ids\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"min_selections\": 1,\n \"max_selections\": 1\n }\n ],\n \"description\": \"<string>\",\n \"image_url\": \"<string>\",\n \"disabled\": false,\n \"out_of_stock\": false,\n \"restrictions\": [],\n \"price_overrides\": []\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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.put("https://server.chataigne.ai/v1/locations/{location_id}/catalogs/{catalog_id}")
.header("Idempotency-Key", "<idempotency-key>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Delivery menu\",\n \"categories\": [\n {\n \"id\": \"burgers\",\n \"name\": \"Burgers\",\n \"description\": \"<string>\",\n \"image_url\": \"<string>\"\n }\n ],\n \"products\": [\n {\n \"id\": \"burger-classic\",\n \"name\": \"Classic Burger\",\n \"category_id\": \"burgers\",\n \"price\": {\n \"amount\": 12.9,\n \"currency\": \"EUR\"\n },\n \"modifier_group_ids\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"image_url\": \"<string>\",\n \"disabled\": false,\n \"out_of_stock\": false,\n \"restrictions\": [],\n \"price_overrides\": [],\n \"bundle_only\": false,\n \"order\": 1\n }\n ],\n \"modifier_groups\": [\n {\n \"id\": \"sauces\",\n \"name\": \"Choose a sauce\",\n \"modifiers\": [\n {\n \"id\": \"bacon\",\n \"name\": \"Bacon\",\n \"image_url\": \"<string>\",\n \"disabled\": false,\n \"out_of_stock\": false,\n \"restrictions\": [],\n \"price_overrides\": []\n }\n ],\n \"min_selections\": 0,\n \"max_selections\": 1\n }\n ],\n \"bundles\": [\n {\n \"id\": \"classic-meal\",\n \"name\": \"Classic Meal\",\n \"category_id\": \"meals\",\n \"price\": {\n \"amount\": 12.9,\n \"currency\": \"EUR\"\n },\n \"lines\": [\n {\n \"id\": \"main\",\n \"product_ids\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"min_selections\": 1,\n \"max_selections\": 1\n }\n ],\n \"description\": \"<string>\",\n \"image_url\": \"<string>\",\n \"disabled\": false,\n \"out_of_stock\": false,\n \"restrictions\": [],\n \"price_overrides\": []\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://server.chataigne.ai/v1/locations/{location_id}/catalogs/{catalog_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Delivery menu\",\n \"categories\": [\n {\n \"id\": \"burgers\",\n \"name\": \"Burgers\",\n \"description\": \"<string>\",\n \"image_url\": \"<string>\"\n }\n ],\n \"products\": [\n {\n \"id\": \"burger-classic\",\n \"name\": \"Classic Burger\",\n \"category_id\": \"burgers\",\n \"price\": {\n \"amount\": 12.9,\n \"currency\": \"EUR\"\n },\n \"modifier_group_ids\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"image_url\": \"<string>\",\n \"disabled\": false,\n \"out_of_stock\": false,\n \"restrictions\": [],\n \"price_overrides\": [],\n \"bundle_only\": false,\n \"order\": 1\n }\n ],\n \"modifier_groups\": [\n {\n \"id\": \"sauces\",\n \"name\": \"Choose a sauce\",\n \"modifiers\": [\n {\n \"id\": \"bacon\",\n \"name\": \"Bacon\",\n \"image_url\": \"<string>\",\n \"disabled\": false,\n \"out_of_stock\": false,\n \"restrictions\": [],\n \"price_overrides\": []\n }\n ],\n \"min_selections\": 0,\n \"max_selections\": 1\n }\n ],\n \"bundles\": [\n {\n \"id\": \"classic-meal\",\n \"name\": \"Classic Meal\",\n \"category_id\": \"meals\",\n \"price\": {\n \"amount\": 12.9,\n \"currency\": \"EUR\"\n },\n \"lines\": [\n {\n \"id\": \"main\",\n \"product_ids\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"min_selections\": 1,\n \"max_selections\": 1\n }\n ],\n \"description\": \"<string>\",\n \"image_url\": \"<string>\",\n \"disabled\": false,\n \"out_of_stock\": false,\n \"restrictions\": [],\n \"price_overrides\": []\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "csync_123",
"object": "catalog_sync",
"catalog_id": "delivery-menu",
"status": "queued",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"error": {
"code": "<string>",
"message": "<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.
Headers
Unique key that makes this create safe to retry; replays return the original response.
Body
application/json
Response
The queued catalog synchronization.
Example:
"csync_123"
Available options:
catalog_sync Example:
"delivery-menu"
Available options:
queued, processing, succeeded, failed Show child attributes
Show child attributes