Returns a list of delivery objects without items. If a cursor property is returned, more deliveries may be requested using the cursor in another request.

Deliveries are ordered chronologically, with the most recent delivery first. When syncing deliveries, you can stop processing once you reach a delivery that you have already seen.

You may specify a status query parameter to filter the deliveries by status, e.g. status=REQUESTED.

Request

GET /deliveries

Parameters

• cursor: The start position for the next result page.
• status: The status to query.

Status codes

• 200 on success

Response properties

• deliveries: The array of delivery objects:
  • id: The delivery identifier
  • type: One of "DELIVERY" or "RETURN"
  • status: One of "REQUESTED", "ACCEPTED", "REJECTED", "CANCELLED" or "DELIVERED"
  • customer: The customer object:
    • id: The customer ID, or null if not provided
    • company: The name of the customer company, or null
    • address: The customer address object:
      • address1: The first line of the address
      • address2: The second line of the address, if provided
      • 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, or null
    • 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
      • city: The city name
      • country: A country ISO code
    • 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
    • user: The user who sent the delivery:
      • name: The name of the user
      • email: The email address of the user
    • message: A message provided by the user
  • responses: An array of response objects:
    • type: Either "ACCEPT" or "REJECT"
    • timestamp: The timestamp when the response was received in ISO 8601 format
    • reference: An optional delivery reference
    • scheduled: Only when accepted, an optional alternative schedule date and time:
      • date: The date in the format YYYY-MM-DD
      • time: The optional time in the format HH:mm
    • user: An optional user who sent the response:
      • name: The name of the user
      • email: The email address of the user
    • message: An optional message provided by the user
• cursor: The cursor to read the next page, if more results are available

Example response

{
  "deliveries": [
    {
      "id": 123456789,
      "type": "DELIVERY",
      "status": "ACCEPTED",
      "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"
        },
        "user": {
          "name": "Lagerist",
          "email": "lagerist@mein-club.ch"
        },
        "message": "Vielen Dank!"
      },
      "responses": [
        {
          "timestamp": "2021-06-23T14:46:48.309Z",
          "reference": "delivery-123",
          "scheduled": {
            "date": "2020-05-26",
            "time": "14:00"
          },
          "user": {
            "name": "Lieferant",
            "email": "lieferant@beispiel-lieferant.ch"
          },
          "message": "Gerne!"
        }
      ]
    }
  ],
  "cursor": 1234
}