API-referanse¶
Oversikt¶
Cargonizer Connector eksponerer AL API-sider for integrasjon med eksterne systemer som Power Automate, egendefinerte apper og tredjeparts logistikkplattformer. Disse sidene følger standardkonvensjonene for BC API-sider og er tilgjengelige via OData.
Tilgjengelige API-sider¶
Transport Order API¶
Side: DYP CA Transport Order API
Kildetabell: DYP CM Transport Order (70190215)
Publisher / Group / Version: dynapro / dypca / v2.0
Entitetssett: transportOrders
| Felt | Type | Beskrivelse |
|---|---|---|
id |
GUID | Unik postidentifikator (SystemId) |
sourceDocumentType |
Enum | Salgsordre, bokført følgeseddel, serviceordre, bokført servicelevering, overføringsordre, bokført overføringslevering, salgstilbud |
sourceDocumentNo |
Text | Tilknyttet BC-dokumentnummer |
consignmentId |
Integer | Cargonizer Consignment ID (settes etter sending) |
trackingNo |
Text | Transportørens sporingsnummer |
labelUrl |
Text | URL til forsendelsesetiketten |
transportAgreementCode |
Text | Kode for transportøravtale |
productCode |
Text | Transportørprodukt (tjenestenivå) |
carrierName |
Text | Transportørens visningsnavn |
consigneeEmail / consigneePhone |
Text | Mottakerens kontaktdetaljer |
consigneesReference / consignorsReference |
Text | Referansetekster på sendingen |
netPrice / grossPrice / customersPrice |
Decimal | Fraktprising |
currencyCode |
Text | Dokumentvaluta |
status |
Enum | Ny, Sendt, Etiketter skrevet ut |
sentDate |
Date | Datoen sendingen ble sendt |
locationCode |
Text | Opprinnelig lagerlokasjon |
messageToCarrier |
Text | Fritekstinstruksjon til transportøren |
Eksempel på OData-URL:
Transport Order Lines API¶
Side: DYP CA Transp. Order Lines API
Kildetabell: DYP CM Transport Order Line (70190212)
Entitetssett: transportOrderLines
| Felt | Type | Beskrivelse |
|---|---|---|
id |
GUID | Unik postidentifikator (SystemId) |
documentNo |
Text | Overordnet transportbestillingsnummer |
lineNo |
Integer | Linjesekvensnummer |
itemNo |
Text | Varenummer |
description |
Text | Linjebeskrivelse |
quantity |
Decimal | Antall kolli på linjen |
weight |
Decimal | Kollivekt (kg) |
length |
Decimal | Kollilengde (cm) |
width |
Decimal | Kollibredde (cm) |
height |
Decimal | Kollihøyde (cm) |
volume |
Decimal | Beregnet volum |
transportUnitOfMeasure |
Text | Kollitype (eske, pall osv.) |
sourceDocumentLineNo |
Integer | Opprinnelig BC-dokumentlinje |
Transport Order Services API¶
Side: DYP CA Tra. Order Services API
Kildetabell: DYP CM Transport Order Service (70190217)
Entitetssett: transportOrderServices
| Felt | Type | Beskrivelse |
|---|---|---|
id |
GUID | Unik postidentifikator (SystemId) |
documentNo |
Text | Overordnet transportbestillingsnummer |
carrierServiceId |
Text | Transportørens tjenesteidentifikator |
selected |
Boolean | Om tjenesten er aktiv på bestillingen |
Source Document Lines API¶
Side: DYP CA Source Doc. Lines API
Kildetabell: DYP CM Source Document Line (70190224)
Entitetssett: sourceDocumentLines
Eksponerer de denormaliserte kildedokumentlinjene som er lagret mot en transportbestilling (brukes til prising, toll og NVIT-beregninger).
| Felt | Type | Beskrivelse |
|---|---|---|
id |
GUID | Unik postidentifikator (SystemId) |
documentNo |
Text | Transportbestillingsnummer |
lineNo |
Integer | Linjesekvensnummer |
itemNo |
Text | Varenummer |
description |
Text | Linjebeskrivelse |
quantity |
Decimal | Antall |
unitPrice |
Decimal | Enhetspris |
lineAmount |
Decimal | Linjebeløp |
netWeight / grossWeight |
Decimal | Linjevekter |
Cargonizer HTTP-endepunkter (eksterne)¶
Dette er Cargonizer REST-endepunktene som kalles av connectoren. De er dokumentert her for referanse ved feilsøking av integrasjonsproblemer.
| Endepunkt | Metode | Formål |
|---|---|---|
/transport_agreements.xml |
GET | Hent transportøravtaler, produkter og tjenester |
/printers.xml |
GET | Hent DirectPrint-skriverlisten |
/consignments.xml |
POST | Opprett en sending; returnerer Consignment ID, Label URL, Tracking URL |
/consignment_costs.xml |
POST | Be om et estimat på fraktpris |
/consignments/label_direct |
GET | DirectPrint en etikett (printer_id, consignment_ids[]) |
Base-URL-er:
- Produksjon: https://cargonizer.no
- Sandkasse: https://sandbox.cargonizer.no
Autentisering: To egendefinerte forespørselshoder på hvert kall — X-Cargonizer-Key (API-nøkkel) og X-Cargonizer-Sender (avsender-ID).
Content-Type: application/xml
Merknader¶
- API-sider er stabile fra og med versjon 1.15.116.1.
- Alle API-sider krever tillatelsessettet DYP CA Carg User (eller Admin) på den kallende brukeren eller tjenestekontoen.
- For Power Automate-integrasjoner bruker du standard Business Central-connector og velger API-sidene oppført ovenfor fra det egendefinerte API-endepunktet.