> For the complete documentation index, see [llms.txt](https://api-portal.novapost.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api-portal.novapost.com/metodi-1/methods/cmr.md).

# CMR

## Create New CMR

> This method allows users to create a new CMR document in the EuroGate system with sender, recipient, carrier, vehicle, and Manifest information.<br>

```json
{"openapi":"3.0.0","info":{"title":"API Nova Post","version":"1.0.0"},"tags":[],"servers":[{"description":"sandbox","url":"https://api-stage.novapost.com/v.1.0/"},{"description":"production","url":"https://api.novapost.com/v.1.0/"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"Authorization","description":"Authorization JWT-token with a lifetime of 1 hour in header"}}},"paths":{"/cmrs":{"post":{"tags":["Customs Integration"],"summary":"Create New CMR","description":"This method allows users to create a new CMR document in the EuroGate system with sender, recipient, carrier, vehicle, and Manifest information.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["senderCompanyTin","senderDivisionId","recipientCompanyTin","recipientDivisionId","loadingDateTime","customsRecipient","carrierTin","vehicleNumber","trailerNumber","sealNumber","dateOfSealing","documents","numberMrn","carnetTir"],"properties":{"partnerNumber":{"type":"string","maxLength":50,"nullable":true,"description":"Unique partner CMR number generated in the partner system.\nIf absent, the parameter does not need to be transferred.\n"},"senderCompanyTin":{"type":"string","maxLength":20,"description":"Sender company TIN code agreed upon with the integration manager.\n"},"senderDivisionId":{"type":"integer","description":"Sender division identifier agreed upon with the integration manager.\n"},"senderCompanyName":{"type":"string","maxLength":200,"nullable":true,"description":"Name of the sender organization.\nFill this field if `senderCompanyTin == null` or the value is not found in the directory.\n"},"senderAddress":{"type":"string","maxLength":255,"nullable":true,"description":"Loading address.\nFill this field if `senderDivisionId == null` or the value is not found in the directory.\n"},"senderCompanyLegalAddress":{"type":"string","maxLength":255,"nullable":true,"description":"Registered address of the sender legal entity.\nFill this field if `senderCompanyTin == null` or the value is not found in the directory.\n"},"senderCountry":{"type":"string","pattern":"^[A-Z]{2}$","nullable":true,"description":"Sender country code according to the Alpha-2 standard.\nFill this field if `senderDivisionId == null` or the value is not found in the directory.\n"},"recipientCompanyTin":{"type":"string","maxLength":20,"description":"Recipient company TIN code agreed upon with the integration manager.\n"},"recipientDivisionId":{"type":"integer","description":"Recipient division identifier agreed upon with the integration manager.\n"},"recipientCompanyName":{"type":"string","maxLength":200,"nullable":true,"description":"Name of the recipient organization.\nFill this field if `recipientCompanyTin == null` or the value is not found in the directory.\n"},"recipientAddress":{"type":"string","maxLength":255,"nullable":true,"description":"Unloading address.\nFill this field if `recipientDivisionId == null` or the value is not found in the directory.\n"},"recipientCompanyLegalAddress":{"type":"string","maxLength":255,"nullable":true,"description":"Registered address of the recipient legal entity.\nFill this field if `recipientCompanyTin == null` or the value is not found in the directory.\n"},"recipientCountry":{"type":"string","pattern":"^[A-Z]{2}$","nullable":true,"description":"Recipient country code according to the Alpha-2 standard.\nFill this field if `recipientDivisionId == null` or the value is not found in the directory.\n"},"loadingDateTime":{"type":"string","format":"date-time","nullable":true,"description":"Date and time of vehicle loading.\n\nIf the vehicle is not loaded yet at the moment of CMR creation, `null` must be transferred and updated later.\n"},"customsRecipient":{"type":"string","maxLength":255,"description":"Recipient customs details agreed upon with the integration manager.\n"},"carrierTin":{"type":"string","maxLength":20,"description":"Carrier company TIN code agreed upon with the integration manager.\n"},"carrierName":{"type":"string","maxLength":200,"nullable":true,"description":"Name of the freight carrier.\nFill this field if `carrierTin == null` or the value is not found in the directory.\n"},"vehicleNumber":{"type":"string","maxLength":20,"description":"Vehicle number.\nLetters must be entered in Latin only.\n"},"trailerNumber":{"type":"string","maxLength":20,"nullable":true,"description":"Trailer number.\nLetters must be entered in Latin only.\n\nIf there is no trailer, the value `null` must be transferred.\n"},"sealNumber":{"type":"string","maxLength":20,"nullable":true,"description":"Seal number.\n\nIf the seal number is not yet known at the moment of creation, `null` must be transferred and updated later.\n"},"dateOfSealing":{"type":"string","format":"date-time","nullable":true,"description":"Date and time of vehicle sealing.\n\nIf sealing information is not yet known at the moment of creation, `null` must be transferred and updated later.\n"},"documents":{"type":"array","description":"Array of pre-created manifests.\n","items":{"type":"object","required":["number","type"],"properties":{"number":{"type":"string","maxLength":50,"description":"Manifest number.\n\nThe parameter may contain either:\n- partner manifest number (`partnerNumber`)\n- unique manifest number in the EuroGate system (`number`)\n"},"type":{"type":"string","enum":["Manifest"],"description":"Document type.\nThe parameter must contain the value `Manifest`.\n"}}}},"numberMrn":{"type":"string","maxLength":20,"nullable":true,"description":"MRN T1 number.\n\nIf shipments are transported under CarnetTIR, the value `null` must be transferred.\n"},"carnetTir":{"type":"string","maxLength":20,"nullable":true,"description":"CarnetTIR number.\n\nIf shipments are transported under T1, the value `null` must be transferred.\n"},"externalNumber":{"type":"string","maxLength":20,"nullable":true,"description":"Optional external number.\n\nThis parameter is not required for current integration scenarios.\n"},"senderNote":{"type":"string","maxLength":50,"nullable":true,"description":"Optional sender note.\n\nThis parameter is not required for current integration scenarios.\n"},"recipientNote":{"type":"string","maxLength":50,"nullable":true,"description":"Optional recipient note.\n\nThis parameter is not required for current integration scenarios.\n"},"carrierNote":{"type":"string","maxLength":200,"nullable":true,"description":"Optional carrier note.\n\nThis parameter is not required for current integration scenarios.\n"}}}}}},"responses":{"200":{"description":"Response to a successful request.","content":{"application/json":{"schema":{"type":"object","properties":{"documents":{"type":"array","description":"Array of processed or generated documents associated with the CMR.","items":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the document."},"number":{"type":"string","description":"Unique manifest or document number in the system."},"type":{"type":"string","description":"Type of the document (e.g., Manifest)."},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the document was created."},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp when the document was last updated."},"deletedAt":{"type":"string","format":"date-time","nullable":true,"description":"Timestamp when the document was deleted, if applicable."}}}},"number":{"type":"string","description":"Unique CMR number in the EuroGate system."},"partnerNumber":{"type":"string","description":"The unique partner CMR number generated in the partner system."},"status":{"type":"string","description":"Current operational status of the CMR (e.g., Created)."},"senderCompanyTin":{"type":"string","description":"The sender's company TIN code."},"senderCompanyName":{"type":"string","description":"Full name of the shipper's organization."},"senderCompanyLegalAddress":{"type":"string","description":"The registered legal address of the sender."},"senderCompanyPhone":{"type":"string","nullable":true,"description":"Contact phone number of the sender's company."},"senderCountryCode":{"type":"string","pattern":"^[A-Z]{2}$","description":"Sender's country code (Alpha-2)."},"senderCityCode":{"type":"string","description":"System or postal code for the sender's city."},"senderDivisionId":{"type":"integer","description":"Identifier of the sender's division."},"senderAddress":{"type":"string","description":"Full physical address or loading location for the sender."},"recipientCompanyTin":{"type":"string","description":"The recipient's company TIN code."},"recipientCompanyName":{"type":"string","description":"Full name of the consignee's organization."},"recipientCompanyLegalAddress":{"type":"string","description":"The registered legal address of the recipient."},"recipientCountryCode":{"type":"string","pattern":"^[A-Z]{2}$","description":"Recipient's country code (Alpha-2)."},"recipientCityCode":{"type":"string","description":"System or postal code for the recipient's city."},"recipientDivisionId":{"type":"integer","description":"Identifier of the recipient's division."},"recipientAddress":{"type":"string","description":"Full physical address or unloading location for the recipient."},"loadingDateTime":{"type":"string","format":"date-time","description":"Date and time of vehicle loading."},"customsRecipient":{"type":"string","description":"Recipient customs details and office codes."},"carrierTin":{"type":"string","description":"TIN code of the carrier company."},"carrierName":{"type":"string","nullable":true,"description":"Name of the freight carrier."},"vehicleNumber":{"type":"string","nullable":true,"description":"Main vehicle registration number."},"trailerNumber":{"type":"string","nullable":true,"description":"Trailer registration number."},"sealNumber":{"type":"string","nullable":true,"description":"Number of the applied mechanical seal."},"dateOfSealing":{"type":"string","format":"date-time","nullable":true,"description":"Date and time when the vehicle was sealed."},"userCreate":{"type":"string","format":"uuid","description":"Identifier (UUID) of the user who created the record."},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the CMR record was created."},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp when the CMR record was last updated."},"deletedAt":{"type":"string","format":"date-time","nullable":true,"description":"Timestamp when the CMR record was deleted."},"externalNumber":{"type":"string","nullable":true,"description":"Optional external reference number."},"numberMrn":{"type":"string","nullable":true,"description":"MRN T1 declaration number."},"rampDestinationTime":{"type":"string","format":"date-time","nullable":true,"description":"Estimated or actual time of arrival at the loading ramp."},"rampDepartureTime":{"type":"string","format":"date-time","nullable":true,"description":"Estimated or actual time of departure from the loading ramp."},"unloadingRampDestinationTime":{"type":"string","format":"date-time","nullable":true,"description":"Estimated or actual time of arrival at the unloading ramp."},"unloadingRampDepartureTime":{"type":"string","format":"date-time","nullable":true,"description":"Estimated or actual time of departure from the unloading ramp."},"actualWeight":{"type":"number","description":"Total actual weight of the cargo in kilograms or grams."},"senderNote":{"type":"string","nullable":true,"description":"Informational notes or comments provided by the sender."},"recipientNote":{"type":"string","nullable":true,"description":"Informational notes or comments provided by the recipient."},"carrierNote":{"type":"string","nullable":true,"description":"Informational notes or comments provided by the carrier."},"carnetTir":{"type":"string","nullable":true,"description":"CarnetTIR transit document number."},"parcelsAmount":{"type":"integer","description":"Total number of parcels included in the CMR."},"shipmentAmount":{"type":"integer","description":"Total number of shipments combined in this document."},"transferOfCustomsData":{"type":"string","nullable":true,"description":"Status or confirmation reference of customs data transmission."}}}}}}}}}}}
```

## Update CMR

> This method allows users to update an existing CMR document in the EuroGate system with sender, recipient, carrier, customs, and transport information.\
> \
> The \`{number}\` path parameter can contain either:\
> \- the partner CMR number (\`partnerNumber\`), or\
> \- the unique CMR number in the EuroGate system (\`number\`).\
> \
> In response to a successful request, the complete object will be received from the EuroGate system.\
> \
> ℹ️ \*\*Information:\*\* \</br>\
> If the vehicle has not yet been loaded or sealed at the moment of updating the CMR, the related parameters may contain the value \`null\`.\
> The data can be updated later after the actual loading or sealing is completed.<br>

```json
{"openapi":"3.0.0","info":{"title":"API Nova Post","version":"1.0.0"},"tags":[],"servers":[{"description":"sandbox","url":"https://api-stage.novapost.com/v.1.0/"},{"description":"production","url":"https://api.novapost.com/v.1.0/"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"Authorization","description":"Authorization JWT-token with a lifetime of 1 hour in header"}}},"paths":{"/cmrs/{number}":{"put":{"tags":["Customs Integration"],"summary":"Update CMR","description":"This method allows users to update an existing CMR document in the EuroGate system with sender, recipient, carrier, customs, and transport information.\n\nThe `{number}` path parameter can contain either:\n- the partner CMR number (`partnerNumber`), or\n- the unique CMR number in the EuroGate system (`number`).\n\nIn response to a successful request, the complete object will be received from the EuroGate system.\n\nℹ️ **Information:** </br>\nIf the vehicle has not yet been loaded or sealed at the moment of updating the CMR, the related parameters may contain the value `null`.\nThe data can be updated later after the actual loading or sealing is completed.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["senderCompanyTin","senderDivisionId","recipientCompanyTin","recipientDivisionId","loadingDateTime","customsRecipient","carrierTin","vehicleNumber","trailerNumber","sealNumber","dateOfSealing","numberMrn","carnetTir"],"properties":{"senderCompanyTin":{"type":"string","maxLength":20,"description":"The sender company's TIN code agreed upon with the manager responsible for integration.\n"},"senderDivisionId":{"type":"integer","description":"Sender division identifier agreed upon with the manager responsible for integration.\n"},"senderCompanyName":{"type":"string","nullable":true,"maxLength":200,"description":"Name of the shipper organization.\n\nFill in this field if `senderCompanyTin == null` or the value is not found in the directory.\n"},"senderAddress":{"type":"string","nullable":true,"maxLength":255,"description":"Loading address.\n\nFill in this field if `senderDivisionId == null` or the value is not found in the directory.\n"},"senderCompanyLegalAddress":{"type":"string","nullable":true,"maxLength":255,"description":"Registered address of the sender legal entity.\n\nFill in this field if `senderCompanyTin == null` or the value is not found in the directory.\n"},"senderCountry":{"type":"string","nullable":true,"pattern":"^[A-Z]{2}$","description":"Sender country code according to the Alpha-2 standard.\n\nFill in this field if `senderDivisionId == null` or the value is not found in the directory.\n"},"recipientCompanyTin":{"type":"string","maxLength":20,"description":"The recipient company's TIN code agreed upon with the manager responsible for integration.\n"},"recipientDivisionId":{"type":"integer","description":"Recipient division identifier agreed upon with the manager responsible for integration.\n"},"recipientCompanyName":{"type":"string","nullable":true,"maxLength":200,"description":"Name of the consignee organization.\n\nFill in this field if `recipientCompanyTin == null` or the value is missing from the directory.\n"},"recipientAddress":{"type":"string","nullable":true,"maxLength":255,"description":"Unloading address.\n\nFill in this field if `recipientDivisionId == null` or the value is missing from the directory.\n"},"recipientCompanyLegalAddress":{"type":"string","nullable":true,"maxLength":255,"description":"Registered address of the recipient legal entity.\n\nFill in this field if `recipientCompanyTin == null` or the value is missing from the directory.\n"},"recipientCountry":{"type":"string","nullable":true,"pattern":"^[A-Z]{2}$","description":"Recipient country code according to the Alpha-2 standard.\n\nFill in this field if `recipientDivisionId == null` or the value is missing from the directory.\n"},"loadingDateTime":{"type":"string","format":"date-time","nullable":true,"description":"Date and time of vehicle loading.\n\nIf the vehicle has not yet been loaded at the time of updating the CMR, the value `null` must be transferred and updated later after loading.\n"},"customsRecipient":{"type":"string","maxLength":255,"description":"Recipient customs details agreed upon with the manager responsible for integration.\n"},"carrierTin":{"type":"string","maxLength":20,"description":"TIN code of the carrier company agreed upon with the manager responsible for integration.\n"},"carrierName":{"type":"string","nullable":true,"maxLength":200,"description":"Name of the freight carrier.\n\nFill in this field if `carrierTin == null` or the value is not found in the directory.\n"},"vehicleNumber":{"type":"string","maxLength":20,"description":"Vehicle number.\n\nLetters must be entered in Latin only.\n"},"trailerNumber":{"type":"string","nullable":true,"maxLength":20,"description":"Trailer number.\n\nLetters must be entered in Latin only.\n\nIf there is no trailer, the value `null` must be transferred.\n"},"sealNumber":{"type":"string","nullable":true,"maxLength":20,"description":"Seal number.\n\nIf the seal number is not yet known at the time of updating the CMR, the value `null` must be transferred and updated later.\n"},"dateOfSealing":{"type":"string","format":"date-time","nullable":true,"description":"Date and time of vehicle sealing.\n\nIf the seal number and sealing time are not yet known at the time of updating the CMR, the value `null` must be transferred and updated later.\n"},"numberMrn":{"type":"string","nullable":true,"maxLength":20,"description":"MRN T1 number.\n\nIf shipments are transported under CarnetTIR, the value `null` must be transferred.\n"},"carnetTir":{"type":"string","nullable":true,"maxLength":20,"description":"CarnetTIR number.\n\nIf shipments are transported under T1, the value `null` must be transferred.\n"},"externalNumber":{"type":"string","nullable":true,"maxLength":20,"description":"Optional external number.\n\nThis parameter is optional and is not required for the integration.\nThe `null` value is shown in the example only to demonstrate the request structure.\n"},"senderNote":{"type":"string","nullable":true,"maxLength":50,"description":"Optional sender note.\n\nThis parameter is optional and is not required for the integration.\nThe `null` value is shown in the example only to demonstrate the request structure.\n"},"recipientNote":{"type":"string","nullable":true,"maxLength":50,"description":"Optional recipient note.\n\nThis parameter is optional and is not required for the integration.\nThe `null` value is shown in the example only to demonstrate the request structure.\n"},"carrierNote":{"type":"string","nullable":true,"maxLength":200,"description":"Optional carrier note.\n\nThis parameter is optional and is not required for the integration.\nThe `null` value is shown in the example only to demonstrate the request structure.\n"}}}}}},"responses":{"200":{"description":"Successfully updated CMR object returned from the EuroGate system.","content":{"application/json":{"schema":{"type":"object","properties":{"documents":{"type":"array","description":"List of documents linked to the CMR.","items":{"type":"object","properties":{"id":{"type":"integer","description":"Unique document identifier."},"number":{"type":"string","description":"Unique document number."},"type":{"type":"string","description":"Document type."},"createdAt":{"type":"string","format":"date-time","description":"Document creation date and time."},"updatedAt":{"type":"string","format":"date-time","description":"Document update date and time."},"deletedAt":{"type":"string","nullable":true,"description":"Document deletion date and time."}}}},"number":{"type":"string","description":"Unique CMR number in the EuroGate system."},"partnerNumber":{"type":"string","description":"Partner CMR number."},"status":{"type":"string","description":"Current CMR status."},"senderCompanyTin":{"type":"string","description":"Sender company TIN."},"senderCompanyName":{"type":"string","description":"Sender company name."},"senderCompanyLegalAddress":{"type":"string","description":"Sender legal address."},"senderCompanyPhone":{"type":"string","nullable":true,"description":"Sender company phone number."},"senderCountryCode":{"type":"string","description":"Sender country code."},"senderCityCode":{"type":"string","description":"Sender city code."},"senderDivisionId":{"type":"integer","description":"Sender division identifier."},"senderAddress":{"type":"string","description":"Sender address."},"recipientCompanyTin":{"type":"string","description":"Recipient company TIN."},"recipientCompanyName":{"type":"string","description":"Recipient company name."},"recipientCompanyLegalAddress":{"type":"string","description":"Recipient legal address."},"recipientCountryCode":{"type":"string","description":"Recipient country code."},"recipientCityCode":{"type":"string","description":"Recipient city code."},"recipientDivisionId":{"type":"integer","description":"Recipient division identifier."},"recipientAddress":{"type":"string","description":"Recipient address."},"loadingDateTime":{"type":"string","format":"date-time","description":"Vehicle loading date and time."},"customsRecipient":{"type":"string","description":"Customs recipient details."},"carrierTin":{"type":"string","description":"Carrier company TIN."},"carrierName":{"type":"string","nullable":true,"description":"Carrier company name."},"vehicleNumber":{"type":"string","nullable":true,"description":"Vehicle number."},"trailerNumber":{"type":"string","nullable":true,"description":"Trailer number."},"sealNumber":{"type":"string","nullable":true,"description":"Seal number."},"dateOfSealing":{"type":"string","format":"date-time","nullable":true,"description":"Vehicle sealing date and time."},"userCreate":{"type":"string","description":"Identifier of the user who created the CMR."},"createdAt":{"type":"string","format":"date-time","description":"CMR creation date and time."},"updatedAt":{"type":"string","format":"date-time","description":"CMR update date and time."},"deletedAt":{"type":"string","nullable":true,"description":"CMR deletion date and time."},"externalNumber":{"type":"string","nullable":true,"description":"External number."},"numberMrn":{"type":"string","nullable":true,"description":"MRN T1 number."},"rampDestinationTime":{"type":"string","format":"date-time","nullable":true,"description":"Ramp destination time."},"rampDepartureTime":{"type":"string","format":"date-time","nullable":true,"description":"Ramp departure time."},"unloadingRampDestinationTime":{"type":"string","format":"date-time","nullable":true,"description":"Unloading ramp destination time."},"unloadingRampDepartureTime":{"type":"string","format":"date-time","nullable":true,"description":"Unloading ramp departure time."},"actualWeight":{"type":"integer","description":"Actual shipment weight."},"senderNote":{"type":"string","nullable":true,"description":"Sender note."},"recipientNote":{"type":"string","nullable":true,"description":"Recipient note."},"carrierNote":{"type":"string","nullable":true,"description":"Carrier note."},"carnetTir":{"type":"string","nullable":true,"description":"CarnetTIR number."},"parcelsAmount":{"type":"integer","description":"Number of parcels."},"shipmentAmount":{"type":"integer","description":"Number of shipments."},"transferOfCustomsData":{"type":"string","nullable":true,"description":"Customs data transfer status."}}}}}}}}}}}
```

## Delete CMR

> This method allows users to delete a CMR in the EuroGate system, where a successful response contains the deletion timestamp.<br>

```json
{"openapi":"3.0.0","info":{"title":"API Nova Post","version":"1.0.0"},"tags":[],"servers":[{"description":"sandbox","url":"https://api-stage.novapost.com/v.1.0/"},{"description":"production","url":"https://api.novapost.com/v.1.0/"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"Authorization","description":"Authorization JWT-token with a lifetime of 1 hour in header"}}},"paths":{"/cmrs/{number}":{"delete":{"tags":["Customs Integration"],"summary":"Delete CMR","description":"This method allows users to delete a CMR in the EuroGate system, where a successful response contains the deletion timestamp.\n","parameters":[{"name":"number","in":"path","required":true,"schema":{"type":"string","maxLength":50},"description":"CMR identifier.\n\nThe parameter can contain either:\n- the partner CMR number (`partnerNumber`), or\n- the unique CMR number in the EuroGate system (`number`).\n"}],"responses":{"200":{"description":"CMR successfully deleted.","content":{"application/json":{"schema":{"type":"object","properties":{"deletedAt":{"type":"string","format":"date-time","description":"Date and time when the CMR was deleted."}}}}}}}}}}}
```

## Add additional manifests to CMR

> This method allows users to add additional pre-created manifests to an existing CMR in the EuroGate system.\
> \
> In response to a successful request, the complete object will be received from the EuroGate system.<br>

```json
{"openapi":"3.0.0","info":{"title":"API Nova Post","version":"1.0.0"},"tags":[],"servers":[{"description":"sandbox","url":"https://api-stage.novapost.com/v.1.0/"},{"description":"production","url":"https://api.novapost.com/v.1.0/"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"Authorization","description":"Authorization JWT-token with a lifetime of 1 hour in header"}}},"paths":{"/cmrs/documents/{number}":{"post":{"tags":["Customs Integration"],"summary":"Add additional manifests to CMR","description":"This method allows users to add additional pre-created manifests to an existing CMR in the EuroGate system.\n\nIn response to a successful request, the complete object will be received from the EuroGate system.\n","parameters":[{"name":"number","in":"path","required":true,"schema":{"type":"string"},"description":"CMR identifier.\n\nThe parameter can contain either:\n- the partner CMR number (`partnerNumber`), or\n- the unique CMR number in the EuroGate system (`number`).\n"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["documents"],"properties":{"documents":{"type":"array","description":"Array of pre-created manifests.\n","items":{"type":"object","required":["number","type"],"properties":{"number":{"type":"string","maxLength":50,"description":"Manifest identifier.\n\nThe parameter can contain either:\n- the partner manifest number (`partnerNumber`), or\n- the unique manifest number in the EuroGate system (`number`).\n"},"type":{"type":"string","enum":["Manifest"],"description":"Manifest type.\n\nThe parameter must always contain the value `Manifest`.\n"}}}}}}}}},"responses":{"200":{"description":"Successfully updated CMR object returned from the EuroGate system.","content":{"application/json":{"schema":{"type":"object","properties":{"documents":{"type":"array","description":"List of documents linked to the CMR.","items":{"type":"object","properties":{"id":{"type":"integer","description":"Unique document identifier."},"number":{"type":"string","description":"Unique document number."},"type":{"type":"string","description":"Document type."},"createdAt":{"type":"string","format":"date-time","description":"Document creation date and time."},"updatedAt":{"type":"string","format":"date-time","description":"Document update date and time."},"deletedAt":{"type":"string","nullable":true,"description":"Document deletion date and time."}}}},"number":{"type":"string","description":"Unique CMR number in the EuroGate system."},"partnerNumber":{"type":"string","description":"Partner CMR number."},"status":{"type":"string","description":"Current CMR status."},"senderCompanyTin":{"type":"string","description":"Sender company TIN."},"senderCompanyName":{"type":"string","description":"Sender company name."},"senderCompanyLegalAddress":{"type":"string","description":"Sender legal address."},"senderCompanyPhone":{"type":"string","nullable":true,"description":"Sender company phone number."},"senderCountryCode":{"type":"string","description":"Sender country code."},"senderCityCode":{"type":"string","description":"Sender city code."},"senderDivisionId":{"type":"integer","description":"Sender division identifier."},"senderAddress":{"type":"string","description":"Sender address."},"recipientCompanyTin":{"type":"string","description":"Recipient company TIN."},"recipientCompanyName":{"type":"string","description":"Recipient company name."},"recipientCompanyLegalAddress":{"type":"string","description":"Recipient legal address."},"recipientCountryCode":{"type":"string","description":"Recipient country code."},"recipientCityCode":{"type":"string","description":"Recipient city code."},"recipientDivisionId":{"type":"integer","description":"Recipient division identifier."},"recipientAddress":{"type":"string","description":"Recipient address."},"loadingDateTime":{"type":"string","format":"date-time","description":"Vehicle loading date and time."},"customsRecipient":{"type":"string","description":"Customs recipient details."},"carrierTin":{"type":"string","description":"Carrier company TIN."},"carrierName":{"type":"string","nullable":true,"description":"Carrier company name."},"vehicleNumber":{"type":"string","nullable":true,"description":"Vehicle number."},"trailerNumber":{"type":"string","nullable":true,"description":"Trailer number."},"sealNumber":{"type":"string","nullable":true,"description":"Seal number."},"dateOfSealing":{"type":"string","format":"date-time","nullable":true,"description":"Vehicle sealing date and time."},"userCreate":{"type":"string","description":"Identifier of the user who created the CMR."},"createdAt":{"type":"string","format":"date-time","description":"CMR creation date and time."},"updatedAt":{"type":"string","format":"date-time","description":"CMR update date and time."},"deletedAt":{"type":"string","nullable":true,"description":"CMR deletion date and time."},"externalNumber":{"type":"string","nullable":true,"description":"External number."},"numberMrn":{"type":"string","nullable":true,"description":"MRN T1 number."},"rampDestinationTime":{"type":"string","format":"date-time","nullable":true,"description":"Ramp destination time."},"rampDepartureTime":{"type":"string","format":"date-time","nullable":true,"description":"Ramp departure time."},"unloadingRampDestinationTime":{"type":"string","format":"date-time","nullable":true,"description":"Unloading ramp destination time."},"unloadingRampDepartureTime":{"type":"string","format":"date-time","nullable":true,"description":"Unloading ramp departure time."},"actualWeight":{"type":"integer","description":"Actual shipment weight."},"senderNote":{"type":"string","nullable":true,"description":"Sender note."},"recipientNote":{"type":"string","nullable":true,"description":"Recipient note."},"carrierNote":{"type":"string","nullable":true,"description":"Carrier note."},"carnetTir":{"type":"string","nullable":true,"description":"CarnetTIR number."},"parcelsAmount":{"type":"integer","description":"Number of parcels."},"shipmentAmount":{"type":"integer","description":"Number of shipments."},"transferOfCustomsData":{"type":"string","nullable":true,"description":"Customs data transfer status."}}}}}}}}}}}
```

## Delete manifests from CMR

> This method allows users to delete manifests linked to an existing CMR in the EuroGate system.\
> \
> In response to a successful request, the complete object will be received from the EuroGate system.<br>

```json
{"openapi":"3.0.0","info":{"title":"API Nova Post","version":"1.0.0"},"tags":[],"servers":[{"description":"sandbox","url":"https://api-stage.novapost.com/v.1.0/"},{"description":"production","url":"https://api.novapost.com/v.1.0/"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"Authorization","description":"Authorization JWT-token with a lifetime of 1 hour in header"}}},"paths":{"/cmrs/documents/{number}":{"delete":{"tags":["Customs Integration"],"summary":"Delete manifests from CMR","description":"This method allows users to delete manifests linked to an existing CMR in the EuroGate system.\n\nIn response to a successful request, the complete object will be received from the EuroGate system.\n","parameters":[{"name":"number","in":"path","required":true,"schema":{"type":"string"},"description":"CMR identifier.\n\nThe parameter can contain either:\n- the partner CMR number (`partnerNumber`), or\n- the unique CMR number in the EuroGate system (`number`).\n"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["documents"],"properties":{"documents":{"type":"array","description":"Array of pre-created manifests.\n","items":{"type":"object","required":["number","type"],"properties":{"number":{"type":"string","maxLength":50,"description":"Manifest identifier.\n\nThe parameter can contain either:\n- the partner manifest number (`partnerNumber`), or\n- the unique manifest number in the EuroGate system (`number`).\n"},"type":{"type":"string","enum":["Manifest"],"description":"Manifest type.\n\nThe parameter must always contain the value `Manifest`.\n"}}}}}}}}},"responses":{"200":{"description":"Successfully updated CMR object returned from the EuroGate system.","content":{"application/json":{"schema":{"type":"object","properties":{"documents":{"type":"array","description":"List of documents linked to the CMR.","items":{"type":"object","properties":{"id":{"type":"integer","description":"Unique document identifier."},"number":{"type":"string","description":"Unique document number."},"type":{"type":"string","description":"Document type."},"createdAt":{"type":"string","format":"date-time","description":"Document creation date and time."},"updatedAt":{"type":"string","format":"date-time","description":"Document update date and time."},"deletedAt":{"type":"string","nullable":true,"description":"Document deletion date and time."}}}},"number":{"type":"string","description":"Unique CMR number in the EuroGate system."},"partnerNumber":{"type":"string","description":"Partner CMR number."},"status":{"type":"string","description":"Current CMR status."},"senderCompanyTin":{"type":"string","description":"Sender company TIN."},"senderCompanyName":{"type":"string","description":"Sender company name."},"senderCompanyLegalAddress":{"type":"string","description":"Sender legal address."},"senderCompanyPhone":{"type":"string","nullable":true,"description":"Sender company phone number."},"senderCountryCode":{"type":"string","description":"Sender country code."},"senderCityCode":{"type":"string","description":"Sender city code."},"senderDivisionId":{"type":"integer","description":"Sender division identifier."},"senderAddress":{"type":"string","description":"Sender address."},"recipientCompanyTin":{"type":"string","description":"Recipient company TIN."},"recipientCompanyName":{"type":"string","description":"Recipient company name."},"recipientCompanyLegalAddress":{"type":"string","description":"Recipient legal address."},"recipientCountryCode":{"type":"string","description":"Recipient country code."},"recipientCityCode":{"type":"string","description":"Recipient city code."},"recipientDivisionId":{"type":"integer","description":"Recipient division identifier."},"recipientAddress":{"type":"string","description":"Recipient address."},"loadingDateTime":{"type":"string","format":"date-time","description":"Vehicle loading date and time."},"customsRecipient":{"type":"string","description":"Customs recipient details."},"carrierTin":{"type":"string","description":"Carrier company TIN."},"carrierName":{"type":"string","nullable":true,"description":"Carrier company name."},"vehicleNumber":{"type":"string","nullable":true,"description":"Vehicle number."},"trailerNumber":{"type":"string","nullable":true,"description":"Trailer number."},"sealNumber":{"type":"string","nullable":true,"description":"Seal number."},"dateOfSealing":{"type":"string","format":"date-time","nullable":true,"description":"Vehicle sealing date and time."},"userCreate":{"type":"string","description":"Identifier of the user who created the CMR."},"createdAt":{"type":"string","format":"date-time","description":"CMR creation date and time."},"updatedAt":{"type":"string","format":"date-time","description":"CMR update date and time."},"deletedAt":{"type":"string","nullable":true,"description":"CMR deletion date and time."},"externalNumber":{"type":"string","nullable":true,"description":"External number."},"numberMrn":{"type":"string","nullable":true,"description":"MRN T1 number."},"rampDestinationTime":{"type":"string","format":"date-time","nullable":true,"description":"Ramp destination time."},"rampDepartureTime":{"type":"string","format":"date-time","nullable":true,"description":"Ramp departure time."},"unloadingRampDestinationTime":{"type":"string","format":"date-time","nullable":true,"description":"Unloading ramp destination time."},"unloadingRampDepartureTime":{"type":"string","format":"date-time","nullable":true,"description":"Unloading ramp departure time."},"actualWeight":{"type":"integer","description":"Actual shipment weight."},"senderNote":{"type":"string","nullable":true,"description":"Sender note."},"recipientNote":{"type":"string","nullable":true,"description":"Recipient note."},"carrierNote":{"type":"string","nullable":true,"description":"Carrier note."},"carnetTir":{"type":"string","nullable":true,"description":"CarnetTIR number."},"parcelsAmount":{"type":"integer","description":"Number of parcels."},"shipmentAmount":{"type":"integer","description":"Number of shipments."},"transferOfCustomsData":{"type":"string","nullable":true,"description":"Customs data transfer status."}}}}}}}}}}}
```

## Get printed CMR form

> This method allows users to get printed CMR forms generated in the EuroGate system, where one or multiple CMR print forms can be downloaded in \`.pdf\` or \`.docx\` format.\
> \
> The generated file is returned encoded in Base64.<br>

```json
{"openapi":"3.0.0","info":{"title":"API Nova Post","version":"1.0.0"},"tags":[],"servers":[{"description":"sandbox","url":"https://api-stage.novapost.com/v.1.0/"},{"description":"production","url":"https://api.novapost.com/v.1.0/"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"Authorization","description":"Authorization JWT-token with a lifetime of 1 hour in header"}}},"paths":{"/cmrs/prints":{"get":{"tags":["Customs Integration"],"summary":"Get printed CMR form","description":"This method allows users to get printed CMR forms generated in the EuroGate system, where one or multiple CMR print forms can be downloaded in `.pdf` or `.docx` format.\n\nThe generated file is returned encoded in Base64.\n","parameters":[{"name":"numbers[]","in":"query","required":true,"schema":{"type":"array","items":{"type":"string","maxLength":50}},"description":"List of CMR identifiers.\n\nEach value can contain either:\n- the partner CMR number (`partnerNumber`), or\n- the unique CMR number in the EuroGate system (`number`).\n"},{"name":"format","in":"query","required":true,"schema":{"type":"string","enum":["Pdf","Docx"]},"description":"Output file format of the generated print form.\n"},{"name":"weightPrecision","in":"query","required":false,"schema":{"type":"integer"},"description":"Number of decimal places used for weight values in the printed document.\n\nIf the parameter is not specified, the default precision is `2` decimal places.\n\nIf the value `3` is specified, the print form returns weight values with `3` decimal places.\n"}],"responses":{"200":{"description":"Printed CMR form successfully generated.","content":{"application/json":{"schema":{"type":"object","properties":{"file":{"type":"string","description":"Base64-encoded printed CMR form."},"format":{"type":"string","description":"Generated file format.","enum":["Pdf","Docx"]}}}}}}}}}}}
```

## Create manifests archive file

> This method allows users to create an archive file containing printed manifests linked to the specified CMRs, where the archive can be generated in \`.pdf\` or \`.xlsx\` format.\
> \
> After a successful response returns a \`fileId\` that can be used to check the file generation status in the next request.<br>

```json
{"openapi":"3.0.0","info":{"title":"API Nova Post","version":"1.0.0"},"tags":[],"servers":[{"description":"sandbox","url":"https://api-stage.novapost.com/v.1.0/"},{"description":"production","url":"https://api.novapost.com/v.1.0/"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"Authorization","description":"Authorization JWT-token with a lifetime of 1 hour in header"}}},"paths":{"/manifests-archive/file":{"post":{"tags":["Customs Integration"],"summary":"Create manifests archive file","description":"This method allows users to create an archive file containing printed manifests linked to the specified CMRs, where the archive can be generated in `.pdf` or `.xlsx` format.\n\nAfter a successful response returns a `fileId` that can be used to check the file generation status in the next request.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["format","cmrsNumbers"],"properties":{"format":{"type":"string","enum":["Pdf","Xlsx"],"description":"Output format of the generated archive file.\n"},"weightPrecision":{"type":"integer","description":"Number of decimal places used for weight values in the generated document.\n\nIf the parameter is not specified, the default precision is `2` decimal places.\n\nIf the value `3` is specified, the print form returns weight values with `3` decimal places.\n"},"cmrsNumbers":{"type":"array","description":"List of CMR identifiers.\n\nEach value can contain either:\n- the partner CMR number (`partnerNumber`), or\n- the unique CMR number in the EuroGate system (`number`).\n","items":{"type":"string","maxLength":50}}}}}}},"responses":{"200":{"description":"Archive generation request successfully created.","content":{"application/json":{"schema":{"type":"object","properties":{"fileId":{"type":"string","description":"Identifier of the generated archive file."}}}}}}}}}}}
```

## Get manifests archive file status

> This method allows users to retrieve the file creation status for previously requested manifests archive files.\
> \
> Once the file status changes to \`Finished\`, the response contains a download URL for the generated file.\
> \
> The generated file remains available until the \`expiredAt\` date and time.\
> After expiration, a new archive generation request must be created.<br>

```json
{"openapi":"3.0.0","info":{"title":"API Nova Post","version":"1.0.0"},"tags":[],"servers":[{"description":"sandbox","url":"https://api-stage.novapost.com/v.1.0/"},{"description":"production","url":"https://api.novapost.com/v.1.0/"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"Authorization","description":"Authorization JWT-token with a lifetime of 1 hour in header"}}},"paths":{"/manifests-archive/files/status":{"get":{"tags":["Customs Integration"],"summary":"Get manifests archive file status","description":"This method allows users to retrieve the file creation status for previously requested manifests archive files.\n\nOnce the file status changes to `Finished`, the response contains a download URL for the generated file.\n\nThe generated file remains available until the `expiredAt` date and time.\nAfter expiration, a new archive generation request must be created.\n","parameters":[{"name":"ids[]","in":"query","required":true,"schema":{"type":"array","items":{"type":"string"}},"description":"List of archive file identifiers.\n"}],"responses":{"200":{"description":"File status information successfully retrieved.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"File identifier."},"status":{"type":"string","enum":["InProcess","Finished","NotFound"],"description":"File creation status.\n\nAvailable values:\n- `InProcess` — file is being generated.\n- `Finished` — file is ready for download.\n- `NotFound` — file with the specified identifier was not found.\n"},"url":{"type":"string","nullable":true,"description":"Download link for the generated file.\n\nThe field appears only when the file status is `Finished`.\n"},"expiredAt":{"type":"string","format":"date-time","nullable":true,"description":"Date and time when the file will no longer be available for download.\n\nAfter the specified time, a new request must be created to generate printed forms again.\n"}}}}}}}}}}}}
```

## Create “List of Manifests” archive file

> This method allows users to create a printable “List of Manifests” file for the specified CMR, where the file can be generated in \`.pdf\` or \`.xlsx\` format.\
> \
> After a successful response returns a \`fileId\` that can be used to check the file generation status in the next request.<br>

```json
{"openapi":"3.0.0","info":{"title":"API Nova Post","version":"1.0.0"},"tags":[],"servers":[{"description":"sandbox","url":"https://api-stage.novapost.com/v.1.0/"},{"description":"production","url":"https://api.novapost.com/v.1.0/"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"Authorization","description":"Authorization JWT-token with a lifetime of 1 hour in header"}}},"paths":{"/list-of-manifests-archive/file":{"post":{"tags":["Customs Integration"],"summary":"Create “List of Manifests” archive file","description":"This method allows users to create a printable “List of Manifests” file for the specified CMR, where the file can be generated in `.pdf` or `.xlsx` format.\n\nAfter a successful response returns a `fileId` that can be used to check the file generation status in the next request.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["format","cmrNumberOrPartnerNumber"],"properties":{"format":{"type":"string","enum":["Pdf","Xlsx"],"description":"Output format of the generated file.\n"},"cmrNumberOrPartnerNumber":{"type":"string","maxLength":50,"description":"CMR identifier.\n\nThe parameter can contain either:\n- the partner CMR number (`partnerNumber`), or\n- the unique CMR number in the EuroGate system (`number`).\n"},"weightPrecision":{"type":"integer","description":"Number of decimal places used for weight values in the generated document.\n\nIf the parameter is not specified, the default precision is `2` decimal places.\n\nIf the value `3` is specified, the print form returns weight values with `3` decimal places.\n"}}}}}},"responses":{"200":{"description":"File generation request successfully created.","content":{"application/json":{"schema":{"type":"object","properties":{"fileId":{"type":"string","description":"Identifier of the generated file."}}}}}}}}}}}
```

## Get “List of Manifests” file status

> This method allows users to retrieve the file creation status for previously requested “List of Manifests” files.\
> \
> Once the file status changes to \`Finished\`, the response contains a download URL for the generated file.\
> \
> The generated file remains available until the \`expiredAt\` date and time, after which a new file generation request must be created.<br>

```json
{"openapi":"3.0.0","info":{"title":"API Nova Post","version":"1.0.0"},"tags":[],"servers":[{"description":"sandbox","url":"https://api-stage.novapost.com/v.1.0/"},{"description":"production","url":"https://api.novapost.com/v.1.0/"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"Authorization","description":"Authorization JWT-token with a lifetime of 1 hour in header"}}},"paths":{"/list-of-manifests-archive/files/status":{"get":{"tags":["Customs Integration"],"summary":"Get “List of Manifests” file status","description":"This method allows users to retrieve the file creation status for previously requested “List of Manifests” files.\n\nOnce the file status changes to `Finished`, the response contains a download URL for the generated file.\n\nThe generated file remains available until the `expiredAt` date and time, after which a new file generation request must be created.\n","parameters":[{"name":"ids[]","in":"query","required":true,"schema":{"type":"array","items":{"type":"string"}},"description":"List of generated file identifiers.\n"}],"responses":{"200":{"description":"File status information successfully retrieved.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"File identifier."},"status":{"type":"string","enum":["InProcess","Finished","NotFound"],"description":"File creation status.\n\nAvailable values:\n- `InProcess` — file is being generated.\n- `Finished` — file is ready for download.\n- `NotFound` — file with the specified identifier was not found.\n"},"url":{"type":"string","nullable":true,"description":"Download link for the generated file.\n\nThe field appears only when the file status is `Finished`.\n"},"expiredAt":{"type":"string","format":"date-time","nullable":true,"description":"Date and time when the file will no longer be available for download.\n\nAfter the specified time, a new request must be created to generate the file again.\n"}}}}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://api-portal.novapost.com/metodi-1/methods/cmr.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.