| Method name | Description |
|---|---|
| Create Shipment | Create a Shipment Document. This API method is engineered to streamline the process of generating a shipping document for logistics operations through Nova Post. By submitting key data, such as the originating and destination addresses for the shipment, users can effortlessly create a document detailing the transportation of goods. This method includes optional fields for customs authorities, accommodating shipments that cross borders. The API response will provide the unique identifier of the generated document along with other relevant information. Settlement validation rules: For shipments to or from Moldova and Ukraine, the settlement (city) must be successfully resolved. If the provided city value cannot be matched to a settlement, the request will fail with the error: Additional requirement: For shipments that require customs clearance (imports), the client invoice must be uploaded as a file through the POST /shipments/uploads/{id} method (after shipment creation). |
| Find Shipments List | This API method enables you to retrieve a list of transportation documents (shipments) that you have created. By making a request with this method, you can access the transportation documents that belongs to you or your account. The response will include details of each shipment, such as the shipment ID, number, recipient, cargo detail, and other relevant information. |
| Update Shipment Document | This API method enables you to update an existing transportation document by providing the document ID and the complete set of updated data. By specifying the document ID and including all the necessary information, you can replace the old document with the new data provided in the request. The response will typically indicate the success of the update operation and may include details of the modified document. Update restrictions:
|
| Delete Shipment Document | This method allows you to delete a shipment document based on its unique identifier (ID). To successfully remove the document from the system, the request must include its ID. The response will indicate the success of the operation. Implementation Details for Different Regions: 1. Europe:
2. Ukraine:
|
| Create Light Return Shipment | Creates a return shipment after the original order has been delivered. This method allows customers to create a return shipment after delivery — regardless of who handled the last mile (Nova Post or a partner). ℹ️ Information: The return can be created only if the parent shipment has the Delivered status and includes the AllowedLightReturn service. The current status of a shipment can be found in the
If all these conditions are met, the return creation request is accepted; otherwise, the system responds with a validation error indicating why the return is not permitted. How the Light Return Shipment works
When the return is created, the system automatically generates a return waybill. For more information on creating a parent shipment, see Create documents |
| Calculate delivery cost | This API method allows you to calculate the estimated delivery cost and delivery time for your cargo. The delivery cost and delivery time are calculated based on factors such as weight, dimensions, destination, and shipping method. By providing the necessary details of your cargo and shipment, you can obtain an estimated cost for delivering the goods. The response will typically include the calculated cost and the scheduled delivery date based on the provided information. |
| Get Verification status of UA→World shipments | Returns verification statuses for international shipments for the UA→World direction (“international shipment from Ukraine to World”). Responses and errors from the core system are proxied unchanged. |
| Shipments uploads file | Uploads supporting documents to a specific shipment by its ID. This method is used for attaching invoices, product specifications, customs declarations, or other shipment-related documents required for processing and clearance. Files are stored and linked to the shipment, ensuring better traceability and compliance. ⚠️ Region restriction: This method is available only for European shipments (EU/EU and EU/UA directions). It is not available for shipments originating from Ukraine. File naming: • If the "fileName" parameter is provided, the uploaded file will be stored with that name. • If "fileName" is not provided, the default file name will be set to "invoice". Use cases:
|
| Print Shipment Documents | This API method allows you to retrieve a transportation document marking in PDF format by providing the document number. The document marking is a printable document that clients can attach or affix to their cargo when sending it. By specifying the document number in the request, you can generate a PDF file containing the document marking for easy printing. |
| BasicTracking | This API method enables you to retrieve the status of a shipment by providing the transportation document number. By specifying the document number in the request, you can obtain information about the current location or status of the shipment, providing clients with real-time updates on the progress of their cargo. 🔸This method works only with the transportation document number (shipment number) and does not support searching by client order numbers or any external identifiers. 🔸BasicTracking provides a simplified tracking response focused on the shipment’s status history and, optionally, its related shipment numbers. Unlike FullTracking, it does not return detailed routing information, parcel-level data, undelivery reasons, return/redirect records, or extended metadata. This method is intended for quick, lightweight status checks. |
| FullTracking | This API method enables you to retrieve the status of a shipment by providing the transportation document number. By specifying the document number in the request, you can obtain information about the current location or status of the shipment, providing clients with real-time updates on the progress of their cargo. By default, the response contains the following data blocks:
If necessary, additional blocks can be included in the response by passing the appropriate parameters:
🔸FullTracking provides a comprehensive tracking response containing detailed shipment status data, full movement history, parcel descriptions, undelivery reasons, and information about related or derivative shipments. Unlike BasicTracking, it offers extended operational details and is designed for cases requiring full visibility into the shipment’s logistics lifecycle. |
| List attachments | Returns a list of available shipment-related attachment files (photos and/or signature) for the specified shipment only if the shipment belongs to the authenticated client. |
| Download attachment | Returns the stream of the file specified by fileId, if the shipment belongs to the authenticated client. |
| Field | Type | Required | Description |
|---|---|---|---|
| status | enum | yes | Signifies the current status of the transportation document, tracking its progress through the shipping lifecycle. Statuses detail each critical phase:
Allowed: ReadyToShip |
| clientOrder | string | yes | Represents all potential order identifiers associated with the shipment. These identifiers are set by the customer for internal tracking purposes and are crucial for tracking the shipment throughout its journey. All entered values can be tracked in the shipment's tracking system. Constraints: Max 50 chars |
| note | string | yes | Any additional information or special instructions that pertain to the order can be included here. This could encompass delivery instructions, special handling requests, or other pertinent details that facilitate the handling and processing of the shipment. Constraints: Max 255 chars |
| deliveryType | string | no | Defines the tariff type to be applied to the shipment during creation or update.
If the field is not provided, the tariff type is determined automatically according to current business rules, and the existing shipment creation behaviour remains unchanged. |
| payerType | enum | yes | Identifies who is responsible for the payment of delivery services. The payer type determines which party bears the cost:
Allowed: Sender┃Recipient┃ThirdPerson |
| payerContractNumber | string┃null | yes | This field is required in the following cases:
If this field is not provided in the cases described above, the payment method will automatically default to cash. Ensure that the provided information is accurate, as it is essential for correct payment processing. For more detailed information, refer to the article on Payment for Delivery Services via Nova Post API. Constraints: 2 to 20 chars |
| services | array | no | Contains information about additional services for the shipment. |
| services.shipmentParcelRowNumber | integer | yes | Specifies the row number of the parcel to which the service is applied. The value must correspond to the For services applied to the entire shipment (for example, |
| services.serviceCode | string | yes | The code indicating the service. A list of available codes and descriptions of their meanings:
🔸The COD service is planned to expand to other countries and delivery directions in the future, both for international shipments and within European countries.
🔹This field is required for the |
| services.serviceName | string | yes | Name of the service. Allowed values include:
🔹This field is required within the |
| services.serviceId | string | yes | Unique identifier (reference ID) of the selected service. This value must correspond to the service reference returned by the system. When creating or updating a shipment, the exact 🔹This field is required within the |
| services.amount | number | yes | The total amount the recipient must pay under the COD service. 🔹This field is required for the |
| services.contractNumber | string┃null | yes | Contract number of the payer responsible for the selected service. This parameter is used to identify the contractual agreement under which the service is paid. The field is required when the service payer is a third party or when non-cash payment terms are applied. If not provided, the payment may be processed according to default billing rules. |
| services.payerType | string | yes | Determines who is responsible for paying for the service. The payer type determines which party bears the costs:
🔻This field is required |
| services.additionalParameters | string | yes | Additional parameters for the service. |
| services.additionalParameters.cod | string | yes | Additional parameters for configuring COD. 🔹These parameters are mandatory and required only for the COD service |
| services.additionalParameters.cod.bankAccount | object | no | Information describing the bank account details to which the funds will be transferred. Includes the transfer amount, transaction currency, account identifiers, and the party responsible for paying the service fee. |
| services.additionalParameters.cod.bankAccount.amount | number | yes | The amount that will be transferred to the sender’s account after payment. Specifies the amount the recipient must pay upon receipt. Automatic currency conversion is possible depending on the sender's or recipient's country. 🔹This field is required for the |
| services.additionalParameters.cod.bankAccount.currencyCode | string | yes | The currency for the transaction, defined by the sender’s contract. Specified according to the ISO 4217 standard. 🔸By default, the currency of the sender’s country is used, but it is possible to set the currency manually (Feature under development)/ Pattern: ^[A-Z]{3}$ |
| services.additionalParameters.cod.bankAccount.bankAccountId | string | yes | Tax identification number of an individual or a legal entity, used for its unique identification in the system and for verifying the existence of an active contract and the availability of financial services. The same as the value passed in the 🔹This field is required for the 🔸Must contain the tax identification number or equivalent identifier (EDRPOU, TIN, NIP). |
| services.additionalParameters.cod.bankAccount.bankAccountName | string | yes | IBAN 🔹This field is required for the 🔸Must contain the full account number in IBAN format. |
| services.additionalParameters.cod.bankAccount.description | string | yes | Additional description of the payment details. |
| services.additionalParameters.cod.bankAccount.commissionPayer | string | yes | Specifies the party responsible for paying the commission:
🔹This field is required for the |
| services.additionalParameters.backwardDelivery | object | yes | Additional parameters for configuring return delivery. 🔹These parameters are mandatory and required only for the ExpBackwardGoods service |
| services.additionalParameters.backwardDelivery.description | string | no | Description of the goods to be returned. This value is used for informational and operational purposes during the return delivery process. |
| invoice | object | no | This object presents the necessary data for customs authorities to process the consignment efficiently, including the assessment of duties and taxes, and to confirm adherence to import/export regulations. The structured format of the invoice ensures that all pertinent information is easily accessible and clear, facilitating a smoother transit across borders. Updated logic for invoice value handling. Clients must now send only two parameters in the invoice object:
🔸It encapsulates the invoice details, which are required for international shipments undergoing customs clearance. |
| invoice.customerNumber | string┃null | yes | Unique identifier/number of the invoice accompanying the goods in the shipment, generated directly by the client. It is used for customs processing (export and import clearance) because it ensures a clear link between the goods in the shipment and their accompanying documentation, including value, origin, and other necessary information for customs clearance. If a client invoice exists in the shipment but its information is missing—specifically, its number—the shipment processing in the information system will be halted, the customs clearance period will be extended, and in the worst case, customs authorities may refuse clearance and initiate a return to the country of export. |
| invoice.customerCreatedAt | string | yes | You must provide the date specified in the invoice accompanying the shipment. If the date is not present in the client document, the shipment creation date may be used. 🔹This field is required if the Pattern: |
| invoice.type | string | yes | Type of client invoice accompanying the shipment and used for customs declaration. This field must reflect the actual type of document enclosed in the parcel. Available values:
🔹This field is required if the Possible values: |
| invoice.incoterm | string | yes | Specifies the trade terms for the shipping agreement between the buyer and seller, based on selected standards from the Incoterms® rules. These terms define the allocation of shipping costs, insurance, customs duties, and the distribution of risk. Only a limited subset of Incoterms® is available for use:
🔹This field is required for shipments crossing the EU border or going outside the EU. Possible values: |
| invoice.exportReason | string | yes | Specifies the general reason for exporting items, which is required for customs and other regulatory bodies. This classification helps in understanding the type of shipment without getting into specifics. It's used to categorize shipments at a high level for smoother processing through customs. The available options are:
🔹This field is required for shipments crossing the EU border or going outside the EU. Possible values: |
| invoice.cost | number | yes | Total declared invoice value in the original currency, which must equal the sum of all invoice items calculated as (amount × cost) for each item. Used for customs and shipment declarations. 🔸If the provided 🔸Values are validated for decimal precision, and digits beyond two decimal places are ignored. 🔹This field is required for shipments crossing the EU border or going outside the EU. |
| invoice.currency | string | yes | ISO 4217 currency code of the invoice. All items in the invoice must use the same currency. 🔹This field is required for shipments crossing the EU border or going outside the EU. Pattern: |
| invoice.payerFeesCustoms | string | yes | Specifies who is responsible for paying for customs services. The parameter determines which party bears the costs:
The default value is "Recipient". 🔹This parameter is required and valid only for the UA-EU direction. Possible values: |
| invoice.items | object | yes | A detailed list of goods being shipped, including required descriptions and values, essential for customs declarations and assessing duties. Logic: If the items block is provided, the system checks whether the total sum of all ( 🔸It is required to provide this information for each individual good in the shipment in the form of an array. |
| invoice.items.id | string | no | A unique identifier for each item within the shipment. 🔹This field is optional. |
| invoice.items.hsCode | string | null | yes | The Harmonized System code for each item, a standardized numerical method of classifying traded products. This field is required for international shipments that pass through customs clearance. You can obtain the valid
🔹This field is required for shipments crossing the EU border or going outside the EU. |
| invoice.items.name | string | yes | Represents the item's name in the local language, offering an accurate description for customs and logistical planning. The name should correspond with terminologies found in the Cargo Classifiers (UKT ZED) dictionary, ensuring compliance with standard classification codes. This detailed description aids in precise item identification during the customs clearance process. This field supports Unicode encoding, permitting the inclusion of special characters and symbols using the \uXXXX format. This capability allows for precise representation of item names in languages that incorporate non-Latin characters, enhancing clarity and understanding across diverse regulatory environments. 🔹This field is required for shipments crossing the EU border or going outside the EU. |
| invoice.items.nameEng | string | yes | Specifies the item's name in English, critical for ensuring that the product is identifiable and understandable across international trade and logistics channels. The English name simplifies communication and documentation processes when dealing with international partners and authorities, aiding in the seamless facilitation of global shipments. Similar to the 'name' field, this parameter also supports Unicode encoding. Using the \uXXXX format, it accommodates the accurate rendering of any special characters necessary for the correct representation of the item's name in English. 🔹This field is required for shipments crossing the EU border or going outside the EU. |
| invoice.items.material | string | no | The primary material from which the item is made, important for customs declarations and potential restrictions. 🔸If this field is not provided, the default value will be applied. |
| invoice.items.materialEng | string | no | The description of the item's material in English, aiding in the universal understanding of the product's composition. 🔸If this field is not provided, the default value will be applied. |
| invoice.items.madeInCountryCode | string | null | no | The ISO 3166-1 alpha-2 code indicating the country of manufacture, essential for determining import duties and compliance with trade agreements. 🔸This field is not required; however, shipments with this field filled are given priority during customs clearance. Pattern: |
| invoice.items.producerAndModel | string | null | no | The parameter represents the manufacturer and model of the device when creating a shipment. Both values are included in a single parameter. This parameter is mandatory for the following categories:
🔸This field is not required; however, shipments with this field filled are given priority during customs clearance. |
| invoice.items.actualWeight | integer | null | yes | Actual total weight of all units of the item in grams (g). Supported precision: 10 grams (0.01 kg). Values not divisible by 10 g are rounded down to the nearest lower multiple of 10 g. 🔸This field is mandatory when the ⚠️IMPORTANT: Ensure that all invoice item weights are correctly rounded and that their total weight exactly matches the shipment weight to avoid validation errors. |
| invoice.items.measurementCode | string | yes | The unit of measurement for the item quantity, such as pieces, kilograms, meters, etc., standardizing the way quantities are reported. 🔹This field is required for shipments crossing the EU border or going outside the EU. |
| invoice.items.amount | number | yes | The quantity of the item being shipped, necessary for inventory and customs documentation. Value in the units of measurement corresponding to the field 🔹This field is required for shipments crossing the EU border or going outside the EU. |
| invoice.items.cost | number | yes | The value per single unit of the item in the sender's currency, important for insurance and customs valuation. 🔸Values are validated for decimal precision, and digits beyond two decimal places are ignored. 🔹This field is required for shipments crossing the EU border or going outside the EU. |
| parcels | object | yes | Parcels` description block. Array contains objects, each object responsible for information about parcel. 🔻All fields in this array must be filled. |
| parcels.cargoCategory | string | no | Specifies the type of the shipment, helping to categorize the goods for logistics and customs processing. The category impacts how the shipment is handled, its shipping cost, and the required documentation. Available categories are:
Possible values: |
| parcels.parcelDescription | string | no | This field requires a concise description of the contents within the shipment, providing essential information on the nature of the items enclosed. This description aids in the logistics process, offering a clear understanding of the package contents for transportation planning and customs clearance. The summary should include details like the type of items, their purpose, and any other relevant information that describes the contents. It’s crucial for ensuring that the shipment complies with shipping regulations and facilitates smooth customs processing. Additionally, this field supports data in Unicode encoding, allowing for the inclusion of special characters and symbols using the \uXXXX format. This feature is particularly useful for languages that use non-Latin characters, ensuring accurate representation of item descriptions across diverse linguistic contexts. |
| parcels.insuranceCost | number | yes | Represents the declared value of the shipment for insurance coverage, in the currency of the sender's country. This value indicates the maximum compensation amount in the event of damage or loss during transit. Setting this value appropriately is crucial for ensuring adequate insurance protection. It is important to accurately declare this value to match the actual worth of the shipment contents, as underdeclaring can result in insufficient compensation. The minimum allowable value depends on the shipment direction:
Example: |
| parcels.rowNumber | integer | yes | Sequential identifier for each parcel within a shipment, used to organize and track individual packages, especially when multiple items are involved. If the shipment contains only one package, the value should be 1. |
| parcels.width | integer | yes | The parcel's width measured in millimeters, used alongside length and height to compute the total volume for logistical planning. |
| parcels.length | integer | yes | The parcel's length measured in millimeters, used alongside height and width to compute the total volume for logistical planning. |
| parcels.height | integer | yes | The parcel's height measured in millimeters, used alongside length and width to compute the total volume for logistical planning. |
| parcels.actualWeight | integer | yes | Actual item weight in grams (g). Supported precision: 10 grams (0.01 kg). Values not divisible by 10 g are rounded down to the nearest lower multiple of 10 g. 🔸This field is mandatory when the ⚠️IMPORTANT: Ensure that all invoice item weights are correctly rounded and that their total weight exactly matches the shipment weight to avoid validation errors. |
| sender | object | yes | Information about the party sending the shipment, including details about an individual or organization responsible for the dispatch. 🔻This array of fields is required |
| sender.companyTin | string | yes | The tax identification number or equivalent identifier (EDRPOU, TIN, NIP, IČO - for Slovakia) of a legal entity. 🔸The fields are required for a legal entity. If they are not filled in, the sender will be considered an individual |
| sender.companyName | string | null | yes | The official name of the sender's company. This field is used when the sender is a business entity, helping to identify the sending organization in documentation and records. |
| sender.eoriCode | string | null | yes | The EORI code (Economic Operators Registration and Identification number) is used by the European Union to identify economic operators engaged in international trade. The sender's EORI code should be included in the invoice to ensure correct customs clearance and taxation when shipping goods to EU countries. The code is not mandatory but strongly recommended for international shipments to the EU, as it facilitates customs processing and helps avoid delays. |
| sender.phone | string | yes | The contact phone number of the sender or the sender’s company representative. It is required for shipment-related communication, including pickup coordination and issue resolution. Format: The phone number must be provided in international format according to the E.164 standard. Example: 380XXXXXXXXX, 491234567890, 371XXXXXXXX Restrictions:
🔻This field is required |
| sender.email | string | yes | Email address of the sender, providing an electronic means of contact for updates, inquiries, and important notifications about the shipment. 🔹This field is required for shipments crossing the EU border or going outside the EU. |
| sender.name | string | yes | The full name of the individual sender or the primary contact person for a company sender. This name is used in all correspondences and documents related to the shipment. 🔸Important for EU → UA international shipments: 🔻This field is required |
| sender.ioss | string | no | The IOSS (Import One-Stop Shop) number is an optional input used to facilitate the VAT declaration process for shipments from non-EU countries with a declared value of up to EUR 150. It is utilized by shippers using the IOSS process to simplify customs procedures for deliveries to private customers in the EU. This field is available for shipments where the sender's country is outside the EU and the destination is within the EU. Pattern: |
| sender.countryCode | string | yes | A two-letter code representing the sender's country, following the ISO 3166-1 Alpha-2 standard, indicating the country of origin for the shipment. 🔻This field is required Pattern: |
| sender.divisionNumber | string | null | yes | This field is mandatory for parcels that are dispatched from a post office division or parcel locker, requiring the unique identifier of the dispatch location to be specified. 🔹This field is required if both the Example: |
| sender.divisionID | integer | null | yes | Division ID for specific branch identification. 🔹This field is required if both the |
| sender.addressParts | object | yes | This array of fields is required when shipping directly from an address, detailing the specific components of the location from which the parcel is dispatched. It includes detailed address information, ensuring the accurate identification of the pickup location. |
| sender.addressParts.city | string | yes | The name of the city from which the shipment is dispatched. It helps pinpoint the exact urban location for pickup or shipping. 🔹This field is required if |
| sender.addressParts.region | string | yes | Specifies the broader administrative area, like a state or province, encompassing the city, providing additional context for the shipment's origin. 🔹This field is required for shipments when the sender or recipient country is the USA, Ireland, or Canada. |
| sender.addressParts.street | string | yes | Identifies the specific street address for the sender's location, crucial for accurate pickup or delivery operations. 🔹This field is required if |
| sender.addressParts.postCode | string | yes | The postal or ZIP code corresponding to the sender's address. It's essential for sorting and routing the shipment efficiently. 🔹This field is required if |
| sender.addressParts.building | string | yes | The building number or name at the specified street address, pinpointing the precise location for shipment collection. 🔹This field is required if |
| sender.addressParts.flat | string | no | If applicable, the apartment or suite number within a building from which the shipment originates, ensuring pickup personnel can locate the sender's exact unit. |
| sender.addressParts.block | string | null | no | Indicates a specific block or section within a larger residential area or complex, if relevant, aiding in locating the sender's precise starting point for the shipment. |
| sender.addressParts.note | string | no | Allows for the inclusion of additional details or instructions about the sender's address that might facilitate the pickup process, such as gate codes, specific entry points, or preferred contact times. |
| recipient | object | yes | Information about the party receiving the shipment, detailing either an individual or an organization responsible for receiving the dispatched goods. 🔻This array of fields is required |
| recipient.companyTin | string | null | yes | The tax identification number or equivalent identifier (EDRPOU, TIN, NIP, IČO - for Slovakia) of a legal entity. 🔸The fields are required for a legal entity. If they are not filled in, the recipient will be considered an individual |
| recipient.companyName | string | null | yes | The formal name of the recipient's company. Utilize this field when the recipient is a business entity, aiding in the identification of the receiving organization in documents and records. |
| recipient.eoriCode | string | null | yes | The recipient's EORI code is important for customs clearance when shipping goods to European Union countries, especially when sending to legal entities. The code is not mandatory but recommended, as it helps ensure smooth customs clearance and minimizes the risk of delays. The requirement for the recipient eoriCode depends on the type of goods being shipped:
|
| recipient.phone | string | yes | The contact phone number of the recipient or the recipient’s company representative. Used for delivery notifications and communication with the customer during shipment processing. Format: The phone number must be provided in international format according to the E.164 standard. Example: 380XXXXXXXXX, 491234567890, 371XXXXXXXX Restrictions:
🔻This field is required |
| recipient.email | string | yes | The email address of the recipient, serving as a digital contact point for shipment updates, inquiries, and essential notifications. 🔹This field is required for shipments crossing the EU border or going outside the EU. |
| recipient.name | string | yes | The complete name of the individual recipient or the primary contact for a company recipient. This is the name used for all shipping-related correspondence and documentation. 🔻This field is required |
| recipient.countryCode | string | yes | A two-letter code that identifies the recipient's country, adhering to the ISO 3166-1 Alpha-2 standard, which specifies the shipment's destination country. 🔻This field is required Pattern: |
| recipient.divisionNumber | string | null | yes | This field is mandatory for parcels intended to be collected from a post office division or parcel locker, requiring the insertion of the unique identifier for the designated location. 🔹This field is required if both the Example: |
| recipient.divisionID | integer | null | yes | Division ID for specific branch identification. 🔹This field is required if both the |
| recipient.addressParts | object | yes | This array of fields is necessary when the shipment is directed to a specific address, outlining the precise location details to which the parcel is to be delivered. It encompasses comprehensive address information to ensure the exact identification of the delivery location. 🔸The values in the nested address fields must not duplicate each other. Providing the same address information in multiple inner fields will result in an error. |
| recipient.addressParts.city | string | yes | The city to which the shipment is being delivered. This detail ensures the parcel is directed to the correct urban area for the recipient. 🔹This field is required if |
| recipient.addressParts.region | string | yes | Specifies the recipient's state or province within the destination country, crucial for accurate shipment routing and delivery. When sending to the USA, it's essential to include a two-letter state code, such as "WA" for Washington or "DC" for the District of Columbia, according to the ISO 3166-2:US standard. 🔹This field is required for shipments when the sender or recipient country is the USA, Ireland, or Canada. |
| recipient.addressParts.street | string | yes | The street name of the recipient's address, vital for pinpointing the exact delivery spot. 🔹This field is required if |
| recipient.addressParts.postCode | string | yes | The postal or ZIP code for the recipient's address, critical for the precise sorting and routing of the parcel to its final destination. 🔹This field is required if |
| recipient.addressParts.building | string | yes | Specifies the building number or name at the recipient's address, guiding the delivery to the exact building within a given street. 🔹This field is required if |
| recipient.addressParts.flat | string | no | The apartment or suite number, if the delivery is to a multi-unit building, ensuring the parcel reaches the specific unit of the recipient. |
| recipient.addressParts.block | string | null | no | Identifies a block or section within a larger complex or residential area for the recipient, useful in large housing developments to further narrow down the delivery point. |
| recipient.addressParts.note | string | no | The space for any additional recipient-related address instructions or details that might assist in the delivery process, such as security instructions, specific doors for delivery, or preferred delivery times. |
| recipient.registrationAddressRecipient | object | no | The registrationAddressRecipient object provides a detailed breakdown of the recipient's registered address and is required when shipping to countries with specific customs requirements, such as Germany, Slovakia, Hungary, and France. This ensures compliance with local regulations and facilitates smooth customs processing. The object allows for a precise and complete representation of the recipient's address, which is especially important for international shipments to countries with strict customs regulations. |
| recipient.registrationAddressRecipient.city | string | yes | The name of the city where the recipient is registered. It must match the local naming conventions for accurate identification. 🔹This field is required for shipments to countries with specific customs requirements, including Germany, Slovakia, Hungary, and France. |
| recipient.registrationAddressRecipient.street | string | yes | The name of the street in the recipient's address. It must match the local naming conventions for accurate identification. 🔹This field is required for shipments to countries with specific customs requirements, including Germany, Slovakia, Hungary, and France. |
| recipient.registrationAddressRecipient.zipCode | string | yes | The postal code of the recipient's registered address. 🔹This field is required for shipments to countries with specific customs requirements, including Germany, Slovakia, Hungary, and France. |
| recipient.registrationAddressRecipient.building | string | yes | The building number or name where the recipient is registered. 🔹This field is required for shipments to countries with specific customs requirements, including Germany, Slovakia, Hungary, and France. |
| recipient.registrationAddressRecipient.apartment | string | no | The flat or apartment number within the building. |
| recipient.registrationAddressRecipient.state | strin | no | The state or region where the recipient is registered. Required in some countries for detailed geographical identification. |