ParcelOne Profile API

openapi: 3.2.0
info:
  title: Parcel.One Shipping REST Profile API
  description: 'ParcelOne https://parcel.one provides you with a REST API for implementing an interface to ParcelOne shipping services into your own shop/warehouse or, respectively, into the shops/warehouses of your customers. ___

    This documentation was created adhering to the OpenAPI 3.0 standard. We use Swagger.IO tool for display. If you prefer to use another OpenAPI-Tool or want to implement this into your own environment, you may download the underlying OpenAPI-Document from here:

    * JSON-Format

    * YAML-Format

    ___

    ## Basic Implementation Principles

    ### Sandbox and Production-Modes

    In order to be able to test your implementation without interfering production environment, we provide a SandBox-Mode as well as a Production-Mode. The URLs:

    * Sandbox: https://sandbox.parcelone.io/shippingapi/v1

    * Production: https://production.parcelone.io/shippingapi/v1


    Please, use the Sandbox mode to test your client application thoroughly before switching to Production mode. In Sandbox mode all data will be saved to a separate database. ### Dynamic Approach

    Differenty from other carriers, Parcel.one provides a products and services structure that may vary for different customers. Therefore, we strongly recommend not to use hardcoded products and services identifiers, but to use a dynamic approach using the profile-functions to get the products and services hierarchy and show it dynamically in your client UI! Also there may be several mandators and for each mandator several consigner/sender-addresses. Every mandator can have a different portfolio of products/services. So, please, strongly consider a dynamic approach! To get acquainted with the dynamic mandator, consigner, Carriers and Products/Services setup, please, start with the customer- and profile-path-functions. ___

    ## Verification and Validation process

    After we took a careful look to your shipments in our sandbox environment to validate your integration, you will be provided with access to our production environment. For the validation of your implementation, we will look for the following items, which you should consider carefully while developing your software:

    > Provision of an own string in the data field ''Software'' (including a version number) to make your implementation identifiable


    > Creation of shipping labels

    > > to various recipients

    > > including a phone and/or mobile phone number of the recipient

    > > including an eMail address of the recipient

    > > with different recipient addresses

    > > in different destination countries

    > > EU and non-EU shipments

    > > using various PARCEL.ONE products

    > > with various combinations of optional services, that can be applied

    > > with different weights for shipments

    > > providing the dimensions of the shipment, even if you intend to skip providing them or to provide default values in production use

    > > providing full customs information for all shipments to non EU countries, even if you currently do not intend to ship to such countries

    > Cancellation of shipping labels


    We are listing these points in such detail as we want to see in advance, that your implementation is capable to provide all parameters for creating shipments and that you have understood our API and the products PARCEL.ONE provides. This will save both of us a lot of trouble in the future, when production mode is going on. Please contact us as soon as you have completed your creation of your test shipments that we may start immediately with our evaluation. ___

    ## Authentification

    Authentification is provided by Basic Authentification secured over SSL. Further authentification is done via an API-Key to authenificate the provider of the software accessing the API. If you are a platform provider for Parcel.One clients, please, keep in mind, that the ApiKey is only as an identification for you and should not be provided to or even be edited in the UI by the users of your platform.'
  termsOfService: https://parcel.one/en/data-security
  contact:
    name: Contact our support
    url: https://parcel.one/en/contact
    email: support@parcel.one
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.0.0
servers:
- url: https://sandbox.parcelone.io/shippingapi/v1
  description: Parcel.One Shipping REST API - Sandbox
security:
- api_key: []
  BasicAuth: []
  Bearer_JWT: []
tags:


# --- truncated at 32 KB (41 KB total) ---
# Full source: https://artifacts.apis.io/parcelone/openapi/parcelone-profile-api-openapi.yml