Special data types

Some Ordering API fields use structured JSON. Preserve the exact field names and value types shown by the target operation schema.

Schedules

Schedules are used by resources such as businesses, menus, and delivery areas. A non-null schedule contains exactly seven day objects. Each day has a Boolean enabled value and an array of lapses.

[
  {"enabled": true, "lapses": [{"open": {"hour": 9, "minute": 0}, "close": {"hour": 17, "minute": 0}}]},
  {"enabled": true, "lapses": [{"open": {"hour": 9, "minute": 0}, "close": {"hour": 17, "minute": 0}}]},
  {"enabled": true, "lapses": [{"open": {"hour": 9, "minute": 0}, "close": {"hour": 17, "minute": 0}}]},
  {"enabled": true, "lapses": [{"open": {"hour": 9, "minute": 0}, "close": {"hour": 17, "minute": 0}}]},
  {"enabled": true, "lapses": [{"open": {"hour": 9, "minute": 0}, "close": {"hour": 17, "minute": 0}}]},
  {"enabled": true, "lapses": [{"open": {"hour": 9, "minute": 0}, "close": {"hour": 17, "minute": 0}}]},
  {"enabled": false, "lapses": []}
]

• open and close contain integer hour and minute fields.
• Use 24-hour values. Hours range from 0 to 23, and minutes range from 0 to 59.
• An opening time cannot be later than its closing time within the same lapse.
• The source convention orders days from Sunday through Saturday. The current validator enforces seven entries and their shape, but does not label the entries, so preserve the order required by the consuming operation.

Order products

Order product input contains a product id, quantity, optional comment, ingredient identifiers, and selected options.

The legacy numeric form remains supported by current order handling:

[
  {
    "id": 1309,
    "quantity": 1,
    "comment": "No onions",
    "ingredients": [10],
    "options": [
      {
        "id": 53,
        "suboptions": [174, 175]
      }
    ]
  }
]

The object form adds position and quantity for each suboption:

[
  {
    "id": 1309,
    "quantity": 1,
    "comment": "No onions",
    "ingredients": [10],
    "options": [
      {
        "id": 53,
        "suboptions": [
          {
            "id": 174,
            "position": "left",
            "quantity": 1
          }
        ]
      }
    ]
  }
]

Current code also uses whole as the default position. When half-option behavior is enabled and the position is not whole, pricing can use the suboption's half_price. Check the product and option configuration before sending positional suboptions.

Locations

Locations use latitude and longitude:

{
  "lat": 40.8065,
  "lng": -73.9536
}

Polygons

A polygon is an array of at least three distinct locations:

[
  {"lat": 40.8065, "lng": -73.9536},
  {"lat": 40.8083, "lng": -73.9436},
  {"lat": 40.8013, "lng": -73.9375}
]

Delivery-zone validation normalizes lat and lng to numeric values and rejects malformed polygons.

Radius-based delivery zones

The legacy contract uses the field name radio for the radius value. Preserve that literal key.

{
  "center": {
    "lat": 40.8065,
    "lng": -73.9536
  },
  "radio": 10
}

The source documentation describes radio in kilometers. Confirm the unit in the target operation before calculating or transforming delivery-zone data.

Customer data

Customer objects can include identity, contact, address, and location fields. Use synthetic data in examples and send only fields accepted by the target operation.

{
  "id": -1,
  "name": "Example",
  "lastname": "Customer",
  "email": "customer@example.com",
  "address": "100 Example Street",
  "address_notes": "Leave at reception",
  "zipcode": "10001",
  "cellphone": "5550100",
  "phone": "5550101",
  "location": {
    "lat": 40.7314,
    "lng": -73.997
  },
  "map_data": {
    "library": "google",
    "place_id": "example-place-id"
  }
}

The historical contract uses id: -1 for a non-registered customer. Verify that behavior against the operation that accepts the customer object.

Map data

map_data can be null or an object containing the map provider and place identifier:

{
  "library": "google",
  "place_id": "example-place-id"
}