Read a list of customers and their settings.

Request

GET /customers

Status codes

• 200 on success

Response properties

• customers: The array of customer objects:
  • id: The customer identifier.
  • name: The customer's name.
  • price_group: The customer's price group.
  • delivery_days: An object where keys are numbers 0 (Sunday) to 6 (Saturday) and values are objects with the following properties.
    • lead_days: The number of days that customers have to order in advance. Use 0 for same day delivery.
    • cutoff: The time until when orders have to be placed in the format HH:mm. After this time lead_days is incremented by one.
  • delivery_date_overrides: An object where keys are ISO dates (e.g. 2023-12-26) and values are objects with the following properties.
    • lead_days: The number of days that customers have to order in advance. Use 0 for same day delivery.
    • cutoff: The time until when orders have to be placed in the format HH:mm. After this time lead_days is incremented by one.
  • dates_with_no_delivery: An array of dates in ISO date format. Customers cannot send orders for these dates.

Example response

{
  "customers": [
    {
      "name": "Zurich Restaurant",
      "id": "CS338012",
      "price_group": "group-1",
      "dates_with_no_delivery": ["2023-12-25"]
    },
    {
      "name": "Bar in Zug",
      "id": "CS334002",
      "delivery_days": {
        "1": { "lead_days": 3 },
        "2": { "lead_days": 1, "cutoff": "11:00" },
        "3": { "lead_days": 1, "cutoff": "11:00" },
        "4": { "lead_days": 1, "cutoff": "11:00" },
        "5": { "lead_days": 1, "cutoff": "11:00" }
      },
      "delivery_date_overrides": {
        "2023-12-27": {
          "lead_days": 4,
          "cutoff": "16:00"
        }
      },
      "dates_with_no_delivery": ["2023-12-25"]
    }
  ]
}