Unfortunately, this feature is not supported on mobile devices. For the best experience, please use a computer.

zipmend API (1.0.0)

Documentation of 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

Informations about cities and zipcodes

Operations

Price

Get price calculated by the

Operations

Booking

Museum tickets for general entrance or special events.

Operations

Publish a booking

Request

Endpoint for publish a booking

Bodyapplication/jsonrequired
itemsArray of objects(Item)
vehicle_typeinteger
Example:

11

additional_informationstring
Example:

"Attention highly flammable goods"

loadingsArray of objects(SpotAddresses)
unloadingsArray of objects(SpotAddresses)
curl -i -X POST \
  -u <username>:<password> \
  https://docs.zipmend.com/_mock/openapi/booking/publish \
  -H 'Content-Type: application/json' \
  -d '{
    "items": [
      {
        "name": "Tannenbaum",
        "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"
          }
        ]
      }
    ]
  }'
Experience it firsthand in the API Explorer!

Responses

Created.

Bodyapplication/json
eventIdstring(uuid)(EventId)required

Identifier for a special event.

namestring(EventName)required

Name of the special event.

locationstring(EventLocation)required

Location where the special event is held.

eventDescriptionstring(EventDescription)required

Description of the special event.

datesArray of strings(date)(EventDates)required

List of planned dates for the special event.

Example:

["2024-07-19T08:00:00+01:00"]

pricenumber(float)(EventPrice)required

Price of a ticket for the special event.

Response
application/json
{ "eventId": "dad4bce8-f5cb-4078-a211-995864315e39", "name": "Mermaid Treasure Identification and Analysis", "location": "Under the seaaa 🦀 🎶 🌊.", "eventDescription": "Join us as we review and classify a rare collection of 20 thingamabobs, gadgets, gizmos, whoosits, and whatsits, kindly donated by Ariel.", "dates": [ "2023-09-05", "2023-09-08" ], "price": 30 }