POSTapi.synup.com/api/v4/menus
Create a menu
Requires an API key. Send it as
Authorization: API <your-key> — see Getting started.Parameters
Headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type | string | required |
Body
| Name | Type | Required | Description |
|---|---|---|---|
input | object | required | |
input.displayName | string | required | |
input.currencyCode | string | required | |
input.description | string | required | |
input.locationId | string | required | |
input.offeringsSection | object | required | |
input.offeringsSection.displayName | string | required | |
input.offeringsSection.description | string | required | |
input.offeringsSection.offeringsItem | object | required | |
input.offeringsSection.offeringsItem.displayName | string | required | |
input.offeringsSection.offeringsItem.description | string | required | |
input.offeringsSection.offeringsItem.price | string | required |
Request
Request
curl -X POST 'https://api.synup.com/api/v4/menus' \
-H 'Authorization: API YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"input": {
"displayName": "Dinner Menu",
"currencyCode": "us_usd",
"description": "Our full dinner menu",
"locationId": "{locationId}",
"offeringsSection": {
"displayName": "Starters",
"description": "Appetizers and small plates",
"offeringsItem": {
"displayName": "Bruschetta",
"description": "Grilled bread with tomato",
"price": "8.00"
}
}
}
}'const res = await fetch('https://api.synup.com/api/v4/menus', {
method: 'POST',
headers: {
Authorization: 'API YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"input": {
"displayName": "Dinner Menu",
"currencyCode": "us_usd",
"description": "Our full dinner menu",
"locationId": "{locationId}",
"offeringsSection": {
"displayName": "Starters",
"description": "Appetizers and small plates",
"offeringsItem": {
"displayName": "Bruschetta",
"description": "Grilled bread with tomato",
"price": "8.00"
}
}
}
}),
});
const data = await res.json();import requests
res = requests.post(
"https://api.synup.com/api/v4/menus",
headers={
"Authorization": "API YOUR_API_KEY",
"Content-Type": "application/json",
},
json={
"input": {
"displayName": "Dinner Menu",
"currencyCode": "us_usd",
"description": "Our full dinner menu",
"locationId": "{locationId}",
"offeringsSection": {
"displayName": "Starters",
"description": "Appetizers and small plates",
"offeringsItem": {
"displayName": "Bruschetta",
"description": "Grilled bread with tomato",
"price": "8.00"
}
}
}
},
)
data = res.json()req, _ := http.NewRequest("POST", "https://api.synup.com/api/v4/menus", bytes.NewBufferString(payload))
req.Header.Set("Authorization", "API YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)Responses
| Status | Description |
|---|---|
200 |
Example response (generated from the schema)
{}