Breadcrumbs

Request Shipping Labels

Ventoo Shipping offers three ways to create a shipment label:

  • from a Sales Order,

  • from a Posted Sales Shipment,

  • manually, without a source document.

In all cases the Create Shipment Label assistant (page Create Shipment Label VTO) opens. Within the assistant you review and complete the data relevant to the carrier, then submit it via the Send to Carrier action.

Prerequisites

  • At least one Enabled carrier exists in the carrier setup.

  • OAuth credentials for the carrier are stored.

  • Optional: default carrier and Default Pickup From Company are set in the shipping setup.

Create a shipment label from a sales order

  1. Open the relevant Sales Order.

  2. In the ribbon, choose Create Shipment Label.

  3. The Create Shipment Label assistant opens with the following defaults:

    • Source Document Type = Sales Order, Source Document No. = order number.

    • Reference = order number (max. 40 characters).

    • Pickup Address taken from the company information when Default Pickup From Company is enabled.

    • Delivery Address copied from the Ship-to fields of the order (name, address, postal code, city, country, contact).

    • Carrier Code = default carrier from the shipping setup.

    • Pickup Date and Delivery Date = WorkDate().

    • One empty package row (transport unit) is initialized.

Note: Phone and email are not part of the Ship-to fields of the order and must be entered manually if needed. The integration event OnPopulateDeliveryAddress can be used to pre-fill additional fields automatically.

Create a shipment label from a posted sales shipment

  1. Open the Posted Sales Shipment.

  2. Choose Create Shipment Label.

  3. The assistant opens with Source Document Type = Posted Shipment and the Ship-to fields from the shipment.

Create a shipment label manually

  1. Open the Shipment Labels page.

  2. Choose New. The record is created with Source Document Type = Manual.

  3. Fill in the required fields in the assistant.

Fields in the assistant

In the Carrier & Reference FastTab, select the carrier and the reference (max. 40 characters). Source document type and number cannot be edited.

In the Pickup Address and Delivery Address FastTabs, review and complete the address data. For Planzer the following fields are required in particular:

  • Name, street, postal code, city, and country code.

  • The country code must be CH or LI.

  • The postal code must be four digits and numeric.

In the Dates & Times FastTab, set Pickup Date and Delivery Date. Optionally, Pickup Time From/To and Delivery Time From/To can be specified.

In the Packages sub form (Transport Units / Parcels) you enter one line per transport unit:

Field

Description

Content

Description of the package content (max. 100 characters).

Weight (kg)

Weight per package. For Planzer (unit type PAKE) the maximum is 30 kg.

Length (cm)

Length in centimeters.

Width (cm)

Width in centimeters.

Height (cm)

Height in centimeters.

Transport Unit No.

Filled in after the carrier responds.

Tracking Link

Filled in after the carrier responds.

In the Service Options sub form, select a service option via the Description column from the codes enabled for the carrier (for example 2030001 – Mandatory signature or 2030004 – Saturday delivery). The lookup is filtered to the carrier and to enabled codes only.

In the Notifications sub form, add text-based extra information, for example a general remark (remark), an additional reference (reference1), or a deposit instruction (deposit). The maximum length is validated against the carrier definition (field Max Length) on save.

In the Label Settings FastTab, choose Label Format (PDF or ZPL) and Label Resolution (dpi). For ZPL, the resolution is mandatory.

Submit the shipment label

  1. In the assistant, choose Send to Carrier.

  2. Ventoo Shipping validates the input (ValidateRequest). If required fields are empty or invalid (for example invalid country code, reference too long, missing packages, weight > 30 kg), the status is set to Error and all validation messages are collected in Error Message.

  3. On successful validation, the carrier connector builds the JSON payload, obtains an OAuth access token, and sends the request to the carrier API. The status transitions to Sent.

  4. On a successful response:

    • The status becomes Success.

    • The returned base64 PDF is stored in the Label PDF field.

    • The Transport Unit No., the Tracking Link, and – if provided – the Barcode are stored on the matching package line.

  5. On an HTTP error or invalid response:

    • The status becomes Error.

    • The Error Message field is populated.

    • If Log API Calls is enabled on the carrier, the request and response are stored on the label.

  6. If Auto-Print After Creation is enabled in the shipping setup, the PDF is automatically printed via the configured printer selection after success. Otherwise a confirmation message with the label entry number is displayed. For PDF labels without auto-print, the PDF is opened directly for preview.

Discard a label

In the assistant, the Cancel action ends the wizard. The label remains in the Shipment Labels list with status Draft and can be processed later or deleted via standard Business Central functions.

Next steps