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

Product

referencestring or null

namestring or null

{
  "reference": "string",
  "name": "string"
}

Shipping

idstring or null

merchantstring or null

channelstring or null

statestring

Enum"intent""removed""processing""failed""confirmed"

referencestring or null

tmsReferencestring or null

orderIdstring or null

adapterIdstring or null

namestring or null

totalobject or null

vatRatenumber(double)

deliveryDetailsobject or null

addonsArray of objects or null(Addon)

attributesobject or null

{
  "id": "string",
  "merchant": "string",
  "channel": "string",
  "state": "intent",
  "reference": "string",
  "tmsReference": "string",
  "orderId": "string",
  "adapterId": "string",
  "name": "string",
  "total": {
    "includingVat": 0.1,
    "excludingVat": 0.1
  },
  "vatRate": 0.1,
  "deliveryDetails": {
    "carrier": "string",
    "class": "string",
    "product": { … },
    "pickupLocation": { … }
  },
  "addons": [
    { … }
  ],
  "attributes": {
    "property1": null,
    "property2": null
  }
}

ShippingAddon

idstring or null

Addon identifier

namestring or null

Addon name

descriptionstring or null

Addon description

pricenumber or null(double)

Addon price

taxRatenumber or null(double)

Tax rate percentage

selectedboolean

Whether the addon is selected

requiredboolean

Whether the addon is required

{
  "id": "string",
  "name": "string",
  "description": "string",
  "price": 0.1,
  "taxRate": 0.1,
  "selected": true,
  "required": true
}

Norce Callbacks

Operations

nShift client side callbacks

Operations

nShift Delivery Checkout Orders

Operations