This part of the documentation describes the resources contained in the MyParcel.com API, how to use them and what you can expect from them. Divided in the following chapters:
The postal carriers that MyParcel.com works with and are available for your region.
The pick-up and drop-off locations offered by the carriers.
PDF labels and other file resources returned by the carriers.
Hooks are there to automate processes on the API.
Functionality to create or reset the password of a user.
All available regions with their region code and country code to easily filter available services.
All services provided by the carriers, possibly filtered on a specific region.
Contracts define the service and prices available for a carrier.
Various options which are available for different carrier services in our API.
Statuses which are attached to shipments, containing carrier status details.
The main resource in our API containing shipment information, files and statuses.
A user needs at least one shop to be able to create shipments.
Various statuses which are available for different resources in our API.
Service rates determine the price and limitations for a given service.
This part of the documentation describes objects, commonly used in resources. Divided in the following chapters: Addresses A commonly used model structure that represents an address. Prices A commonly used model structure that represents a price.