zipmend API (1.0.0)

Documentation for the zipmend API

Download OpenAPI description
Languages
Servers
Mock server
https://docs.zipmend.com/_mock/openapi/
Production server (uses live data)
https://app.zipmend.com/api/v3/
Sandbox server (uses test data)
https://sandbox.zipmend.com/api/v3/

Cities

Find location based on city and zipcode

Operations

Price

Get price

Operations

Booking

Book a transport

Operations

Book a transport

Request

Endpoint to book a transport

Bodyapplication/jsonrequired
itemsArray of objects
vehicle_typeinteger
Example: 11
additional_informationstring
Example: "Attention: highly flammable goods"
loadingsArray of objects(SpotAddresses)
unloadingsArray of objects(SpotAddresses)
curl -i -X POST \
  https://docs.zipmend.com/_mock/openapi/booking/publish \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "items": [
      {
        "name": "Product Name",
        "quantity": 22,
        "length": 120,
        "width": 100,
        "height": 80,
        "weight": 320
      }
    ],
    "vehicle_type": 13,
    "additional_information": "Attention: highly flammable goods",
    "loadings": [
      {
        "company_name": "Acme Corporation",
        "first_name": "John",
        "last_name": "Smith",
        "address_line_1": "Karl-Marx-Strasse 1",
        "address_line_2": "Tor 2",
        "country": "DE",
        "zip": "28779",
        "city": "Bremen",
        "phone": "+49123456789",
        "reference_number": "123456789",
        "dates": [
          {
            "start": "2024-07-20T07:00:00+01:00",
            "end": "2024-07-20T10:00:00+01:00"
          }
        ]
      }
    ],
    "unloadings": [
      {
        "company_name": "zipmend GmbH",
        "first_name": "Max",
        "last_name": "Mustermann",
        "address_line_1": "Steintorweg 4",
        "address_line_2": "Tor 2",
        "country": "DE",
        "zip": "12247",
        "city": "Berlin",
        "phone": "+49123456789",
        "reference_number": "123456789",
        "dates": [
          {
            "start": "2024-07-20T13:50:00+01:00",
            "end": "2024-07-20T16:50:00+01:00"
          }
        ]
      }
    ]
  }'

Responses

Created.

Bodyapplication/json
messagestring
Example: "Booking created successfully."
Response
application/json
{ "message": "Success!", "data": { "id": "67ee79799b10373f880ee9d6", "items": [ { "category": "other", "is_stackable": false, "quantity": 1, "name": "Tannenbaum", "weight": 320, "length": 120, "width": 100, "height": 80 } ], "additional_information": "Achtung leicht entzündliche Ware", "loadings": [ { "company_name": "Acme Corporation", "first_name": "John", "last_name": "Smith", "address_line_1": "Karl-Marx-Strasse 1", "address_line_2": "Tor 2", "country": "DE", "zip": "28779", "city": "Bremen", "phone": "+49123456789", "reference_number": "123456789", "dates": [ { "start": "2025-04-03T15:00:00+02:00", "end": "2025-04-03T17:00:00+02:00" } ] } ], "unloadings": [ { "company_name": "zipmend GmbH", "first_name": "Max", "last_name": "Mustermann", "address_line_1": "Steintorweg 4", "address_line_2": "Tor 2", "country": "DE", "zip": "12247", "city": "Berlin", "phone": "+49123456789", "reference_number": "123456789", "dates": [ { "start": "2025-04-03T19:50:00+02:00", "end": "2025-04-03T21:50:00+02:00" } ] } ] } }