NORCE CHECKOUT
/
SHIPPING ADAPTERS
/
nShift Adapter
/
Schemas
/
NShiftSession

Norce Checkout - nShift Adapter API (1.0.0)

Build 2026-01-13 12:26:53

The nShift Adapter API is used to create and manage nShift shippings.

Download OpenAPI description
nshift-adapter.json
nshift-adapter.yaml
Languages
Servers

https://docs.norce.io/

Callback

Shipping

Schemas

NShiftSelectionResult

Represents the result object from the nShift Checkout widget when a user makes a selection. This is sent via the resultCallback when the user interacts with the widget.

validboolean

Whether the result is valid and can be used to create a shipment.

sessionIdstring or null

UUID of the session used to request the shipping options. Required to create a shipment.

checkoutIdstring or null

UUID of the checkout configuration used to generate the shipping options.

checkoutVersionstring or null

Version number of the checkout configuration used to generate the shipping options.

optionIdstring or null

UUID of the shipping option that is selected in the widget. Required to create a shipment.

pickupPointIdstring or null

Carrier-specific ID of the pickup point selected in the widget. Required only if the shipping option uses pickup points.

timeSlotIdstring or null

Carrier-specific ID of the time slot selected in the widget. Required only if the shipping option uses time slots.

addonsArray of objects or null(NShiftSelectedAddon)

Array of addons selected under the selected shipping option.

fieldsArray of objects or null(NShiftFieldValue)

Array of field inputs under the selected shipping option.

totalPricenumber or null(double)

Total price of the selected shipping option and any selected addons.

totalOriginalPricenumber or null(double)

Total original price of the selected shipping option and any selected addons.

taxRatenumber or null(double)

Tax rate set in the checkout configuration.

additionalValuesobject or null

Additional key-value pairs defined by the checkout configuration.

resultsVersionstring or null

Version of the results object. Currently always "2".

widgetVersionstring or null

Version of the widget that generated the results object. Currently always "2".

{
  "valid": true,
  "sessionId": "string",
  "checkoutId": "string",
  "checkoutVersion": "string",
  "optionId": "string",
  "pickupPointId": "string",
  "timeSlotId": "string",
  "addons": [
    { … }
  ],
  "fields": [
    { … }
  ],
  "totalPrice": 0.1,
  "totalOriginalPrice": 0.1,
  "taxRate": 0.1,
  "additionalValues": {
    "property1": null,
    "property2": null
  },
  "resultsVersion": "string",
  "widgetVersion": "string"
}

NShiftSession

shippingIdstring or null

Shipping identifier

sessionIdstring or null

Session id

selectedOptionIdstring or null

The currently selected shipping option ID. In CreateSession this is the first valid option, in GetSession this is the option that was previously selected (from shipping reference). Used by the frontend to preselect the same option when the user refreshes the checkout page.

settingsobject or null

Widget settings for the nShift checkout widget

dataobject or null

Shipping options data from nShift (matching ShippingOptionsResponse format for widget compatibility)

{
  "shippingId": "string",
  "sessionId": "string",
  "selectedOptionId": "string",
  "settings": {
    "widgetVersion": "string",
    "theme": "string",
    "themeOverride": { … },
    "mode": "string",
    "widthBreakpoints": { … }
  },
  "data": {
    "options": [ … ],
    "addons": [ … ],
    "fields": [ … ],
    "categories": [ … ]
  }
}

NorceOrder

idstring or null
merchantstring or null
channelstring or null
referencestring or null
createdstring(date-time)
lastModifiedstring(date-time)
stateobject or null
culturestring or null
currencystring or null
countrystring or null
cartobject or null
shippingsArray of objects or null(Shipping)
paymentsArray of objects or null(Payment)
customerobject or null
consentsArray of objects or null(Consent)
validationsArray of objects or null(Callback)
hooksArray of objects or null(Hook)
notificationsArray of objects or null(Callback)
totalobject or null
attributesobject or null
{
  "id": "string",
  "merchant": "string",
  "channel": "string",
  "reference": "string",
  "created": "2019-08-24T14:15:22Z",
  "lastModified": "2019-08-24T14:15:22Z",
  "state": {
    "currentStatus": "checkout",
    "transitions": [ … ]
  },
  "culture": "string",
  "currency": "string",
  "country": "string",
  "cart": {
    "reference": "string",
    "items": [ … ],
    "discounts": [ … ],
    "total": { … },
    "attributes": { … }
  },
  "shippings": [
    { … }
  ],
  "payments": [
    { … }
  ],
  "customer": {
    "billing": { … },
    "shipping": { … },
    "type": "person",
    "attributes": { … }
  },
  "consents": [
    { … }
  ],
  "validations": [
    { … }
  ],
  "hooks": [
    { … }
  ],
  "notifications": [
    { … }
  ],
  "total": {
    "includingVat": 0.1,
    "excludingVat": 0.1
  },
  "attributes": {
    "property1": null,
    "property2": null
  }
}

Norce Callbacks

Operations

nShift client side callbacks

Operations

nShift Delivery Checkout Orders

Operations