NORCE CHECKOUT

NORCE ADAPTER

Handle Customer changed

Norce Checkout - Norce Adapter API (1.0.0)

Build 2026-01-12 15:09:14

The Norce Adapter API is used to create and manage an Order based on a Norce Checkout Basket.

Download OpenAPI description

norce-adapter.json

norce-adapter.yaml

Servers

Test server

https://checkout-norce-adapter.test.norce.tech/

Schemas

Orders

Operations

Hooks

Operations

Handle State Changed

Request

This hook is registered when an order is created.

Path

orderIdstringrequired

Order id in Norce Checkout

Headers

x-merchantstringrequired

Merchant identifier.

Example: norce

x-channelstringrequired

Channel identifier

Example: 1

Bodyapplication/json

idstring

merchantstring

channelstring

referencestring

createdstring(date-time)

lastModifiedstring(date-time)

stateobject

culturestring

currencystring

countrystring

cartobject

shippingsArray of objects(Shipping)

paymentsArray of objects(Payment)

customerobject

consentsArray of objects(Consent)

validationsArray of objects(Callback)

hooksArray of objects(Hook)

notificationsArray of objects(Notification)

totalobject

attributesobject

curl -i -X POST \
  'https://checkout-norce-adapter.test.norce.tech/api/v1/orders/{orderId}/state-changed' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -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",
          "productType": "physical",
          "items": [
            {}
          ],
          "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
              },
              "reference": "string",
              "description": "string"
            }
          ],
          "logistics": {
            "weight": 0,
            "height": 0,
            "width": 0,
            "length": 0,
            "tags": [
              "string"
            ],
            "shippingDate": "2019-08-24T14:15:22Z"
          },
          "upsell": true,
          "attributes": {
            "property1": null,
            "property2": null
          }
        }
      ],
      "discounts": [
        {
          "type": "item",
          "name": "string",
          "code": "string",
          "value": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "attributes": {
            "property1": null,
            "property2": null
          },
          "reference": "string",
          "description": "string"
        }
      ],
      "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",
          "carrierProductId": "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",
        "name": "string",
        "merchant": "string",
        "channel": "string",
        "currency": "string",
        "type": "default",
        "orderId": "string",
        "amount": 0.1,
        "upperLimitAmount": 0.1,
        "state": "intent",
        "reference": "string",
        "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
        }
      },
      "attributes": {
        "property1": null,
        "property2": null
      },
      "type": "person"
    },
    "consents": [
      {
        "id": "string",
        "checked": true,
        "text": "string",
        "required": true
      }
    ],
    "validations": [
      {
        "id": "string",
        "adapterId": "string",
        "url": "string"
      }
    ],
    "hooks": [
      {
        "id": "string",
        "adapterId": "string",
        "subscribeTo": "string",
        "target": "string",
        "invoke": "string"
      }
    ],
    "notifications": [
      {
        "id": "string",
        "adapterId": "string",
        "reference": "string",
        "description": "string",
        "scope": "string",
        "schema": {
          "property1": null,
          "property2": null
        },
        "invoke": "string",
        "delay": 0
      }
    ],
    "total": {
      "includingVat": 0.1,
      "excludingVat": 0.1
    },
    "attributes": {
      "property1": null,
      "property2": null
    }
  }'

Responses

Bodyapplication/jsonArray [

opstring

pathstring

valueany

]

Response

application/json

[
  {
    "op": "string",
    "path": "string",
    "value": null
  }
]

Handle Customer changed

Request

Callback added to the Norce Checkout Order as a hook. Syncs down to Norce Commerce and applies basket changes due to changes to the customer information.

Path

orderIdstringrequired

Order id in Norce Checkout

Headers

x-merchantstringrequired

Merchant identifier.

Example: norce

x-channelstringrequired

Channel identifier

Example: 1

Bodyapplication/json

idstring

merchantstring

channelstring

referencestring

createdstring(date-time)

lastModifiedstring(date-time)

stateobject

culturestring

currencystring

countrystring

cartobject

shippingsArray of objects(Shipping)

paymentsArray of objects(Payment)

customerobject

consentsArray of objects(Consent)

validationsArray of objects(Callback)

hooksArray of objects(Hook)

notificationsArray of objects(Notification)

totalobject

attributesobject

curl -i -X POST \
  'https://checkout-norce-adapter.test.norce.tech/api/v1/orders/{orderId}/customer-changed' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -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",
          "productType": "physical",
          "items": [
            {}
          ],
          "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
              },
              "reference": "string",
              "description": "string"
            }
          ],
          "logistics": {
            "weight": 0,
            "height": 0,
            "width": 0,
            "length": 0,
            "tags": [
              "string"
            ],
            "shippingDate": "2019-08-24T14:15:22Z"
          },
          "upsell": true,
          "attributes": {
            "property1": null,
            "property2": null
          }
        }
      ],
      "discounts": [
        {
          "type": "item",
          "name": "string",
          "code": "string",
          "value": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "attributes": {
            "property1": null,
            "property2": null
          },
          "reference": "string",
          "description": "string"
        }
      ],
      "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",
          "carrierProductId": "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",
        "name": "string",
        "merchant": "string",
        "channel": "string",
        "currency": "string",
        "type": "default",
        "orderId": "string",
        "amount": 0.1,
        "upperLimitAmount": 0.1,
        "state": "intent",
        "reference": "string",
        "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
        }
      },
      "attributes": {
        "property1": null,
        "property2": null
      },
      "type": "person"
    },
    "consents": [
      {
        "id": "string",
        "checked": true,
        "text": "string",
        "required": true
      }
    ],
    "validations": [
      {
        "id": "string",
        "adapterId": "string",
        "url": "string"
      }
    ],
    "hooks": [
      {
        "id": "string",
        "adapterId": "string",
        "subscribeTo": "string",
        "target": "string",
        "invoke": "string"
      }
    ],
    "notifications": [
      {
        "id": "string",
        "adapterId": "string",
        "reference": "string",
        "description": "string",
        "scope": "string",
        "schema": {
          "property1": null,
          "property2": null
        },
        "invoke": "string",
        "delay": 0
      }
    ],
    "total": {
      "includingVat": 0.1,
      "excludingVat": 0.1
    },
    "attributes": {
      "property1": null,
      "property2": null
    }
  }'

Responses

Bodyapplication/jsonArray [

opstring

pathstring

valueany

]

Response

application/json

[
  {
    "op": "string",
    "path": "string",
    "value": null
  }
]

Handle Shipping Changed

Request

Callback added to the Norce Checkout Order as a hook. Syncs down to Norce Commerce and applies basket changes due to changes to the shipping/freight information.

Path

orderIdstringrequired

Order id in Norce Checkout

Headers

x-merchantstringrequired

Merchant identifier.

Example: norce

x-channelstringrequired

Channel identifier

Example: 1

Bodyapplication/json

idstring

merchantstring

channelstring

referencestring

createdstring(date-time)

lastModifiedstring(date-time)

stateobject

culturestring

currencystring

countrystring

cartobject

shippingsArray of objects(Shipping)

paymentsArray of objects(Payment)

customerobject

consentsArray of objects(Consent)

validationsArray of objects(Callback)

hooksArray of objects(Hook)

notificationsArray of objects(Notification)

totalobject

attributesobject

curl -i -X POST \
  'https://checkout-norce-adapter.test.norce.tech/api/v1/orders/{orderId}/shipping-changed' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -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",
          "productType": "physical",
          "items": [
            {}
          ],
          "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
              },
              "reference": "string",
              "description": "string"
            }
          ],
          "logistics": {
            "weight": 0,
            "height": 0,
            "width": 0,
            "length": 0,
            "tags": [
              "string"
            ],
            "shippingDate": "2019-08-24T14:15:22Z"
          },
          "upsell": true,
          "attributes": {
            "property1": null,
            "property2": null
          }
        }
      ],
      "discounts": [
        {
          "type": "item",
          "name": "string",
          "code": "string",
          "value": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "attributes": {
            "property1": null,
            "property2": null
          },
          "reference": "string",
          "description": "string"
        }
      ],
      "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",
          "carrierProductId": "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",
        "name": "string",
        "merchant": "string",
        "channel": "string",
        "currency": "string",
        "type": "default",
        "orderId": "string",
        "amount": 0.1,
        "upperLimitAmount": 0.1,
        "state": "intent",
        "reference": "string",
        "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
        }
      },
      "attributes": {
        "property1": null,
        "property2": null
      },
      "type": "person"
    },
    "consents": [
      {
        "id": "string",
        "checked": true,
        "text": "string",
        "required": true
      }
    ],
    "validations": [
      {
        "id": "string",
        "adapterId": "string",
        "url": "string"
      }
    ],
    "hooks": [
      {
        "id": "string",
        "adapterId": "string",
        "subscribeTo": "string",
        "target": "string",
        "invoke": "string"
      }
    ],
    "notifications": [
      {
        "id": "string",
        "adapterId": "string",
        "reference": "string",
        "description": "string",
        "scope": "string",
        "schema": {
          "property1": null,
          "property2": null
        },
        "invoke": "string",
        "delay": 0
      }
    ],
    "total": {
      "includingVat": 0.1,
      "excludingVat": 0.1
    },
    "attributes": {
      "property1": null,
      "property2": null
    }
  }'

Responses

Bodyapplication/jsonArray [

opstring

pathstring

valueany

]

Response

application/json

[
  {
    "op": "string",
    "path": "string",
    "value": null
  }
]

Notifications

Operations

Norce Checkout - Norce Adapter API (1.0.0)

Schemas

Orders

Hooks

Handle State Changed

Request

Responses

Did the information on the page help you?

Handle Customer changed

Request

Responses

Did the information on the page help you?

Handle Shipping Changed

Request

Responses

Did the information on the page help you?

Notifications

Norce Checkout - Norce Adapter API (1.0.0)

Schemas

Orders

Hooks

Handle State Changed

RequestExpand all

Responses

Did the information on the page help you?

Handle Customer changed

RequestExpand all

Responses

Did the information on the page help you?

Handle Shipping Changed

RequestExpand all

Responses

Did the information on the page help you?

Notifications

Request

Request

Request