Quickstart
This guide will get you all set up and ready to use the Evership API. We'll cover how to get started using one of our API clients and how to make your first API request. We'll also look at where to go next to find all the information you need to take full advantage of our powerful REST API.
Before you can make requests to the Evership API, you will need to generate an API key from your Evership dashboard via Integrations.
Making your first API request
Once your API key is ready, we'll test it by creating a draft shipment — this will confirm that your integration is working and allow you to test sending parcel and address data without purchasing a label, as the purchase_label field is set to false.
curl --request POST \
--url https://api.evership.app/v1/shipments \
--header "Authorization: Bearer YOUR_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"sender": {
"name": "Michael Scott",
"contact": "0712345678",
"email": "michael@dundermifflin.com",
"collection_address": {
"address1": "Unit 22",
"address2": "26 Washington Rd",
"suburb": "Claremont",
"city": "Cape Town",
"province": "Western Cape",
"postal_code": "7780",
"country": "South Africa",
"full_address": "Unit 22, 26 Washington Rd, Claremont, Cape Town, 7780, South Africa",
"latitude": -33.9706,
"longitude": 18.4649
},
"pickup_instructions": "Call when arrived"
},
"receiver": {
"name": "Dwight Schrute",
"contact": "0712345678",
"email": "dwight@dundermifflin.com",
"delivery_address": {
"address1": "Tech Solutions Inc., Tech Park, Suite 500",
"address2": "12 Clyde Road",
"suburb": "Green Point",
"city": "Cape Town",
"province": "Western Cape",
"postal_code": "8005",
"country": "South Africa",
"full_address": "Tech Solutions Inc., Tech Park, Suite 500, 12 Clyde Road, Green Point, Cape Town, 8005, South Africa",
"latitude": -33.9095,
"longitude": 18.4155
},
"drop_off_instructions": "Please ring the bell twice"
},
"parcels": [
{
"reference": "Parcel-REF-1",
"description": "Books",
"dimensions": {
"length": 30,
"width": 20,
"height": 10
},
"weight": 5
}
],
"shipment_title": "Order #1234",
"shipment_type": "outbound",
"carrier_service": "dpd-econ",
"purchase_label": false,
"collection_date": "2025-02-14",
"collection_time": "12:30:00"
}'
What's next?
Great, now you're set up and have made your first request to the API. Here are a few links that might be handy as you venture further into the Evership API: