Order object

Description

This page describes whole order object and its requirements.

Example of order object:

{
    "parcelType": "package",
    "countryFrom": "PL",
    "countryTo": "SK",
    "parcelData": [
        {
            "width": 25,
            "height": 5,
            "length": 25,
            "weight": 15,
            "additions": ["nonstandard"]
        }
    ],
    "isOwnTransport": true,
    "collectionDate": "2019-12-17",
    "collectionHour": 12,
    "description": "Package description",
    "globalAdditions": ["cod"],
    "cod": 155.59, 
    "sendingInformation": {
      "recipient": {
        "companyName": "Exportpaczka",
        "firstName": "John",
        "surname": "Doe",
        "street": "Long street",
        "buildingNumber": "15a",
        "flatNumber": "5b",
        "city": "Katowice",
        "postCode": 54321,
        "telephone": "512123123",
        "email": "email@example.com"
      },
      "sender": {
        "companyName": "Exportpaczka",
        "firstName": "John",
        "surname": "Doe",
        "street": "Long street",
        "buildingNumber": "15a",
        "flatNumber": "5b",
        "city": "Katowice",
        "postCode": 54321,
        "telephone": "512123123",
        "email": "email@example.com"
      }
    }
}

Order object

Required fields

• countryFrom - string - code of country from where package is sent - available country routes
• countryTo - string - code of country to where package is sent - available country routes
• parcelType - string - type of package - available country routes
• isOwnTransport - boolean - this field determines if you want to transport yourself (when set to true) or if courier should get package from your (when set to false)
• description - string - short description of order
• parcelData - array of parcel objects - minimum 1, maximum 5 packages in one order
• sendingInformation - object containing two objects - contains recipient and sender of the order

Optional fields

• cod - numeric - required when cod is provided in globalAdditions - value of the COD, when this field is included you also have to provide its code inside globalAdditions array
• globalAdditions - array with string values - order additions, such as COD, insurance
• postCodeFrom - integer - required when parcelType is pallete or halfpallete - post code of person who sends the package
• postCodeTo - integer - required when parcelType is pallete or halfpallete - post code of person who receives the package
• collectionDate - date in format YYYY-MM-DD - required when own transport is set to false - day when courier should pick up the package from sender. When country from where the package is sent is different than Poland, then it has to be the next working day
• collectionHour - integer - required when own transport is set to false - 8 (8-10), 10 (10-12), 12 (12-14), 14 (14-16), 16 (16-18) - hour when courier should pick up the package. It is only available when the package is sent from Poland
• discountCode - string - discount code

Parcel object

{
    "width": 25,
    "height": 5,
    "length": 25,
    "weight": 15,
    "additions": ["nonstandard"]
}

Required fields

• width - integer - width of the package
• height - integer - height of the package
• length - integer - length of the package
• weight - integer - weight of the package

Optional fields

• additions - array of strings - package additions, currently available addition is nonstandard

Sending information object

{
    "sendingInformation": {
        "recipient": {
            "companyName": "Exportpaczka",
            "firstName": "John",
            "surname": "Doe",
            "street": "Long street",
            "buildingNumber": "15a",
            "flatNumber": "5b",
            "city": "Katowice",
            "postCode": 54321,
            "telephone": "512123123",
            "email": "email@example.com"
        },
        "sender": {
            "companyName": "Exportpaczka",
            "firstName": "John",
            "surname": "Doe",
            "street": "Long street",
            "buildingNumber": "15a",
            "flatNumber": "5b",
            "city": "Katowice",
            "postCode": 54321,
            "telephone": "512123123",
            "email": "email@example.com"
        }
    }
}

Required fields in sender and recipient objects

• firstName - string
• surname - string
• street - string
• buildingNumber - string
• city - string
• postCode - integer
• telephone - string
• email - string, valid email address

Optional fields

• companyName - string
• flatNumber - string