Review immutable proposed changes to an accepted catering booking
curl --request GET \
--url https://api.craveup.com/api/v1/storefront/locations/{locationId}/catering/events/{eventId}/amendments \
--header 'X-Catering-Token: <api-key>'import requests
url = "https://api.craveup.com/api/v1/storefront/locations/{locationId}/catering/events/{eventId}/amendments"
headers = {"X-Catering-Token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Catering-Token': '<api-key>'}};
fetch('https://api.craveup.com/api/v1/storefront/locations/{locationId}/catering/events/{eventId}/amendments', 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.craveup.com/api/v1/storefront/locations/{locationId}/catering/events/{eventId}/amendments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Catering-Token: <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"
"net/http"
"io"
)
func main() {
url := "https://api.craveup.com/api/v1/storefront/locations/{locationId}/catering/events/{eventId}/amendments"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Catering-Token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.craveup.com/api/v1/storefront/locations/{locationId}/catering/events/{eventId}/amendments")
.header("X-Catering-Token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.craveup.com/api/v1/storefront/locations/{locationId}/catering/events/{eventId}/amendments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Catering-Token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"proposals": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"originalQuoteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"revision": 4503599627370495,
"version": 4503599627370495,
"offerFingerprint": "<string>",
"currency": "<string>",
"offer": {
"originalQuoteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"eventSnapshot": {
"eventDate": "<string>",
"serviceTime": "<string>",
"headcount": {
"guests": 5000,
"approximate": true
},
"serviceStyle": "pickup",
"serviceAddress": "<string>",
"deliveryAddress": {
"street": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "United States",
"streetOptional": ""
}
},
"lines": [
{
"source": {
"menuId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"channel": "catering",
"kind": "released",
"menuReleaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"kind": "menu",
"lineId": "<string>",
"productId": "<string>",
"name": "<string>",
"unitPrice": "<string>",
"quantity": "<string>",
"unit": "person",
"note": "<string>",
"lineTotal": "<string>",
"minimumSpendEligibility": "food_beverage",
"configuration": {
"source": {
"menuId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"channel": "catering",
"kind": "released",
"menuReleaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"lineId": "<string>",
"productId": "<string>",
"selections": [
{
"groupId": "<string>",
"selectedOptions": [
{
"optionId": "<string>",
"quantity": 50,
"children": "<array>"
}
]
}
],
"quantity": "<string>",
"allocation": {
"groupId": "<string>",
"guests": 5000
},
"requestedQuantity": "<string>",
"acceptedSelections": [
{
"groupId": "<string>",
"selectedOptions": [
{
"optionId": "<string>",
"quantity": 49,
"selectionPath": [
"<string>"
],
"provenance": "customer",
"children": "<array>"
}
]
}
],
"priceBasis": "per_person",
"unit": "person",
"planningYield": {
"guests": "<string>",
"quantity": "<string>",
"reviewNote": "<string>"
},
"unitPrice": {
"minCents": 49999999,
"maxCents": 49999999
},
"lineTotal": {
"minCents": 49999999,
"maxCents": 49999999
},
"charges": [
{
"chargeId": "<string>",
"scope": "sold_unit",
"bucketId": "<string>",
"selectionPath": [
"<string>"
],
"quantity": "<string>",
"unitPrice": {
"minCents": 49999999,
"maxCents": 49999999
},
"lineTotal": {
"minCents": 49999999,
"maxCents": 49999999
},
"minimumSpendEligibility": "food_beverage",
"coveredByBucket": true
}
],
"effectiveRules": {
"values": {
"minimumGuests": 5000,
"maximumGuests": 5000,
"minimumUnits": "<string>",
"maximumUnits": "<string>",
"minimumSpend": {
"amountCents": 49999999,
"basis": "eligible_food_beverage_before_discounts"
},
"leadTimeHours": 4380
},
"sources": {}
},
"food": {
"source": {
"menuId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"channel": "online",
"kind": "released",
"menuReleaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"contributions": [
{
"entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"selectionPath": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"fraction": {
"numerator": 1,
"denominator": 1
},
"provenance": {
"kind": "entered"
},
"nutrients": {
"caloriesKcal": 1,
"proteinGrams": 1,
"carbohydrateGrams": 1,
"fatGrams": 1,
"fiberGrams": 1,
"sugarGrams": 1,
"saturatedFatGrams": 1,
"sodiumMilligrams": 1
}
}
],
"serving": {
"label": "<string>",
"grams": 1
},
"quantity": {
"unit": "serving",
"count": 5000
},
"trayYield": {
"servingsPerTray": 1
},
"perServing": {
"caloriesKcal": 1,
"proteinGrams": 1,
"carbohydrateGrams": 1,
"fatGrams": 1,
"fiberGrams": 1,
"sugarGrams": 1,
"saturatedFatGrams": 1,
"sodiumMilligrams": 1
},
"perTray": {
"caloriesKcal": 1,
"proteinGrams": 1,
"carbohydrateGrams": 1,
"fatGrams": 1,
"fiberGrams": 1,
"sugarGrams": 1,
"saturatedFatGrams": 1,
"sodiumMilligrams": 1
},
"lineTotal": {
"caloriesKcal": 1,
"proteinGrams": 1,
"carbohydrateGrams": 1,
"fatGrams": 1,
"fiberGrams": 1,
"sugarGrams": 1,
"saturatedFatGrams": 1,
"sodiumMilligrams": 1
},
"completeness": "complete",
"missing": [
{
"entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"nutrient": "caloriesKcal"
}
],
"warnings": [
{
"code": "DIETARY_CONFLICT",
"entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"preferenceId": "vegetarian",
"selectionPath": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
]
},
"explanation": "<string>",
"dietaryPreferences": {
"preferences": [
"vegetarian"
],
"avoidAllergenIds": [
"milk"
]
}
}
}
],
"totals": {
"subtotal": "<string>",
"discount": "<string>",
"taxRate": "<string>",
"taxTotal": "<string>",
"serviceFeeRate": "<string>",
"serviceFeeTotal": "<string>",
"total": "<string>",
"depositPercent": 50,
"depositAmount": "<string>",
"depositTotal": "<string>",
"balanceAmount": "<string>",
"balanceTotal": "<string>"
},
"noteToCustomer": "<string>",
"terms": {
"changeCutoffHours": 0,
"balanceDue": {
"rule": "at_cutoff"
},
"quoteValidityDays": 0,
"cancellationTerms": "<string>"
},
"timeZone": "<string>",
"lockAt": "2023-11-07T05:31:56Z"
},
"totals": {
"subtotal": "<string>",
"discount": "<string>",
"taxRate": "<string>",
"taxTotal": "<string>",
"serviceFeeRate": "<string>",
"serviceFeeTotal": "<string>",
"total": "<string>",
"depositPercent": 50,
"depositAmount": "<string>",
"depositTotal": "<string>",
"balanceAmount": "<string>",
"balanceTotal": "<string>"
},
"state": "proposed",
"createdAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"decidedAt": "2023-11-07T05:31:56Z",
"noticeState": "pending"
}
],
"currentProposalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"effectiveProposalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"requestId": "<string>",
"details": {}
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"requestId": "<string>",
"details": {}
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"requestId": "<string>",
"details": {}
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"requestId": "<string>",
"details": {}
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"requestId": "<string>",
"details": {}
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"requestId": "<string>",
"details": {}
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"requestId": "<string>",
"details": {}
}Catering
Review immutable proposed changes to an accepted catering booking
GET
/
locations
/
{locationId}
/
catering
/
events
/
{eventId}
/
amendments
Review immutable proposed changes to an accepted catering booking
curl --request GET \
--url https://api.craveup.com/api/v1/storefront/locations/{locationId}/catering/events/{eventId}/amendments \
--header 'X-Catering-Token: <api-key>'import requests
url = "https://api.craveup.com/api/v1/storefront/locations/{locationId}/catering/events/{eventId}/amendments"
headers = {"X-Catering-Token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Catering-Token': '<api-key>'}};
fetch('https://api.craveup.com/api/v1/storefront/locations/{locationId}/catering/events/{eventId}/amendments', 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.craveup.com/api/v1/storefront/locations/{locationId}/catering/events/{eventId}/amendments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Catering-Token: <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"
"net/http"
"io"
)
func main() {
url := "https://api.craveup.com/api/v1/storefront/locations/{locationId}/catering/events/{eventId}/amendments"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Catering-Token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.craveup.com/api/v1/storefront/locations/{locationId}/catering/events/{eventId}/amendments")
.header("X-Catering-Token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.craveup.com/api/v1/storefront/locations/{locationId}/catering/events/{eventId}/amendments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Catering-Token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"proposals": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"originalQuoteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"revision": 4503599627370495,
"version": 4503599627370495,
"offerFingerprint": "<string>",
"currency": "<string>",
"offer": {
"originalQuoteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"eventSnapshot": {
"eventDate": "<string>",
"serviceTime": "<string>",
"headcount": {
"guests": 5000,
"approximate": true
},
"serviceStyle": "pickup",
"serviceAddress": "<string>",
"deliveryAddress": {
"street": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "United States",
"streetOptional": ""
}
},
"lines": [
{
"source": {
"menuId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"channel": "catering",
"kind": "released",
"menuReleaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"kind": "menu",
"lineId": "<string>",
"productId": "<string>",
"name": "<string>",
"unitPrice": "<string>",
"quantity": "<string>",
"unit": "person",
"note": "<string>",
"lineTotal": "<string>",
"minimumSpendEligibility": "food_beverage",
"configuration": {
"source": {
"menuId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"channel": "catering",
"kind": "released",
"menuReleaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"lineId": "<string>",
"productId": "<string>",
"selections": [
{
"groupId": "<string>",
"selectedOptions": [
{
"optionId": "<string>",
"quantity": 50,
"children": "<array>"
}
]
}
],
"quantity": "<string>",
"allocation": {
"groupId": "<string>",
"guests": 5000
},
"requestedQuantity": "<string>",
"acceptedSelections": [
{
"groupId": "<string>",
"selectedOptions": [
{
"optionId": "<string>",
"quantity": 49,
"selectionPath": [
"<string>"
],
"provenance": "customer",
"children": "<array>"
}
]
}
],
"priceBasis": "per_person",
"unit": "person",
"planningYield": {
"guests": "<string>",
"quantity": "<string>",
"reviewNote": "<string>"
},
"unitPrice": {
"minCents": 49999999,
"maxCents": 49999999
},
"lineTotal": {
"minCents": 49999999,
"maxCents": 49999999
},
"charges": [
{
"chargeId": "<string>",
"scope": "sold_unit",
"bucketId": "<string>",
"selectionPath": [
"<string>"
],
"quantity": "<string>",
"unitPrice": {
"minCents": 49999999,
"maxCents": 49999999
},
"lineTotal": {
"minCents": 49999999,
"maxCents": 49999999
},
"minimumSpendEligibility": "food_beverage",
"coveredByBucket": true
}
],
"effectiveRules": {
"values": {
"minimumGuests": 5000,
"maximumGuests": 5000,
"minimumUnits": "<string>",
"maximumUnits": "<string>",
"minimumSpend": {
"amountCents": 49999999,
"basis": "eligible_food_beverage_before_discounts"
},
"leadTimeHours": 4380
},
"sources": {}
},
"food": {
"source": {
"menuId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"channel": "online",
"kind": "released",
"menuReleaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"contributions": [
{
"entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"selectionPath": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"fraction": {
"numerator": 1,
"denominator": 1
},
"provenance": {
"kind": "entered"
},
"nutrients": {
"caloriesKcal": 1,
"proteinGrams": 1,
"carbohydrateGrams": 1,
"fatGrams": 1,
"fiberGrams": 1,
"sugarGrams": 1,
"saturatedFatGrams": 1,
"sodiumMilligrams": 1
}
}
],
"serving": {
"label": "<string>",
"grams": 1
},
"quantity": {
"unit": "serving",
"count": 5000
},
"trayYield": {
"servingsPerTray": 1
},
"perServing": {
"caloriesKcal": 1,
"proteinGrams": 1,
"carbohydrateGrams": 1,
"fatGrams": 1,
"fiberGrams": 1,
"sugarGrams": 1,
"saturatedFatGrams": 1,
"sodiumMilligrams": 1
},
"perTray": {
"caloriesKcal": 1,
"proteinGrams": 1,
"carbohydrateGrams": 1,
"fatGrams": 1,
"fiberGrams": 1,
"sugarGrams": 1,
"saturatedFatGrams": 1,
"sodiumMilligrams": 1
},
"lineTotal": {
"caloriesKcal": 1,
"proteinGrams": 1,
"carbohydrateGrams": 1,
"fatGrams": 1,
"fiberGrams": 1,
"sugarGrams": 1,
"saturatedFatGrams": 1,
"sodiumMilligrams": 1
},
"completeness": "complete",
"missing": [
{
"entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"nutrient": "caloriesKcal"
}
],
"warnings": [
{
"code": "DIETARY_CONFLICT",
"entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"preferenceId": "vegetarian",
"selectionPath": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
]
},
"explanation": "<string>",
"dietaryPreferences": {
"preferences": [
"vegetarian"
],
"avoidAllergenIds": [
"milk"
]
}
}
}
],
"totals": {
"subtotal": "<string>",
"discount": "<string>",
"taxRate": "<string>",
"taxTotal": "<string>",
"serviceFeeRate": "<string>",
"serviceFeeTotal": "<string>",
"total": "<string>",
"depositPercent": 50,
"depositAmount": "<string>",
"depositTotal": "<string>",
"balanceAmount": "<string>",
"balanceTotal": "<string>"
},
"noteToCustomer": "<string>",
"terms": {
"changeCutoffHours": 0,
"balanceDue": {
"rule": "at_cutoff"
},
"quoteValidityDays": 0,
"cancellationTerms": "<string>"
},
"timeZone": "<string>",
"lockAt": "2023-11-07T05:31:56Z"
},
"totals": {
"subtotal": "<string>",
"discount": "<string>",
"taxRate": "<string>",
"taxTotal": "<string>",
"serviceFeeRate": "<string>",
"serviceFeeTotal": "<string>",
"total": "<string>",
"depositPercent": 50,
"depositAmount": "<string>",
"depositTotal": "<string>",
"balanceAmount": "<string>",
"balanceTotal": "<string>"
},
"state": "proposed",
"createdAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"decidedAt": "2023-11-07T05:31:56Z",
"noticeState": "pending"
}
],
"currentProposalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"effectiveProposalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"requestId": "<string>",
"details": {}
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"requestId": "<string>",
"details": {}
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"requestId": "<string>",
"details": {}
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"requestId": "<string>",
"details": {}
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"requestId": "<string>",
"details": {}
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"requestId": "<string>",
"details": {}
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"requestId": "<string>",
"details": {}
}Authorizations
Event and location scoped customer catering capability. Never place in query parameters.
Path Parameters
Required string length:
1 - 128Required string length:
1 - 128Response
Scoped offer history and the current proposal.
Show child attributes
Show child attributes
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)$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)$