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

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

ShippingField

idstring or null

Field identifier

namestring or null

Field name

typestring or null

Field type (e.g., text, select)

requiredboolean

Whether the field is required

defaultValuestring or null

Default value for the field

descriptionstring or null

Field description

optionsArray of strings or null

Available options for select fields

{
  "id": "string",
  "name": "string",
  "type": "string",
  "required": true,
  "defaultValue": "string",
  "description": "string",
  "options": [
    "string"
  ]
}

ShippingOption

validboolean

Whether the option is valid/available

optionIdstring or null

Unique option identifier

categoryIdstring or null

Category identifier this option belongs to

namestring or null

Display name of the option

titlestring or null

Title of the option (from nShift)

descriptionstring or null

Description of the option

carrierIdstring or null

Carrier identifier

carrierProductIdstring or null

Carrier product identifier

carrierProductVersioninteger or null(int32)

Carrier product version

carrierProductNamestring or null

Carrier product name

carrierProductSourceSystemstring or null

Carrier product source system

sourceSystemCarrierIdstring or null

Source system carrier identifier

sourceSystemProductIdstring or null

Source system product identifier

externalSystemCustomCarrierstring or null

External system custom carrier

carrierNamestring or null

Carrier name

textsArray of strings or null

Text descriptions for the option

priceDescriptionstring or null

Price description text

pricenumber or null(double)

Price including VAT

originalPriceDescriptionstring or null

Original price description text

originalPricenumber or null(double)

Original price before discount

taxRatenumber or null(double)

Tax rate percentage

logoIdstring or null

Logo identifier

logoUrlstring or null

Logo URL

addonsArray of objects or null(ShippingAddon)

Available addons for this option

fieldsArray of objects or null(ShippingField)

Fields for this option

deliveryTimeobject or null

Delivery time information

pickupPointsArray of objects or null(ShippingPickupPoint)

Available pickup points

timeSlotsArray of objects or null(ShippingTimeSlot)

Available time slots

externalSystemExtraobject or null

External system extra data

noDefaultPickupPointboolean

Whether to not use default pickup point

additionalValuesobject or null

Additional values

tagsArray of strings or null

Tags for the option

additionalMerchantInfostring or null

Additional merchant info

{
  "valid": true,
  "optionId": "string",
  "categoryId": "string",
  "name": "string",
  "title": "string",
  "description": "string",
  "carrierId": "string",
  "carrierProductId": "string",
  "carrierProductVersion": 0,
  "carrierProductName": "string",
  "carrierProductSourceSystem": "string",
  "sourceSystemCarrierId": "string",
  "sourceSystemProductId": "string",
  "externalSystemCustomCarrier": "string",
  "carrierName": "string",
  "texts": [
    "string"
  ],
  "priceDescription": "string",
  "price": 0.1,
  "originalPriceDescription": "string",
  "originalPrice": 0.1,
  "taxRate": 0.1,
  "logoId": "string",
  "logoUrl": "string",
  "addons": [
    { … }
  ],
  "fields": [
    { … }
  ],
  "deliveryTime": {
    "earliestDate": "string",
    "latestDate": "string",
    "earliestTime": "string",
    "latestTime": "string",
    "description": "string"
  },
  "pickupPoints": [
    { … }
  ],
  "timeSlots": [
    { … }
  ],
  "externalSystemExtra": {
    "property1": null,
    "property2": null
  },
  "noDefaultPickupPoint": true,
  "additionalValues": {
    "property1": null,
    "property2": null
  },
  "tags": [
    "string"
  ],
  "additionalMerchantInfo": "string"
}

ShippingOptionsData

optionsArray of objects or null(ShippingOption)

Available shipping options

addonsArray of objects or null(ShippingAddon)

Global addons available for all options

fieldsArray of objects or null(ShippingField)

Global fields for all options

categoriesArray of objects or null(ShippingCategory)

Categories for grouping shipping options

{
  "options": [
    { … }
  ],
  "addons": [
    { … }
  ],
  "fields": [
    { … }
  ],
  "categories": [
    { … }
  ]
}

Norce Callbacks

Operations

nShift client side callbacks

Operations

nShift Delivery Checkout Orders

Operations