This event is sent to the WebHook when a customer requests a delivery or a return.

Event properties

• type: "request-delivery"
• idempotency_key: A random key, unique to the event. Can be uses to recognize subsequent retries of the same event.
• data: The event data:
  • id: The delivery identifier
  • type: One of "DELIVERY" or "RETURN"
  • status: "REQUESTED"
  • customer: The customer object:
    • id: The customer ID
    • company: The name of the customer company, or null
    • address: The delivery address:
      • address1: The first line of the address
      • address2: The second line of the address, if provided
      • zip: The ZIP code
      • city: The city name
      • country: A country ISO code
    • contact: The customer contact object:
      • name: The name of the customer contact
      • email: The email address of the customer contact
  • request: The request object:
    • timestamp: The timestamp when the delivery was requested in ISO 8601 format
    • company: The requesting company name, or null
    • customer_id: The customer ID
    • cost_center: The cost center, or null
    • address: The delivery address:
      • address1: The first line of the address
      • address2: The second line of the address, if provided
      • zip: The ZIP code
      • city: The city name
      • country: A country ISO code
    • user: The user who sent the delivery:
      • name: The name of the user
      • email: The email address of the user
    • scheduled: The desired schedule date and optional time, or null if none was specified:
      • date: The date in the format YYYY-MM-DD
      • time: The optional time in the format HH:mm
    • items: The array of item objects:
      • id: The product identifier
      • name: The product name
      • order_by: Only present if specified on the product. One of "vessel" or "kg".
      • vessel: The vessel object, if available:
        • id: The custom vessel identifier
        • size: Integer size of the vessel in the specified unit
        • unit: One of "l", "dl", "cl", "ml", "kg", "g" or "quantity"
        • type: See vessel and bundle types
      • count: The count of bundles or vessels ordered
      • bundle: The bundle object, or null:
        • id: The custom bundle identifier
        • type: See vessel and bundle types
        • size: The number of vessels in the bundle, or the number of bundles on the pallet if type is "PX"
        • pallet_bundle: Only if type is "PX". Specifies the bundle on the pallet:
          • type: See vessel and bundle types
          • size: The number of vessels in the bundle
      • vessel_count: The total count of vessels (count * bundle.size or count * bundle.size * bundle.pallet_bundle.size)
      • price: The expected unit price in cents
      • price_per: Only present if specified on the product. One of "vessel", "kg", "100g" or "l"
      • message: An optional message for the item provided by the user
    • message: An optional message for the delivery provided by the user

Example message

{
  "type": "request-delivery",
  "idempotency_key": "aJb5iQs18NrZqg3H-tiDq",
  "data": {
    "id": 123456789,
    "type": "DELIVERY",
    "status": "REQUESTED",
    "customer": {
      "id": "12345",
      "company": "Mein Club AG",
      "address": {
        "address1": "Beispielstrasse 1",
        "zip": "8045",
        "city": "Zürich",
        "country": "CH"
      },
      "contact": {
        "name": "Besitzer",
        "email": "besitzer@mein-club.ch"
      }
    },
    "request": {
      "timestamp": "2021-06-23T14:46:48.309Z",
      "address": {
        "address1": "Beispielstrasse 42",
        "zip": "8045",
        "city": "Zürich",
        "country": "CH"
      },
      "scheduled": {
        "date": "2020-05-26",
        "time": "12:30"
      },
      "items": [
        {
          "id": "2",
          "name": "Gin",
          "vessel": {
            "size": 7,
            "unit": "dl",
            "type": "BO"
          },
          "count": 2,
          "bundle": {
            "id": "001",
            "type": "CT",
            "size": 6
          },
          "vessel_count": 12,
          "price": 750
        }
      ],
      "user": {
        "name": "Lagerist",
        "email": "lagerist@mein-club.ch"
      },
      "message": "Vielen Dank!"
    }
  }
}