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 contracts offered by the carriers.
Carrier PUDO locations
The pickup and dropoff locations offered by the carriers.
PDF labels and other file resources returned by the carriers.
Invitations sent to friends and the users connected this way.
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.
A service can have one or multiple contracts, this resource specifies the prices and available options.
Various options which are available for different carrier services in our API.
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.
Informative messages about different types of resources or the system in general.
Registering a user is required to communicate with our API.
The webhooks offered by our API. Shops can be subscribed to push messages upon these events.
A carrier resource represents one of the many postal carriers that MyParcel.com works with to provide you with a broad range of contracts. This endpoint can...
Fri, 6 Mar, 2020 at 10:02 AM
A carrier contract combines a carrier with service contracts. It only contains a currency attribute, other data like pricing and options is linked through t...
Fri, 6 Mar, 2020 at 10:06 AM
Carrier PUDO locations are locations where: your shipments can be picked up once delivered (Pickup) you can drop the shipments you want to send (Drop-off...
Fri, 6 Mar, 2020 at 10:32 AM
A file resource can represent all kinds of files like shipment labels, available in different file formats. File API specification Format If you...
Fri, 6 Mar, 2020 at 10:36 AM
The invitations are used to invite new users to the MyParcel.com platform. When an invitation is created, our system will automatically send an email to th...
Fri, 6 Mar, 2020 at 10:38 AM
The password reset resource is available in order to change the password for a MyParcel.com user. A password reset can be initiated by providing the email a...
Fri, 6 Mar, 2020 at 10:43 AM
Regions are geographical areas arranged in a tree-like structure with “Earth” being the root region. Countries are regions with a non-empty country_code. C...
Fri, 6 Mar, 2020 at 10:46 AM
Services are provided by carriers and can be used to send shipments. Services are offered from a specific region to a specific region. To limit the number o...
Fri, 6 Mar, 2020 at 10:53 AM
A service contract is a combination of a service with a carrier_contract. Each combination contains a unique recipe to send a shipment. The weight of the sh...
Fri, 6 Mar, 2020 at 11:06 AM
Service options can be added to a shipment. The added price depends on the selected service contract. Options are a generic resource since many carriers off...
Fri, 6 Mar, 2020 at 11:12 AM