Resources

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:

  • Carriers
  • The postal carriers that MyParcel.com works with and are available for your region.

  • Carrier PUDO locations
  • The pickup and dropoff locations offered by the carriers.

  • Files
  • PDF labels and other file resources returned by the carriers.

  • Password Resets
  • Functionality to create or reset the password of a user.

  • Regions
  • All available regions with their region code and country code to easily filter available services.

  • Services
  • All services provided by the carriers, possibly filtered on a specific region.

  • Contracts
  • Contracts define the service and prices available for a carrier.

  • Service Options
  • Various options which are available for different carrier services in our API.

  • Shipment Statuses
  • Statuses which are attached to shipments, containing carrier status details.

  • Shipments
  • The main resource in our API containing shipment information, files and statuses.

  • Shops
  • A user needs at least one shop to be able to create shipments.

  • Statuses
  • Various statuses which are available for different resources in our API.

  • Service Rates
  • Service rates determine the price and limitations for a given service.

  • Common objects
  • 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.

10-08-2018