NORCE CHECKOUT
/
SHIPPING ADAPTERS
/
nShift Adapter
/
Norce 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

Handle Cart changed in Norce order.

Request

Cart 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

Updated order

idstring or null
merchantstring or null
channelstring or null
referencestring or null
createdstring(date-time)
lastModifiedstring(date-time)
stateobject or null
culturestring or null
currencystring or null
countrystring or null
cartobject or null
shippingsArray of objects or null(Shipping)
paymentsArray of objects or null(Payment)
customerobject or null
consentsArray of objects or null(Consent)
validationsArray of objects or null(Callback)
hooksArray of objects or null(Hook)
notificationsArray of objects or null(Callback)
totalobject or null
attributesobject or null
curl -i -X POST \
  'https://docs.norce.io/api/checkout/v1/callback/orders/{order_id}/shippings/{shipping_id}/update-nshift-session' \
  -H 'Content-Type: application/json' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce' \
  -d '{
    "id": "string",
    "merchant": "string",
    "channel": "string",
    "reference": "string",
    "created": "2019-08-24T14:15:22Z",
    "lastModified": "2019-08-24T14:15:22Z",
    "state": {
      "currentStatus": "checkout",
      "transitions": [
        {
          "status": "checkout",
          "timeStamp": "2019-08-24T14:15:22Z"
        }
      ]
    },
    "culture": "string",
    "currency": "string",
    "country": "string",
    "cart": {
      "reference": "string",
      "items": [
        {
          "id": "string",
          "reference": "string",
          "name": "string",
          "sku": "string",
          "url": "string",
          "imageUrl": "string",
          "quantity": 0,
          "unit": "string",
          "price": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "total": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "originalTotal": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "vatRate": 0.1,
          "discounts": [
            {
              "type": "item",
              "name": "string",
              "code": "string",
              "value": {
                "includingVat": 0.1,
                "excludingVat": 0.1
              },
              "attributes": {
                "property1": null,
                "property2": null
              }
            }
          ],
          "logistics": {
            "weight": 0,
            "height": 0,
            "width": 0,
            "length": 0,
            "tags": [
              "string"
            ],
            "shippingDate": "2019-08-24T14:15:22Z"
          },
          "attributes": {
            "property1": null,
            "property2": null
          }
        }
      ],
      "discounts": [
        {
          "type": "item",
          "name": "string",
          "code": "string",
          "value": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "attributes": {
            "property1": null,
            "property2": null
          }
        }
      ],
      "total": {
        "includingVat": 0.1,
        "excludingVat": 0.1
      },
      "attributes": {
        "property1": null,
        "property2": null
      }
    },
    "shippings": [
      {
        "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": {
            "reference": "string",
            "name": "string"
          },
          "pickupLocation": {
            "reference": "string",
            "name": "string",
            "address": {
              "streetAddress": "string",
              "city": "string",
              "postalCode": "string",
              "country": "string"
            }
          }
        },
        "addons": [
          {
            "reference": "string",
            "price": 0.1
          }
        ],
        "attributes": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "payments": [
      {
        "id": "string",
        "adapterId": "string",
        "reference": "string",
        "name": "string",
        "price": {
          "includingVat": 0.1,
          "excludingVat": 0.1
        },
        "state": "intent",
        "attributes": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "customer": {
      "billing": {
        "type": "person",
        "givenName": "string",
        "familyName": "string",
        "careOf": "string",
        "reference": "string",
        "organizationName": "string",
        "streetAddress": "string",
        "streetAddress2": "string",
        "postalCode": "string",
        "city": "string",
        "region": "string",
        "country": "string",
        "phone": "string",
        "email": "string",
        "nationalIdentificationNumber": "string",
        "organizationIdentificationNumber": "string",
        "attributes": {
          "property1": null,
          "property2": null
        }
      },
      "shipping": {
        "type": "person",
        "givenName": "string",
        "familyName": "string",
        "careOf": "string",
        "reference": "string",
        "organizationName": "string",
        "streetAddress": "string",
        "streetAddress2": "string",
        "postalCode": "string",
        "city": "string",
        "region": "string",
        "country": "string",
        "phone": "string",
        "email": "string",
        "nationalIdentificationNumber": "string",
        "organizationIdentificationNumber": "string",
        "attributes": {
          "property1": null,
          "property2": null
        }
      },
      "type": "person",
      "attributes": {
        "property1": null,
        "property2": null
      }
    },
    "consents": [
      {
        "id": "string",
        "checked": true,
        "text": "string",
        "required": true
      }
    ],
    "validations": [
      {
        "id": "string",
        "adapterId": "string",
        "event": "validate",
        "url": "string"
      }
    ],
    "hooks": [
      {
        "id": "string",
        "adapterId": "string",
        "subscribeTo": "string",
        "target": "string",
        "invoke": "string"
      }
    ],
    "notifications": [
      {
        "id": "string",
        "adapterId": "string",
        "event": "validate",
        "url": "string"
      }
    ],
    "total": {
      "includingVat": 0.1,
      "excludingVat": 0.1
    },
    "attributes": {
      "property1": null,
      "property2": null
    }
  }'

Responses

OK

Bodyapplication/jsonArray [
opstring or null
pathstring or null
valueany or null
]
Response
application/json
[
  {
    "op": "string",
    "path": "string",
    "value": null
  }
]

Handle State changed in Norce order.

Request

State 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

Updated order

idstring or null
merchantstring or null
channelstring or null
referencestring or null
createdstring(date-time)
lastModifiedstring(date-time)
stateobject or null
culturestring or null
currencystring or null
countrystring or null
cartobject or null
shippingsArray of objects or null(Shipping)
paymentsArray of objects or null(Payment)
customerobject or null
consentsArray of objects or null(Consent)
validationsArray of objects or null(Callback)
hooksArray of objects or null(Hook)
notificationsArray of objects or null(Callback)
totalobject or null
attributesobject or null
curl -i -X POST \
  'https://docs.norce.io/api/checkout/v1/callback/orders/{order_id}/shippings/{shipping_id}/state-changed' \
  -H 'Content-Type: application/json' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce' \
  -d '{
    "id": "string",
    "merchant": "string",
    "channel": "string",
    "reference": "string",
    "created": "2019-08-24T14:15:22Z",
    "lastModified": "2019-08-24T14:15:22Z",
    "state": {
      "currentStatus": "checkout",
      "transitions": [
        {
          "status": "checkout",
          "timeStamp": "2019-08-24T14:15:22Z"
        }
      ]
    },
    "culture": "string",
    "currency": "string",
    "country": "string",
    "cart": {
      "reference": "string",
      "items": [
        {
          "id": "string",
          "reference": "string",
          "name": "string",
          "sku": "string",
          "url": "string",
          "imageUrl": "string",
          "quantity": 0,
          "unit": "string",
          "price": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "total": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "originalTotal": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "vatRate": 0.1,
          "discounts": [
            {
              "type": "item",
              "name": "string",
              "code": "string",
              "value": {
                "includingVat": 0.1,
                "excludingVat": 0.1
              },
              "attributes": {
                "property1": null,
                "property2": null
              }
            }
          ],
          "logistics": {
            "weight": 0,
            "height": 0,
            "width": 0,
            "length": 0,
            "tags": [
              "string"
            ],
            "shippingDate": "2019-08-24T14:15:22Z"
          },
          "attributes": {
            "property1": null,
            "property2": null
          }
        }
      ],
      "discounts": [
        {
          "type": "item",
          "name": "string",
          "code": "string",
          "value": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "attributes": {
            "property1": null,
            "property2": null
          }
        }
      ],
      "total": {
        "includingVat": 0.1,
        "excludingVat": 0.1
      },
      "attributes": {
        "property1": null,
        "property2": null
      }
    },
    "shippings": [
      {
        "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": {
            "reference": "string",
            "name": "string"
          },
          "pickupLocation": {
            "reference": "string",
            "name": "string",
            "address": {
              "streetAddress": "string",
              "city": "string",
              "postalCode": "string",
              "country": "string"
            }
          }
        },
        "addons": [
          {
            "reference": "string",
            "price": 0.1
          }
        ],
        "attributes": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "payments": [
      {
        "id": "string",
        "adapterId": "string",
        "reference": "string",
        "name": "string",
        "price": {
          "includingVat": 0.1,
          "excludingVat": 0.1
        },
        "state": "intent",
        "attributes": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "customer": {
      "billing": {
        "type": "person",
        "givenName": "string",
        "familyName": "string",
        "careOf": "string",
        "reference": "string",
        "organizationName": "string",
        "streetAddress": "string",
        "streetAddress2": "string",
        "postalCode": "string",
        "city": "string",
        "region": "string",
        "country": "string",
        "phone": "string",
        "email": "string",
        "nationalIdentificationNumber": "string",
        "organizationIdentificationNumber": "string",
        "attributes": {
          "property1": null,
          "property2": null
        }
      },
      "shipping": {
        "type": "person",
        "givenName": "string",
        "familyName": "string",
        "careOf": "string",
        "reference": "string",
        "organizationName": "string",
        "streetAddress": "string",
        "streetAddress2": "string",
        "postalCode": "string",
        "city": "string",
        "region": "string",
        "country": "string",
        "phone": "string",
        "email": "string",
        "nationalIdentificationNumber": "string",
        "organizationIdentificationNumber": "string",
        "attributes": {
          "property1": null,
          "property2": null
        }
      },
      "type": "person",
      "attributes": {
        "property1": null,
        "property2": null
      }
    },
    "consents": [
      {
        "id": "string",
        "checked": true,
        "text": "string",
        "required": true
      }
    ],
    "validations": [
      {
        "id": "string",
        "adapterId": "string",
        "event": "validate",
        "url": "string"
      }
    ],
    "hooks": [
      {
        "id": "string",
        "adapterId": "string",
        "subscribeTo": "string",
        "target": "string",
        "invoke": "string"
      }
    ],
    "notifications": [
      {
        "id": "string",
        "adapterId": "string",
        "event": "validate",
        "url": "string"
      }
    ],
    "total": {
      "includingVat": 0.1,
      "excludingVat": 0.1
    },
    "attributes": {
      "property1": null,
      "property2": null
    }
  }'

Responses

OK

Bodyapplication/jsonArray [
opstring or null
pathstring or null
valueany or null
]
Response
application/json
[
  {
    "op": "string",
    "path": "string",
    "value": null
  }
]

nShift client side callbacks

Operations

nShift Delivery Checkout Orders

Operations