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

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

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
  }
}

OrderStatus

string(OrderStatus)
Enum"checkout""processing""accepted""completed""declined""removed"
"checkout"

Norce Callbacks

Operations

nShift client side callbacks

Operations

nShift Delivery Checkout Orders

Operations