NORCE CHECKOUT
/
SHIPPING ADAPTERS
/
nShift Adapter
/
nShift Delivery Checkout Orders
/
Get nShift session

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

Norce Callbacks

Operations

nShift client side callbacks

Operations

nShift Delivery Checkout Orders

Operations

Create a new nShift session

Request

Requires an existing order.

Path
order_idstringrequired

Order identifier

Headers
x-merchantstringrequired

Merchant identifier.

Example: norce
x-channelstringrequired

Channel identifier

Example: 1
curl -i -X POST \
  'https://docs.norce.io/api/checkout/v1/orders/{order_id}/shippings' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce'

Responses

OK

Bodyapplication/json
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)

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

Get nShift session

Request

Used to get the session with shipping options

Path
order_idstringrequired

Order identifier

shipping_idstringrequired

Shipping identifier

Headers
x-merchantstringrequired

Merchant identifier.

Example: norce
x-channelstringrequired

Channel identifier

Example: 1
curl -i -X GET \
  'https://docs.norce.io/api/checkout/v1/orders/{order_id}/shippings/{shipping_id}' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce'

Responses

OK

Bodyapplication/json
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)

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

Remove a nShift session

Request

Requires an existing shipping on order.

Path
order_idstringrequired

Order identifier

shipping_idstringrequired

Shipping identifier

Headers
x-merchantstringrequired

Merchant identifier.

Example: norce
x-channelstringrequired

Channel identifier

Example: 1
curl -i -X POST \
  'https://docs.norce.io/api/checkout/v1/orders/{order_id}/shippings/{shipping_id}/remove' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce'

Responses

OK

Bodyapplication/json
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)

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