ParcelOne Mandator API

openapi: 3.2.0
info:
  title: Parcel.One Shipping REST Mandator 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:
- name: mandator
paths:
  /mandator:
    get:
      tags:
      - mandator
      summary: get mandators status and availabe Mandators and Consigners data
      description: 'Get mandator status and availabe Mandators and Consigners data

        Also provides information about status of a mandator - active, blocked or annulled - and which entities are considered default. Reflects system configuration for mandator.'
      operationId: getmandatorStatus
      parameters:
      - $ref: '#/components/parameters/Lang'
      - $ref: '#/components/parameters/Getaccesstoken'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    results:
                      $ref: '#/components/schemas/Customer'
                  type: object
                - $ref: '#/components/schemas/ResultSuccess'
              examples:
                ResultSuccess:
                  summary: ResultSuccess
                  value:
                    status: 200
                    success: 1
                    message: OK
                    type: success
                    instance: /mandator
                    results:
                    - CustomerID: '12345'
                      MandatorID: '1'
                      Shortname: test-company
                      Default: 1
                      StatusID: 0
                      Status: Customer active.
                      Consigners:
                      - ConsignerID: '2'
                        Shortname: consigner-test1
                        Default: '1'
                      - ConsignerID: '4'
                        Shortname: consigner-test4
                        Default: 0
                    UniqId: 6499698a6f6e1
        '401':
          description: Authentification failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultError'
components:
  schemas:
    ResultSuccess:
      description: Success Result basic structure - extended by individual Results
      properties:
        status:
          description: '- 3 digits http-Status-Code'
          type: integer
          example: 200
        success:
          description: '- 1 for Success'
          type: integer
          format: int32
          example: 1
        message:
          description: '- Short Message of http-Status'
          type: string
          example: OK
        type:
          description: '- value ''success'''
          type: string
          example: success
        instance:
          description: '- URL Request Path'
          type: string
          example: '...your request path...'
        UniqId:
          description: '- Unique Request Id for Log Reference'
          type: string
          example: 649956bfd9eb0
      type: object
    ShipmentError:
      properties:
        ErrorNo:
          description: '- MaxLen 4'
          type: string
        Message:
          description: '- no Maxlimit'
          type: string
        StatusCode:
          description: '- MaxLen 20'
          type: string
      type: object
      xml: {}
    Customer:
      description: Customer information including Mandators and Consigners
      properties:
        CustomerID:
          description: '- Customers Client No. - MaxLen 20'
          type: string
        MandatorID:
          description: '- Mandator ID - MaxLen 20'
          type: string
        Shortname:
          description: '- Mandator Shortname - MaxLen 20'
          type: string
        Default:
          description: '- if Default for this Customer - bool'
          type: integer
        StatusID:
          description: '- Status ID (0=Customer active, 1=Customer blocked, 2=Customer annulled)'
          type: integer
        Status:
          description: '- Status Description (e.g. Customer active) - MaxLen 20'
          type: string
        Consigners:
          description: '- List of Consigners for this Mandator'
          type: array
          items:
            $ref: '#/components/schemas/Consigner'
      type: object
    Consigner:
      description: Consigner / Sender Information
      required:
      - Currency
      - Value
      properties:
        ConsignerID:
          description: '- Consigner ID - MaxLen 50'
          type: string
        Shortname:
          description: '- Consigner Shortname - MaxLen 30'
          type: string
        Default:
          description: '- if default Consigner for this Mandator - bool'
          type: integer
      type: object
    ResultError:
      description: Error-Result
      properties:
        status:
          description: '- 3 digits http-Status-Code'
          type: integer
          format: int32
          example: 401
        success:
          description: '- -1 for Error'
          type: integer
          format: int32
          example: -1
        message:
          description: '- Short Message of http-Status'
          type: string
          example: Unauthorized
        type:
          description: '- value ''error'''
          type: string
          example: error
        instance:
          description: '- URL Request Path'
          type: string
          example: '...your request path...'
        errors:
          description: '- Detailed Errors'
          type: array
          items:
            $ref: '#/components/schemas/ShipmentError'
          example:
          - ErrorNo: 4012
            Message: Wrong ApiKey for access to WebService.
            StatusCode: Authentification failed
        UniqId:
          description: '- Unique Request Id for Log Reference'
          type: string
          example: 649956bfd9eb0
      type: object
  parameters:
    Getaccesstoken:
      name: Getaccesstoken
      in: header
      description: Header-flag to return JWT Access Token, insert 'true' to send this header
      required: false
      schema:
        type: string
        enum:
        - 'true'
    Lang:
      name: Lang
      in: header
      description: Header-flag to control multilingual properties
      required: false
      schema:
        type: string
        default: en
        enum:
        - en
        - de
        - es
  securitySchemes:
    api_key:
      type: apiKey
      name: Apikey
      in: header
    BasicAuth:
      type: http
      scheme: basic
    Bearer_JWT:
      type: http
      bearerFormat: JWT
      scheme: bearer
externalDocs:
  description: Find out more about Parcel.One
  url: http://parcel.one