NORCE CHECKOUT
/
SHIPPING ADAPTERS
/
nShift Adapter
/
nShift client side callbacks

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

Shipping changed - called when user selects a shipping option in the nShift widget

Request

Shipping changed.

Path
order_idstringrequired

Order identifier

shipping_idstringrequired

Shipping identifier

Headers
x-merchantstringrequired

Merchant identifier.

Example: norce
x-channelstringrequired

Channel identifier

Example: 1
Bodyapplication/json

The selection result from the nShift widget containing the user's selection

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".

curl -i -X POST \
  'https://docs.norce.io/api/checkout/v1/callback/orders/{order_id}/shippings/{shipping_id}/shipping-changed' \
  -H 'Content-Type: application/json' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce' \
  -d '{
    "valid": true,
    "sessionId": "string",
    "checkoutId": "string",
    "checkoutVersion": "string",
    "optionId": "string",
    "pickupPointId": "string",
    "timeSlotId": "string",
    "addons": [
      {
        "addonId": "string",
        "price": 0.1,
        "originalPrice": 0.1,
        "fields": [
          {
            "fieldId": "string",
            "value": "string"
          }
        ],
        "additionalValues": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "fields": [
      {
        "fieldId": "string",
        "value": "string"
      }
    ],
    "totalPrice": 0.1,
    "totalOriginalPrice": 0.1,
    "taxRate": 0.1,
    "additionalValues": {
      "property1": null,
      "property2": null
    },
    "resultsVersion": "string",
    "widgetVersion": "string"
  }'

Responses

OK

Response
No content

nShift Delivery Checkout Orders

Operations