Save or withdraw existing revisioned catering commercial facts
curl --request PUT \
--url https://api.example.com/api/v1/catalog/workspace/commercial-facts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"expectedDraftRevision": 4503599627370495,
"locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"canonicalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"commercialFacts": {
"kind": "menu",
"facts": {
"rules": {
"all": {
"minimumGuests": 5000,
"maximumGuests": 5000,
"minimumUnits": "<string>",
"maximumUnits": "<string>",
"leadTimeHours": 4380
},
"byServiceStyle": {}
},
"allocationGroups": [
{
"groupId": "<string>",
"minimumGuests": 5000,
"maximumGuests": 5000,
"minimumGuestsPerProduct": 5000,
"maximumDistinctProducts": 50,
"total": "event_headcount"
}
],
"reviewFacts": [
{
"sourceText": "<string>",
"reason": "<string>"
}
]
}
}
}
'import requests
url = "https://api.example.com/api/v1/catalog/workspace/commercial-facts"
payload = {
"expectedDraftRevision": 4503599627370495,
"locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"canonicalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"commercialFacts": {
"kind": "menu",
"facts": {
"rules": {
"all": {
"minimumGuests": 5000,
"maximumGuests": 5000,
"minimumUnits": "<string>",
"maximumUnits": "<string>",
"leadTimeHours": 4380
},
"byServiceStyle": {}
},
"allocationGroups": [
{
"groupId": "<string>",
"minimumGuests": 5000,
"maximumGuests": 5000,
"minimumGuestsPerProduct": 5000,
"maximumDistinctProducts": 50,
"total": "event_headcount"
}
],
"reviewFacts": [
{
"sourceText": "<string>",
"reason": "<string>"
}
]
}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
expectedDraftRevision: 4503599627370495,
locationId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
canonicalId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
commercialFacts: {
kind: 'menu',
facts: {
rules: {
all: {
minimumGuests: 5000,
maximumGuests: 5000,
minimumUnits: '<string>',
maximumUnits: '<string>',
leadTimeHours: 4380
},
byServiceStyle: {}
},
allocationGroups: [
{
groupId: '<string>',
minimumGuests: 5000,
maximumGuests: 5000,
minimumGuestsPerProduct: 5000,
maximumDistinctProducts: 50,
total: 'event_headcount'
}
],
reviewFacts: [{sourceText: '<string>', reason: '<string>'}]
}
}
})
};
fetch('https://api.example.com/api/v1/catalog/workspace/commercial-facts', 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://api.example.com/api/v1/catalog/workspace/commercial-facts",
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([
'expectedDraftRevision' => 4503599627370495,
'locationId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'canonicalId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'commercialFacts' => [
'kind' => 'menu',
'facts' => [
'rules' => [
'all' => [
'minimumGuests' => 5000,
'maximumGuests' => 5000,
'minimumUnits' => '<string>',
'maximumUnits' => '<string>',
'leadTimeHours' => 4380
],
'byServiceStyle' => [
]
],
'allocationGroups' => [
[
'groupId' => '<string>',
'minimumGuests' => 5000,
'maximumGuests' => 5000,
'minimumGuestsPerProduct' => 5000,
'maximumDistinctProducts' => 50,
'total' => 'event_headcount'
]
],
'reviewFacts' => [
[
'sourceText' => '<string>',
'reason' => '<string>'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.example.com/api/v1/catalog/workspace/commercial-facts"
payload := strings.NewReader("{\n \"expectedDraftRevision\": 4503599627370495,\n \"locationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"canonicalId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"commercialFacts\": {\n \"kind\": \"menu\",\n \"facts\": {\n \"rules\": {\n \"all\": {\n \"minimumGuests\": 5000,\n \"maximumGuests\": 5000,\n \"minimumUnits\": \"<string>\",\n \"maximumUnits\": \"<string>\",\n \"leadTimeHours\": 4380\n },\n \"byServiceStyle\": {}\n },\n \"allocationGroups\": [\n {\n \"groupId\": \"<string>\",\n \"minimumGuests\": 5000,\n \"maximumGuests\": 5000,\n \"minimumGuestsPerProduct\": 5000,\n \"maximumDistinctProducts\": 50,\n \"total\": \"event_headcount\"\n }\n ],\n \"reviewFacts\": [\n {\n \"sourceText\": \"<string>\",\n \"reason\": \"<string>\"\n }\n ]\n }\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.example.com/api/v1/catalog/workspace/commercial-facts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"expectedDraftRevision\": 4503599627370495,\n \"locationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"canonicalId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"commercialFacts\": {\n \"kind\": \"menu\",\n \"facts\": {\n \"rules\": {\n \"all\": {\n \"minimumGuests\": 5000,\n \"maximumGuests\": 5000,\n \"minimumUnits\": \"<string>\",\n \"maximumUnits\": \"<string>\",\n \"leadTimeHours\": 4380\n },\n \"byServiceStyle\": {}\n },\n \"allocationGroups\": [\n {\n \"groupId\": \"<string>\",\n \"minimumGuests\": 5000,\n \"maximumGuests\": 5000,\n \"minimumGuestsPerProduct\": 5000,\n \"maximumDistinctProducts\": 50,\n \"total\": \"event_headcount\"\n }\n ],\n \"reviewFacts\": [\n {\n \"sourceText\": \"<string>\",\n \"reason\": \"<string>\"\n }\n ]\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/catalog/workspace/commercial-facts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expectedDraftRevision\": 4503599627370495,\n \"locationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"canonicalId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"commercialFacts\": {\n \"kind\": \"menu\",\n \"facts\": {\n \"rules\": {\n \"all\": {\n \"minimumGuests\": 5000,\n \"maximumGuests\": 5000,\n \"minimumUnits\": \"<string>\",\n \"maximumUnits\": \"<string>\",\n \"leadTimeHours\": 4380\n },\n \"byServiceStyle\": {}\n },\n \"allocationGroups\": [\n {\n \"groupId\": \"<string>\",\n \"minimumGuests\": 5000,\n \"maximumGuests\": 5000,\n \"minimumGuestsPerProduct\": 5000,\n \"maximumDistinctProducts\": 50,\n \"total\": \"event_headcount\"\n }\n ],\n \"reviewFacts\": [\n {\n \"sourceText\": \"<string>\",\n \"reason\": \"<string>\"\n }\n ]\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"draftRevision": 4503599627370495,
"locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"canonicalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"commercialFacts": {
"kind": "menu",
"facts": {
"rules": {
"all": {
"minimumGuests": 5000,
"maximumGuests": 5000,
"minimumUnits": "<string>",
"maximumUnits": "<string>",
"minimumSpend": {
"amountCents": 49999999,
"basis": "eligible_food_beverage_before_discounts"
},
"leadTimeHours": 4380
},
"byServiceStyle": {}
},
"allocationGroups": [
{
"groupId": "<string>",
"minimumGuests": 5000,
"maximumGuests": 5000,
"minimumGuestsPerProduct": 5000,
"maximumDistinctProducts": 50,
"total": "event_headcount"
}
],
"reviewFacts": [
{
"code": "conflicting_lead_time",
"sourceText": "<string>",
"reason": "<string>"
}
]
}
}
}API Reference
Save or withdraw existing revisioned catering commercial facts
PUT
/
api
/
v1
/
catalog
/
workspace
/
commercial-facts
Save or withdraw existing revisioned catering commercial facts
curl --request PUT \
--url https://api.example.com/api/v1/catalog/workspace/commercial-facts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"expectedDraftRevision": 4503599627370495,
"locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"canonicalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"commercialFacts": {
"kind": "menu",
"facts": {
"rules": {
"all": {
"minimumGuests": 5000,
"maximumGuests": 5000,
"minimumUnits": "<string>",
"maximumUnits": "<string>",
"leadTimeHours": 4380
},
"byServiceStyle": {}
},
"allocationGroups": [
{
"groupId": "<string>",
"minimumGuests": 5000,
"maximumGuests": 5000,
"minimumGuestsPerProduct": 5000,
"maximumDistinctProducts": 50,
"total": "event_headcount"
}
],
"reviewFacts": [
{
"sourceText": "<string>",
"reason": "<string>"
}
]
}
}
}
'import requests
url = "https://api.example.com/api/v1/catalog/workspace/commercial-facts"
payload = {
"expectedDraftRevision": 4503599627370495,
"locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"canonicalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"commercialFacts": {
"kind": "menu",
"facts": {
"rules": {
"all": {
"minimumGuests": 5000,
"maximumGuests": 5000,
"minimumUnits": "<string>",
"maximumUnits": "<string>",
"leadTimeHours": 4380
},
"byServiceStyle": {}
},
"allocationGroups": [
{
"groupId": "<string>",
"minimumGuests": 5000,
"maximumGuests": 5000,
"minimumGuestsPerProduct": 5000,
"maximumDistinctProducts": 50,
"total": "event_headcount"
}
],
"reviewFacts": [
{
"sourceText": "<string>",
"reason": "<string>"
}
]
}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
expectedDraftRevision: 4503599627370495,
locationId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
canonicalId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
commercialFacts: {
kind: 'menu',
facts: {
rules: {
all: {
minimumGuests: 5000,
maximumGuests: 5000,
minimumUnits: '<string>',
maximumUnits: '<string>',
leadTimeHours: 4380
},
byServiceStyle: {}
},
allocationGroups: [
{
groupId: '<string>',
minimumGuests: 5000,
maximumGuests: 5000,
minimumGuestsPerProduct: 5000,
maximumDistinctProducts: 50,
total: 'event_headcount'
}
],
reviewFacts: [{sourceText: '<string>', reason: '<string>'}]
}
}
})
};
fetch('https://api.example.com/api/v1/catalog/workspace/commercial-facts', 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://api.example.com/api/v1/catalog/workspace/commercial-facts",
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([
'expectedDraftRevision' => 4503599627370495,
'locationId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'canonicalId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'commercialFacts' => [
'kind' => 'menu',
'facts' => [
'rules' => [
'all' => [
'minimumGuests' => 5000,
'maximumGuests' => 5000,
'minimumUnits' => '<string>',
'maximumUnits' => '<string>',
'leadTimeHours' => 4380
],
'byServiceStyle' => [
]
],
'allocationGroups' => [
[
'groupId' => '<string>',
'minimumGuests' => 5000,
'maximumGuests' => 5000,
'minimumGuestsPerProduct' => 5000,
'maximumDistinctProducts' => 50,
'total' => 'event_headcount'
]
],
'reviewFacts' => [
[
'sourceText' => '<string>',
'reason' => '<string>'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.example.com/api/v1/catalog/workspace/commercial-facts"
payload := strings.NewReader("{\n \"expectedDraftRevision\": 4503599627370495,\n \"locationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"canonicalId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"commercialFacts\": {\n \"kind\": \"menu\",\n \"facts\": {\n \"rules\": {\n \"all\": {\n \"minimumGuests\": 5000,\n \"maximumGuests\": 5000,\n \"minimumUnits\": \"<string>\",\n \"maximumUnits\": \"<string>\",\n \"leadTimeHours\": 4380\n },\n \"byServiceStyle\": {}\n },\n \"allocationGroups\": [\n {\n \"groupId\": \"<string>\",\n \"minimumGuests\": 5000,\n \"maximumGuests\": 5000,\n \"minimumGuestsPerProduct\": 5000,\n \"maximumDistinctProducts\": 50,\n \"total\": \"event_headcount\"\n }\n ],\n \"reviewFacts\": [\n {\n \"sourceText\": \"<string>\",\n \"reason\": \"<string>\"\n }\n ]\n }\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.example.com/api/v1/catalog/workspace/commercial-facts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"expectedDraftRevision\": 4503599627370495,\n \"locationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"canonicalId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"commercialFacts\": {\n \"kind\": \"menu\",\n \"facts\": {\n \"rules\": {\n \"all\": {\n \"minimumGuests\": 5000,\n \"maximumGuests\": 5000,\n \"minimumUnits\": \"<string>\",\n \"maximumUnits\": \"<string>\",\n \"leadTimeHours\": 4380\n },\n \"byServiceStyle\": {}\n },\n \"allocationGroups\": [\n {\n \"groupId\": \"<string>\",\n \"minimumGuests\": 5000,\n \"maximumGuests\": 5000,\n \"minimumGuestsPerProduct\": 5000,\n \"maximumDistinctProducts\": 50,\n \"total\": \"event_headcount\"\n }\n ],\n \"reviewFacts\": [\n {\n \"sourceText\": \"<string>\",\n \"reason\": \"<string>\"\n }\n ]\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/catalog/workspace/commercial-facts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expectedDraftRevision\": 4503599627370495,\n \"locationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"canonicalId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"commercialFacts\": {\n \"kind\": \"menu\",\n \"facts\": {\n \"rules\": {\n \"all\": {\n \"minimumGuests\": 5000,\n \"maximumGuests\": 5000,\n \"minimumUnits\": \"<string>\",\n \"maximumUnits\": \"<string>\",\n \"leadTimeHours\": 4380\n },\n \"byServiceStyle\": {}\n },\n \"allocationGroups\": [\n {\n \"groupId\": \"<string>\",\n \"minimumGuests\": 5000,\n \"maximumGuests\": 5000,\n \"minimumGuestsPerProduct\": 5000,\n \"maximumDistinctProducts\": 50,\n \"total\": \"event_headcount\"\n }\n ],\n \"reviewFacts\": [\n {\n \"sourceText\": \"<string>\",\n \"reason\": \"<string>\"\n }\n ]\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"draftRevision": 4503599627370495,
"locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"canonicalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"commercialFacts": {
"kind": "menu",
"facts": {
"rules": {
"all": {
"minimumGuests": 5000,
"maximumGuests": 5000,
"minimumUnits": "<string>",
"maximumUnits": "<string>",
"minimumSpend": {
"amountCents": 49999999,
"basis": "eligible_food_beverage_before_discounts"
},
"leadTimeHours": 4380
},
"byServiceStyle": {}
},
"allocationGroups": [
{
"groupId": "<string>",
"minimumGuests": 5000,
"maximumGuests": 5000,
"minimumGuestsPerProduct": 5000,
"maximumDistinctProducts": 50,
"total": "event_headcount"
}
],
"reviewFacts": [
{
"code": "conflicting_lead_time",
"sourceText": "<string>",
"reason": "<string>"
}
]
}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Required range:
0 < x <= 9007199254740991Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
Show child attributes
Show child attributes
Response
Committed authoring evidence or read-only review; no publication is activated by a review.
Required range:
0 < x <= 9007199254740991Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
Show child attributes
Show child attributes
