This documentation provides all the basic information you need to start using the “Lithuania post” API. It covers not only how to find streets, building, localities, addresses and buildings in Lithuania but as well how to create a shipping item, how to manage all the process of sending it from start to the end by calling the courier and creating required documents for the shipment.

We offer a TEST environment of “Lithuania Post“ which mimics the PRODUCTION environment, so developers who integrate the public “Lithuania post” API to their application can experiment and test the product without any consequences.

Note: At this step you already have to have authentication to the TEST environment. We will provide you with the authentication to the PRODUCTION environment when you will be done with the integration in the TEST environment and all your needs have been reached ensuring that everything is working as it should.

All the communication with the API must be authenticated. Only authenticated request will be authorized. See Authorization page for detailed information about used security.

One of the most important function of this API is to let the user create, manage and send an item by creating it, adding required documents, calling the courier and tracking it. The processes of doing so are visualized bellow. As well find all the needed API methods and data structures for creating a request for the API.

B2+PFQJRofYbAAAAAElFTkSuQmCC

Note: As well we are giving you a base requests collection for POSTMAN, which will help you with trying out the test environment of the API. All the needed actions to do are:

  1. Use(POST): Authorization(Without client secret) script. In the params tab add your credentials.

  2. You will get a response which will contain access token. Add it to your collection, select: View more actions → Edit →Authorization→Token
    = Shipping item creation and management process

  3. Shipping item creation process

wd7fc1jF59uWQAAAABJRU5ErkJggg==
No Process Description

1

Get shipping item templates

To create a new shipping item, it is necessary to specify the default shipping item attributes (parameters) first. For this purpose, the system uses shipping item templates, i.e. sets of default parameters which are used to create a shipping item. A list of shipping item templates and their description may be obtained using the getShippingItemTemplates method.
Note: the method is called whenever appropriate (when it is necessary to update the templates), but not every time to initiate a shipping item to be created.

2

Create shipping item

To create a shipping item, it is necessary to enter the shipping item details by calling the createShippingItem method. To create a shipping item, it is necessary to specify the shipping item template number and the recipient’s details.
Note: if the sender’s address is not provided, the system will automatically detect the sender’s address using the account details. This method may have (not mandatory) the additional services regarding the shipping item and declaration details entered.

3

Check available options for a shipping item

When a shipping item is created, it is possible to check the available options for it. The getShippingItemOptions method presents the available countries of the shipping item recipient, a list of additional services, the required declarations to be completed and the shipping item weight and size ranges. Note: the method is called whenever appropriate (when it is necessary to update the available shipping item properties). If the shipping item parameters are known and do not change, this step is not mandatory for a shipping item to be created and dispatched.

5

Update shipping item details

When a shipping item is created, shipping item details may be updated, where necessary, using updateShippingItem.
Note: the method is called whenever appropriate.

6

Initiate shipping

When a shipping item or a list of shipping items is/are created, initiate shipping. The call of the initiateShipping method and specification of the shipping item identifiers is followed by a confirmation of the shipping item dispatch order.

7

Receive cart identification numbers

When a shipping item order is successfully confirmed, the call of the initiateShipping returns cart identifiers.

  1. Shipping item additional services management

McRdfgDYZ6Wt4T6nTgAAAAASUVORK5CYII=
No Process Description

1

Create shipping item

To create a shipping item, it is necessary to enter the shipping item details by calling the createShippingItem method. To create a shipping item, it is necessary to specify the shipping item template number and the recipient’s details. It is possible to add the additional services in the beginning of creating the item. If the required additional service is registered service. The form requires to input both additional services (priority and registered).
Note: if the sender’s address is not provided, the system will automatically detect the sender’s address using the account details. This method may have (not mandatory) the additional services regarding the shipping item and declaration details entered.

2

Check available options for a shipping item

When a shipping item is created, it is possible to check the available options for it. The getShippingItemOptions method presents the available countries of the shipping item recipient, a list of additional services, the required declarations to be completed and the shipping item weight and size ranges. Note: the method is called whenever appropriate (when it is necessary to update the available shipping item properties). If the shipping item parameters are known and do not change, this step is not mandatory for a shipping item to be created and dispatched.

3

Does the shipping item needs a change or a different service?

When a shipping item is created, shipping item details may be updated, where necessary, using updateShippingItem.
Note: the method is called whenever appropriate.

4

Adding registered or priority service for a shipping item

In available options it will be seen that there is additional services: priority, which gives the item an additional service of priority and reaches the customer faster, and registered, which gives the item an additional service of registered item, and the item will be presented to the receiver directly. If the required additional service is registered service. The form requires to input both additional services (priority and registered). For priority form requires only priority. Using updateShippingItem adding an id of the additionalServices from the response of getShippingItemOptions. Note: these actions are available only before initiating the item, as well it is possible to add the services while creating an item.item.

5

Initiate shipping

When a shipping item or a list of shipping items is/are created, initiate shipping. The call of the initiateShipping method and specification of the shipping item identifiers is followed by a confirmation of the shipping item dispatch order. Note: After initiating the shipping item or items it is impossible to add any services or update the items/items.

  1. Delete shipping item

j+SD+3DYczGIeEWZRZFHonnzFsQ0vZX4+HiRMHadsWLFCrJPHGbHtq1YgsQQU5ZR6JLo0OkvRNZpRJ8+fYRAyiD+H6ow2ARaRB1FAAAAAElFTkSuQmCC
No Process Description

1

Create shipping item

See Table 1– Shipping item creation and management process description

2

Delete shipping item

A shipping item in progress may be deleted by calling the deleteShippingItem () method.
Note: if the shipping item has been dispatched, it cannot be deleted.

  1. Get shipping item details

Q0q0zwIvDtWMgAAAABJRU5ErkJggg==
No Process Description

1

Create shipping item

See Table 1– Shipping item creation and management process diagram

2

Initiate shipping

See Table 1– Shipping item creation and management process diagram

3

Get shipping item details

The details (e.g. status) of both a shipping item in progress and a dispatched shipping item may be received by calling the getShippingItem method.
Note: certain shipping item details (e.g. barcode) may be obtained only for dispatched shipping items.

  1. Get details for a list of shipping items

wGwEWaISgHkaAAAAABJRU5ErkJggg==

No

Process

Description

1

Create shipping item

See Table 1– Shipping item creation and management process description

2

Initiate shipping

See Table 1– Shipping item creation and management process description

3

Get a list of shipping items and item details based on a filter

The details (e.g. status) of both the shipping items in progress and the dispatched shipping items may be received by calling the getShippingItems method. The following filters may be used to get a list of shipping items
limit, offset, createdAfter, createdBefore.

  1. Get shipping item documents

aBHlZnuN26AAAAAElFTkSuQmCC

No

Process

Description

1

Create shipping item

See Table 1– Shipping item creation and management process description

2

Initiate shipping

See Table 1– Shipping item creation and management process description

3

Get cart numbers

When a shipping item or a list of shipping items is/are created, initiate shipping. The call of the initiateShipping method and specification of the shipping item identifiers is followed by a confirmation of the shipping item dispatch order. The call of the initiateShipping method returns the identifiers of created carts.

4

Get shipping item document

When a shipping item is created, the required documents may be obtained, where necessary, using one of the available methods: getDocumentCN23Report.
Note: Documents are generated only for the successfully dispatched shipping items.

  1. Get courier manifest

zKx51OQ+UU0AAAAASUVORK5CYII=

No

Process

Description

1

Create shipping item

See Table 1– Shipping item creation and management process description

2

Initiate shipping

See Table 1– Shipping item creation and management process description

3

Get cart numbers

When a shipping item or a list of shipping items is/are created, initiate shipping. The call of the initiateShipping method and specification of the shipping item identifiers is followed by a confirmation of the shipping item dispatch order. The call of the initiateShipping method returns the identifiers of created carts.

4

Get courier manifests

The use of the getManifest method returns a courier manifest for the shipping item cart.
Note: A manifest may only be obtained for initiated and dispatched shipping items. A shipping item manifest is automatically generated for every shipping item unless your contract provides for a possibility to call a courier.

  1. Call a courier

6hXt0dE6QgkCRdD5k0GrhLJSUlETOQF+MvZJZCBWKXHdIAAAAASUVORK5CYII=

No

Process

Description

1

Create shipping item

See Table 1– Shipping item creation and management process description

2

Initiate shipping

See Table 1– Shipping item creation and management process description

3

Call a courier

Initiates the call of a courier. (See 2.28 callCourier (POST) method)

DOCUMENTATION FOR OPEN APPLICATION PROGRAMMING INTERFACE OF THE LITHUANIAN POST

1. Overview

1.1. Version information

Version : 2.0.1

1.2. URI scheme

BasePath : /
Schemes : HTTP, HTTPS

1.3. Tags

  • Address operations

  • Address validation operations.

  • Documents operations

  • Shipping operations

  • Tracking operations

  • User operations

2. Resources

2.1. Address Operations

2.1.1. findCountries

GET /api/v1/address/country
Description

To find a list of available countries.

Parameters
Type Name Description Schema Default

Query

keyword
optional

Keyword for the countries to be returned, which is a search criterion for the countries.

string

Query

page
optional

A parameter used for paging the countries to be returned, which determines the number of countries to be skipped in the list of selected countries before a list of countries is returned.

integer (int32)

0

Query

size
optional

A limitation to the number of countries to be returned, which determines the maximum number of countries to be generated on the list.

integer (int32)

Responses
HTTP Code Description Schema

200

The method returns a list of countries or an empty array if the country is not found based on the given parameters.

< CountryResponse > array

Produces
  • application/json

Security
Type Name

Unknown

Unknown

Example HTTP request
Request path
/api/v1/address/country
Example HTTP response
Response 200
[ {
  "id" : 0,
  "country" : "string",
  "regions" : [ {
    "countryId" : 0,
    "bpCode" : "string",
    "lpCode" : "string",
    "id" : 0,
    "name" : "string"
  } ],
  "code" : "string",
  "default" : true
} ]

2.1.2. getCountry

GET /api/v1/address/country/{countryId}
Description

To get a country.

Parameters
Type Name Description Schema

Path

countryId
required

The identifier of the country to be returned in the open application programming interface of the Lithuanian Post.

integer (int64)

Responses
HTTP Code Description Schema

200

Returns a country. If the country is not found, it returns an empty array.

Produces
  • application/json

Security
Type Name

Unknown

Unknown

Example HTTP request
Request path
/api/v1/address/country/0
Example HTTP response
Response 200
{
  "id" : 0,
  "country" : "string",
  "regions" : [ {
    "countryId" : 0,
    "bpCode" : "string",
    "lpCode" : "string",
    "id" : 0,
    "name" : "string"
  } ],
  "code" : "string",
  "default" : true
}

2.1.3. findLocalities

GET /api/v1/address/country/{countryId}/locality
Description

To find a list of available localities.

Parameters
Type Name Description Schema Default

Path

countryId
required

Country identifier in the open application programming interface of the Lithuanian Post.

integer (int64)

Query

keyword
required

Keyword for locality search.

string

Query

page
optional

A parameter used for paging the localities to be returned, which determines the number of localities to be skipped in the list of selected localities before a list of localities is returned.

integer (int32)

0

Query

postalCode
optional

Postal code for locality search.

string

Query

size
optional

A limitation to the number of localities to be returned, which determines the maximum number of localities present on the list.

integer (int32)

Responses
HTTP Code Description Schema

200

Locality search result. If the locality is not found, it returns an empty array.

< LocalityResponse > array

Produces
  • application/json

Security
Type Name

Unknown

Unknown

Example HTTP request
Request path
/api/v1/address/country/0/locality?keyword=string
Example HTTP response
Response 200
[ {
  "id" : 0,
  "municipality" : "string",
  "district" : "string",
  "locality" : "string",
  "country" : {
    "id" : 0,
    "country" : "string",
    "regions" : [ {
      "countryId" : 0,
      "bpCode" : "string",
      "lpCode" : "string",
      "id" : 0,
      "name" : "string"
    } ],
    "code" : "string",
    "default" : true
  }
} ]

2.1.4. getLocality

GET /api/v1/address/country/{countryId}/locality/{localityId}
Description

To get a locality.

Parameters
Type Name Description Schema

Path

countryId
required

Country identifier in the open application programming interface of the Lithuanian Post for locality search.

integer (int64)

Path

localityId
required

Locality identification number.

integer (int32)

Responses
HTTP Code Description Schema

200

Returned result of the locality search. This result may be empty if the system could not find a match.

Produces
  • application/json

Security
Type Name

Unknown

Unknown

Example HTTP request
Request path
/api/v1/address/country/0/locality/0
Example HTTP response
Response 200
{
  "id" : 0,
  "municipality" : "string",
  "district" : "string",
  "locality" : "string",
  "country" : {
    "id" : 0,
    "country" : "string",
    "regions" : [ {
      "countryId" : 0,
      "bpCode" : "string",
      "lpCode" : "string",
      "id" : 0,
      "name" : "string"
    } ],
    "code" : "string",
    "default" : true
  }
}

2.1.5. findLocalityPostalCodes

GET /api/v1/address/country/{countryId}/locality/{localityId}/postalcode
Description

To find locality postal codes.

Parameters
Type Name Description Schema Default

Path

countryId
required

Country identifier in the open application programming interface of the Lithuanian Post for postal code search.

integer (int64)

Path

localityId
required

Locality identification number in the open application programming interface of the Lithuanian Post.

integer (int32)

Query

page
optional

A parameter used for paging the postal codes to be returned, which determines the number of postal codes to be skipped in the list of selected postal codes before a list of postal codes is returned.

integer (int32)

0

Query

postalCode
optional

Postal code keyword used, in full or in part, for locality search.

string

Query

size
optional

A limitation to the number of postal codes to be returned, which determines the maximum number of postal codes to be generated on the list.

integer (int32)

Query

street
optional

Keyword for street search.

string

Responses
HTTP Code Description Schema

200

Result of postal code search. This result may not be returned, if the request could not find matches on the system.

< PostalCodeResponse > array

Produces
  • application/json

Security
Type Name

Unknown

Unknown

Example HTTP request
Request path
/api/v1/address/country/0/locality/0/postalcode
Example HTTP response
Response 200
[ {
  "id" : 0,
  "postalCode" : "string",
  "country" : {
    "id" : 0,
    "country" : "string",
    "regions" : [ {
      "countryId" : 0,
      "bpCode" : "string",
      "lpCode" : "string",
      "id" : 0,
      "name" : "string"
    } ],
    "code" : "string",
    "default" : true
  }
} ]

2.1.6. findStreets

GET /api/v1/address/country/{countryId}/locality/{localityId}/street
Description

To find a list of available streets.

Parameters
Type Name Description Schema Default

Path

countryId
required

Country identifier in the open application programming interface of the Lithuanian Post for searching the streets of the locality.

integer (int64)

Path

localityId
required

Locality identification number in the open application programming interface of the Lithuanian Post.

integer (int32)

Query

keyword
optional

Keyword for street search.

string

Query

page
optional

A parameter used for paging the streets to be returned, which determines the number of streets to be skipped in the list of selected streets before a list of streets is returned.

integer (int32)

0

Query

postalCode
optional

Postal code keyword used, in full or in part, for street search.

string

Query

size
optional

A limitation to the number of streets to be returned, which determines the maximum number of streets to be generated on the list.

integer (int32)

Responses
HTTP Code Description Schema

200

Street search result. This result may be empty if the system could not find any matches for the request.

< StreetResponse > array

Produces
  • application/json

Security
Type Name

Unknown

Unknown

Example HTTP request
Request path
/api/v1/address/country/0/locality/0/street
Example HTTP response
Response 200
[ {
  "id" : 0,
  "street" : "string",
  "locality" : {
    "id" : 0,
    "municipality" : "string",
    "district" : "string",
    "locality" : "string",
    "country" : {
      "id" : 0,
      "country" : "string",
      "regions" : [ {
        "countryId" : 0,
        "bpCode" : "string",
        "lpCode" : "string",
        "id" : 0,
        "name" : "string"
      } ],
      "code" : "string",
      "default" : true
    }
  }
} ]

2.1.7. getStreet

GET /api/v1/address/country/{countryId}/locality/{localityId}/street/{streetId}
Description

To get a street.

Parameters
Type Name Description Schema

Path

countryId
required

Searched street identifier in the open application programming interface of the Lithuanian Post.

integer (int64)

Path

localityId
required

Locality identification number in the open application programming interface of the Lithuanian Post.

integer (int32)

Path

streetId
required

Identified of the street to be returned in the open application programming interface of the Lithuanian Post.

integer (int32)

Responses
HTTP Code Description Schema

200

Search result of the returned street. This result may be empty if the system could not find any matches for the request.

Produces
  • application/json

Security
Type Name

Unknown

Unknown

Example HTTP request
Request path
/api/v1/address/country/0/locality/0/street/0
Example HTTP response
Response 200
{
  "id" : 0,
  "street" : "string",
  "locality" : {
    "id" : 0,
    "municipality" : "string",
    "district" : "string",
    "locality" : "string",
    "country" : {
      "id" : 0,
      "country" : "string",
      "regions" : [ {
        "countryId" : 0,
        "bpCode" : "string",
        "lpCode" : "string",
        "id" : 0,
        "name" : "string"
      } ],
      "code" : "string",
      "default" : true
    }
  }
}

2.1.8. findBuildings

GET /api/v1/address/country/{countryId}/locality/{localityId}/street/{streetId}/building
Description

To find buildings.

Parameters
Type Name Description Schema Default

Path

countryId
required

Country identifier in the open application programming interface of the Lithuanian Post.

integer (int64)

Path

localityId
required

Locality identification number in the open application programming interface of the Lithuanian Post.

integer (int32)

Path

streetId
required

Street identifier in the open application programming interface of the Lithuanian Post.

integer (int32)

Query

keyword
optional

Keyword for building search.

string

Query

page
optional

A parameter used for paging the buildings to be returned, which determines the number of buildings to be skipped in the list of selected buildings before a list of buildings is returned.

integer (int32)

0

Query

postalCode
optional

Postal code for building search.

string

Query

size
optional

A limitation to the number of buildings to be returned, which determines the maximum number of buildings to be generated on the list.

integer (int32)

Responses
HTTP Code Description Schema

200

Building search result. This result may be empty if the system could not find any matches for the request.

< BuildingResponse > array

Produces
  • application/json

Security
Type Name

Unknown

Unknown

Example HTTP request
Request path
/api/v1/address/country/0/locality/0/street/0/building
Example HTTP response
Response 200
[ {
  "id" : 0,
  "building" : "string",
  "postalCode" : "string",
  "street" : {
    "id" : 0,
    "street" : "string",
    "locality" : {
      "id" : 0,
      "municipality" : "string",
      "district" : "string",
      "locality" : "string",
      "country" : {
        "id" : 0,
        "country" : "string",
        "regions" : [ {
          "countryId" : 0,
          "bpCode" : "string",
          "lpCode" : "string",
          "id" : 0,
          "name" : "string"
        } ],
        "code" : "string",
        "default" : true
      }
    }
  }
} ]

2.1.9. getBuilding

GET /api/v1/address/country/{countryId}/locality/{localityId}/street/{streetId}/building/{buildingId}
Description

To get a building.

Parameters
Type Name Description Schema

Path

buildingId
required

Building identifier in the open application programming interface of the Lithuanian Post.

integer (int32)

Path

countryId
required

Country identifier in the open application programming interface of the Lithuanian Post.

integer (int64)

Path

localityId
required

Locality identification number in the open application programming interface of the Lithuanian Post.

integer (int32)

Path

streetId
required

Street identifier in the open application programming interface of the Lithuanian Post.

integer (int32)

Responses
HTTP Code Description Schema

200

Search result for a returned building. This result may be empty if the system could not find any matches for the request.

Produces
  • application/json

Security
Type Name

Unknown

Unknown

Example HTTP request
Request path
/api/v1/address/country/0/locality/0/street/0/building/0
Example HTTP response
Response 200
{
  "id" : 0,
  "building" : "string",
  "postalCode" : "string",
  "street" : {
    "id" : 0,
    "street" : "string",
    "locality" : {
      "id" : 0,
      "municipality" : "string",
      "district" : "string",
      "locality" : "string",
      "country" : {
        "id" : 0,
        "country" : "string",
        "regions" : [ {
          "countryId" : 0,
          "bpCode" : "string",
          "lpCode" : "string",
          "id" : 0,
          "name" : "string"
        } ],
        "code" : "string",
        "default" : true
      }
    }
  }
}

2.1.10. findStreetPostalCodes

GET /api/v1/address/country/{countryId}/locality/{localityId}/street/{streetId}/postalcode
Description

To find street postal codes.

Parameters
Type Name Description Schema Default

Path

countryId
required

Country identifier in the open application programming interface of the Lithuanian Post.

integer (int64)

Path

localityId
required

Locality identification number in the open application programming interface of the Lithuanian Post.

integer (int32)

Path

streetId
required

Street identifier in the open application programming interface of the Lithuanian Post.

integer (int32)

Query

keyword
optional

Search keyword.

string

Query

page
optional

A parameter used for paging the postal codes to be returned, which determines the number of postal codes to be skipped in the list of selected postal codes before a list of postal codes is returned.

integer (int32)

0

Query

postalCode
optional

Postal code for locality search.

string

Query

size
optional

A limitation to the number of postal codes to be returned, which determines the maximum number of postal codes to be generated on the list.

integer (int32)

Responses
HTTP Code Description Schema

200

Result of postal code search. This result may be empty if the system could not find any matches for the request.

< PostalCodeResponse > array

Produces
  • application/json

Security
Type Name

Unknown

Unknown

Example HTTP request
Request path
/api/v1/address/country/0/locality/0/street/0/postalcode
Example HTTP response
Response 200
[ {
  "id" : 0,
  "postalCode" : "string",
  "country" : {
    "id" : 0,
    "country" : "string",
    "regions" : [ {
      "countryId" : 0,
      "bpCode" : "string",
      "lpCode" : "string",
      "id" : 0,
      "name" : "string"
    } ],
    "code" : "string",
    "default" : true
  }
} ]

2.1.11. findCountryPostalCodes

GET /api/v1/address/country/{countryId}/postalcode
Description

To find country’s postal codes.

Parameters
Type Name Description Schema Default

Path

countryId
required

Country identifier in the open application programming interface of the Lithuanian Post.

integer (int64)

Query

keyword
optional

Search keyword.

string

Query

page
optional

A parameter used for paging the postal codes to be returned, which determines the number of postal codes to be skipped in the list of selected shipping items before a list of postal codes is returned.

integer (int32)

0

Query

size
optional

A limitation to the number of postal codes to be returned, which determines the maximum number of postal codes to be generated on the list.

integer (int32)

Responses
HTTP Code Description Schema

200

Result of postal code search. This result may be empty if the system could not find any matches for the request.

< PostalCodeResponse > array

Produces
  • application/json

Security
Type Name

Unknown

Unknown

Example HTTP request
Request path
/api/v1/address/country/0/postalcode
Example HTTP response
Response 200
[ {
  "id" : 0,
  "postalCode" : "string",
  "country" : {
    "id" : 0,
    "country" : "string",
    "regions" : [ {
      "countryId" : 0,
      "bpCode" : "string",
      "lpCode" : "string",
      "id" : 0,
      "name" : "string"
    } ],
    "code" : "string",
    "default" : true
  }
} ]

2.1.12. getCountryPostalCodePostOffice

GET /api/v1/address/country/{countryId}/postalcode/{postalCode}/postoffice
Description

To get country’s post offices.

Parameters
Type Name Description Schema

Path

countryId
required

Country identifier in the open application programming interface of the Lithuanian Post.

integer (int64)

Path

postalCode
required

Postal code in the open application programming interface of the Lithuanian Post for the post office to be returned.

string

Responses
HTTP Code Description Schema

200

Result of post office search. This result may be empty if the system could not find any matches for the request.

Produces
  • application/json

Security
Type Name

Unknown

Unknown

Example HTTP request
Request path
/api/v1/address/country/0/postalcode/string/postoffice
Example HTTP response
Response 200
{
  "id" : 0,
  "name" : "string",
  "postalCode" : "string",
  "locality" : {
    "id" : 0,
    "municipality" : "string",
    "district" : "string",
    "locality" : "string",
    "country" : {
      "id" : 0,
      "country" : "string",
      "regions" : [ {
        "countryId" : 0,
        "bpCode" : "string",
        "lpCode" : "string",
        "id" : 0,
        "name" : "string"
      } ],
      "code" : "string",
      "default" : true
    }
  }
}

2.1.13. findPostBoxes

GET /api/v1/address/country/{countryId}/postbox
Description

To find a list of PO boxes.

Parameters
Type Name Description Schema Default

Path

countryId
required

Country identifier in the open application programming interface of the Lithuanian Post.

integer (int64)

Query

keyword
optional

Search keyword.

string

Query

page
optional

A parameter used for paging the post boxes to be returned, which determines the number of post boxes to be skipped in the list of selected post boxes before a list of post boxes is returned.

integer (int32)

0

Query

size
optional

A limitation to the number of post boxes to be returned, which determines the maximum number of post boxes to be generated on the list.

integer (int32)

Responses
HTTP Code Description Schema

200

Result of post box search. This result may be empty if the system could not find any matches for the request.

< PostBoxResponse > array

Produces
  • application/json

Security
Type Name

Unknown

Unknown

Example HTTP request
Request path
/api/v1/address/country/0/postbox
Example HTTP response
Response 200
[ {
  "postOffice" : {
    "id" : 0,
    "name" : "string",
    "postalCode" : "string",
    "locality" : {
      "id" : 0,
      "municipality" : "string",
      "district" : "string",
      "locality" : "string",
      "country" : {
        "id" : 0,
        "country" : "string",
        "regions" : [ {
          "countryId" : 0,
          "bpCode" : "string",
          "lpCode" : "string",
          "id" : 0,
          "name" : "string"
        } ],
        "code" : "string",
        "default" : true
      }
    }
  },
  "boxes" : [ {
    "fromNumber" : 0,
    "toNumber" : 0
  } ]
} ]

2.1.14. findPostOffices

GET /api/v1/address/country/{countryId}/postoffice
Description

To find a list of post offices.

Parameters
Type Name Description Schema Default

Path

countryId
required

Country identifier in the open application programming interface of the Lithuanian Post.

integer (int64)

Query

keyword
optional

Search keyword.

string

Query

page
optional

A parameter used for paging the post offices to be returned, which determines the number of post offices to be skipped in the list of selected post offices before a list of post offices is returned.

integer (int32)

0

Query

size
optional

A limitation to the number of post offices to be returned, which determines the maximum number of post offices to be generated on the list.

integer (int32)

Responses
HTTP Code Description Schema

200

Result of post office search. This result may be empty if the system could not find any matches for the request.

< PostOfficeResponse > array

Produces
  • application/json

Security
Type Name

Unknown

Unknown

Example HTTP request
Request path
/api/v1/address/country/0/postoffice
Example HTTP response
Response 200
[ {
  "id" : 0,
  "name" : "string",
  "postalCode" : "string",
  "locality" : {
    "id" : 0,
    "municipality" : "string",
    "district" : "string",
    "locality" : "string",
    "country" : {
      "id" : 0,
      "country" : "string",
      "regions" : [ {
        "countryId" : 0,
        "bpCode" : "string",
        "lpCode" : "string",
        "id" : 0,
        "name" : "string"
      } ],
      "code" : "string",
      "default" : true
    }
  }
} ]

2.1.15. findPostOfficePostBoxes

GET /api/v1/address/country/{countryId}/postoffice/{postOfficeId}/postbox
Description

To find post office’s PO boxes.

Parameters
Type Name Description Schema

Path

countryId
required

Country identifier in the open application programming interface of the Lithuanian Post.

integer (int64)

Path

postOfficeId
required

Locality identification number.

integer (int32)

Query

keyword
required

Search keyword.

string

Responses
HTTP Code Description Schema

200

successful operation

Produces
  • application/json

Security
Type Name

Unknown

Unknown

Example HTTP request
Request path
/api/v1/address/country/0/postoffice/0/postbox?keyword=string
Example HTTP response
Response 200
{
  "postOffice" : {
    "id" : 0,
    "name" : "string",
    "postalCode" : "string",
    "locality" : {
      "id" : 0,
      "municipality" : "string",
      "district" : "string",
      "locality" : "string",
      "country" : {
        "id" : 0,
        "country" : "string",
        "regions" : [ {
          "countryId" : 0,
          "bpCode" : "string",
          "lpCode" : "string",
          "id" : 0,
          "name" : "string"
        } ],
        "code" : "string",
        "default" : true
      }
    }
  },
  "boxes" : [ {
    "fromNumber" : 0,
    "toNumber" : 0
  } ]
}

2.1.16. getDefaultValues

GET /api/v1/address/default
Description

To get a default country.

Responses
HTTP Code Description Schema

200

Returns the default country value in the open application programming interface of the Lithuanian Post.

Produces
  • application/json

Security
Type Name

Unknown

Unknown

Example HTTP request
Request path
/api/v1/address/default
Example HTTP response
Response 200
{
  "country" : {
    "id" : 0,
    "country" : "string",
    "regions" : [ {
      "countryId" : 0,
      "bpCode" : "string",
      "lpCode" : "string",
      "id" : 0,
      "name" : "string"
    } ],
    "code" : "string",
    "default" : true
  }
}

2.1.17. findTerminals

GET /api/v1/address/terminals
Description

To find a list of available terminals.

Parameters
Type Name Description Schema Default

Query

countryCode
required

string

Query

page
optional

A parameter used for paging the terminals to be returned, which determines the number of terminals to be skipped in the list of selected terminals before a list of terminals is returned.

integer (int32)

0

Query

size
required

A limitation to the number of terminals to be returned, which determines the maximum number of terminals to be generated on the list.

integer (int32)

Query

templateId
required

Template identifier, which requires a list of terminals.

string

Responses
HTTP Code Description Schema

200

successful operation

< Terminal > array

Produces
  • application/json

Security
Type Name

Unknown

Unknown

Example HTTP request
Request path
/api/v1/address/terminals?countryCode=string&size=0&templateId=string
Example HTTP response
Response 200
[ {
  "id" : "string",
  "name" : "string",
  "city" : "string",
  "address" : "string",
  "postalCode" : "string",
  "boxes" : [ "string" ],
  "latitude" : "string",
  "longitude" : "string",
  "workingHours" : "string",
  "servicingHours" : "string",
  "comment" : "string"
} ]

2.2. Address Validation Operations.

2.2.1. verify

POST /api/v1/address/verification
Parameters
Type Name Schema

Body

body
optional

Responses
HTTP Code Description Schema

200

successful operation

Produces
  • application/json

Security
Type Name

Unknown

Unknown

Example HTTP request
Request path
/api/v1/address/verification
Request body
{
  "countryId" : 0,
  "municipality" : "string",
  "district" : "string",
  "locality" : "string",
  "street" : "string",
  "building" : "string",
  "flat" : "string",
  "postalCode" : "string"
}
Example HTTP response
Response 200
{
  "countryId" : 0,
  "municipality" : "string",
  "district" : "string",
  "locality" : "string",
  "street" : "string",
  "building" : "string",
  "flat" : "string",
  "postalCode" : "string"
}

2.3. Documents Operations

2.3.1. getDocumentCn23Report

GET /api/v1/documents/cart/{cartId}/cn23
Description

To get a CN23 document for a cart.

Parameters
Type Name Description Schema

Path

cartId
required

Shipping item cart identifier.

integer (int64)

Responses
HTTP Code Description Schema

200

Document generated from a CN 23 template.

Produces
  • application/json

Security
Type Name

Unknown

Unknown

Example HTTP request
Request path
/api/v1/documents/cart/0/cn23
Example HTTP response
Response 200
{
  "document" : [ "string" ],
  "contentType" : "string",
  "cartId" : 0
}

2.3.2. getManifest

GET /api/v1/documents/cart/{cartId}/manifest
Description

To get a manifest for a completed cart.

Parameters
Type Name Description Schema

Path

cartId
required

Shipping item cart identifier.

integer (int64)

Responses
HTTP Code Description Schema

200

Document of the shipping item courier manifest.

Produces
  • application/json

Security
Type Name

Unknown

Unknown

Example HTTP request
Request path
/api/v1/documents/cart/0/manifest
Example HTTP response
Response 200
{
  "document" : [ "string" ],
  "contentType" : "string",
  "cartId" : 0
}

2.3.3. getOrderStickersAndManifest

GET /api/v1/documents/cart/{cartId}/stickers
Description

To get stickers and manifest for initiated shipping items in a cart.

Parameters
Type Name Description Schema

Path

cartId
required

Shipping item cart identifier.

integer (int64)

Query

layout
required

The format of shipping item sticker layout across the page.

enum (LAYOUT_MAX, LAYOUT_A4, LAYOUT_10x15)

Query

rotation
optional

0-360 degrees rotation may be applied for the sticker

integer (int32)

Responses
HTTP Code Description Schema

200

successful operation

Produces
  • application/json

Security
Type Name

Unknown

Unknown

Example HTTP request
Request path
/api/v1/documents/cart/0/stickers?layout=string
Example HTTP response
Response 200
{
  "stickers" : {
    "document" : [ "string" ],
    "contentType" : "string"
  },
  "manifest" : {
    "document" : [ "string" ],
    "contentType" : "string"
  },
  "cartId" : 0
}

2.3.4. getSPDSticker

GET /api/v1/documents/item/spd
Caution

operation.deprecated

Description

To get SPD stickers for initiated shipping items.

Parameters
Type Name Schema

Query

itemId
required

< integer (int64) > array(multi)

Responses
HTTP Code Description Schema

200

successful operation

Produces
  • application/json

Security
Type Name

Unknown

Unknown

Example HTTP request
Request path
/api/v1/documents/item/spd?itemId=0
Example HTTP response
Response 200
[ {
  "itemId" : "11100",
  "label" : [ "string" ],
  "contentType" : "string"
} ]

2.3.5. getStickers

GET /api/v1/documents/item/sticker
Description

To get stickers for initiated shipping items.

Parameters
Type Name Description Schema

Query

itemId
required

Unique identifier of a shipping item.

< integer (int64) > array(multi)

Query

layout
required

The format of shipping item sticker layout across the page.

enum (LAYOUT_MAX, LAYOUT_A4, LAYOUT_10x15)

Query

rotation
optional

0-360 degrees rotation may be applied for the sticker

integer (int32)

Responses
HTTP Code Description Schema

200

successful operation

Produces
  • application/json

Security
Type Name

Unknown

Unknown

Example HTTP request
Request path
/api/v1/documents/item/sticker?itemId=0&layout=string
Example HTTP response
Response 200
[ {
  "itemId" : "11100",
  "label" : [ "string" ],
  "contentType" : "string"
} ]

2.3.6. Get sticker

GET /api/v1/documents/item/sticker/
Caution

operation.deprecated

Description

To get stickers for initiated shipping items.

Parameters
Type Name Description Schema

Query

itemId
required

Unique identifier of a shipping item.

< integer (int64) > array(multi)

Query

layout
required

The format of shipping item sticker layout across the page.

enum (LAYOUT_MAX, LAYOUT_A4, LAYOUT_10x15)

Query

rotation
optional

0-360 degrees rotation may be applied for the sticker

integer (int32)

Responses
HTTP Code Description Schema

200

Shipping item sticker documents where the stickers have been generated in the open application programming interface of the Lithuanian Post.

Produces
  • application/json

Security
Type Name

Unknown

Unknown

Example HTTP request
Request path
/api/v1/documents/item/sticker/?itemId=0&layout=string
Example HTTP response
Response 200
[ {
  "itemId" : "11100",
  "label" : [ "string" ],
  "contentType" : "string"
} ]

2.3.7. getManifestByBarcode

GET /api/v1/documents/item/{barcode}/manifest
Description

To get a manifest/manifests for completed shipping item/items based on barcode.

Parameters
Type Name Description Schema

Path

barcode
required

Shipping item barcode identifier.

string

Responses
HTTP Code Description Schema

200

Document of the shipping item courier manifest.

Produces
  • application/json

Security
Type Name

Unknown

Unknown

Example HTTP request
Request path
/api/v1/documents/item/string/manifest
Example HTTP response
Response 200
{
  "document" : [ "string" ],
  "contentType" : "string",
  "barcode" : "string"
}

2.4. Shipping Operations

2.4.1. createShippingItem

POST /api/v1/shipping
Description

Creates single shipping item.

Parameters
Type Name Schema

Body

body
optional

Responses
HTTP Code Description Schema

200

Shipping item data structure

400

Bad request provided

No Content

Produces
  • application/json

Security
Type Name

Unknown

Unknown

Example HTTP request
Request path
/api/v1/shipping
Request body
{
  "externalId" : "string",
  "template" : "string",
  "weight" : 0.0,
  "partCount" : 0,
  "documents" : {
    "cn22Form" : {
      "parcelType" : "string",
      "parcelTypeNotes" : "string",
      "description" : "string",
      "cnParts" : [ {
        "summary" : "string",
        "weight" : 0,
        "quantity" : 0,
        "hsCode" : 0,
        "amount" : 0.0,
        "currencyCode" : "string",
        "countryCode" : "string",
        "sortOrder" : 0
      } ]
    },
    "cn23Form" : {
      "parcelType" : "GIFT",
      "parcelTypeNotes" : "string",
      "license" : "string",
      "certificate" : "string",
      "invoice" : "string",
      "notes" : "string",
      "description" : "string",
      "importerCode" : "string",
      "importerPhone" : "string",
      "importerFax" : "string",
      "importerEmail" : "string",
      "importerTaxCode" : "string",
      "importerVatCode" : "string",
      "importerCustomsCode" : "string",
      "exporterCustomsCode" : "string",
      "failureInstruction" : "string",
      "cnParts" : [ {
        "summary" : "string",
        "weight" : 0,
        "quantity" : 0,
        "hsCode" : 0,
        "amount" : 0.0,
        "currencyCode" : "string",
        "countryCode" : "string",
        "sortOrder" : 0
      } ]
    }
  },
  "sender" : {
    "id" : "string",
    "terminalId" : "string",
    "postOfficeAddress" : {
      "postOfficeId" : "string",
      "postOfficeBoxAddress" : {
        "postOfficeBoxId" : "string"
      }
    },
    "name" : "string",
    "companyName" : "string",
    "address" : {
      "country" : "string",
      "availableCountries" : [ {
        "id" : "string",
        "name" : "string",
        "code" : "string"
      } ],
      "postalCode" : "19200",
      "regionId" : 0,
      "locality" : "Vilnius",
      "street" : "J. Jasinskio",
      "building" : "16",
      "apartment" : "string",
      "address1" : "string",
      "address2" : "string"
    },
    "email" : "string",
    "comment" : "string",
    "phone" : "string"
  },
  "receiver" : {
    "id" : "string",
    "terminalId" : "string",
    "postOfficeAddress" : {
      "postOfficeId" : "string",
      "postOfficeBoxAddress" : {
        "postOfficeBoxId" : "string"
      }
    },
    "name" : "string",
    "companyName" : "string",
    "address" : {
      "country" : "string",
      "availableCountries" : [ {
        "id" : "string",
        "name" : "string",
        "code" : "string"
      } ],
      "postalCode" : "19200",
      "regionId" : 0,
      "locality" : "Vilnius",
      "street" : "J. Jasinskio",
      "building" : "16",
      "apartment" : "string",
      "address1" : "string",
      "address2" : "string"
    },
    "email" : "string",
    "comment" : "string",
    "phone" : "string"
  },
  "pickup" : {
    "id" : "string",
    "terminalId" : "string",
    "postOfficeAddress" : {
      "postOfficeId" : "string",
      "postOfficeBoxAddress" : {
        "postOfficeBoxId" : "string"
      }
    },
    "name" : "string",
    "companyName" : "string",
    "address" : {
      "country" : "string",
      "availableCountries" : [ {
        "id" : "string",
        "name" : "string",
        "code" : "string"
      } ],
      "postalCode" : "19200",
      "regionId" : 0,
      "locality" : "Vilnius",
      "street" : "J. Jasinskio",
      "building" : "16",
      "apartment" : "string",
      "address1" : "string",
      "address2" : "string"
    },
    "email" : "string",
    "comment" : "string",
    "phone" : "string"
  },
  "sendingDocuments" : true,
  "additionalServices" : [ {
    "id" : 1,
    "note" : "This is an example additional service note",
    "variant" : "1",
    "amount" : 2.0
  } ]
}
Example HTTP response
Response 200
{
  "externalId" : "string",
  "template" : "string",
  "weight" : 0.0,
  "partCount" : 0,
  "documents" : {
    "cn22Form" : {
      "parcelType" : "string",
      "parcelTypeNotes" : "string",
      "description" : "string",
      "cnParts" : [ {
        "summary" : "string",
        "weight" : 0,
        "quantity" : 0,
        "hsCode" : 0,
        "amount" : 0.0,
        "currencyCode" : "string",
        "countryCode" : "string",
        "sortOrder" : 0
      } ]
    },
    "cn23Form" : {
      "parcelType" : "GIFT",
      "parcelTypeNotes" : "string",
      "license" : "string",
      "certificate" : "string",
      "invoice" : "string",
      "notes" : "string",
      "description" : "string",
      "importerCode" : "string",
      "importerPhone" : "string",
      "importerFax" : "string",
      "importerEmail" : "string",
      "importerTaxCode" : "string",
      "importerVatCode" : "string",
      "importerCustomsCode" : "string",
      "exporterCustomsCode" : "string",
      "failureInstruction" : "string",
      "cnParts" : [ {
        "summary" : "string",
        "weight" : 0,
        "quantity" : 0,
        "hsCode" : 0,
        "amount" : 0.0,
        "currencyCode" : "string",
        "countryCode" : "string",
        "sortOrder" : 0
      } ]
    }
  },
  "sender" : {
    "id" : "string",
    "terminalId" : "string",
    "postOfficeAddress" : {
      "postOfficeId" : "string",
      "postOfficeBoxAddress" : {
        "postOfficeBoxId" : "string"
      }
    },
    "name" : "string",
    "companyName" : "string",
    "address" : {
      "country" : "string",
      "availableCountries" : [ {
        "id" : "string",
        "name" : "string",
        "code" : "string"
      } ],
      "postalCode" : "19200",
      "regionId" : 0,
      "locality" : "Vilnius",
      "street" : "J. Jasinskio",
      "building" : "16",
      "apartment" : "string",
      "address1" : "string",
      "address2" : "string"
    },
    "email" : "string",
    "comment" : "string",
    "phone" : "string"
  },
  "receiver" : {
    "id" : "string",
    "terminalId" : "string",
    "postOfficeAddress" : {
      "postOfficeId" : "string",
      "postOfficeBoxAddress" : {
        "postOfficeBoxId" : "string"
      }
    },
    "name" : "string",
    "companyName" : "string",
    "address" : {
      "country" : "string",
      "availableCountries" : [ {
        "id" : "string",
        "name" : "string",
        "code" : "string"
      } ],
      "postalCode" : "19200",
      "regionId" : 0,
      "locality" : "Vilnius",
      "street" : "J. Jasinskio",
      "building" : "16",
      "apartment" : "string",
      "address1" : "string",
      "address2" : "string"
    },
    "email" : "string",
    "comment" : "string",
    "phone" : "string"
  },
  "pickup" : {
    "id" : "string",
    "terminalId" : "string",
    "postOfficeAddress" : {
      "postOfficeId" : "string",
      "postOfficeBoxAddress" : {
        "postOfficeBoxId" : "string"
      }
    },
    "name" : "string",
    "companyName" : "string",
    "address" : {
      "country" : "string",
      "availableCountries" : [ {
        "id" : "string",
        "name" : "string",
        "code" : "string"
      } ],
      "postalCode" : "19200",
      "regionId" : 0,
      "locality" : "Vilnius",
      "street" : "J. Jasinskio",
      "building" : "16",
      "apartment" : "string",
      "address1" : "string",
      "address2" : "string"
    },
    "email" : "string",
    "comment" : "string",
    "phone" : "string"
  },
  "sendingDocuments" : true,
  "additionalServices" : [ {
    "id" : 1,
    "note" : "This is an example additional service note",
    "variant" : "1",
    "amount" : 2.0
  } ],
  "id" : "string",
  "createdOn" : "string",
  "barcode" : "CC800058625LT",
  "price" : {
    "amount" : 0.0,
    "vat" : 0.0,
    "currency" : "string"
  },
  "dateSent" : "string",
  "status" : "string",
  "partsBarcode" : [ "string" ],
  "type" : "string",
  "size" : "string",
  "title" : "string",
  "cartId" : "string",
  "summary" : "string",
  "description" : "string",
  "addressResolverInfo" : [ {
    "addressType" : "string",
    "resolved" : true
  } ]
}

2.4.2. callCourier

POST /api/v1/shipping/courier/call
Description

To call a courier for individual shipping items.

Parameters
Type Name Description Schema

Body

body
required

Unique identifier of the shipping item.

< string > array

Responses
HTTP Code Description Schema

200

successful operation

403

Resource cannot be accessed with provided credentials

No Content

Produces
  • application/json

Security
Type Name

Unknown

Unknown

Example HTTP request
Request path
/api/v1/shipping/courier/call
Request body
[ "string" ]
Example HTTP response
Response 200
[ {
  "barcode" : "RS102001338LT",
  "manifestId" : "string"
} ]

2.4.3. getShippingItems

GET /api/v1/shipping/filter
Description

To get details of dispatched shipping items.

Parameters
Type Name Description Schema

Query

count
required

A limitation to the number of shipping items to be returned, which determines the maximum number of shipping items to be generated on the list.

integer (int64)

Query

createdAfter
required

A limitation to the creation time of the shipping items to be returned, which instructs the selection of shipping items created after a specific time period. The parameter must have a time stamp entered in seconds in Unix format (https://www.unixtimestamp.com/).

integer (int64)

Query

createdBefore
required

A limitation to the creation time of the shipping items to be returned, which instructs the selection of shipping items created before a specific time period. The parameter must have a time stamp entered in seconds in Unix format (https://www.unixtimestamp.com/).

integer (int64)

Query

offset
required

A parameter used for paging the shipping items to be returned, which determines the number of shipping items to be skipped in the list of selected shipping items before a list of shipping items is returned.

integer (int64)

Responses
HTTP Code Description Schema

200

A list of selected shipping items

Produces
  • application/json

Security
Type Name

Unknown

Unknown

Example HTTP request
Request path
/api/v1/shipping/filter?count=0&createdAfter=0&createdBefore=0&offset=0
Example HTTP response
Response 200
[ {
  "externalId" : "string",
  "template" : "string",
  "weight" : 0.0,
  "partCount" : 0,
  "documents" : {
    "cn22Form" : {
      "parcelType" : "string",
      "parcelTypeNotes" : "string",
      "description" : "string",
      "cnParts" : [ {
        "summary" : "string",
        "weight" : 0,
        "quantity" : 0,
        "hsCode" : 0,
        "amount" : 0.0,
        "currencyCode" : "string",
        "countryCode" : "string",
        "sortOrder" : 0
      } ]
    },
    "cn23Form" : {
      "parcelType" : "GIFT",
      "parcelTypeNotes" : "string",
      "license" : "string",
      "certificate" : "string",
      "invoice" : "string",
      "notes" : "string",
      "description" : "string",
      "importerCode" : "string",
      "importerPhone" : "string",
      "importerFax" : "string",
      "importerEmail" : "string",
      "importerTaxCode" : "string",
      "importerVatCode" : "string",
      "importerCustomsCode" : "string",
      "exporterCustomsCode" : "string",
      "failureInstruction" : "string",
      "cnParts" : [ {
        "summary" : "string",
        "weight" : 0,
        "quantity" : 0,
        "hsCode" : 0,
        "amount" : 0.0,
        "currencyCode" : "string",
        "countryCode" : "string",
        "sortOrder" : 0
      } ]
    }
  },
  "sender" : {
    "id" : "string",
    "terminalId" : "string",
    "postOfficeAddress" : {
      "postOfficeId" : "string",
      "postOfficeBoxAddress" : {
        "postOfficeBoxId" : "string"
      }
    },
    "name" : "string",
    "companyName" : "string",
    "address" : {
      "country" : "string",
      "availableCountries" : [ {
        "id" : "string",
        "name" : "string",
        "code" : "string"
      } ],
      "postalCode" : "19200",
      "regionId" : 0,
      "locality" : "Vilnius",
      "street" : "J. Jasinskio",
      "building" : "16",
      "apartment" : "string",
      "address1" : "string",
      "address2" : "string"
    },
    "email" : "string",
    "comment" : "string",
    "phone" : "string"
  },
  "receiver" : {
    "id" : "string",
    "terminalId" : "string",
    "postOfficeAddress" : {
      "postOfficeId" : "string",
      "postOfficeBoxAddress" : {
        "postOfficeBoxId" : "string"
      }
    },
    "name" : "string",
    "companyName" : "string",
    "address" : {
      "country" : "string",
      "availableCountries" : [ {
        "id" : "string",
        "name" : "string",
        "code" : "string"
      } ],
      "postalCode" : "19200",
      "regionId" : 0,
      "locality" : "Vilnius",
      "street" : "J. Jasinskio",
      "building" : "16",
      "apartment" : "string",
      "address1" : "string",
      "address2" : "string"
    },
    "email" : "string",
    "comment" : "string",
    "phone" : "string"
  },
  "pickup" : {
    "id" : "string",
    "terminalId" : "string",
    "postOfficeAddress" : {
      "postOfficeId" : "string",
      "postOfficeBoxAddress" : {
        "postOfficeBoxId" : "string"
      }
    },
    "name" : "string",
    "companyName" : "string",
    "address" : {
      "country" : "string",
      "availableCountries" : [ {
        "id" : "string",
        "name" : "string",
        "code" : "string"
      } ],
      "postalCode" : "19200",
      "regionId" : 0,
      "locality" : "Vilnius",
      "street" : "J. Jasinskio",
      "building" : "16",
      "apartment" : "string",
      "address1" : "string",
      "address2" : "string"
    },
    "email" : "string",
    "comment" : "string",
    "phone" : "string"
  },
  "sendingDocuments" : true,
  "additionalServices" : [ {
    "id" : 1,
    "note" : "This is an example additional service note",
    "variant" : "1",
    "amount" : 2.0
  } ],
  "id" : "string",
  "createdOn" : "string",
  "barcode" : "CC800058625LT",
  "price" : {
    "amount" : 0.0,
    "vat" : 0.0,
    "currency" : "string"
  },
  "dateSent" : "string",
  "status" : "string",
  "partsBarcode" : [ "string" ],
  "type" : "string",
  "size" : "string",
  "title" : "string",
  "cartId" : "string",
  "summary" : "string",
  "description" : "string",
  "addressResolverInfo" : [ {
    "addressType" : "string",
    "resolved" : true
  } ]
} ]

2.4.4. initiateShipping

POST /api/v1/shipping/initiate
Description

To initiate dispatch of shipping items. The response returns the identification numbers of shipping item carts. It is important to mention that when initiating shipments, they need to be grouped: LP Express parcels and Lithuanian postal service parcels. But if you initiate at one time parcels with Lithuanian postal services and LP Express services - then no statuses will appear after the initiation (there will be PENDING)

Parameters
Type Name Description Schema

Body

body
required

A list of shipping items sought to be dispatched.

< string > array

Responses
HTTP Code Description Schema

200

Shipping initiation confirmed.

< string > array

Produces
  • application/json

Security
Type Name

Unknown

Unknown

Example HTTP request
Request path
/api/v1/shipping/initiate
Request body
[ "string" ]

2.4.5. Returns shipping templates

OPTIONS /api/v1/shipping/shippingItemTemplates
Description

To get descriptions of shipping item templates.

Parameters
Type Name Schema Default

Query

availableCountries
optional

boolean

"false"

Responses
HTTP Code Description Schema

200

Shipping item template data structure.

Produces
  • application/json

Security
Type Name

Unknown

Unknown

Example HTTP request
Request path
/api/v1/shipping/shippingItemTemplates
Example HTTP response
Response 200
[ {
  "externalId" : "string",
  "template" : "string",
  "weight" : 0.0,
  "partCount" : 0,
  "documents" : {
    "cn22Form" : {
      "parcelType" : "string",
      "parcelTypeNotes" : "string",
      "description" : "string",
      "cnParts" : [ {
        "summary" : "string",
        "weight" : 0,
        "quantity" : 0,
        "hsCode" : 0,
        "amount" : 0.0,
        "currencyCode" : "string",
        "countryCode" : "string",
        "sortOrder" : 0
      } ]
    },
    "cn23Form" : {
      "parcelType" : "GIFT",
      "parcelTypeNotes" : "string",
      "license" : "string",
      "certificate" : "string",
      "invoice" : "string",
      "notes" : "string",
      "description" : "string",
      "importerCode" : "string",
      "importerPhone" : "string",
      "importerFax" : "string",
      "importerEmail" : "string",
      "importerTaxCode" : "string",
      "importerVatCode" : "string",
      "importerCustomsCode" : "string",
      "exporterCustomsCode" : "string",
      "failureInstruction" : "string",
      "cnParts" : [ {
        "summary" : "string",
        "weight" : 0,
        "quantity" : 0,
        "hsCode" : 0,
        "amount" : 0.0,
        "currencyCode" : "string",
        "countryCode" : "string",
        "sortOrder" : 0
      } ]
    }
  },
  "sender" : {
    "id" : "string",
    "terminalId" : "string",
    "postOfficeAddress" : {
      "postOfficeId" : "string",
      "postOfficeBoxAddress" : {
        "postOfficeBoxId" : "string"
      }
    },
    "name" : "string",
    "companyName" : "string",
    "address" : {
      "country" : "string",
      "availableCountries" : [ {
        "id" : "string",
        "name" : "string",
        "code" : "string"
      } ],
      "postalCode" : "19200",
      "regionId" : 0,
      "locality" : "Vilnius",
      "street" : "J. Jasinskio",
      "building" : "16",
      "apartment" : "string",
      "address1" : "string",
      "address2" : "string"
    },
    "email" : "string",
    "comment" : "string",
    "phone" : "string"
  },
  "receiver" : {
    "id" : "string",
    "terminalId" : "string",
    "postOfficeAddress" : {
      "postOfficeId" : "string",
      "postOfficeBoxAddress" : {
        "postOfficeBoxId" : "string"
      }
    },
    "name" : "string",
    "companyName" : "string",
    "address" : {
      "country" : "string",
      "availableCountries" : [ {
        "id" : "string",
        "name" : "string",
        "code" : "string"
      } ],
      "postalCode" : "19200",
      "regionId" : 0,
      "locality" : "Vilnius",
      "street" : "J. Jasinskio",
      "building" : "16",
      "apartment" : "string",
      "address1" : "string",
      "address2" : "string"
    },
    "email" : "string",
    "comment" : "string",
    "phone" : "string"
  },
  "pickup" : {
    "id" : "string",
    "terminalId" : "string",
    "postOfficeAddress" : {
      "postOfficeId" : "string",
      "postOfficeBoxAddress" : {
        "postOfficeBoxId" : "string"
      }
    },
    "name" : "string",
    "companyName" : "string",
    "address" : {
      "country" : "string",
      "availableCountries" : [ {
        "id" : "string",
        "name" : "string",
        "code" : "string"
      } ],
      "postalCode" : "19200",
      "regionId" : 0,
      "locality" : "Vilnius",
      "street" : "J. Jasinskio",
      "building" : "16",
      "apartment" : "string",
      "address1" : "string",
      "address2" : "string"
    },
    "email" : "string",
    "comment" : "string",
    "phone" : "string"
  },
  "sendingDocuments" : true,
  "additionalServices" : [ {
    "id" : 1,
    "note" : "This is an example additional service note",
    "variant" : "1",
    "amount" : 2.0
  } ],
  "id" : "string",
  "createdOn" : "string",
  "barcode" : "CC800058625LT",
  "price" : {
    "amount" : 0.0,
    "vat" : 0.0,
    "currency" : "string"
  },
  "dateSent" : "string",
  "status" : "string",
  "partsBarcode" : [ "string" ],
  "type" : "string",
  "size" : "string",
  "title" : "string",
  "cartId" : "string",
  "summary" : "string",
  "description" : "string",
  "addressResolverInfo" : [ {
    "addressType" : "string",
    "resolved" : true
  } ]
} ]

2.4.6. template

OPTIONS /api/v1/shipping/template/{template}
Description

To get template variables

Parameters
Type Name Description Schema

Path

template
required

Unique identifier of a shipping item template.

string

Responses
HTTP Code Description Schema

200

Result returned for the template method

Produces
  • application/json

Security
Type Name

Unknown

Unknown

Example HTTP request
Request path
/api/v1/shipping/template/42
Example HTTP response
Response 200
{
  "terminals" : [ {
    "id" : "string",
    "name" : "string",
    "city" : "string",
    "address" : "string",
    "postalCode" : "string",
    "boxes" : [ "string" ],
    "latitude" : "string",
    "longitude" : "string",
    "workingHours" : "string",
    "servicingHours" : "string",
    "comment" : "string"
  } ],
  "countries" : [ {
    "id" : "string",
    "name" : "string",
    "code" : "string",
    "weightOptions" : {
      "min" : 0.0,
      "max" : 0.0
    }
  } ],
  "templateId" : "string"
}

2.4.7. Gathers information about shipping item.

GET /api/v1/shipping/{itemId}
Description

To get details of a single shipping item.

Parameters
Type Name Description Schema

Path

itemId
required

Unique identifier of the shipping item on “Mano siuntos” system.

string

Responses
HTTP Code Description Schema

200

Shipping item data structure (see 3.10 ShippingItemType)

Produces
  • application/json

Security
Type Name

Unknown

Unknown

Example HTTP request
Request path
/api/v1/shipping/4100003
Example HTTP response
Response 200
{
  "externalId" : "string",
  "template" : "string",
  "weight" : 0.0,
  "partCount" : 0,
  "documents" : {
    "cn22Form" : {
      "parcelType" : "string",
      "parcelTypeNotes" : "string",
      "description" : "string",
      "cnParts" : [ {
        "summary" : "string",
        "weight" : 0,
        "quantity" : 0,
        "hsCode" : 0,
        "amount" : 0.0,
        "currencyCode" : "string",
        "countryCode" : "string",
        "sortOrder" : 0
      } ]
    },
    "cn23Form" : {
      "parcelType" : "GIFT",
      "parcelTypeNotes" : "string",
      "license" : "string",
      "certificate" : "string",
      "invoice" : "string",
      "notes" : "string",
      "description" : "string",
      "importerCode" : "string",
      "importerPhone" : "string",
      "importerFax" : "string",
      "importerEmail" : "string",
      "importerTaxCode" : "string",
      "importerVatCode" : "string",
      "importerCustomsCode" : "string",
      "exporterCustomsCode" : "string",
      "failureInstruction" : "string",
      "cnParts" : [ {
        "summary" : "string",
        "weight" : 0,
        "quantity" : 0,
        "hsCode" : 0,
        "amount" : 0.0,
        "currencyCode" : "string",
        "countryCode" : "string",
        "sortOrder" : 0
      } ]
    }
  },
  "sender" : {
    "id" : "string",
    "terminalId" : "string",
    "postOfficeAddress" : {
      "postOfficeId" : "string",
      "postOfficeBoxAddress" : {
        "postOfficeBoxId" : "string"
      }
    },
    "name" : "string",
    "companyName" : "string",
    "address" : {
      "country" : "string",
      "availableCountries" : [ {
        "id" : "string",
        "name" : "string",
        "code" : "string"
      } ],
      "postalCode" : "19200",
      "regionId" : 0,
      "locality" : "Vilnius",
      "street" : "J. Jasinskio",
      "building" : "16",
      "apartment" : "string",
      "address1" : "string",
      "address2" : "string"
    },
    "email" : "string",
    "comment" : "string",
    "phone" : "string"
  },
  "receiver" : {
    "id" : "string",
    "terminalId" : "string",
    "postOfficeAddress" : {
      "postOfficeId" : "string",
      "postOfficeBoxAddress" : {
        "postOfficeBoxId" : "string"
      }
    },
    "name" : "string",
    "companyName" : "string",
    "address" : {
      "country" : "string",
      "availableCountries" : [ {
        "id" : "string",
        "name" : "string",
        "code" : "string"
      } ],
      "postalCode" : "19200",
      "regionId" : 0,
      "locality" : "Vilnius",
      "street" : "J. Jasinskio",
      "building" : "16",
      "apartment" : "string",
      "address1" : "string",
      "address2" : "string"
    },
    "email" : "string",
    "comment" : "string",
    "phone" : "string"
  },
  "pickup" : {
    "id" : "string",
    "terminalId" : "string",
    "postOfficeAddress" : {
      "postOfficeId" : "string",
      "postOfficeBoxAddress" : {
        "postOfficeBoxId" : "string"
      }
    },
    "name" : "string",
    "companyName" : "string",
    "address" : {
      "country" : "string",
      "availableCountries" : [ {
        "id" : "string",
        "name" : "string",
        "code" : "string"
      } ],
      "postalCode" : "19200",
      "regionId" : 0,
      "locality" : "Vilnius",
      "street" : "J. Jasinskio",
      "building" : "16",
      "apartment" : "string",
      "address1" : "string",
      "address2" : "string"
    },
    "email" : "string",
    "comment" : "string",
    "phone" : "string"
  },
  "sendingDocuments" : true,
  "additionalServices" : [ {
    "id" : 1,
    "note" : "This is an example additional service note",
    "variant" : "1",
    "amount" : 2.0
  } ],
  "id" : "string",
  "createdOn" : "string",
  "barcode" : "CC800058625LT",
  "price" : {
    "amount" : 0.0,
    "vat" : 0.0,
    "currency" : "string"
  },
  "dateSent" : "string",
  "status" : "string",
  "partsBarcode" : [ "string" ],
  "type" : "string",
  "size" : "string",
  "title" : "string",
  "cartId" : "string",
  "summary" : "string",
  "description" : "string",
  "addressResolverInfo" : [ {
    "addressType" : "string",
    "resolved" : true
  } ]
}

2.4.8. updateShippingItem

PUT /api/v1/shipping/{itemId}
Description

To update and edit shipping item details.

Parameters
Type Name Schema

Path

itemId
required

string

Body

body
optional

Responses
HTTP Code Description Schema

200

Details of an updated or edited shipping item.

400

Bad request provided

No Content

Produces
  • application/json

Security
Type Name

Unknown

Unknown

Example HTTP request
Request path
/api/v1/shipping/400001
Request body
{
  "externalId" : "string",
  "template" : "string",
  "weight" : 0.0,
  "partCount" : 0,
  "documents" : {
    "cn22Form" : {
      "parcelType" : "string",
      "parcelTypeNotes" : "string",
      "description" : "string",
      "cnParts" : [ {
        "summary" : "string",
        "weight" : 0,
        "quantity" : 0,
        "hsCode" : 0,
        "amount" : 0.0,
        "currencyCode" : "string",
        "countryCode" : "string",
        "sortOrder" : 0
      } ]
    },
    "cn23Form" : {
      "parcelType" : "GIFT",
      "parcelTypeNotes" : "string",
      "license" : "string",
      "certificate" : "string",
      "invoice" : "string",
      "notes" : "string",
      "description" : "string",
      "importerCode" : "string",
      "importerPhone" : "string",
      "importerFax" : "string",
      "importerEmail" : "string",
      "importerTaxCode" : "string",
      "importerVatCode" : "string",
      "importerCustomsCode" : "string",
      "exporterCustomsCode" : "string",
      "failureInstruction" : "string",
      "cnParts" : [ {
        "summary" : "string",
        "weight" : 0,
        "quantity" : 0,
        "hsCode" : 0,
        "amount" : 0.0,
        "currencyCode" : "string",
        "countryCode" : "string",
        "sortOrder" : 0
      } ]
    }
  },
  "sender" : {
    "id" : "string",
    "terminalId" : "string",
    "postOfficeAddress" : {
      "postOfficeId" : "string",
      "postOfficeBoxAddress" : {
        "postOfficeBoxId" : "string"
      }
    },
    "name" : "string",
    "companyName" : "string",
    "address" : {
      "country" : "string",
      "availableCountries" : [ {
        "id" : "string",
        "name" : "string",
        "code" : "string"
      } ],
      "postalCode" : "19200",
      "regionId" : 0,
      "locality" : "Vilnius",
      "street" : "J. Jasinskio",
      "building" : "16",
      "apartment" : "string",
      "address1" : "string",
      "address2" : "string"
    },
    "email" : "string",
    "comment" : "string",
    "phone" : "string"
  },
  "receiver" : {
    "id" : "string",
    "terminalId" : "string",
    "postOfficeAddress" : {
      "postOfficeId" : "string",
      "postOfficeBoxAddress" : {
        "postOfficeBoxId" : "string"
      }
    },
    "name" : "string",
    "companyName" : "string",
    "address" : {
      "country" : "string",
      "availableCountries" : [ {
        "id" : "string",
        "name" : "string",
        "code" : "string"
      } ],
      "postalCode" : "19200",
      "regionId" : 0,
      "locality" : "Vilnius",
      "street" : "J. Jasinskio",
      "building" : "16",
      "apartment" : "string",
      "address1" : "string",
      "address2" : "string"
    },
    "email" : "string",
    "comment" : "string",
    "phone" : "string"
  },
  "pickup" : {
    "id" : "string",
    "terminalId" : "string",
    "postOfficeAddress" : {
      "postOfficeId" : "string",
      "postOfficeBoxAddress" : {
        "postOfficeBoxId" : "string"
      }
    },
    "name" : "string",
    "companyName" : "string",
    "address" : {
      "country" : "string",
      "availableCountries" : [ {
        "id" : "string",
        "name" : "string",
        "code" : "string"
      } ],
      "postalCode" : "19200",
      "regionId" : 0,
      "locality" : "Vilnius",
      "street" : "J. Jasinskio",
      "building" : "16",
      "apartment" : "string",
      "address1" : "string",
      "address2" : "string"
    },
    "email" : "string",
    "comment" : "string",
    "phone" : "string"
  },
  "sendingDocuments" : true,
  "additionalServices" : [ {
    "id" : 1,
    "note" : "This is an example additional service note",
    "variant" : "1",
    "amount" : 2.0
  } ]
}
Example HTTP response
Response 200
{
  "externalId" : "string",
  "template" : "string",
  "weight" : 0.0,
  "partCount" : 0,
  "documents" : {
    "cn22Form" : {
      "parcelType" : "string",
      "parcelTypeNotes" : "string",
      "description" : "string",
      "cnParts" : [ {
        "summary" : "string",
        "weight" : 0,
        "quantity" : 0,
        "hsCode" : 0,
        "amount" : 0.0,
        "currencyCode" : "string",
        "countryCode" : "string",
        "sortOrder" : 0
      } ]
    },
    "cn23Form" : {
      "parcelType" : "GIFT",
      "parcelTypeNotes" : "string",
      "license" : "string",
      "certificate" : "string",
      "invoice" : "string",
      "notes" : "string",
      "description" : "string",
      "importerCode" : "string",
      "importerPhone" : "string",
      "importerFax" : "string",
      "importerEmail" : "string",
      "importerTaxCode" : "string",
      "importerVatCode" : "string",
      "importerCustomsCode" : "string",
      "exporterCustomsCode" : "string",
      "failureInstruction" : "string",
      "cnParts" : [ {
        "summary" : "string",
        "weight" : 0,
        "quantity" : 0,
        "hsCode" : 0,
        "amount" : 0.0,
        "currencyCode" : "string",
        "countryCode" : "string",
        "sortOrder" : 0
      } ]
    }
  },
  "sender" : {
    "id" : "string",
    "terminalId" : "string",
    "postOfficeAddress" : {
      "postOfficeId" : "string",
      "postOfficeBoxAddress" : {
        "postOfficeBoxId" : "string"
      }
    },
    "name" : "string",
    "companyName" : "string",
    "address" : {
      "country" : "string",
      "availableCountries" : [ {
        "id" : "string",
        "name" : "string",
        "code" : "string"
      } ],
      "postalCode" : "19200",
      "regionId" : 0,
      "locality" : "Vilnius",
      "street" : "J. Jasinskio",
      "building" : "16",
      "apartment" : "string",
      "address1" : "string",
      "address2" : "string"
    },
    "email" : "string",
    "comment" : "string",
    "phone" : "string"
  },
  "receiver" : {
    "id" : "string",
    "terminalId" : "string",
    "postOfficeAddress" : {
      "postOfficeId" : "string",
      "postOfficeBoxAddress" : {
        "postOfficeBoxId" : "string"
      }
    },
    "name" : "string",
    "companyName" : "string",
    "address" : {
      "country" : "string",
      "availableCountries" : [ {
        "id" : "string",
        "name" : "string",
        "code" : "string"
      } ],
      "postalCode" : "19200",
      "regionId" : 0,
      "locality" : "Vilnius",
      "street" : "J. Jasinskio",
      "building" : "16",
      "apartment" : "string",
      "address1" : "string",
      "address2" : "string"
    },
    "email" : "string",
    "comment" : "string",
    "phone" : "string"
  },
  "pickup" : {
    "id" : "string",
    "terminalId" : "string",
    "postOfficeAddress" : {
      "postOfficeId" : "string",
      "postOfficeBoxAddress" : {
        "postOfficeBoxId" : "string"
      }
    },
    "name" : "string",
    "companyName" : "string",
    "address" : {
      "country" : "string",
      "availableCountries" : [ {
        "id" : "string",
        "name" : "string",
        "code" : "string"
      } ],
      "postalCode" : "19200",
      "regionId" : 0,
      "locality" : "Vilnius",
      "street" : "J. Jasinskio",
      "building" : "16",
      "apartment" : "string",
      "address1" : "string",
      "address2" : "string"
    },
    "email" : "string",
    "comment" : "string",
    "phone" : "string"
  },
  "sendingDocuments" : true,
  "additionalServices" : [ {
    "id" : 1,
    "note" : "This is an example additional service note",
    "variant" : "1",
    "amount" : 2.0
  } ],
  "id" : "string",
  "createdOn" : "string",
  "barcode" : "CC800058625LT",
  "price" : {
    "amount" : 0.0,
    "vat" : 0.0,
    "currency" : "string"
  },
  "dateSent" : "string",
  "status" : "string",
  "partsBarcode" : [ "string" ],
  "type" : "string",
  "size" : "string",
  "title" : "string",
  "cartId" : "string",
  "summary" : "string",
  "description" : "string",
  "addressResolverInfo" : [ {
    "addressType" : "string",
    "resolved" : true
  } ]
}

2.4.9. deleteShippingItem

DELETE /api/v1/shipping/{itemId}
Description

To delete a shipping item.

Parameters
Type Name Description Schema

Path

itemId
required

Unique identifier of the shipping item on “Mano siuntos” system.

string

Responses
HTTP Code Description Schema

200

successful operation

boolean

Produces
  • application/json

Security
Type Name

Unknown

Unknown

Example HTTP request
Request path
/api/v1/shipping/string

2.4.10. Returns shipping item options after shipping item is created.

OPTIONS /api/v1/shipping/{itemId}
Description

To get available options for a shipping item. The result returns available recipient’s countries, additional services, required documents to be completed and size and weight ranges.

Parameters
Type Name Description Schema

Path

itemId
required

Unique identifier of the shipping item.

string

Responses
HTTP Code Description Schema

200

Result returned for the getShippingItemOptions method

Produces
  • application/json

Security
Type Name

Unknown

Unknown

Example HTTP request
Request path
/api/v1/shipping/4100003
Example HTTP response
Response 200
{
  "terminals" : [ {
    "id" : "string",
    "name" : "string",
    "city" : "string",
    "address" : "string",
    "postalCode" : "string",
    "boxes" : [ "string" ],
    "latitude" : "string",
    "longitude" : "string",
    "workingHours" : "string",
    "servicingHours" : "string",
    "comment" : "string"
  } ],
  "countries" : [ {
    "id" : "string",
    "name" : "string",
    "code" : "string"
  } ],
  "weights" : [ {
    "weightMax" : 0.0,
    "weightMin" : 0.0
  } ],
  "requiredDocuments" : {
    "cn22Required" : true,
    "cn23Required" : true
  },
  "availableServices" : [ {
    "id" : 1,
    "note" : "This is an example additional service note",
    "variant" : "1",
    "amount" : 2.0,
    "title" : "string",
    "description" : "string",
    "summary" : "string",
    "price" : {
      "amount" : 0.0,
      "vat" : 0.0,
      "currency" : "string"
    }
  } ],
  "itemId" : "string"
}

2.5. Tracking Operations

2.5.1. Gathers tracking information about shipping items.

POST /api/v1/tracking
Parameters
Type Name Schema

Body

body
optional

< string > array

Responses
HTTP Code Description Schema

200

successful operation

Produces
  • application/json

Security
Type Name

Unknown

Unknown

Example HTTP request
Request path
/api/v1/tracking
Request body
[ "string" ]
Example HTTP response
Response 200
[ {
  "id" : "string",
  "barcode" : "string",
  "state" : "string",
  "events" : [ {
    "eventTitle" : "string",
    "eventDescription" : "string",
    "eventDate" : "string"
  } ]
} ]

2.5.2. Gathers tracking information about shipping item.

GET /api/v1/tracking/byBarcode/{barcode}
Parameters
Type Name Description Schema

Path

barcode
required

Shipping item unique barcode

string

Responses
HTTP Code Description Schema

200

TTracking shipments and checking shipment delivery status

Produces
  • application/json

Security
Type Name

Unknown

Unknown

Example HTTP request
Request path
/api/v1/tracking/byBarcode/RS000000000LT
Example HTTP response
Response 200
{
  "id" : "string",
  "barcode" : "string",
  "state" : "string",
  "events" : [ {
    "eventTitle" : "string",
    "eventDescription" : "string",
    "eventDate" : "string"
  } ]
}

2.5.3. Gathers tracking information about shipping item.

GET /api/v1/tracking/byItemId/{itemId}
Parameters
Type Name Description Schema

Path

itemId
required

Unique identifier of the shipping item on 'Mano siuntos' system.

string

Responses
HTTP Code Description Schema

200

Tracking shipments and checking shipment delivery status

Produces
  • application/json

Security
Type Name

Unknown

Unknown

Example HTTP request
Request path
/api/v1/tracking/byItemId/4100003
Example HTTP response
Response 200
{
  "id" : "string",
  "barcode" : "string",
  "state" : "string",
  "events" : [ {
    "eventTitle" : "string",
    "eventDescription" : "string",
    "eventDate" : "string"
  } ]
}

3. Definitions

3.1. Additional service base data structure.

Name Description Schema

amount
optional

Additional service amount. Required if service template returns amountProperties with required precision.
Example : 2.0

number (double)

description
optional

Additional service description.
Example : "string"

string

id
required

Additional service id.
Example : 1

integer (int32)

note
optional

Additional service note. Required if service template returns noteProperties.
Example : "This is an example additional service note"

string

price
optional

Additional service price.
Example : Price entity.

summary
optional

Additional service summary.
Example : "string"

string

title
optional

Additional service title.
Example : "string"

string

variant
optional

Additional service variant. Required if service template returns variantProperties.
Example : "1"

string

3.2. Address

Name Description Schema

building
optional

Example : "string"

string

countryId
optional

Example : 0

integer (int64)

district
optional

Example : "string"

string

flat
optional

Example : "string"

string

locality
optional

Example : "string"

string

municipality
optional

Example : "string"

string

postalCode
optional

Example : "string"

string

street
optional

Example : "string"

string

3.3. AddressResolverShippingInfo

Name Description Schema

addressType
optional

Example : "string"

string

resolved
optional

Example : true

boolean

3.4. Base entity for address.

Name Description Schema

address1
optional

Address 1
Length : 0 - 100
Example : "string"

string

address2
optional

Address 2
Length : 0 - 100
Example : "string"

string

apartment
optional

Apartament of address entity.
Length : 0 - 20
Example : "string"

string

availableCountries
optional

Example : [ "Country" ]

< Country > array

building
optional

Building of address entity. Required when no freeformAddress is provided.
Length : 0 - 20
Example : "16"

string

country
required

Country code which is provided by template possible countries.
Example : "string"

string

locality
optional

Locality of address entity. Required when freeformAddress or structured address is provided.
Length : 0 - 35
Example : "Vilnius"

string

postalCode
required

Postal code of address entity
Length : 0 - 15
Example : "19200"

string

regionId
optional

Region ID.
Example : 0

integer (int64)

street
optional

Street of address entity. Required when no freeformAddress is provided.
Length : 0 - 50
Example : "J. Jasinskio"

string

3.5. BaseDocumentResponse

Name Description Schema

contentType
optional

Example : "string"

string

document
optional

Example : [ "string" ]

< string (byte) > array

3.6. BuildingResponse

Name Description Schema

building
optional

Example : "string"

string

id
optional

Example : 0

integer (int32)

postalCode
optional

Example : "string"

string

street
optional

Example : StreetResponse

3.7. CN22FormBase

Name Description Schema

cnParts
optional

Example : [ "CNPartBase" ]

< CNPartBase > array

description
optional

Example : "string"

string

parcelType
optional

Example : "string"

string

parcelTypeNotes
optional

Example : "string"

string

3.8. CN23FormBase

Name Description Schema

certificate
optional

Example : "string"

string

cnParts
optional

Example : [ "CNPartBase" ]

< CNPartBase > array

description
optional

Example : "string"

string

exporterCustomsCode
optional

Example : "string"

string

failureInstruction
optional

Example : "string"

string

importerCode
optional

Example : "string"

string

importerCustomsCode
optional

Example : "string"

string

importerEmail
optional

Example : "string"

string

importerFax
optional

Example : "string"

string

importerPhone
optional

Example : "string"

string

importerTaxCode
optional

Example : "string"

string

importerVatCode
optional

Example : "string"

string

invoice
optional

Example : "string"

string

license
optional

Example : "string"

string

notes
optional

Example : "string"

string

parcelType
required

Example : "GIFT"

string

parcelTypeNotes
optional

Example : "string"

string

3.9. CNPartBase

Name Description Schema

amount
optional

Example : 0.0

number (double)

countryCode
optional

Example : "string"

string

currencyCode
optional

Example : "string"

string

hsCode
optional

Example : 0

integer (int32)

quantity
optional

Example : 0

integer (int32)

sortOrder
optional

Example : 0

integer (int32)

summary
optional

Example : "string"

string

weight
optional

Example : 0

integer (int32)

3.10. Core entity for shipping item.

Name Description Schema

additionalServices
optional

addressResolverInfo
optional

Example : [ "AddressResolverShippingInfo" ]

barcode
optional

Barcode of the specific shipping item. Only provided when initiation was succesful.
Example : "CC800058625LT"

string

cartId
optional

Example : "string"

string

createdOn
optional

Example : "string"

string (date-time)

dateSent
optional

Date at which the shipping item was sent.
Example : "string"

string (date-time)

description
optional

Example : "string"

string

documents
optional

A list of declarations to accompany the shipping item.
Example : ShippingDocumentsBase

externalId
optional

Unique identifier assigned to the shipping item on the user’s system.
Example : "string"

string

id
optional

Shipping item identificator mainly used across whole API. This id is immutable and generated in internal API systems.
Example : "string"

string

partCount
required

Number of parts of the shipping item.
Example : 0

integer (int32)

partsBarcode
optional

Example : [ "string" ]

< string > array

pickup
optional

Shipping item pickup address details. If not provided, the default value will w taken from sender field.
Example : DeliveryPartyBase

price
optional

Price of the shipping item without the price of actual additional services.
Example : Price entity.

receiver
required

Shipping item recipient’s details
Example : DeliveryPartyBase

sender
optional

Shipping item sender’s details. If not provided, the default details available in the user profile are given.
Example : DeliveryPartyBase

sendingDocuments
optional

Example : true

boolean

size
optional

Example : "string"

string

status
required

Status of the shipping item. This status is not needed from API user it will provide the status from application.
Example : "string"

enum (LABEL_CREATED, PENDING)

summary
optional

Example : "string"

string

template
required

Unique identifier of a shipping item template.
Example : "string"

string

title
optional

Example : "string"

string

type
optional

Example : "string"

string

weight
optional

Shipping item weight (g). Required if the selected shipping item template has default shipping item weights.
Example : 0.0

number (double)

3.11. Country

Name Description Schema

code
optional

Example : "string"

string

id
optional

Example : "string"

string

name
optional

Example : "string"

string

3.12. CountryOptions

Name Description Schema

code
optional

Example : "string"

string

id
optional

Example : "string"

string

name
optional

Example : "string"

string

weightOptions
optional

Example : WeightOptions

3.13. CountryResponse

Name Description Schema

code
optional

Example : "string"

string

country
optional

Example : "string"

string

default
optional

Example : true

boolean

id
optional

Example : 0

integer (int64)

regions
optional

Example : [ "RegionLong" ]

< RegionLong > array

3.14. DefaultResponse

Name Description Schema

country
optional

Example : CountryResponse

3.15. DeliveryPartyBase

Name Description Schema

address
optional

comment
optional

Length : 0 - 120
Example : "string"

string

companyName
optional

Length : 0 - 100
Example : "string"

string

email
optional

Length : 0 - 128
Example : "string"

string

id
optional

Example : "string"

string

name
optional

Length : 0 - 100
Example : "string"

string

phone
optional

Length : 0 - 18
Example : "string"

string

postOfficeAddress
optional

Example : PostOfficeAddress

terminalId
optional

Example : "string"

string

3.16. DocumentResponse

Name Description Schema

cartId
optional

Example : 0

integer (int64)

contentType
optional

Example : "string"

string

document
optional

Example : [ "string" ]

< string (byte) > array

3.17. LocalityResponse

Name Description Schema

country
optional

Example : CountryResponse

district
optional

Example : "string"

string

id
optional

Example : 0

integer (int32)

locality
optional

Example : "string"

string

municipality
optional

Example : "string"

string

3.18. Main additional service base structure.

Name Description Schema

amount
optional

Additional service amount. Required if service template returns amountProperties with required precision.
Example : 2.0

number (double)

id
required

Additional service id.
Example : 1

integer (int32)

note
optional

Additional service note. Required if service template returns noteProperties.
Example : "This is an example additional service note"

string

variant
optional

Additional service variant. Required if service template returns variantProperties.
Example : "1"

string

3.19. ManifestResponse

Name Description Schema

barcode
optional

Example : "string"

string

contentType
optional

Example : "string"

string

document
optional

Example : [ "string" ]

< string (byte) > array

3.20. PostBoxRangeResponse

Name Description Schema

fromNumber
optional

Example : 0

integer (int32)

toNumber
optional

Example : 0

integer (int32)

3.21. PostBoxResponse

Name Description Schema

boxes
optional

Example : [ "PostBoxRangeResponse" ]

postOffice
optional

Example : PostOfficeResponse

3.22. PostOfficeAddress

Name Description Schema

postOfficeBoxAddress
optional

postOfficeId
optional

Example : "string"

string

3.23. PostOfficeBoxAddress

Name Description Schema

postOfficeBoxId
optional

Example : "string"

string

3.24. PostOfficeResponse

Name Description Schema

id
optional

Example : 0

integer (int64)

locality
optional

Example : LocalityResponse

name
optional

Example : "string"

string

postalCode
optional

Example : "string"

string

3.25. PostalCodeResponse

Name Description Schema

country
optional

Example : CountryResponse

id
optional

Example : 0

integer (int32)

postalCode
optional

Example : "string"

string

3.26. Price entity.

Name Description Schema

amount
optional

Amount of price.
Example : 0.0

number

currency
optional

Currency representation in which price amount is displayed.
Example : "string"

string

vat
optional

VAT for price amount.
Example : 0.0

number

3.27. Region

Name Description Schema

bpCode
optional

Length : 1 - 10
Example : "string"

string

countryId
required

Example : 0

integer (int64)

id
optional

Example : Serializable

lpCode
optional

Length : 1 - 10
Example : "string"

string

name
optional

Example : "string"

string

3.28. RegionLong

Name Description Schema

bpCode
optional

Length : 1 - 10
Example : "string"

string

countryId
required

Example : 0

integer (int64)

id
optional

Example : 0

integer (int64)

lpCode
optional

Length : 1 - 10
Example : "string"

string

name
optional

Example : "string"

string

3.29. RequiredDocuments

Name Description Schema

cn22Required
optional

Example : true

boolean

cn23Required
optional

Example : true

boolean

3.30. Response entity for manual call courier.

Name Description Schema

barcode
required

Barcode of the shipping item
Example : "RS102001338LT"

string

manifestId
required

Generated manifest id from external systems.
Example : "string"

string

3.31. Serializable

Type : object

3.32. Shipping item data structure

Name Description Schema

additionalServices
optional

documents
optional

A list of declarations to accompany the shipping item.
Example : ShippingDocumentsBase

externalId
optional

Unique identifier assigned to the shipping item on the user’s system.
Example : "string"

string

partCount
required

Number of parts of the shipping item.
Example : 0