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

Calculate price

Request

Calculate a transport price, based on loadings, unloadings and items

Bodyapplication/jsonrequired
itemsArray of objects(Item)
loadingsArray of objects(City)required
loadings[].​namestring(Name)
loadings[].​zip_codestring(ZipCode)
loadings[].​countrystring(Country)
unloadingsArray of objects(City)required
unloadings[].​namestring(Name)
unloadings[].​zip_codestring(ZipCode)
unloadings[].​countrystring(Country)
loading_datestring(date)(Date)required
ftl_timeslot_durationinteger(FTL_Timeslot_Duration)

The FTL timeslot duration must be either 6, 3, or 0.

Enum630
curl -i -X POST \
  https://docs.zipmend.com/_mock/openapi/price \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "items": [
      {
        "quantity": 1,
        "length": 230,
        "width": 120,
        "height": 80,
        "weight": 320
      }
    ],
    "loadings": [
      {
        "name": "Bremen",
        "zip_code": "28779",
        "country": "DE"
      }
    ],
    "unloadings": [
      {
        "name": "Bremen",
        "zip_code": "28779",
        "country": "DE"
      }
    ],
    "loading_date": "2024-07-19T08:00:00+01:00",
    "ftl_timeslot_duration": 6
  }'

Responses

Created.

Bodyapplication/json
messagestringrequired
Example: "Success!"
dataArray of objects(PriceObject)required
data[].​vehicle_typeinteger
Example: 11
data[].​valuenumber
Example: 407.15
data[].​driving_timeinteger
Example: 23575
data[].​estimated_loading_timesArray of objects(SpotTimes)
data[].​estimated_unloading_timesArray of objects(SpotTimes)
data[].​available_extra_servicesArray of objects(ExtraService)
Response
application/json
{ "message": "Success!", "data": [ { "vehicle_type": 11, "value": 407.15, "driving_time": 23575, "estimated_loading_times": [ { "start": "2024-09-19T09:00:00+02:00", "end": "2024-09-19T10:00:00+02:00" } ], "estimated_unloading_times": [ { "start": "2024-09-19T14:00:00+02:00", "end": "2024-09-19T15:00:00+02:00" } ], "available_extra_services": [ { "label": "loadingThroughDriver", "cost": 29.9 }, { "label": "unloadingThroughDriver", "cost": 29.9 } ] }, { "vehicle_type": 12, "value": 450, "driving_time": 24000, "estimated_loading_times": [ { "start": "2024-09-19T09:30:00+02:00", "end": "2024-09-19T10:30:00+02:00" } ], "estimated_unloading_times": [ { "start": "2024-09-19T14:30:00+02:00", "end": "2024-09-19T15:30:00+02:00" } ], "available_extra_services": [ { "label": "loadingThroughDriver", "cost": 34.9 }, { "label": "unloadingThroughDriver", "cost": 34.9 } ] } ] }

Booking

Book a transport

Operations