> 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/registers.md). # Registers ## Get registries > The method allows the user to get information about their registries or registries related to their profile in the registry.\ > \ > 🔸Registries are automatically filtered by creation source (\`clientapi\` or \`bc\`) depending on the method used.\
\ > 🔸Shipments that were removed from the registry are not included in the response.\ > \ > 🔹\*\*Description of control elements:\*\*\ > \ > \*\*SCHEMA\*\*\
\ > Displays the full technical structure of the request or response, including field names, data types, required fields, allowed values, and validation rules.\ > \- \*\*Single line description\*\*\
\ > A description that fits into a single line; any text that does not fit remains hidden.\ > \- \*\*Multiline description\*\*\
\ > An expanded description that displays more than one line of text.\ > \ > \*\*EXAMPLE\*\*\
\ > Shows a ready-made sample JSON with correctly formatted values to demonstrate how a valid request or response should look.
```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"}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"The specified resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Validation":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Time-out":{"description":"Connection time-out","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","properties":{"errors":{"type":"object","properties":{"":{"type":"string"}}}}}}},"paths":{"/registry":{"get":{"tags":["Registers"],"summary":"Get registries","description":"The method allows the user to get information about their registries or registries related to their profile in the registry.\n\n🔸Registries are automatically filtered by creation source (`clientapi` or `bc`) depending on the method used.
\n🔸Shipments that were removed from the registry are not included in the response.\n\n🔹**Description of control elements:**\n\n**SCHEMA**
\nDisplays the full technical structure of the request or response, including field names, data types, required fields, allowed values, and validation rules.\n- **Single line description**
\n A description that fits into a single line; any text that does not fit remains hidden.\n- **Multiline description**
\n An expanded description that displays more than one line of text.\n\n**EXAMPLE**
\nShows a ready-made sample JSON with correctly formatted values to demonstrate how a valid request or response should look.\n","parameters":[{"in":"query","name":"isEURegistry","description":"Indicates that European registries should be returned.\n","schema":{"type":"boolean"}},{"in":"query","name":"ids[]","description":"Unique registry identifiers for which information should be retrieved. This parameter is required if the `numbers` parameter is not specified.","schema":{"type":"array","items":{"type":"string"}}},{"in":"query","name":"numbers[]","description":"Unique registry number for which information should be retrieved. This parameter is required if the `ids` parameter is not specified.","schema":{"type":"array","items":{"type":"string"}}},{"in":"query","name":"settlementIds[]","description":"Unique settlement identifier.","schema":{"type":"array","items":{"type":"string"}}},{"in":"query","name":"withShipmentsInfo","description":"When set to `true`, the response includes extended shipment information in the `shipmentsInfo` array.\n\nIf omitted or set to `false`, the response contains only `shipmentId` and `shipmentNumber` in the `shipments` array.\n","schema":{"type":"boolean"}},{"in":"query","name":"createdAtFrom","description":"Start date of the registry filtering period. Used to retrieve records created from this date onwards (inclusive). The `createdAtFrom` field must be a date before `createdAtTo`","schema":{"type":"string","format":"date"}},{"in":"query","name":"createdAtTo","description":"End date of the registry filtering period. Used to retrieve records created before this date (exclusive).","schema":{"type":"string","format":"date"}},{"in":"query","name":"page","description":"Number of page to return.","schema":{"type":"integer"}},{"in":"query","name":"limit","description":"Max number of items to return on page.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Registries list","content":{"application/json":{"schema":{"type":"object","properties":{"current_page":{"type":"integer","description":"Indicates the current page number in the paginated response.\n"},"last_page":{"type":"integer","description":"Total number of available pages calculated.\n"},"per_page":{"type":"integer","description":"Number of registry records returned per page.\n"},"total":{"type":"integer","description":"Total number of registries that match the request criteria.\n"},"items":{"type":"array","description":"Array of registry objects.\nEach registry aggregates shipments and related metadata.\n","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the registry generated by the system.\n"},"number":{"type":"string","description":"Registry number in the format:\nCR + country code + unique numeric identifier.\n"},"createdAt":{"type":"string","format":"date-time","description":"Date and time when the registry was created.\n"},"updatedAt":{"type":"string","format":"date-time","description":"Date and time of the last registry update.\n"},"deletedAt":{"type":"string","format":"date-time","description":"Date and time when the registry was deleted, if applicable.\n"},"posted":{"type":"boolean","description":"Indicates whether the registry has been posted (processed).\n- `true` — registry is processed\n- `false` — registry is not processed\n"},"printed":{"type":"boolean","description":"Indicates whether the registry has been printed.\n"},"description":{"type":"string","description":"User-defined name of the registry.\n"},"status":{"type":"string","description":"Current registry status.\n"},"type":{"type":"string","description":"Registry type.\nWhen created via API, the value is always `Client`.\n","enum":["Client"]},"createdByUser":{"type":"string","description":"Identifier of the user who created the registry.\n"},"scannedBarcodesAmount":{"type":"integer","description":"Number of shipments included in the registry.\n"},"source":{"type":"string","description":"Source of registry creation (for example, `clientapi`).\n"},"companyId":{"type":"string","description":"Company identification number.\n"},"companyTin":{"type":"string","description":"Company tax identification number.\n"},"companyName":{"type":"string","description":"Company name.\n"},"fullName":{"type":"string","description":"Full sender name from the first shipment in the registry.\n"},"phone":{"type":"string","description":"Sender phone number from the first shipment.\n"},"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country code of the sender.\n"},"country":{"type":"string","description":"Country of the sender.\n"},"settlementId":{"type":"string","description":"Sender settlement identifier.\n"},"settlementName":{"type":"string","description":"Sender settlement name.\n"},"divisionId":{"type":"string","description":"Sender division identifier.\n"},"divisionName":{"type":"string","description":"Sender division name.\n"},"address":{"type":"string","description":"Full sender address in text format.\n"},"addressParts":{"type":"object","description":"Structured address object containing detailed address information.\n\nUsed for accurate routing, pickup, delivery, and customs processing.\n","properties":{"city":{"type":"string","description":"City name."},"region":{"type":"string","description":"Region, province, or administrative area."},"street":{"type":"string","description":"Street name."},"streetId":{"type":"string","description":"Unique street identifier."},"postCode":{"type":"string","description":"Postal or ZIP code."},"building":{"type":"string","description":"Building number or name."},"flat":{"type":"string","description":"Apartment or unit number."},"block":{"type":"string","description":"Block or section of the building."},"latitude":{"type":"number","description":"Geographic latitude coordinate."},"longitude":{"type":"number","description":"Geographic longitude coordinate."},"note":{"type":"string","description":"Additional address details or instructions."},"addressId":{"type":"string","description":"Unique address identifier in the system."}}},"currencyCode":{"type":"string","description":"Currency code.\n"},"shipments":{"type":"array","description":"Array of shipment objects included in the registry.\n\nReturned when `withShipmentsInfo` is omitted or set to `false`.\n","items":{"type":"object","properties":{"shipmentId":{"type":"string","description":"Unique shipment identifier.\n"},"shipmentNumber":{"type":"string","description":"Shipment number.\n"}}}},"shipmentsInfo":{"type":"array","description":"Array of shipment objects included in the registry.\n\nReturned when `withShipmentsInfo=true`.\n","items":{"type":"object","properties":{"id":{"type":"string","description":"Shipment identifier."},"number":{"type":"string","description":"Shipment number."},"totalWeight":{"type":"integer","description":"Total shipment weight in grams."},"totalCost":{"type":"number","description":"Total shipment value."},"currencyCode":{"type":"string","description":"Shipment currency code."},"invoice":{"type":"boolean","description":"Indicates whether an invoice exists."}}}}}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Validation"},"503":{"$ref":"#/components/responses/Time-out"}}}}}} ``` ## Create a shipment registry > The method is used to create a \*\*client registry of shipments\*\*, which combines multiple shipments into a single document for further processing.\ > \ > This method is available for shipments \*\*from anywhere in the world to anywhere in the world\*\*.\ > \ > \*\*Limitations for working with registers:\*\*\ > 1\. A shipment can be added to a register only if the sender’s data (city, counterparty, address) are identical for all shipments being added.\ > 2\. A shipment can be added only to one register — the same document cannot be added to multiple registers simultaneously.\ > 3\. A shipment can be added to a register only until an express waybill has been created for it (or until the shipment has been scanned at a Nova Post branch/unit).\ > 4\. A shipment marked for deletion cannot be added to a register.\ > 5\. The maximum number of shipments in a single register is \*\*100\*\*.\ > \ > 🔹\*\*Description of control elements:\*\*\ > \ > \*\*SCHEMA\*\*\
\ > Displays the full technical structure of the request or response, including field names, data types, required fields, allowed values, and validation rules.\ > \- \*\*Single line description\*\*\
\ > A description that fits into a single line; any text that does not fit remains hidden.\ > \- \*\*Multiline description\*\*\
\ > An expanded description that displays more than one line of text.\ > \ > \*\*EXAMPLE\*\*\
\ > Shows a ready-made sample JSON with correctly formatted values to demonstrate how a valid request or response should look.
```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"}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"The specified resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Validation":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Time-out":{"description":"Connection time-out","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","properties":{"errors":{"type":"object","properties":{"":{"type":"string"}}}}}}},"paths":{"/registry":{"post":{"tags":["Registers"],"summary":"Create a shipment registry","description":"The method is used to create a **client registry of shipments**, which combines multiple shipments into a single document for further processing.\n\nThis method is available for shipments **from anywhere in the world to anywhere in the world**.\n\n**Limitations for working with registers:**\n1. A shipment can be added to a register only if the sender’s data (city, counterparty, address) are identical for all shipments being added.\n2. A shipment can be added only to one register — the same document cannot be added to multiple registers simultaneously.\n3. A shipment can be added to a register only until an express waybill has been created for it (or until the shipment has been scanned at a Nova Post branch/unit).\n4. A shipment marked for deletion cannot be added to a register.\n5. The maximum number of shipments in a single register is **100**.\n\n🔹**Description of control elements:**\n\n**SCHEMA**
\nDisplays the full technical structure of the request or response, including field names, data types, required fields, allowed values, and validation rules.\n- **Single line description**
\n A description that fits into a single line; any text that does not fit remains hidden.\n- **Multiline description**
\n An expanded description that displays more than one line of text.\n\n**EXAMPLE**
\nShows a ready-made sample JSON with correctly formatted values to demonstrate how a valid request or response should look.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["description","shipments"],"properties":{"description":{"type":"string","description":"Name of the registry."},"shipments":{"type":"array","description":"Array of unique shipment numbers for World parcels.\nEach shipment must belong to the same sender.\n","minItems":1,"maxItems":100,"uniqueItems":true,"items":{"type":"string","description":"Unique shipment number (World parcel)."}}},"description":"Registry creation request"}}}},"responses":{"200":{"description":"Registry successfully created.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the registry."},"number":{"type":"string","description":"Registry number in the format:\n`CR + alpha country code from the first shipment + unique number`.\n"},"versionTracking":{"type":"string","description":"Registry version tracking identifier."},"status":{"type":"string","description":"Registry status. After creation, the status is `Open`."},"createdAt":{"type":"string","format":"date-time","description":"Registry creation date."},"updatedAt":{"type":"string","format":"date-time","description":"Registry update date."},"deletedAt":{"type":"string","description":"Registry deletion date."},"posted":{"type":"boolean","description":"Registry posting status."},"printed":{"type":"boolean","description":"Registry printing status."},"scannedBarcodesAmount":{"type":"integer","description":"Number of shipments in the registry."},"forScanBarcodesAmount":{"type":"integer","description":"Number of shipments pending scanning."},"description":{"type":"string","description":"Registry name specified during creation."},"senderCompanyId":{"type":"string","description":"Sender company identifier."},"senderCompanyTin":{"type":"string","description":"Sender company TIN."},"senderPhone":{"type":"string","description":"Sender phone number."},"senderCountryCode":{"type":"string","description":"Sender country code in ISO 3166-1 alpha-2 format."},"senderSettlementId":{"type":"string","description":"Sender settlement identifier."},"senderSettlementExternalId":{"type":"string"},"senderSettlementName":{"type":"string","description":"Sender settlement name."},"senderDivisionId":{"type":"string","description":"Sender division identifier."},"senderDivisionExternalId":{"type":"string"},"senderDivisionName":{"type":"string","description":"Sender division name."},"senderAddress":{"type":"string","description":"Full sender address string."},"senderAddressParts":{"type":"object","description":"Structured sender address data.","properties":{"city":{"type":"string","description":"City name."},"region":{"type":"string","description":"Region or administrative area."},"street":{"type":"string","description":"Street name."},"streetId":{"type":"string","description":"Street identifier."},"postCode":{"type":"string","description":"Postal code."},"building":{"type":"string","description":"Building number."},"flat":{"type":"string","description":"Apartment or office number."},"block":{"type":"string","description":"Block or section."},"latitude":{"type":"number","format":"double","description":"Address latitude."},"longitude":{"type":"number","format":"double","description":"Address longitude."},"note":{"type":"string","description":"Additional address note."},"addressId":{"type":"string","description":"Address identifier."}}},"shipments":{"type":"array","description":"List of shipments added to the registry.","items":{"type":"object","properties":{"shipmentId":{"type":"string","description":"Unique shipment identifier."},"shipmentNumber":{"type":"string","description":"Unique shipment number."},"destinationDivision":{"type":"object","description":"Destination division information.","properties":{"name":{"type":"string","description":"Destination division name."},"id":{"type":"integer","description":"Destination division identifier."},"number":{"type":"string","description":"Destination division number."}}}}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Validation"},"503":{"$ref":"#/components/responses/Time-out"}}}}}} ``` ## Add shipments to registry > This method allows users to add a parcel to an existing shipment registry, which simplifies further shipping.\ > \ > The method supports:\ > \- European shipments (shipment numbers such as \`SHPL...\`)\ > \- Ukrainian shipments (MEN/ID identifiers)\ > \ > \*\*Limitations for working with registers:\*\*\ > \ > 1\. This method is available for shipments from anywhere in the world to anywhere in the world.\ > 2\. A shipment can be added to a register only if the sender’s data (city, counterparty, address) are identical for all shipments being added.\ > 4\. A shipment can be added to only one register — the same document cannot be added to multiple registers simultaneously.\ > 5\. A shipment can be added to a register only until an express waybill has been created for it (or until the shipment has been scanned at a Nova Poshta branch/unit).\ > 6\. A shipment marked for deletion cannot be added to a register.\ > 7\. The maximum number of shipments in a single register is \*\*100\*\*.\ > \ > This method is used to add already created shipments to an existing registry.\ > \ > 🔹\*\*Description of control elements:\*\*\ > \ > \*\*SCHEMA\*\*\
\ > Displays the full technical structure of the request or response, including field names, data types, required fields, allowed values, and validation rules.\ > \- \*\*Single line description\*\*\
\ > A description that fits into a single line; any text that does not fit remains hidden.\ > \- \*\*Multiline description\*\*\
\ > An expanded description that displays more than one line of text.\ > \ > \*\*EXAMPLE\*\*\
\ > Shows a ready-made sample JSON with correctly formatted values to demonstrate how a valid request or response should look.
```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"}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"The specified resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Validation":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Time-out":{"description":"Connection time-out","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","properties":{"errors":{"type":"object","properties":{"":{"type":"string"}}}}}}},"paths":{"/registry/{id}/shipments":{"post":{"tags":["Registers"],"summary":"Add shipments to registry","description":"This method allows users to add a parcel to an existing shipment registry, which simplifies further shipping.\n\nThe method supports:\n- European shipments (shipment numbers such as `SHPL...`)\n- Ukrainian shipments (MEN/ID identifiers)\n\n**Limitations for working with registers:**\n\n1. This method is available for shipments from anywhere in the world to anywhere in the world.\n2. A shipment can be added to a register only if the sender’s data (city, counterparty, address) are identical for all shipments being added.\n4. A shipment can be added to only one register — the same document cannot be added to multiple registers simultaneously.\n5. A shipment can be added to a register only until an express waybill has been created for it (or until the shipment has been scanned at a Nova Poshta branch/unit).\n6. A shipment marked for deletion cannot be added to a register.\n7. The maximum number of shipments in a single register is **100**.\n\nThis method is used to add already created shipments to an existing registry.\n\n🔹**Description of control elements:**\n\n**SCHEMA**
\nDisplays the full technical structure of the request or response, including field names, data types, required fields, allowed values, and validation rules.\n- **Single line description**
\n A description that fits into a single line; any text that does not fit remains hidden.\n- **Multiline description**
\n An expanded description that displays more than one line of text.\n\n**EXAMPLE**
\nShows a ready-made sample JSON with correctly formatted values to demonstrate how a valid request or response should look.\n","parameters":[{"in":"path","name":"id","required":true,"description":"Unique register identifier to which the shipment will be added.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["shipments"],"properties":{"shipments":{"type":"array","description":"Array of shipment identifiers that should be added to the registry.\nEach shipment must belong to the same sender.\n","minItems":1,"maxItems":100,"uniqueItems":true,"items":{"type":"string","description":"Unique shipment number."}}}}}}},"responses":{"200":{"description":"Registry","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the registry."},"number":{"type":"string","description":"Registry number."},"versionTracking":{"type":"integer","nullable":true,"description":"Registry version number."},"status":{"type":"string","description":"Registry status."},"createdAt":{"type":"string","format":"date-time","description":"Date of registry creation."},"updatedAt":{"type":"string","format":"date-time","description":"Date of registry update."},"deletedAt":{"type":"string","nullable":true,"description":"Date of registry deletion."},"posted":{"type":"boolean","description":"Mark of registry post."},"printed":{"type":"boolean","description":"Mark of registry print."},"scannedBarcodesAmount":{"type":"integer","description":"Number of shipments in the registry."},"description":{"type":"string","description":"User name of the registry."},"senderCompanyId":{"type":"string","nullable":true,"description":"Sender company identifier."},"senderCompanyTin":{"type":"string","description":"Sender company TIN."},"senderPhone":{"type":"string","description":"Sender phone number."},"senderCountryCode":{"type":"string","description":"Sender country code."},"senderSettlementId":{"type":"string","description":"Sender settlement identifier."},"senderSettlementExternalId":{"type":"string","nullable":true,"description":"External settlement identifier."},"senderSettlementName":{"type":"string","description":"Sender settlement name."},"senderDivisionId":{"type":"string","description":"Sender division identifier."},"senderDivisionExternalId":{"type":"string","nullable":true,"description":"External division identifier."},"senderDivisionName":{"type":"string","description":"Sender division name."},"senderAddress":{"type":"string","description":"Full sender address."},"senderAddressParts":{"type":"object","description":"Structured sender address information.","properties":{"city":{"type":"string","nullable":true},"region":{"type":"string","nullable":true},"street":{"type":"string","nullable":true},"streetId":{"type":"string","nullable":true},"postCode":{"type":"string","nullable":true},"building":{"type":"string","nullable":true},"flat":{"type":"string","nullable":true},"block":{"type":"string","nullable":true},"latitude":{"type":"number","nullable":true},"longitude":{"type":"number","nullable":true},"note":{"type":"string","nullable":true},"addressId":{"type":"string","nullable":true}}},"shipments":{"type":"array","description":"List of shipments included in the registry.","items":{"type":"object","properties":{"shipmentId":{"type":"string","description":"Unique shipment identifier."},"shipmentNumber":{"type":"string","description":"Shipment number."},"destinationDivision":{"type":"object","nullable":true,"description":"Destination division information. Returned for European registries.","properties":{"name":{"type":"string"},"id":{"type":"integer"},"number":{"type":"string"}}}}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Validation"},"503":{"$ref":"#/components/responses/Time-out"}}}}}} ``` ## Remove shipments from registry > The method allows users to delete shipment from an existing client registry.\ > \ > The method supports:\ > \- European shipments (shipment numbers such as \`SHPL...\`)\ > \- Ukrainian shipments (MEN/ID identifiers)\ > \ > 🔹\*\*Description of control elements:\*\*\ > \ > \*\*SCHEMA\*\*\
\ > Displays the full technical structure of the request or response, including field names, data types, required fields, allowed values, and validation rules.\ > \- \*\*Single line description\*\*\
\ > A description that fits into a single line; any text that does not fit remains hidden.\ > \- \*\*Multiline description\*\*\
\ > An expanded description that displays more than one line of text.\ > \ > \*\*EXAMPLE\*\*\
\ > Shows a ready-made sample JSON with correctly formatted values to demonstrate how a valid request or response should look.
```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"}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"The specified resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Validation":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Time-out":{"description":"Connection time-out","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","properties":{"errors":{"type":"object","properties":{"":{"type":"string"}}}}}}},"paths":{"/registry/{id}/shipments":{"delete":{"tags":["Registers"],"summary":"Remove shipments from registry","description":"The method allows users to delete shipment from an existing client registry.\n\nThe method supports:\n- European shipments (shipment numbers such as `SHPL...`)\n- Ukrainian shipments (MEN/ID identifiers)\n\n🔹**Description of control elements:**\n\n**SCHEMA**
\nDisplays the full technical structure of the request or response, including field names, data types, required fields, allowed values, and validation rules.\n- **Single line description**
\n A description that fits into a single line; any text that does not fit remains hidden.\n- **Multiline description**
\n An expanded description that displays more than one line of text.\n\n**EXAMPLE**
\nShows a ready-made sample JSON with correctly formatted values to demonstrate how a valid request or response should look.\n","parameters":[{"in":"path","name":"id","required":true,"description":"Unique register identifier from which the shipment must be removed.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["shipments"],"properties":{"shipments":{"type":"array","description":"Array of shipment identifiers that should be removed from the registry.\nEach shipment must belong to the same sender.\n","minItems":1,"maxItems":100,"uniqueItems":true,"items":{"type":"string","description":"Unique shipment number."}}}}}}},"responses":{"200":{"description":"Shipment successfully removed from registry.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique registry identifier."},"number":{"type":"string","description":"Registry number."},"versionTracking":{"type":"integer","nullable":true,"description":"Registry version number."},"status":{"type":"string","nullable":true,"description":"Registry status."},"createdAt":{"type":"string","format":"date-time","description":"Registry creation date and time."},"updatedAt":{"type":"string","format":"date-time","nullable":true,"description":"Registry update date and time."},"deletedAt":{"type":"string","format":"date-time","nullable":true,"description":"Registry deletion date and time."},"posted":{"type":"boolean","nullable":true,"description":"Indicates whether the registry has been posted."},"printed":{"type":"boolean","nullable":true,"description":"Indicates whether the registry has been printed."},"scannedBarcodesAmount":{"type":"integer","nullable":true,"description":"Number of shipments in the registry."},"description":{"type":"string","description":"Registry name."},"senderCompanyId":{"type":"string","nullable":true,"description":"Sender company identifier."},"senderCompanyTin":{"type":"string","description":"Sender company TIN."},"senderPhone":{"type":"string","description":"Sender phone number."},"senderCountryCode":{"type":"string","description":"Sender country code (ISO Alpha-2)."},"senderSettlementId":{"type":"string","description":"Sender settlement identifier."},"senderSettlementExternalId":{"type":"string","nullable":true,"description":"External settlement identifier."},"senderSettlementName":{"type":"string","description":"Sender settlement name."},"senderDivisionId":{"type":"string","description":"Sender division identifier."},"senderDivisionExternalId":{"type":"string","nullable":true,"description":"External division identifier."},"senderDivisionName":{"type":"string","description":"Sender division name."},"senderAddress":{"type":"string","description":"Sender address."},"senderAddressParts":{"type":"object","description":"Structured sender address."},"shipments":{"type":"array","description":"List of shipments remaining in the registry.","items":{"type":"object","properties":{"shipmentId":{"type":"string","description":"Shipment identifier."},"shipmentNumber":{"type":"string","description":"Shipment number."}}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Validation"},"503":{"$ref":"#/components/responses/Time-out"}}}}}} ``` ## Rename registry > The method allows users to rename an existing registry.\ > \ > The method supports:\ > \- European shipments (shipment numbers such as \`SHPL...\`)\ > \- Ukrainian shipments (MEN/ID identifiers)\ > \ > 🔹\*\*Description of control elements:\*\*\ > \ > \*\*SCHEMA\*\*\
\ > Displays the full technical structure of the request or response, including field names, data types, required fields, allowed values, and validation rules.\ > \- \*\*Single line description\*\*\
\ > A description that fits into a single line; any text that does not fit remains hidden.\ > \- \*\*Multiline description\*\*\
\ > An expanded description that displays more than one line of text.\ > \ > \*\*EXAMPLE\*\*\
\ > Shows a ready-made sample JSON with correctly formatted values to demonstrate how a valid request or response should look.
```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"}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"The specified resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Validation":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Time-out":{"description":"Connection time-out","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","properties":{"errors":{"type":"object","properties":{"":{"type":"string"}}}}}}},"paths":{"/registry/{id}/rename":{"put":{"tags":["Registers"],"summary":"Rename registry","description":"The method allows users to rename an existing registry.\n\nThe method supports:\n- European shipments (shipment numbers such as `SHPL...`)\n- Ukrainian shipments (MEN/ID identifiers)\n\n🔹**Description of control elements:**\n\n**SCHEMA**
\nDisplays the full technical structure of the request or response, including field names, data types, required fields, allowed values, and validation rules.\n- **Single line description**
\n A description that fits into a single line; any text that does not fit remains hidden.\n- **Multiline description**
\n An expanded description that displays more than one line of text.\n\n**EXAMPLE**
\nShows a ready-made sample JSON with correctly formatted values to demonstrate how a valid request or response should look.\n","parameters":[{"in":"path","name":"id","required":true,"description":"Unique register identifier.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["description"],"properties":{"description":{"type":"string","description":"New name of registry."}}}}}},"responses":{"200":{"description":"Request successful. The registry was renamed.","content":{"application/json":{"schema":{"type":"object","required":["success"],"properties":{"id":{"type":"string","description":"Unique registry identifier."},"number":{"type":"string","description":"Registry number."},"versionTracking":{"type":"integer","nullable":true,"description":"Registry version number."},"status":{"type":"string","nullable":true,"description":"Registry status."},"createdAt":{"type":"string","format":"date-time","description":"Registry creation date and time."},"updatedAt":{"type":"string","format":"date-time","nullable":true,"description":"Registry update date and time."},"deletedAt":{"type":"string","format":"date-time","nullable":true,"description":"Registry deletion date and time."},"posted":{"type":"boolean","nullable":true,"description":"Indicates whether the registry has been posted."},"printed":{"type":"boolean","nullable":true,"description":"Indicates whether the registry has been printed."},"scannedBarcodesAmount":{"type":"integer","nullable":true,"description":"Number of shipments in the registry."},"description":{"type":"string","description":"Registry name."},"senderCompanyId":{"type":"string","nullable":true,"description":"Sender company identifier."},"senderCompanyTin":{"type":"string","description":"Sender company TIN."},"senderPhone":{"type":"string","description":"Sender phone number."},"senderCountryCode":{"type":"string","description":"Sender country code (ISO Alpha-2)."},"senderSettlementId":{"type":"string","description":"Sender settlement identifier."},"senderSettlementExternalId":{"type":"string","nullable":true,"description":"External settlement identifier."},"senderSettlementName":{"type":"string","description":"Sender settlement name."},"senderDivisionId":{"type":"string","description":"Sender division identifier."},"senderDivisionExternalId":{"type":"string","nullable":true,"description":"External division identifier."},"senderDivisionName":{"type":"string","description":"Sender division name."},"senderAddress":{"type":"string","description":"Sender address."},"senderAddressParts":{"type":"object","description":"Structured sender address."},"shipments":{"type":"array","description":"Shipments included in the registry.","items":{"type":"object","properties":{"shipmentId":{"type":"string","description":"Shipment identifier."},"shipmentNumber":{"type":"string","description":"Shipment number."}}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Validation"},"503":{"$ref":"#/components/responses/Time-out"}}}}}} ``` ## Delete registry > The method allows users to delete an existing registry.\ > \ > 🔸Currently, deleting the registry is only possible after deleting all shipments from the registry.\ > \ > The method supports:\ > \- European shipments (shipment numbers such as \`SHPL...\`)\ > \- Ukrainian shipments (MEN/ID identifiers)\ > \ > 🔹\*\*Description of control elements:\*\*\ > \ > \*\*SCHEMA\*\*\
\ > Displays the full technical structure of the request or response, including field names, data types, required fields, allowed values, and validation rules.\ > \- \*\*Single line description\*\*\
\ > A description that fits into a single line; any text that does not fit remains hidden.\ > \- \*\*Multiline description\*\*\
\ > An expanded description that displays more than one line of text.\ > \ > \*\*EXAMPLE\*\*\
\ > Shows a ready-made sample JSON with correctly formatted values to demonstrate how a valid request or response should look.
```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"}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"The specified resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Validation":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Time-out":{"description":"Connection time-out","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","properties":{"errors":{"type":"object","properties":{"":{"type":"string"}}}}}}},"paths":{"/registry/{id}":{"delete":{"tags":["Registers"],"summary":"Delete registry","description":"The method allows users to delete an existing registry.\n\n🔸Currently, deleting the registry is only possible after deleting all shipments from the registry.\n\nThe method supports:\n- European shipments (shipment numbers such as `SHPL...`)\n- Ukrainian shipments (MEN/ID identifiers)\n\n🔹**Description of control elements:**\n\n**SCHEMA**
\nDisplays the full technical structure of the request or response, including field names, data types, required fields, allowed values, and validation rules.\n- **Single line description**
\n A description that fits into a single line; any text that does not fit remains hidden.\n- **Multiline description**
\n An expanded description that displays more than one line of text.\n\n**EXAMPLE**
\nShows a ready-made sample JSON with correctly formatted values to demonstrate how a valid request or response should look.\n","parameters":[{"in":"path","name":"id","required":true,"description":"Unique register identifier of the registry to be deleted.","schema":{"type":"string"}}],"responses":{"200":{"description":"Request successful. The registry was deleted.","content":{"application/json":{"schema":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Indicates whether the registry was successfully deleted."}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Validation"},"503":{"$ref":"#/components/responses/Time-out"}}}}}} ``` ## Print parcel registry > The method allows users to receive a generated PDF file with a list of client parcels for further printing.\ > \ > The response is returned as a generated file and contains a printable register with the list of shipments included in the selected registry.\ > \ > 🔹\*\*Description of control elements:\*\*\ > \ > \*\*SCHEMA\*\*\
\ > Displays the full technical structure of the request or response, including field names, data types, required fields, allowed values, and validation rules.\ > \- \*\*Single line description\*\*\
\ > A description that fits into a single line; any text that does not fit remains hidden.\ > \- \*\*Multiline description\*\*\
\ > An expanded description that displays more than one line of text.\ > \ > \*\*EXAMPLE\*\*\
\ > Shows a ready-made sample JSON with correctly formatted values to demonstrate how a valid request or response should look.
```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":{"/registry/print":{"get":{"tags":["Registers"],"summary":"Print parcel registry","description":"The method allows users to receive a generated PDF file with a list of client parcels for further printing.\n\nThe response is returned as a generated file and contains a printable register with the list of shipments included in the selected registry.\n\n🔹**Description of control elements:**\n\n**SCHEMA**
\nDisplays the full technical structure of the request or response, including field names, data types, required fields, allowed values, and validation rules.\n- **Single line description**
\n A description that fits into a single line; any text that does not fit remains hidden.\n- **Multiline description**
\n An expanded description that displays more than one line of text.\n\n**EXAMPLE**
\nShows a ready-made sample JSON with correctly formatted values to demonstrate how a valid request or response should look.\n","parameters":[{"in":"query","name":"id","required":true,"description":"Registry identifier in the system.","schema":{"type":"integer"}},{"in":"query","name":"type","required":false,"description":"Type of printable document.\n\nApplicable only to **Ukrainian** registries.\n\nAvailable values:\n- `international` - international shipment documents\n- `invoice` - shipment invoices\n- `marking` - shipment marking labels\n","schema":{"type":"string","enum":["international","invoice","marking"]}},{"in":"query","name":"printSizeType","required":false,"description":"Marking print size.\n\nApplicable only to **Ukrainian** registries.\n\nRequired for `type=marking`.\n","schema":{"type":"string","enum":["size_100_100"]}},{"in":"query","name":"copies","required":false,"description":"Number of copies of the printed document.","schema":{"type":"integer","default":1}}],"responses":{"200":{"description":"Generated file.","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"422":{"description":"Unprocessable entity.","content":{"application/json":{"schema":{"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"}}}}}}}}},"500":{"description":"Internal Server Error.","content":{"application/json":{"schema":{"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"}}}}}}}}}}} ``` --- # 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: ``` GET https://api-portal.novapost.com/metodi-1/methods/registers.md?ask= ``` The question should be specific, self-contained, and written in natural language. 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.