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

Servers

https://docs.norce.io/

Callback

Shipping

Schemas

ThemeOverride

showLogosboolean or null

If set to false, no carrier logos will be shown in the widget.

showMapboolean or null

If set to false, no map will be shown when selecting pickup points in the widget.

showPickupPointInfoboolean or null

If set to false, no additional information for pickup points will be shown.

showCategoriesboolean or null

If set to false, no category headers will be shown in the widget.

showOriginalPricesboolean or null

If set to false, no original prices will be shown next to the normal price in the widget.

showDeliveryTimeboolean or null

If set to false, no delivery times will be shown in the dedicated delivery time fields of the widget.

selectFirstAvailableOptionboolean or null

If set to false, the first option is no longer automatically selected.

numberOfAlwaysVisibleTextLinesinteger or null(int32)

Set a value between 1-4 to display text fields 1-4 without an option being selected.

numberOfInitiallyVisibleOptionsinteger or null(int32)

Any options after this number will initially be hidden. If not set, all options will always be shown.

{
  "showLogos": true,
  "showMap": true,
  "showPickupPointInfo": true,
  "showCategories": true,
  "showOriginalPrices": true,
  "showDeliveryTime": true,
  "selectFirstAvailableOption": true,
  "numberOfAlwaysVisibleTextLines": 0,
  "numberOfInitiallyVisibleOptions": 0
}

Transition

statusstring

Enum"checkout""processing""accepted""completed""declined""removed"

timeStampstring(date-time)

{
  "status": "checkout",
  "timeStamp": "2019-08-24T14:15:22Z"
}

WidgetSettings

widgetVersionstring or null

Widget version. Must currently always be "2".

themestring or null

The name of the styling theme. The only valid theme right now is "nshift-theme1".

themeOverrideobject or null

Object containing changes to the selected theme.

modestring or null

Set to "standard" for the normal widget, or to "product" for the read-only product page widget.

widthBreakpointsobject or null

Object for width breakpoints used for responsive styling.

{
  "widgetVersion": "string",
  "theme": "string",
  "themeOverride": {
    "showLogos": true,
    "showMap": true,
    "showPickupPointInfo": true,
    "showCategories": true,
    "showOriginalPrices": true,
    "showDeliveryTime": true,
    "selectFirstAvailableOption": true,
    "numberOfAlwaysVisibleTextLines": 0,
    "numberOfInitiallyVisibleOptions": 0
  },
  "mode": "string",
  "widthBreakpoints": {
    "narrow": 0,
    "ultraNarrow": 0
  }
}

Norce Callbacks

Operations

nShift client side callbacks

Operations

nShift Delivery Checkout Orders

Operations