API docs by Redocly

Nowe Kolory Parcel Api (1.2.78)

Download OpenAPI specification:

E-mail: api@nowekolory.pl License: Apache 2.0

This API provides functionalities related to parcel management. It allows users or systems to create new parcels, generate labels and track their history.

Login into application

query Parameters
username
required
string
password
required
string
accountID
required
string

Responses

Create a new parcel

Authorizations:
bearerAuth
Request Body schema: application/json
required
accountID
required
string

Account ID that was provided during account creation.

orderID
required
string
marketplaceOrderID
required
string

This identifier is used to uniquely identify an order within a marketplace, eq. Emag or Skroutz. In case there is no marketplace involved, please use NONE

marketplaceType
string
Enum: "NONE" "EMAG" "SKROUTZ" "ALLEGRO" "PEPITA" "FASHION_DAYS" "JOOM" "DECATHLON" "TEMU"

Required if marketplaceOrderID is present.

deliveryType
required
string
Enum: "COURIER" "EASYBOX" "SAMEDAY_LOCKER" "FAN_COURIER_LOCKER"
required
object (Address)
required
Array of objects (ParcelData)

For every entry there will be generated different package number.

value
required
number <double>

Value can't be negative. WARNING: For HU orders there cannot be decimal point in any values. Their currency doesn't use decimal point. All values has to be rounded down. In case of EMAG/FASHION_DAYS marketplaces, value cannot be greater then order value.

valueCurrency
required
string
codValue
required
number <double>

If there is no COD for order, please enter 0. Value can't be negative. WARNING: For HU orders there cannot be decimal point in any values. Their currency doesn't use decimal point. All values has to be rounded down. In case of EMAG/FASHION_DAYS marketplaces, value cannot be greater then order value.

codCurrency
string

Required if codValue is present.

insuranceValue
required
number <double>

If there is no insurance for package, please enter 0. Value can't be negative.

insuranceCurrency
string

Required if insuranceValue is present. WARNING: For HU orders there cannot be decimal point in any values. Their currency doesn't use decimal point. All values has to be rounded down.

platformSource
string

Platform from which data is sent. For proper value please contact our support.

Responses

Request samples

Content type
application/json
{
  • "accountID": "string",
  • "orderID": "string",
  • "marketplaceOrderID": "string",
  • "marketplaceType": "NONE",
  • "deliveryType": "COURIER",
  • "address": {
    },
  • "parcels": [
    ],
  • "value": 0.1,
  • "valueCurrency": "string",
  • "codValue": 0.1,
  • "codCurrency": "string",
  • "insuranceValue": 0.1,
  • "insuranceCurrency": "string",
  • "platformSource": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": {
    },
  • "parcelNumberList": [
    ]
}

Delete existing parcel

Authorizations:
bearerAuth
Request Body schema: application/json
required
parcelNumber
required
string

Responses

Request samples

Content type
application/json
{
  • "parcelNumber": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": {
    }
}

Get existing parcel

Authorizations:
bearerAuth
Request Body schema: application/json
required
parcelNumber
required
string
loadAllLabelsFromTransport
boolean
labelFormat
string
Enum: "ZPL" "PDF"

Responses

Request samples

Content type
application/json
{
  • "parcelNumber": "string",
  • "loadAllLabelsFromTransport": true,
  • "labelFormat": "ZPL"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": {
    },
  • "parcelDataBase64": "string",
  • "zplDataBase64": "string"
}

Get parcel information

Authorizations:
bearerAuth
query Parameters
waybillNumber
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "error": {
    },
  • "parcelInformation": {
    }
}

Get parcel lockers list for given country.

Supported countries: RO, HU

query Parameters
countryCode
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "error": {
    },
  • "parcelLockerDataList": [
    ]
}

Get parcels history

Request Body schema: application/json
required
parcelNumbers
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "parcelNumbers": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": {
    },
  • "statusDataList": [
    ]
}

Get list of return waybill created at given day

Authorizations:
bearerAuth
Request Body schema: application/json
required
accountID
required
string
date
required
string <date>

Date in format yyyy-MM-dd

Responses

Request samples

Content type
application/json
{
  • "accountID": "string",
  • "date": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": {
    },
  • "returnedWaybillsList": [
    ]
}

Mark parcel as sent

Authorizations:
bearerAuth
Request Body schema: application/json
required
parcelNumber
required
string

Responses

Request samples

Content type
application/json
{
  • "parcelNumber": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": {
    }
}