Menus: Get

Retrieve a specific Menu

path Parameters
listId
required
string

ID of this List.

accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    • "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
    },
  • "response": {
    • "id": "string",
    • "accountId": "string",
    • "name": "string",
    • "title": "string",
    • "size": 0,
    • "publish": true,
    • "language": "string",
    • "currency": "string",
    • "sourceUrl": "string",
    • "sections": [
      • {
        • "id": "string",
        • "name": "string",
        • "description": "string",
        • "items": [
          • {
            • "id": "string",
            • "name": "string",
            • "description": "string",
            • "photo": {
              • "url": "string",
              • "height": 0,
              • "width": 0,
              • "alternateText": "string"
              },
            • "calories": {
              • "type": "FIXED",
              • "calorie": 0,
              • "rangeTo": 0
              },
            • "cost": {
              • "type": "PRICE",
              • "price": "string",
              • "unit": "string",
              • "rangeTo": "string",
              • "other": "string",
              • "options": [
                • {
                  • "name": "string",
                  • "price": "string",
                  • "calorie": 0
                  }
                ]
              },
            • "url": "string",
            • "allergens": [
              • "string"
              ],
            • "featured": true,
            • "spiciness": "string",
            • "dietaryRestrictions": [
              • "string"
              ],
            • "preparationMethods": [
              • "string"
              ]
            }
          ]
        }
      ]
    }
}

Bios: Get

Retrieve a specific Bios ECL

path Parameters
listId
required
string

ID of this List.

accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    • "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
    },
  • "response": {
    • "id": "string",
    • "accountId": "string",
    • "name": "string",
    • "title": "string",
    • "size": 0,
    • "publish": true,
    • "language": "string",
    • "sections": [
      • {
        • "id": "string",
        • "name": "string",
        • "description": "string",
        • "items": [
          • {
            • "id": "string",
            • "name": "string",
            • "description": "string",
            • "photo": {
              • "url": "string",
              • "height": 0,
              • "width": 0,
              • "alternateText": "string"
              },
            • "title": "string",
            • "phone": "string",
            • "email": "string",
            • "education": [
              • "string"
              ],
            • "certifications": [
              • "string"
              ],
            • "services": [
              • "string"
              ],
            • "url": "string"
            }
          ]
        }
      ]
    }
}

Products: Get

Retrieve a specific Products ECL

path Parameters
listId
required
string

ID of this List.

accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    • "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
    },
  • "response": {
    • "id": "string",
    • "accountId": "string",
    • "name": "string",
    • "title": "string",
    • "size": 0,
    • "publish": true,
    • "language": "string",
    • "currency": "string",
    • "sections": [
      • {
        • "id": "string",
        • "name": "string",
        • "description": "string",
        • "items": [
          • {
            • "id": "string",
            • "name": "string",
            • "description": "string",
            • "photos": [
              • {
                • "url": "string",
                • "height": 0,
                • "width": 0,
                • "alternateText": "string"
                }
              ],
            • "cost": {
              • "type": "PRICE",
              • "price": "string",
              • "unit": "string",
              • "rangeTo": "string",
              • "other": "string",
              • "options": [
                • {
                  • "name": "string",
                  • "price": "string",
                  • "calorie": 0
                  }
                ]
              },
            • "idcode": "string",
            • "url": "string",
            • "video": "string",
            • "duration": {
              • "unit": "MINUTES",
              • "value": 1
              },
            • "ranking": 0
            }
          ]
        }
      ]
    }
}

Events (Legacy): Get

Retrieve a specific Events ECL

path Parameters
listId
required
string

ID of this List.

accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    • "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
    },
  • "response": {
    • "id": "string",
    • "accountId": "string",
    • "name": "string",
    • "title": "string",
    • "size": 0,
    • "publish": true,
    • "language": "string",
    • "sections": [
      • {
        • "id": "string",
        • "name": "string",
        • "description": "string",
        • "items": [
          • {
            • "id": "string",
            • "name": "string",
            • "description": "string",
            • "type": "string",
            • "starts": "2019-08-24",
            • "ends": "2019-08-24",
            • "photos": [
              • {
                • "url": "string",
                • "height": 0,
                • "width": 0,
                • "alternateText": "string"
                }
              ],
            • "url": "string",
            • "video": "string"
            }
          ]
        }
      ]
    }
}