Tables and fields reference for Ventoo Shipping

Carrier Setup VTO

70679800

Connection and authentication data per carrier.

Carrier Service Option VTO

70679801

Master data for service options per carrier.

Shipment Label Header VTO

70679802

Header data of a shipment label.

Shipment Label Line VTO

70679803

Transport units / parcels of a label.

Label Notification VTO

70679804

Notifications per label.

Label Service Option VTO

70679805

Service options assigned to a label.

Shipping Setup VTO

70679806

Global shipping setup (singleton).

Carrier Notification VTO

70679807

Master data for notification codes per carrier.

1

Code

Code[10]

Carrier code. References Shipping Agent.Code. On validate, the description is populated automatically.

2

Description

Text[100]

Display name of the carrier.

3

Carrier Type

Enum Carrier Type VTO

Determines the connector implementation (for example Planzer).

4

Enabled

Boolean

Controls whether the carrier may be used for labels (init value true).

10

Base URL Test

Text[250]

API endpoint for the test environment.

11

Base URL Production

Text[250]

API endpoint for the production environment.

12

Use Production

Boolean

Selects which base URL is used.

20

OAuth Token URL

Text[250]

Token endpoint for the client-credentials flow.

21

OAuth Client ID

Text[100]

Client ID. On validate, stored in IsolatedStorage (OAuth_ClientId_<Code>).

22

OAuth Client Secret

Text[100]

Client Secret. On validate, stored in IsolatedStorage (OAuth_ClientSecret_<Code>).

23

OAuth Scope

Text[250]

Optional scope parameter.

30

Default Label Format

Enum Label Format Type VTO

Default format (PDF or ZPL).

31

Default Label Resolution (dpi)

Integer

Default resolution in DPI (init value 200).

40

Account ID

Code[20]

Planzer account ID (6 digits).

41

Customer ID

Code[20]

Planzer customer ID (6 digits).

42

Department ID

Code[20]

Planzer department ID (2 digits).

50

Log API Calls

Boolean

Enables storage of request and response JSON per label.

60

Query Param NachrichtArt

Text[100]

Optional NachrichtArt query parameter.

61

Query Param System

Text[100]

Optional System query parameter.

1

Carrier Code

Code[20]

Reference to Carrier Setup VTO.

2

Service Code

Code[20]

Carrier-specific service code (for example 2030001).

10

Description

Text[100]

Display text of the service option.

30

Enabled

Boolean

Controls whether the option is offered for selection (init value true).

1

Entry No.

Integer

Auto-increment primary key.

2

Carrier Code

Code[20]

Reference to Carrier Setup VTO.

3

Status

Enum Label Status VTO

Current status (init value Draft).

4

Source Document Type

Enum Source Document Type VTO

Sales Order, Posted Shipment, or Manual.

5

Source Document No.

Code[20]

Number of the source document.

6

Reference

Text[40]

Reference assigned by the user (max. 40 characters).

100

Pickup Name

Text[100]

101

Pickup Name 2

Text[50]

102

Pickup Address

Text[100]

103

Pickup Street No.

Text[50]

104

Pickup Post Code

Code[20]

105

Pickup City

Text[40]

106

Pickup Country Code

Code[10]

107

Pickup Contact

Text[50]

108

Pickup Phone

Text[30]

109

Pickup Mobile

Text[20]

110

Pickup Email

Text[100]

111

Pickup Instruction

Text[70]

200

Delivery Name

Text[100]

201

Delivery Name 2

Text[50]

202

Delivery Address

Text[100]

203

Delivery Address 2

Text[50]

204

Delivery Post Code

Code[20]

205

Delivery City

Text[40]

206

Delivery Country Code

Code[10]

207

Delivery Contact

Text[100]

208

Delivery Phone

Text[30]

209

Delivery Mobile

Text[30]

210

Delivery Email

Text[80]

211

Delivery Instruction

Text[70]

300

Pickup Date

Date

301

Pickup Time From

Time

302

Pickup Time To

Time

310

Delivery Date

Date

311

Delivery Time From

Time

312

Delivery Time To

Time

400

Label Format

Enum Label Format Type VTO

Init value PDF.

401

Label Resolution (dpi)

Integer

Resolution in DPI; required for ZPL.

500

Dangerous Goods Code

Integer

501

Dangerous Goods Points

Integer

600

Goods Value

Integer

601

No. of Pallets

Integer

602

No. of Frames

Integer

603

No. of Lids

Integer

701

Error Message

Text[2048]

Validation or carrier error.

702

Request JSON

Blob

Sent JSON payload, when logging is enabled.

703

Response JSON

Blob

Received response, when logging is enabled.

704

Label PDF

Media

Label PDF returned by the carrier.

800

Created By

Code[50]

Set to UserId on insert.

801

Created At

DateTime

Set to CurrentDateTime on insert.

802

Sent At

DateTime

Time of the API call.

1

Label Entry No.

Integer

Reference to Shipment Label Header VTO.

2

Line No.

Integer

Auto-split key of the line.

10

Content

Text[100]

Package content.

20

Weight (kg)

Decimal

Weight in kilograms, one decimal place (MinValue = 0).

21

Length (cm)

Integer

Length in centimeters.

22

Width (cm)

Integer

Width in centimeters.

23

Height (cm)

Integer

Height in centimeters.

30

Barcode

Text[30]

Provided by the carrier (read-only).

31

Transport Unit No.

Text[50]

Provided by the carrier (read-only).

32

Tracking Link

Text[250]

Provided by the carrier (read-only, drill-down opens the URL).

1

Label Entry No.

Integer

Reference to Shipment Label Header VTO.

2

Line No.

Integer

Auto-split key.

10

Notification Code

Code[20]

Validated against Carrier Notification VTO.

11

Value

Text[200]

Notification content. Validated against the maximum length of the code.

12

Description

FlowField (Text[100])

Lookup from Carrier Notification VTO.

20

Carrier Code Filter

FlowFilter (Code[20])

Filter used to compute the description.

1

Label Entry No.

Integer

Reference to Shipment Label Header VTO.

2

Service Code

Code[20]

Free service code provided by the carrier.

10

Description

FlowField (Text[100])

Lookup from Carrier Service Option VTO.

1

Primary Key

Code[10]

Always empty; only one record.

10

Default Carrier Code

Code[20]

Default carrier for new labels.

11

Auto-Print After Creation

Boolean

Enables automatic printing after success.

12

Default Pickup From Company

Boolean

Copies the company information into the pickup address (init value true).

1

Carrier Code

Code[20]

Reference to Carrier Setup VTO.

2

Notification Code

Code[20]

Carrier-specific code (for example remark, routing1).

10

Description

Text[100]

Display text of the notification.

20

Max Length

Integer

Maximum length of the notification value (1–2048, init value 200).

30

Enabled

Boolean

Controls whether the code is available for selection (init value true).

40

Required

Boolean

Marks the notification as mandatory (init value false).

0

(blank)

Dummy Connector VTO (no-op, default implementation)

1

Planzer

Planzer Connector VTO

0

Draft

1

Sent

2

Success

3

Error

4

Cancelled

0

Sales Order

1

Posted Shipment

2

Manual

0

PDF

1

ZPL

Carrier Setup (list)

70679800

List

Carrier Setup Card

70679801

Card

Shipping Setup

70679802

Card (Administration)

Shipment Labels

70679803

List

Shipment Label Card

70679804

Card

Transport Units / Parcels

70679805

ListPart

Notifications

70679806

ListPart

Service Options

70679807

ListPart

Carrier Service Options

70679808

List (Administration)

Create Shipment Label

70679809

Card (assistant)

Carrier Notifications

70679810

List (Administration)

Shipment Label Mgt. VTO

70679800

Central orchestrator for the label lifecycle.

Planzer Connector VTO

70679801

Concrete Planzer implementation of the carrier-connector interface.

Planzer Auth VTO

70679802

OAuth 2.0 client for Planzer, including a token cache.

Dummy Connector VTO

70679803

Placeholder implementation of the connector interface.

Shipping Events VTO

70679804

Publishes the integration events.

Ship Label Print Events VTO

70679820

Event subscriber that injects PDF labels into BC reports.

Planzer Label Print VTO (report)

70679801

Minimal RDLC report used for the BC printer selection.