Quickstart Guide

Integrate the parcelLab API into your system and begin tracking shipments and sending status updates to your customers.

parcelLab API

The parcelLab API can be used from outside the parcelLab platform, and can be accessed via its RESTful endpoints using the https://api.parcellab.com/ URL.

API requests are geographically routed to the nearest endpoint. If you’d like to explicitly target a region, you may substitute api.parcellab.com with either api.us.parcellab.com or api.eu.parcellab.com.

The API processes requests and responses in JSON format and adheres to common HTTP methods and response codes. All interactions with the API must occur through HTTPS for security.

Check out the full list of endpoints in the parcelLab API v4 Enhanced (preview).

API Reference

Access Token

In order to use the parcelLab platform, you'll need an access token to make calls to the API.

When you are onboarded with parcelLab, we will send you the API credentials and inform you which fields should be used so you can transmit and display the data correctly.

Access tokens can also be created in your account settings in the parcelLab App.

Once you have your personal access token, you're able to start making your first API call. To authorize your API requests, include your API token in the request header.

Authorization: Parcellab-API-Token <your-base64-encoded-api-key>

Making Requests

When making an API call, the client interacts with the server by sending requests to access or update the data it holds. An API request consists of:

• HTTP verb - defines the type of operation (for example: GET, POST, PUT, and DELETE)

• Header - contains authorization and request information

• Path - identifies the resource being interacted with

• Message body - optional content used when sending data (for example: creating or updating resources)

HTTP Verbs

The following HTTP verbs are generally used to interact with resources in the parcelLab API:

• GET — retrieve a specific resource or a collection of resources

• POST — create a new resource

• PUT — update an existing resource

• PATCH - partially modify an existing resource

• DELETE — remove a resource

Best Practices for API Requests

When making API calls, it’s important to consider the following:

• Always include the mandatory request fields in your API call and handle the required fields in the response

• Avoid using spaces in field names

• Store and reuse values using variables (for example: your parcelLab user ID)

API Versions

The parcelLab API is used to interact with the parcelLab platform. As changes are made as part of API development, versioning ensures that these changes are rolled out successfully to keep the API secure and high performing.

At parcelLab, we have the API v2 LTS (Long-Term Support), providing flexible and robust integrations with our platform.

We have also recently introduced our API v4 Enhanced (preview) to allow for more enhanced and standardized interaction with our platform.

The API v4 Enhanced (preview) does not yet cover all of the features of our API v2 LTS, which is reflected in the documentation.

Download API v4 Specification

You can download a sample OpenAPI specification of the API v4 Enhanced (preview) here.

1MB

parcelLab API v4.yaml