Skip to main content
All CollectionsAPI
Introduction and Documentation - RESTful API
Introduction and Documentation - RESTful API

Understanding the API and navigating API Documentation.

Mikkel Otte Pedersen avatar
Written by Mikkel Otte Pedersen
Updated over a week ago

The RESTful API is a powerful tool that allows you to process and manage shipments with Shipmondo. The complete technical documentation can be found here.

Creating shipments

The Shipmondo API lets you build the shipping flow that you want, from simple drafts to advanced shipments.

The /draft_shipments endpoint supports creating drafts, from which any shipment can be created at any time.

The /shipments endpoint supports creating both simple shipments, such as packages, and advanced shipments, such as pallets. Further information on creating shipments can be found here.

Trying out methods

The Shipmondo API documentation allows you to test each of the endpoints directly from the documentation itself, no matter which method it may be.

First, to try out an endpoint you must use your API credentials. This is done by filling out the Auth segment on each of the endpoint description. 

You can then modify the parameters or request body before sending the request by hitting Send Request button.

Error handling

Errors through the API is formatted as follows:

  "error": "Invalid or not found parameter(s)"

If able, the API will identify and describe the error in the error value. The most common errors are 422 Unprocessable Entity, and describes that a request cannot be processed.

Examples of common errors would be:

"Insufficient funds. Try again or log on to your account to refill manually." - The shipment could not be created, because there are not enough funds on your account.

"At least one of the following services are required: Email advisering (39 / EMAIL_NT)" - The shipments could not be created, because a required service could not be identified.

Did this answer your question?