# zipmend API

Documentation for the zipmend API

Version: 1.0.0
License: MIT

## Servers

Production server (uses live data)
```
https://app.zipmend.com/api/v3
```

Sandbox server (uses test data)
```
https://sandbox.zipmend.com/api/v3
```

## Security

### bearerAuth

Type: http
Scheme: bearer

## Download OpenAPI description

[zipmend API](https://docs.zipmend.com/_spec/openapi.yaml)

## Cities

Find location based on city and zipcode

### Get cities

 - [GET /cities](https://docs.zipmend.com/openapi/cities/getcities.md): Get cities by country code and search term

## Price

Get price

### Calculate price

 - [POST /price](https://docs.zipmend.com/openapi/price/calculateprice.md): Calculate a transport price, based on loadings, unloadings and items

## Booking

Book a transport

### Book a transport

 - [POST /booking/publish](https://docs.zipmend.com/openapi/booking/booktransport.md): Endpoint to book a transport

## Orders

Manage transport orders

### List orders

 - [GET /orders](https://docs.zipmend.com/openapi/orders/listorders.md): Retrieve orders with optional filters.

### Get order by ID

 - [GET /orders/{orderID}](https://docs.zipmend.com/openapi/orders/getorderbyid.md): Retrieve a single order by its ID.

### Update order status

 - [PUT /orders/{orderID}](https://docs.zipmend.com/openapi/orders/updateorderstatus.md): Update the status of an order. Currently, it is only possible to use this endpoint to cancel a transport