nShift Delivery

nShift Delivery API

Omnium integrates with nShift Delivery (formerly Unifaun) for comprehensive shipping management, including delivery checkout widgets, shipment booking, label generation, and direct printing.

Configuration Steps

Navigate to: Configuration > Settings > Orders > Shipping providers > Add New

Required Settings

Field	Description	Example
Name	Internal provider name	`nShift`
Display Name	Name shown to users	`nShift Delivery`
Shipping Provider	Select provider type	`Unifaun`
Merchant ID	Your nShift user/merchant ID	`user@company.com`
Merchant Secret	Bearer token for API authentication	`your-api-token`
Base URL	nShift API endpoint	`https://api.unifaun.com`
Vue Template	UI template for widget display	`unifaun-provider`

Optional Settings

Field	Description
Add Tax On Provider Price	Add tax to prices returned by nShift
Add Product Names To Label	Include product names/SKUs on shipping labels
Print Label	Enable label printing (default: true)
Tracking URL	Template URL with `{languageCode}` and `{orderNumber}` placeholders

To enable the nShift delivery checkout widget in Omnium:

Set Vue Template to unifaun-provider
Add a property with key UseWidget and value true

Shipment Options

Adding shipment options for each market

Under each market, define the shipping options available in your webshop. You have two booking methods:

If your webshop uses the nShift widget at checkout, retrieve a prepareId from the user session and store it on the Omnium cart or order in the property list:

{
  "properties": [
    {
      "key": "UnifaunPrepareId",
      "value": "6f977858-35b8-4d5f-8fa6-5d46456543"
    }
  ]
}

When using prepareId, configure a single shipping option with:

Shipping Method: Unifaun_deliveryCheckout

Option 2: Direct Booking

Configure individual shipping options for each delivery method:

Field	Description
Shipping Provider	Set to `Unifaun`
Template	`Standard` for home delivery, `PickUp Point` for pickup points
Delivery Type	`Delivery` (sent to customer) or `Pickup` (collected at store)
Display Name	User-friendly name
Shipping Method	Internal name for mapping order shipments
Shipment Product	Service ID from nShift
Shipment Return Product	Service ID for return bookings

Store Configuration

QuickId Configuration

nShift supports QuickId for simplified sender identification. Configure on the store or shipment option:

Property	Description
QuickId	nShift sender quick ID
PreferQuickId	Set to `true` to use only QuickId without full address details

Printer Configuration

For direct printing, configure the printer ID:

Location	Property Key
User preferences	`UnifaunPrinterId`
Store properties	`UnifaunPrinterId`

Delivery Checkout / Delivery Options

Custom Fields

Configure custom fields for delivery checkout queries using the DeliveryCheckoutCustomFields property. Use pipe-delimited key:value pairs:

Field	Description
`MaxVolume`	Maximum package volume (m³)
`TotalWeight`	Total shipment weight (kg)
`MaxLength`	Maximum length (cm)
`MaxWidth`	Maximum width (cm)
`MaxHeight`	Maximum height (cm)
`DangerousGoods`	Boolean flag for dangerous goods
`IsB2B`	Boolean flag for B2B orders
`TotalPrice`	Order total price
`PickUpInStoreNotPossible`	Boolean for pickup availability
`AcquisitionGroup`	Product acquisition group parameters
`FreightClass`	Minimum freight class from products

Additional Query Parameters

Add custom query parameters to delivery checkout requests using the order property:

Key: UnifaunDeliveryOptions_AdditionalQueryStringParameters

Return Shipments

Configuration

Set Shipment Return Product on the shipment option with the nShift service ID for returns
The system automatically reverses sender/recipient addresses for return bookings

Target 1: thermo-se (Swedish thermal printer)
Target 2: laser-a4 (A4 laser printer)

Label Storage

Labels are uploaded to Azure Blob Storage in the unifaunshippinglabels container.

Direct Printing

To enable direct printing:

Configure UnifaunPrinterId on user preferences or store
Labels are sent to the printer queue automatically
Batch processing supports up to 50 shipments per batch

Dangerous Goods Support

Products can be marked with dangerous goods flags. If ANY flag is true, the order is marked as containing dangerous goods:

Explosive
Corrosive
Oxidizing
Toxic
Harmful
Strong odor
Environmentally hazardous
Gas under pressure
Aerosol
Harmful to health
Flammable

Store dangerous goods information as JSON in the product's DangerousGoods property.

API Endpoints

Endpoint	Purpose
`GET /rs-extapi/v1/delivery-checkouts/{merchantId}`	Query delivery options
`POST /rs-extapi/v1/shipments/`	Book direct shipments
`POST /rs-extapi/v1/delivery-checkouts/{merchantId}`	Prepare shipments (creates UnifaunPrepareId)
`GET /rs-extapi/v1/prepared-shipments/{orderId}`	Get prepared shipment data
`POST /rs-extapi/v1/prepared-shipments/{prepareId}/shipments`	Book prepared shipment
`GET /rs-extapi/v1/shipments/{shipmentId}/pdfs/{pdfId}`	Download label PDF
`POST /rs-extapi/v1/print/shipments/{shipmentId}/prints/{labelId}/printjobs`	Submit to printer

Error Handling

Error Keys

Error Key	Description
`UnifaunBookingError`	Booking failure for standard shipments
`UnifaunBookingReturnError`	Booking failure for return shipments

Errors are stored on the Order entity and automatically removed on successful booking.

Supported Features

Feature	Supported
Delivery checkout widget	Yes
Outbound shipment booking	Yes
Return shipment booking	Yes
PrepareId-based booking	Yes
Direct shipment booking	Yes
Label generation (PDF)	Yes
Direct printing	Yes
Pickup point selection	Yes (via widget)
Dangerous goods handling	Yes
B2B/B2C differentiation	Yes
Tax calculations	Yes
Multi-parcel shipments	Yes

Troubleshooting

Common Issues

Booking fails with invalid phone number: The system validates phone numbers against market patterns. Ensure the phone number matches the destination country format.
PrepareId not found: Verify the UnifaunPrepareId property is set on the order or shipment properties.
Widget not loading: Check that UseWidget property is set to true and Vue Template is unifaun-provider.