Skip to content
/
Update order status

zipmend API (1.0.0)

Documentation for the zipmend API

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL

https://docs.zipmend.com

E-mail

api@zipmend.com

License

MIT

Terms of Service

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

List orders

Request

Retrieve orders with optional filters.

Security
bearerAuth
Query
status[]Array of strings(OrderStatus)

Filter by order status. Repeat the parameter for multiple values.

Items Enum"draft""placed""loaded""canceled"
Example: status[]=draft&status[]=placed
order-numberinteger

Filter by order number.

Example: order-number=231231
curl -i -X GET \
  'https://docs.zipmend.com/_mock/openapi/orders?status%5B%5D=draft%2Cplaced&order-number=231231' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success!

Bodyapplication/json
dataArray of objects(Order)required
data[].​idstringrequired
Example: "67a5f6e2cbf149fb4e0bc2d2"
data[].​order_numberintegerrequired
Example: 200151
data[].​loadingsArray of objects(OrderStop)
data[].​unloadingsArray of objects(OrderStop)
data[].​statusstring(OrderStatus)required

Current status of the order.

Enum"draft""placed""loaded""canceled"
linksobject(PaginationLinks)
metaobject(PaginationMeta)
Response
application/json
{
  "data": [
    {
      "id": "67a5f6e2cbf149fb4e0bc2d2",
      "order_number": 200151,
      "loadings": [
        {
          "country": "DE",
          "zip": "22869",
          "city": "Schenefeld",
          "start_date": "2025-02-10T07:00:00+01:00",
          "end_date": "2025-02-10T09:00:00+01:00"
        }
      ],
      "unloadings": [
        {
          "country": "DE",
          "zip": "02829",
          "city": "Königshain",
          "start_date": "2025-02-10T15:50:00+01:00",
          "end_date": "2025-02-10T17:50:00+01:00"
        }
      ],
      "status": "placed"
    }
  ],
  "links": {
    "first": "https://app.zipmend.com/api/v3/orders?page=1",
    "last": "https://app.zipmend.com/api/v3/orders?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "&laquo; Previous",
        "active": false
      },
      {
        "url": "https://app.zipmend.com/api/v3/orders?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next &raquo;",
        "active": false
      }
    ],
    "path": "https://app.zipmend.com/api/v3/orders",
    "per_page": 15,
    "to": 1,
    "total": 1
  }
}

Get order by ID

Request

Retrieve a single order by its ID.

Security
bearerAuth
Path
orderIDstringrequired

The ID of the order to retrieve

Example: 68b9627a8fb3ff609808c842
curl -i -X GET \
  https://docs.zipmend.com/_mock/openapi/orders/68b9627a8fb3ff609808c842 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success!

Bodyapplication/json
messagestringrequired
Example: "Success!"
dataobject(OrderDetail)required

Detailed order object

data.​idstring
Example: "68b9627a8fb3ff609808c842"
data.​order_numberinteger
Example: 200887
data.​statusstring(OrderStatus)

Current status of the order.

Enum"draft""placed""loaded""canceled"
data.​documented_deliveryboolean
Example: false
data.​distanceinteger
Example: 142
data.​payment_methodstring
Example: "invoice"
data.​loadingsArray of objects(OrderDetailedStop)
data.​unloadingsArray of objects(OrderDetailedStop)
data.​goodsArray of objects(OrderGoodsItem)
data.​priceobject(OrderPrice)

Price information for an order.

data.​extra_servicesArray of objects(ExtraService)
Response
application/json
{
  "message": "Success!",
  "data": {
    "id": "68b9627a8fb3ff609808c842",
    "order_number": 200887,
    "status": "loaded",
    "documented_delivery": false,
    "distance": 142,
    "payment_method": "invoice",
    "loadings": [
      {
        "id": "68b9627a8fb3ff609808c844",
        "dates": [
          {
            "start": "2025-09-04T12:00:00+02:00",
            "end": "2025-09-04T14:00:00+02:00"
          }
        ],
        "address": {
          "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"
        },
        "statuses": [
          {
            "type": "finished",
            "date": "2025-09-04T11:50:00+02:00"
          }
        ]
      }
    ],
    "unloadings": [
      {
        "id": "68b9627b8fb3ff609808c846",
        "dates": [
          {
            "start": "2025-09-04T14:40:00+02:00",
            "end": "2025-09-04T16:40:00+02:00"
          }
        ],
        "address": {
          "company_name": "Mike Kolbe Heizungstechnik GmbH",
          "first_name": "Mike",
          "last_name": "Kolbe",
          "address_line_1": "Dannenkamp 4",
          "address_line_2": "3. OG",
          "country": "DE",
          "zip": "22869",
          "city": "Schenefeld"
        },
        "statuses": []
      }
    ],
    "goods": [
      {
        "quantity": 1,
        "category": "epal",
        "name": "Harmlose Handelsware",
        "weight": 100,
        "length": 120,
        "width": 80,
        "height": 100,
        "is_stackable": false
      }
    ],
    "price": {
      "net_amount": 219.82,
      "gross_amount": 261.59,
      "vat_rate": 0.19,
      "currency_code": "EUR",
      "transport_net_amount": 219.82
    },
    "extra_services": []
  }
}

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!"
}
Copyright © zipmend GmbH 2025. All right reserved.