Skip to content

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

Orders

Manage transport orders

Operations

Update order status

Request

Update the status of an order. Currently, it is only possible to use this endpoint to cancel a transport

Security
bearerAuth
Path
orderIDstringrequired

The ID of the order to update

Example: 68822b0ea09ba5655e0a2032
Bodyapplication/jsonrequired
statusstringrequired
Value"canceled"
Example: "canceled"
curl -i -X PUT \
  https://docs.zipmend.com/_mock/openapi/orders/68822b0ea09ba5655e0a2032 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "status": "canceled"
  }'

Responses

Order updated successfully.

Bodyapplication/json
messagestringrequired
Example: "Success!"
Response
application/json
{ "message": "Success!" }