API Reference¶
Overview¶
The Cargonizer Connector exposes AL API pages for integration with external systems such as Power Automate, custom apps, and third-party logistics platforms. These pages follow the standard BC API page conventions and are accessible via OData.
Available API Pages¶
Transport Order API¶
Page: DYP CA Transport Order API
Source Table: DYP CM Transport Order (70190215)
Publisher / Group / Version: dynapro / dypca / v2.0
Entity Set: transportOrders
| Field | Type | Description |
|---|---|---|
id |
GUID | Unique record identifier (SystemId) |
sourceDocumentType |
Enum | Sales Order, Posted Sales Shipment, Service Order, Posted Service Shipment, Transfer Order, Posted Transfer Shipment, Sales Quote |
sourceDocumentNo |
Text | Linked BC document number |
consignmentId |
Integer | Cargonizer consignment ID (set after dispatch) |
trackingNo |
Text | Carrier tracking number |
labelUrl |
Text | URL to the shipping label |
transportAgreementCode |
Text | Carrier agreement code |
productCode |
Text | Carrier product (service level) |
carrierName |
Text | Carrier display name |
consigneeEmail / consigneePhone |
Text | Consignee contact details |
consigneesReference / consignorsReference |
Text | Reference texts on the consignment |
netPrice / grossPrice / customersPrice |
Decimal | Freight pricing |
currencyCode |
Text | Document currency |
status |
Enum | New, Sent, Labels Printed |
sentDate |
Date | Date the consignment was sent |
locationCode |
Text | Originating warehouse location |
messageToCarrier |
Text | Free-text instruction to the carrier |
OData URL example:
Transport Order Lines API¶
Page: DYP CA Transp. Order Lines API
Source Table: DYP CM Transport Order Line (70190212)
Entity Set: transportOrderLines
| Field | Type | Description |
|---|---|---|
id |
GUID | Unique record identifier (SystemId) |
documentNo |
Text | Parent transport order number |
lineNo |
Integer | Line sequence number |
itemNo |
Text | Item number |
description |
Text | Line description |
quantity |
Decimal | Number of parcels on the line |
weight |
Decimal | Parcel weight (kg) |
length |
Decimal | Parcel length (cm) |
width |
Decimal | Parcel width (cm) |
height |
Decimal | Parcel height (cm) |
volume |
Decimal | Calculated volume |
transportUnitOfMeasure |
Text | Parcel type (box, pallet, etc.) |
sourceDocumentLineNo |
Integer | Originating BC document line |
Transport Order Services API¶
Page: DYP CA Tra. Order Services API
Source Table: DYP CM Transport Order Service (70190217)
Entity Set: transportOrderServices
| Field | Type | Description |
|---|---|---|
id |
GUID | Unique record identifier (SystemId) |
documentNo |
Text | Parent transport order number |
carrierServiceId |
Text | Carrier's service identifier |
selected |
Boolean | Whether the service is active on the order |
Source Document Lines API¶
Page: DYP CA Source Doc. Lines API
Source Table: DYP CM Source Document Line (70190224)
Entity Set: sourceDocumentLines
Exposes the denormalized source-document lines stored against a transport order (used for pricing, customs, and NVIT calculations).
| Field | Type | Description |
|---|---|---|
id |
GUID | Unique record identifier (SystemId) |
documentNo |
Text | Transport order number |
lineNo |
Integer | Line sequence number |
itemNo |
Text | Item number |
description |
Text | Line description |
quantity |
Decimal | Quantity |
unitPrice |
Decimal | Unit price |
lineAmount |
Decimal | Line amount |
netWeight / grossWeight |
Decimal | Line weights |
Cargonizer HTTP Endpoints (External)¶
These are the Cargonizer REST endpoints called by the connector. They are documented here for reference when troubleshooting integration issues.
| Endpoint | Method | Purpose |
|---|---|---|
/transport_agreements.xml |
GET | Retrieve carrier agreements, products, and services |
/printers.xml |
GET | Retrieve DirectPrint printer list |
/consignments.xml |
POST | Create a consignment; returns consignment ID, label URL, tracking URL |
/consignment_costs.xml |
POST | Request a freight price estimate |
/consignments/label_direct |
GET | DirectPrint a label (printer_id, consignment_ids[]) |
Base URLs:
- Production: https://cargonizer.no
- Sandbox: https://sandbox.cargonizer.no
Authentication: Two custom request headers on every call — X-Cargonizer-Key (API key) and X-Cargonizer-Sender (Sender ID).
Content-Type: application/xml
Notes¶
- API pages are stable from version 1.15.116.1 onwards.
- All API pages require the DYP CA Carg User (or Admin) permission set on the calling user or service account.
- For Power Automate integrations, use the standard Business Central connector and select the API pages listed above from the custom API endpoint.