Get a restaurant's published packaging configuration

SecurityOAuth2

Request

header Parameters

• Toast-Restaurant-External-ID required:
  string

Responses

200

A restaurant's packaging configuration. You can expect a 200 response even if your restaurant does not have a published packaging configuration. If the restaurant does not have a published configuration, an empty, disabled packaging config is returned.

get /v1/published/packagingConfig

Request samples

curl -i -X GET \
  https://toast-api-server/packaging/v1/published/packagingConfig \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Toast-Restaurant-External-ID: string'

Response samples

application/json

{
  "enabled": true,
  "guestMessage": "string",
  "items": [
    {
      "id": "string",
      "itemTypes": [
        "string"
      ],
      "guestDisplayName": "string",
      "guestDescription": "string",
      "guestInclusionType": "string"
    }
  ]
}