Nova Poshta Setup
To work with Nova Poshta, create a delivery service setup with the API key of the Nova Poshta account (cabinet), fill in the sender data and the default shipment values, and then load the directory of branches.
Creating the setup
- Click the
button, enter Delivery Service Setup, and follow the appropriate link. - Create a line and select Nova Poshta in the Delivery Service field. The system fills in the API address, the print addresses and the status codes with default values.
- Select the Card action. The Setup card opens.
- Fill in the card fields as described below. The Delivery Service Pattern Code field must be filled in: the card cannot be closed without it.
- Select the Fill from NP account action to get the sender data from the Nova Poshta account.
- Select the Enable action.
Setup card fields
General
| Field | Description |
|---|---|
| Is Enabled | Shows whether the setup is enabled. Only one Nova Poshta setup can be enabled at a time. |
| Delivery Service Pattern Code | The delivery service pattern that defines from which documents delivery orders can be created. See Delivery Service Patterns. |
| API URL | The Nova Poshta API address. Filled in by default. |
| API Key | The API key of the Nova Poshta account. |
| Print Order URL | The address template for printing a waybill. Filled in by default. |
| Print Scan Sheet URL | The address template for printing a scan sheet. Filled in by default. |
| Print Marking URL | The address template for printing a marking. Filled in by default. |
| Error Documentation URL | The address of the Nova Poshta API error code reference. Filled in by default. |
| Print Marking | The action after posting the shipment of a document for which a delivery order exists: None — nothing is done; Ask for printing — the system asks whether to print the marking; Automatic printing — the marking is printed automatically; Open card — the delivery order card opens. |
| Auto Register ScanSheet | Select this option if a waybill must be added to a scan sheet automatically after it is registered. The order is added to an existing scan sheet with the same sender, shipping agent, shipping agent service and departure date; if there is no such scan sheet, a new one is created. |
| Shipment Method Code | The shipment method transferred to the source document after the delivery order is created. |
Status
The Nova Poshta status codes that correspond to the delivery order statuses. Separate the codes with |. A code that is not in any field sets the delivery order to the Closed status.
| Field | Description | Default value |
|---|---|---|
| Status Codes for Created | The status codes for the Created status. | 1 |
| Status Codes for In transit | The status codes for the In transit status. | 4\|41\|5\|6\|7\|8\|12\|101\|102\|103\|104\|105\|106\|111\|112 |
| Status Codes for Delivered | The status codes for the Delivered status. | 9\|10\|11 |
Sender Information
The sender data is filled in by the Fill from NP account action: the system gets the sender counterparty, its addresses and contact persons from the Nova Poshta account. The values in the Contact and Address groups can be changed with the field's assist button.
| Field | Description |
|---|---|
| Description | The sender counterparty in the Nova Poshta account. |
| Contact | The sender's contact person. |
| Phone No. | The phone number of the sender's contact person. |
| Allow Edit Sender in Delivery Order | Select this option if the sender data can be changed in the creation wizard and on the delivery order card. |
| Use Sender Location Contact | Select this option if the sender's contact person must be taken from the Contact No. field on the card of the location the goods are shipped from. |
| City | The sender's settlement. |
| Post Office | The Nova Poshta branch from which parcels are sent by default. |
| Address | The sender's address for shipments from the door. |
Cargo Details
| Field | Description |
|---|---|
| Cargo Type | The default cargo type: Cargo, Documents, Money, Pallet, Parcel or Tires Wheels. |
| Cargo Description | The default cargo description. |
| General Volume | The default cargo volume. |
| Minimum General Volume | If the volume in the delivery order is less than this value, this value is sent when the waybill is registered. |
| Dimensional Weight (kg) | Calculated automatically: General Volume × 250. Used to estimate the delivery cost. |
| Weight | The default cargo weight. |
| Minimum Weight | If the weight in the delivery order is less than this value, this value is sent when the waybill is registered. |
| No. of Places | The default number of places. |
Parcel Machine
These parameters are used to check shipments to parcel lockers. If a parcel locker is selected as the point of receipt, the Height, Width and Length fields must be filled in.
| Field | Description |
|---|---|
| Height, Width, Length | The dimensions of a parcel locker cell. |
| Volume Adjustment Factor | The factor the cell volume (Height × Width × Length) is multiplied by. The shipment volume cannot exceed the result. |
| Weight Adjustment Factor | The factor the maximum weight allowed for the parcel locker is multiplied by. The shipment weight cannot exceed the result. |
| Dimension Adjustment Factor | The factor the cell dimensions are multiplied by when the dimensions of the items in the document are checked (by the item unit of measure). |
Backward Delivery
These parameters are used if the Backward Delivery option is selected in the delivery order.
| Field | Description |
|---|---|
| Payer Type | The payer of the backward delivery: Sender, Recipient or Third Person. |
| Cargo Type | The cargo type of the backward delivery. |
Payment
| Field | Description |
|---|---|
| Payment Responsibility Limit | The document amount up to which the recipient pays for the delivery. If the amount payable for the document does not exceed the limit, the payer is Recipient; otherwise, it is Sender. If the value is 0, Payer Type is used. |
| Payer Type | The default delivery payer. The field can be edited if no limit is specified. |
| Payment Method | The default payment method: Cash or Non Cash. If the recipient pays, the payment method depends on the recipient counterparty type: Cash for a private person, Non Cash for an organization. |
Setup card actions
| Action | Description |
|---|---|
| Fill from NP account | Gets the sender counterparty, its addresses and contact persons from the Nova Poshta account and fills in the sender data. |
| Enable | Enables the setup or disables an enabled one. If another Nova Poshta setup is already enabled, the system shows an error. |
| Change Enabled Cabinet | Starts the Change Enabled NP Cabinet wizard; see Changing the enabled cabinet. |
| Get API Errors Codes | Loads the reference of Nova Poshta API error codes. |
Changing the enabled cabinet
If the company moves to another Nova Poshta account, create a separate setup for it and switch the enabled cabinet with the wizard.
- On the setup card, select the Change Enabled Cabinet action.
- In the Current NP Setup field, specify the enabled setup, and in the New NP Setup field, the setup to enable.
- In the Date and Time to Run field, specify when to switch. The system creates a job queue entry with the On Hold status; start it after checking. If no date and time are specified or the task cannot be scheduled, the system offers to switch immediately.
During the switch, the current setup is disabled, the new one is enabled, and the references of customers and post code settlements, as well as the saved contacts and addresses, are registered again in the new cabinet.
Directory of branches and parcel lockers
Nova Poshta branches and parcel lockers are stored in Business Central and used to select the shipping and receiving location.
- Click the
button, enter Load NP Post Offices, and run the report. The report loads all branches and their types from the API. - To view the directory, open the NP Post Offices page. The page has the actions:
- Update from API — loads the directory again;
- Show on map — shows the location of the branch on a map;
- Clear city filter — removes the settlement filter.
The FactBoxes of the page show the branch working schedule, the receipt schedule and the delivery schedule.
You can run the Load NP Post Offices report on a schedule in the job queue to keep the directory up to date.
Settlements and post codes
To match the settlements of Business Central post codes with Nova Poshta settlements automatically, run the Auto match post codes report. The report looks up the delivery service settlement for each post code and saves a reference to it. When it finishes, a list of the post codes without a match opens.
You can view the reference of a single post code on the Post Codes page with the Delivery Services > References action.
Counterparties, contacts and addresses
When delivery orders are created, the system registers the recipient counterparties, their contact persons and addresses in the Nova Poshta account and saves references to them in Business Central. The saved data is available from the cards:
| Card | Delivery Services action | Content |
|---|---|---|
| Customer | References | The Nova Poshta counterparty that corresponds to the customer. |
| Location | References, Contacts, Addresses | The sender counterparty, contact persons and addresses for the location. |
| Ship-to Address | Addresses | The customer's delivery addresses and branches. |
| Contact | Contacts | The contact person in the delivery service. |
On the Delivery Service References and Delivery Service Contacts pages, the Register action registers the record in the Nova Poshta account.
On the location card, specify the location contact in the Contact No. field, and on the contact card, specify the counterparty type in the delivery service in the Counterparty Type field: Organization or Private Person.
Customer counterparty type
The counterparty type of a customer is determined by its organization form. To set up the mapping:
- Click the
button, enter Delivery Service Account Setup, and follow the appropriate link. - For each customer organization form, create a line and fill in the Delivery Service, Organization Form and Counterparty Type fields.
If there is no line for the customer's organization form, the system shows an error when the counterparty is registered.