Shipment

Omnium allows integration with multiple shipping providers, each configured with specific settings and shipment options.

Supported shipping providers

Ingrid
PostNord
Bring (Documentation coming soon)
Consignor (Documentation coming soon)
Logistra (Documentation coming soon)
GLS (Documentation coming soon)
Unifaun (Documentation coming soon)
Porterbuddy (Documentation coming soon)
nShift(Documentation coming soon)

Shipping Providers

Each shipping provider (e.g., Bring, PostNord, GLS, Consignor, Logistra) requires a set of configurations to enable shipment booking and tracking.

Shipping Provider Settings Model

Property	Type	Description
Name	string	Name of the shipping provider.
DisplayName	string	User-friendly name displayed in Omnium.
ShippingGateway	string	Shipping gateway (e.g., Bring, Consignor, PostNord).
MerchantId	string	ID for authentication (if required by the provider).
MerchantSecret	string	Password for authentication (if required by the provider).
ApiToken	string	API token for authentication (if required by the provider).
CustomerNumber	string	Customer number required by some providers for shipment booking.
CustomerReturnNumber	string	Customer number for return booking requests (if applicable).
CustomerName	string	Account owner name.
CustomerEmail	string	Account owner email address.
BaseUrl	string	Provider API URL (test or production).
TrackingUrl	string	URL for tracking shipments.
LogoUrl	string	URL to the provider's logo.
VueTemplate	string	Internal Omnium template.
DisplayInOms	bool	Determines if the provider is visible in the Omnium interface.
IsTest	bool	Indicates if the provider is in test mode (used by Bring and PostNord).
BookTransfer	bool	Used by Logistra for transfer booking.
ProviderSendReturnLabelOnEmail	bool	Used by Logistra to send return labels via email instead of printing.
ValidOnMarkets	List	Specifies the markets where this provider is valid.

Example Configurations

Logistra Shipping Provider

{
    "Name": "Logistra",
    "DisplayName": "Logistra",
    "ShippingGateway": "Logistra",
    "MerchantId": "xxxx",
    "MerchantSecret": "xxxxxxx",
    "BaseUrl": "http://cargonizer.no",
    "BookTransfer": true
}

Bring Shipping Provider

{
    "Name": "Bring",
    "DisplayName": "Bring",
    "ShippingGateway": "Bring",
    "MerchantId": "Merchant Id",
    "ApiToken": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "CustomerNumber": "PARCELS_SWEDEN-xxxxx",
    "BaseUrl": "https://api.bring.com/",
    "IsTest": false
}

PostNord Shipping Provider

{
    "Name": "Postnord",
    "DisplayName": "Postnord",
    "ShippingGateway": "Postnord",
    "MerchantId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "ApiToken": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "BaseUrl": "https://api2.postnord.com/"
}

Shipment Options

Each shipment option represents a specific shipping service provided by the carrier (e.g., home delivery, pickup point).

Shipment Option Model

Property	Type	Description
ShippingMethodName	string	Unique name identifying the shipping product, matching the e-commerce platform.
ShippingMethodId	string	Unique ID for this option (if necessary).
ShippingGateway	string	Provider gateway (e.g., Bring, PostNord).
ShippingPriceGateway	string	If prices should be calculated by the provider but booking should not be done, set this.
CountryCode	string	Two-letter country code used by providers for pickup point retrieval.
ShipmentProduct	string	Provider’s shipment product code (e.g., "PICKUP_PARCEL", "mypack").
ShipmentProductName	string	Optional name for the shipment product.
ProviderNotification	bool	Whether the provider sends notifications (SMS/email).
ShipmentReturnProduct	string	Return shipment product code (if applicable).
ShippingSubTotal	decimal	Default shipping cost, if applicable.
GetPriceFromProvider	bool	If the provider should calculate shipping prices based on the order details.
AddTaxOnProviderPrice	bool	Whether tax should be added to the provider's shipping cost.
AdditionalCustomerPricePercentage	decimal	Extra surcharge percentage on provider cost.
DiscountedPrice	decimal	Discounted price for the shipment option.
DiscountLabel	string	Label for discount display.
DeliveryTime	string	Estimated delivery time.
LogoUrl	string	Provider logo URL.
VueTemplate	string	Internal Omnium template.
DefaultPackage	object	Default package dimensions for the provider.
NumberOfCollisMandatory	bool	Whether specifying the number of packages is required.
ShipmentDeliveryType	string	"Delivery" (to customer) or "PickUp" (customer collects the package).
TranslateKey	string	Internal identifier for the shipment type.
Label	string	User-friendly name for the shipment option.
Description	string	Description of the shipment option.
IsDefaultShipment	bool	Marks this as the default shipping method.
ConsigneeType	string	"CONSUMER" or "BUSINESS" (as required by providers).
ConsignorType	string	"CONSUMER" or "BUSINESS" (as required by providers).
DefaultWarehouseCode	string	Default warehouse for shipments (if applicable).

Shipment

On this page