Manifests

Create Manifest with shipments

post

/declaration-groups

This method allows combining previously created shipments into a single Manifest document in the EuroGate system for customs processing and transportation.

The mainNumbers parameter must contain shipment numbers of previously created shipments.

Authorizations

AuthorizationstringRequired

Authorization JWT-token with a lifetime of 1 hour in header

Body

namestring · max: 255Optional

Special Manifest name used for personalization purposes.

If the parameter is absent, it does not need to be transferred.

partnerNumberstring · max: 50Optional

Unique partner Manifest number generated in the partner system.

If the parameter is absent, it does not need to be transferred.

deliveryPartnerstring · nullableRequired

Delivery partner identifier.

Since delivery is initially performed through the Lviv CSS and customs clearance process, the parameter must be transferred with the value null.

typestring · enumRequired

Document type.

The parameter must be transferred with the value Manifest.

Possible values:

senderCompanyTinstring · max: 20 · nullableOptional

Sender company TIN code.

The value must be agreed upon with the integration manager.

senderCompanyNamestring · max: 255 · nullableOptional

Name of the sender organization.

Fill in this field if senderCompanyTin == null or the value is missing from the directory.

senderAddressstring · max: 255 · nullableOptional

Loading address.

Fill in this field if senderDivisionTin == null or the value is missing from the directory.

senderCountryCodestring · nullableOptional

Sender country code according to the ISO Alpha-2 standard.

Fill in this field if senderDivisionId == null or the value is missing from the directory.

Pattern: ^[A-Z]{2}$

recipientCompanyTinstring · max: 20Required

TIN code of the consignee legal entity according to the Manifest.

recipientCountryCodestringRequired

Recipient country code according to the ISO Alpha-2 standard.

Pattern: ^[A-Z]{2}$

shipmentTypestring · nullableRequired

Shipment type.

Available values:

B2CDeliveryLess150
B2CDeliveryMoreOrEqual150
B2BAndC2BDelivery

grossWeightintegerOptional

Gross weight of the Manifest in grams.

The gross weight cannot be less than the net weight.

mainNumbersstring[]Required

Array of previously created shipment numbers.

Responses

200

Manifest successfully created.

application/json

numberstringOptional

Unique Manifest number in the EuroGate system.

partnerNumberstringOptional

Partner Manifest number.

deliveryPartnerstringOptional

Delivery partner.

statusstringOptional

Manifest status.

statusDateTimestring · date-timeOptional

Date and time of the last status update.

namestringOptional

Manifest name.

typestringOptional

Document type.

userstringOptional

User identifier who created the Manifest.

divisionIdintegerOptional

Division identifier.

countryCodestringOptional

Country code.

recipientCompanyTinstringOptional

Recipient company TIN.

recipientCompanyNamestring · nullableOptional

Recipient company name.

recipientCountryCodestringOptional

Recipient country code.

senderCompanyTinstringOptional

Sender company TIN.

senderCompanyNamestring · nullableOptional

Sender company name.

senderAddressstring · nullableOptional

Sender address.

senderCountryCodestringOptional

Sender country code.

shipmentTypestringOptional

Shipment type.

grossWeightintegerOptional

Gross weight in grams.

parcelsAmountintegerOptional

Number of parcels.

actualWeightintegerOptional

Actual weight in grams.

shipmentAmountintegerOptional

Number of shipments.

totalCostnumberOptional

Total shipment cost.

currencyCodestringOptional

Currency code.

createdAtstring · date-timeOptional

Manifest creation date and time.

updatedAtstring · date-timeOptional

Manifest update date and time.

deletedAtstring · nullableOptional

Manifest deletion date and time.

post

/declaration-groups

POST /v.1.0/declaration-groups HTTP/1.1
Host: api-stage.novapost.com/
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 353

{
  "partnerNumber": "PNDGPL0123456780",
  "name": "B2C 150- Allegro",
  "deliveryPartner": null,
  "type": "Manifest",
  "senderCompanyTin": "12345678",
  "senderCompanyName": null,
  "senderAddress": null,
  "senderCountryCode": "PL",
  "recipientCompanyTin": "31316718",
  "recipientCountryCode": "UA",
  "shipmentType": "B2CDeliveryLess150",
  "grossWeight": 1000,
  "mainNumbers": [
    "SHPL4575233930"
  ]
}

200

Manifest successfully created.

{
  "documents": [
    {
      "id": 254027,
      "declarationGroupNumber": "MFUA0000057204",
      "declarationNumber": "CDUA0000263269",
      "mainNumber": "SHPL4575233930",
      "declarationStatus": "InRoute",
      "createdAt": "2025-08-28T12:07:53.198754Z",
      "updatedAt": "2025-08-28T12:07:53.198763Z",
      "deletedAt": null
    }
  ],
  "number": "MFUA0000057204",
  "partnerNumber": "PNDGPL0123456780",
  "deliveryPartner": "NPUkraine",
  "status": "Opened",
  "statusDateTime": "2025-08-28T12:07:53.196877Z",
  "name": "string",
  "type": "Manifest",
  "user": "ff1d5d8c-72e4-498c-94ad-c8b423b4edb3",
  "divisionId": 1342922,
  "countryCode": "UA",
  "recipientCompanyTin": "string",
  "recipientCompanyName": null,
  "recipientCountryCode": "UA",
  "senderCompanyTin": "string",
  "senderCompanyName": null,
  "senderAddress": null,
  "senderCountryCode": "UA",
  "shipmentType": "DeclaredCostMore1000",
  "grossWeight": 0,
  "parcelsAmount": 1,
  "actualWeight": 5000,
  "shipmentAmount": 1,
  "totalCost": 150,
  "currencyCode": "EUR",
  "createdAt": "2025-08-28T12:07:53.196843Z",
  "updatedAt": "2025-08-28T12:07:53.196886Z",
  "deletedAt": null
}

Add Manifest gross weight

put

/declaration-groups/gross-weights/{number}

This method allows adding or updating the gross weight of the Manifest in the EuroGate system.

The gross weight is specified in grams and cannot be less than the net weight of the Manifest.

Authorizations

AuthorizationstringRequired

Authorization JWT-token with a lifetime of 1 hour in header

Path parameters

numberstring · max: 50Required

Manifest identifier.

It can be transmitted as:

the partner number (partnerNumber value), or
the unique Manifest number in the EuroGate system (number value).

Example: PNDGPL0123456780

Body

grossWeightintegerRequired

Gross weight of the Manifest in grams.

The gross weight cannot be less than the net weight.

Example: 1000

Responses

200

Gross weight successfully updated.

application/json

objectOptional

Full Manifest object returned from the EuroGate system after successful update.

put

/declaration-groups/gross-weights/{number}

PUT /v.1.0/declaration-groups/gross-weights/{number} HTTP/1.1
Host: api-stage.novapost.com/
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "grossWeight": 1000
}

200

Gross weight successfully updated.

{
  "documents": [
    {
      "id": 254027,
      "declarationGroupNumber": "MFUA0000057204",
      "declarationNumber": "CDUA0000263269",
      "mainNumber": "SHPL4575233930",
      "declarationStatus": "InRoute",
      "createdAt": "2025-08-28T12:07:53.198754Z",
      "updatedAt": "2025-08-28T12:07:53.198763Z",
      "deletedAt": null
    }
  ],
  "number": "MFUA0000057204",
  "partnerNumber": "PNDGPL0123456780",
  "deliveryPartner": "NPUkraine",
  "status": "Opened",
  "statusDateTime": "2025-08-28T12:07:53.196877Z",
  "name": "string",
  "type": "Manifest",
  "user": "ff1d5d8c-72e4-498c-94ad-c8b423b4edb3",
  "divisionId": 1342922,
  "countryCode": "UA",
  "recipientCompanyTin": "string",
  "recipientCompanyName": null,
  "recipientCountryCode": "UA",
  "senderCompanyTin": "string",
  "senderCompanyName": null,
  "senderAddress": null,
  "senderCountryCode": "UA",
  "shipmentType": "DeclaredCostMore1000",
  "grossWeight": 1000,
  "parcelsAmount": 1,
  "actualWeight": 5000,
  "shipmentAmount": 1,
  "totalCost": 150,
  "currencyCode": "EUR",
  "createdAt": "2025-08-28T12:07:53.196843Z",
  "updatedAt": "2025-08-28T12:07:53.196886Z",
  "deletedAt": null
}

Add additional shipments to Manifest

post

/declaration-groups/documents/{number}

This method allows adding previously created shipments to an existing Manifest in the EuroGate system.

The request must contain an array of previously created shipment numbers that need to be added to the Manifest.

Authorizations

AuthorizationstringRequired

Authorization JWT-token with a lifetime of 1 hour in header

Path parameters

numberstring · max: 50Required

Manifest identifier.

It can be transmitted as:

the partner number (partnerNumber value), or
the unique Manifest number in the EuroGate system (number value).

Example: PNDGPL0123456780

Body

mainNumbersstring[]Required

Array of previously created shipment numbers that need to be added to the Manifest.

Example: ["SHPL8051043844"]

Responses

200

Shipments successfully added to the Manifest.

application/json

objectOptional

Full Manifest object returned from the EuroGate system after successful update.

post

/declaration-groups/documents/{number}

POST /v.1.0/declaration-groups/documents/{number} HTTP/1.1
Host: api-stage.novapost.com/
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "mainNumbers": [
    "SHPL8051043844"
  ]
}

200

Shipments successfully added to the Manifest.

{
  "documents": [
    {
      "id": 254027,
      "declarationGroupNumber": "MFUA0000057204",
      "declarationNumber": "CDUA0000263269",
      "mainNumber": "SHPL8051043844",
      "declarationStatus": "InRoute",
      "createdAt": "2025-08-28T12:07:53.198754Z",
      "updatedAt": "2025-08-28T12:07:53.198763Z",
      "deletedAt": null
    }
  ],
  "number": "MFUA0000057204",
  "partnerNumber": "PNDGPL0123456780",
  "deliveryPartner": "NPUkraine",
  "status": "Opened",
  "statusDateTime": "2025-08-28T12:07:53.196877Z",
  "name": "string",
  "type": "Manifest",
  "user": "ff1d5d8c-72e4-498c-94ad-c8b423b4edb3",
  "divisionId": 1342922,
  "countryCode": "UA",
  "recipientCompanyTin": "string",
  "recipientCompanyName": null,
  "recipientCountryCode": "UA",
  "senderCompanyTin": "string",
  "senderCompanyName": null,
  "senderAddress": null,
  "senderCountryCode": "UA",
  "shipmentType": "DeclaredCostMore1000",
  "grossWeight": 1000,
  "parcelsAmount": 1,
  "actualWeight": 5000,
  "shipmentAmount": 1,
  "totalCost": 150,
  "currencyCode": "EUR",
  "createdAt": "2025-08-28T12:07:53.196843Z",
  "updatedAt": "2025-08-28T12:07:53.196886Z",
  "deletedAt": null
}

Delete shipments from Manifest

delete

/declaration-groups/documents/{number}

This method allows deleting previously created shipments from an existing Manifest in the EuroGate system.

The request must contain an array of previously created shipment numbers that need to be deleted from the Manifest.

Authorizations

AuthorizationstringRequired

Authorization JWT-token with a lifetime of 1 hour in header

Path parameters

numberstring · max: 50Required

Manifest identifier.

It can be transmitted as:

the partner number (partnerNumber value), or
the unique Manifest number in the EuroGate system (number value).

Example: PNDGPL0123456780

Body

mainNumbersstring[]Required

Array of previously created shipment numbers that need to be deleted from the Manifest.

Example: ["SHPL8051043844"]

Responses

200

Shipments successfully deleted from the Manifest.

application/json

objectOptional

Full Manifest object returned from the EuroGate system after successful update.

delete

/declaration-groups/documents/{number}

DELETE /v.1.0/declaration-groups/documents/{number} HTTP/1.1
Host: api-stage.novapost.com/
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "mainNumbers": [
    "SHPL8051043844"
  ]
}

200

Shipments successfully deleted from the Manifest.

{
  "documents": [],
  "number": "MFUA0000057204",
  "partnerNumber": "PNDGPL0123456780",
  "deliveryPartner": "NPUkraine",
  "status": "Opened",
  "statusDateTime": "2025-08-28T12:07:53.196877Z",
  "name": "string",
  "type": "Manifest",
  "user": "ff1d5d8c-72e4-498c-94ad-c8b423b4edb3",
  "divisionId": 1342922,
  "countryCode": "UA",
  "recipientCompanyTin": "string",
  "recipientCompanyName": null,
  "recipientCountryCode": "UA",
  "senderCompanyTin": "string",
  "senderCompanyName": null,
  "senderAddress": null,
  "senderCountryCode": "UA",
  "shipmentType": "DeclaredCostMore1000",
  "grossWeight": 1000,
  "parcelsAmount": 0,
  "actualWeight": 0,
  "shipmentAmount": 0,
  "totalCost": 0,
  "currencyCode": "EUR",
  "createdAt": "2025-08-28T12:07:53.196843Z",
  "updatedAt": "2025-08-28T12:07:53.196886Z",
  "deletedAt": null
}

Delete Manifest

delete

/declaration-groups/{number}

This method allows deleting a Manifest from the EuroGate system.

Authorizations

AuthorizationstringRequired

Authorization JWT-token with a lifetime of 1 hour in header

Path parameters

numberstring · max: 50Required

Manifest identifier.

It can be transmitted as:

the partner number (partnerNumber value), or
the unique Manifest number in the EuroGate system (number value).

Example: PNDGPL0123456780

Responses

200

Manifest successfully deleted.

application/json

deletedAtstring · date-timeOptional

Date and time when the Manifest was deleted.

Example: 2022-05-11T17:50:04.000000Z

delete

/declaration-groups/{number}

DELETE /v.1.0/declaration-groups/{number} HTTP/1.1
Host: api-stage.novapost.com/
Authorization: YOUR_API_KEY
Accept: */*

200

Manifest successfully deleted.

{
  "deletedAt": "2022-05-11T17:50:04.000000Z"
}

Print Manifest sticker

get

/declaration-groups/prints

This method allows receiving a printed version of the Manifest sticker from the EuroGate system.

In response to a successful request, a Manifest sticker in .pdf format encoded in Base64 is returned.

Authorizations

AuthorizationstringRequired

Authorization JWT-token with a lifetime of 1 hour in header

Query parameters

numbers[]string[]Required

Array of Manifest identifiers.

Each value can be transmitted as:

the partner number (partnerNumber value), or
the unique Manifest number in the EuroGate system (number value).

Example: ["PNDGPL0123456780"]

Responses

200

Manifest sticker successfully generated.

application/json

filestringOptional

Manifest sticker file in .pdf format encoded in Base64.

Example: JVBERi0xLjQKJcfs...

get

/declaration-groups/prints

GET /v.1.0/declaration-groups/prints?numbers[]=text HTTP/1.1
Host: api-stage.novapost.com/
Authorization: YOUR_API_KEY
Accept: */*

200

Manifest sticker successfully generated.

{
  "file": "JVBERi0xLjQKJcfs..."
}

Last updated 7 days ago