Logistra

Integration with Logistra (Cargonizer) for shipment booking in Omnium.

Omnium integrates with Logistra (Cargonizer) for shipment booking, return handling, service point lookup, and direct printing capabilities.


Configuration Steps

  1. Navigate to: Configuration > Settings > Orders > Shipping Providers > Add New

Required Settings

FieldDescriptionExample
NameInternal provider nameLogistra
Display NameName shown to usersLogistra
Shipping ProviderSelect provider typeLogistra
Merchant IDLogistra customer/sender IDcustomer-id
Merchant SecretAPI key (X-Cargonizer-Key)your-api-key
Base URLLogistra API endpointhttps://api.logistra.com/v2

Optional Settings

FieldDescription
Customer NameAccount owner name (added to consignment)
Customer EmailAccount owner email (added to consignment)
Book TransferAutomatically transfer booking
Provider Send Return Label On EmailProvider sends return labels via email
Add Product Names To LabelInclude product names/SKUs on labels

Shipment Options

Adding shipment options for each market

Configure shipping options under each market:

FieldDescription
Shipping ProviderSet to Logistra
Delivery TypeDelivery or Pickup
Display NameUser-friendly name
Shipping MethodInternal name for mapping
Shipment ProductLogistra product code
Shipment Product NameProduct name for API
Shipment Return ProductProduct code for returns
Country CodeTwo-letter country code

Service Point Provider

If pickup points should be fetched from a different provider (e.g., PostNord):

FieldValue
Service Point ProviderProvider key (e.g., PostNordV2)

Store Configuration

Customer ID Override

Override the customer ID per store using External IDs:

Provider NameDescription
LogistraCustomerIdStore-specific customer ID

Transport Agreement Override

Configure store-specific transport agreements:

Provider NameDescription
Logistra{ShippingCompany}IdStore-specific transport agreement

Example: LogistraBringId, LogistraPostNordId

Printer Configuration

For direct printing:

LocationProperty Key
User preferencesLogistraPrinterId
Store propertiesLogistraPrinterId

Provider Services

Configure additional services as JSON array or comma-separated list in Provider Services:

JSON Format

[{"id": "bring_priority", "type": "1_hour"}, {"id": "sms_notification"}]

Comma-Separated Format

bring_priority, sms_notification

Shipment Option Properties

Product Text Placement

Control where product text appears on the consignment:

Property KeyValueResult
ProductTextPropertyconsignee_contact_personProducts in contact person field
ProductTextProperty(any other value)Products in consignor reference

Helthjem Carrier Support

For Helthjem carrier pickup points:

Property KeyDescription
ShopIdShop ID for helthjem carrier queries

Service Points (Pickup Points)

Lookup

GET {BaseUrl}/service_partners.xml?country={countryCode}&postcode={postalCode}

Response Format

XML response containing service partners with:

  • Number (ServicePointId)
  • Name
  • Address details
  • Opening hours by weekday
  • Distance from search location

Delegated Lookup

If ServicePointProvider is configured on the shipment option, pickup point requests are delegated to that provider.


Booking Process

API Endpoint

POST {BaseUrl}/consignments.xml

Headers

HeaderValue
X-Cargonizer-KeyAPI key (Merchant Secret)
X-Cargonizer-SenderCustomer ID
Acceptapplication/xml

XML Request Structure

<consignments>
  <consignment>
    <values>
      <order-id>{orderId}</order-id>
      <provider>{customerName}</provider>
      <provider-email>{customerEmail}</provider-email>
    </values>
    <transfer>{bookTransfer}</transfer>
    <product>{productName}</product>
    <transport_agreement>{transportAgreement}</transport_agreement>
    <parts>
      <consignee>...</consignee>
      <return_address>...</return_address>
      <service_partner>...</service_partner>
    </parts>
    <items>
      <item>
        <type>PK</type>
        <amount>1</amount>
        <weight>{weightKg}</weight>
        <description>{goodsDescription}</description>
      </item>
    </items>
    <services>...</services>
    <references>...</references>
  </consignment>
</consignments>

Response

Successful bookings return:

  • Consignment ID
  • Tracking number with checksum
  • Tracking URL
  • Label PDF URL

Return Shipments

Configuration

  1. Set Shipment Return Product on the shipment option
  2. Optionally enable Provider Send Return Label On Email to have Logistra email labels

Email Label Option

When enabled, labels are emailed by Logistra instead of returned for printing:

  • email_label_to_consignee element set in XML request

Label Management

Label Download

GET {BaseUrl}/consignments/label_pdf?consignment_ids[]={consignmentId}

Label Storage

Labels are uploaded to Azure Blob Storage:

  • Container: logistrashippinglabels
  • Format: PDF

Direct Printing

Logistra supports direct printing to network printers.

POST {BaseUrl}/consignments/label_direct

Batch Processing

  • Consignments are processed in batches of 50
  • Both shipment and return labels can be printed

Printer ID

Printer ID is retrieved from:

  1. User preferences (LogistraPrinterId)
  2. Store properties (fallback)

Product Names on Labels

When Add Product Names To Label is enabled:

  • Order line items are collected for each package
  • Format: {AlternativeProductName or Code}*{quantity}
  • Limited to 30 items, truncated with "..."
  • Placement controlled by ProductTextProperty setting

Error Handling

Error Key

Error KeyDescription
LogistaBookingErrorBooking failure

Error Response Parsing

Error responses are XML with structure:

<consignments>
  <consignment>
    <errors>
      <error>Error message 1</error>
      <error>Error message 2</error>
    </errors>
  </consignment>
</consignments>

Address Mapping

Consignee (Recipient)

Mapped from order address:

  • Name: Full name, FirstName + LastName, or Organization
  • Contact: Daytime phone > Evening phone > General phone
  • Email from address
  • Country defaults to shipment option country code

Return Address (Sender)

Mapped from store:

  • Prefers store's shipping address
  • Falls back to main store address
  • Validates required fields (name, street, zipcode)
  • Country defaults to "NO" (Norway)

Supported Features

FeatureSupported
Outbound shipment bookingYes
Return shipment bookingYes
Label generation (PDF)Yes
Service point lookupYes
Direct printingYes
Email labelsYes
Product names on labelsYes
Provider servicesYes
Delegated service pointsYes
Multi-store configurationYes
Shipment statusNo
Single pickup point lookupNo

Troubleshooting

Common Issues

  1. Missing transport agreement: Ensure the shipment option has a valid transport agreement or configure store-level External ID.

  2. Direct print not working: Verify LogistraPrinterId is configured in user preferences or store properties.

  3. Service points not found: Check if ServicePointProvider should be configured for delegated lookup.

  4. Invalid product: Verify ShipmentProductName matches a valid Logistra product code.