NORCE CHECKOUT

CORE

Order

Norce Checkout - Order Management API (0.1)

Build 2026-01-12 08:21:29

The Order Management API is used to create and handle orders

Download OpenAPI description

order.json

order.yaml

Servers

Playground

https://{slug}.api-se.playground.norce.tech/checkout/order/

Stage

https://{slug}.api-se.stage.norce.tech/checkout/order/

Production

https://{slug}.api-se.norce.tech/checkout/order/

Schemas

Checkout

Operations

Checkout Payment

Operations

Checkout Shipping

Operations

Create Order Shipping

Request

Creates a order shipping

Path

order_idstringrequired

Order identifier

Headers

x-merchantstringnon-emptyrequired

Merchant identifier.

Example: norce

x-channelstringnon-emptyrequired

Channel identifier

Example: 1

x-adapteridstring

Optional adapter identifier. When provided, hooks belonging to this adapter will not be triggered for changes made by the adapter itself.

Example: qliro_checkout_adapter

Bodyapplication/json

Shipping

merchantstring

Merchant identifier.

Example: "norce"

channelstring

Channel identifier

Example: "1"

statestring

Current state of the shipping.

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

referencestring

External reference to shipping.

Example: "e8ed2091-c34c-4837-a3a8-bc827b0dc183"

tmsReferencestring

TMS Reference.

Example: "a935a628-f70c-47a4-a9f6-98c6d08c2ba3"

orderIdstring

ID of the order.

Example: "o_DhZSbDfVzNzuxOzHyCFskzGzaJ"

adapterIdstring

Adapter ID

Example: "ingrid-shipping-adapter"

namestring

Descriptive name of the shipping.

Example: "PostNord MyPack Home"

totalobjectrequired

Total price of the shipping.

total.includingVatnumber(double)

Total price including vat in the checkout specified currency. Amount in major unit currency.

Example: 1234

total.excludingVatnumber(double)

Total price excluding vat in the checkout specified currency. Amount in major unit currency.

Example: 987.2

vatRatenumber(double)required

Value-added tax. 25% would be input as 0.25.

Example: 0.25

deliveryDetailsobject

Delivery details.

addonsArray of objects(Addon)

Shipping addons.

attributesobject

Allows you to store any custom attributes for the shipping.

curl -i -X POST \
  'https://customer-slug.api-se.playground.norce.tech/checkout/order/api/v0/checkout/orders/{order_id}/shippings' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce' \
  -d '{
    "merchant": "norce",
    "channel": "1",
    "state": "intent",
    "reference": "e8ed2091-c34c-4837-a3a8-bc827b0dc183",
    "tmsReference": "a935a628-f70c-47a4-a9f6-98c6d08c2ba3",
    "orderId": "o_DhZSbDfVzNzuxOzHyCFskzGzaJ",
    "adapterId": "ingrid-shipping-adapter",
    "name": "PostNord MyPack Home",
    "total": {
      "includingVat": 1234,
      "excludingVat": 987.2
    },
    "vatRate": 0.25,
    "deliveryDetails": {
      "carrier": "string",
      "carrierProductId": "string",
      "class": "string",
      "product": {
        "reference": "string",
        "name": "string"
      },
      "pickupLocation": {
        "reference": "string",
        "name": "string",
        "address": {
          "streetAddress": "Adaptivevägen 18",
          "city": "Boden",
          "postalCode": "955 60",
          "country": "SE"
        }
      }
    },
    "addons": [
      {
        "reference": "string",
        "price": 0.1
      }
    ],
    "attributes": {
      "property1": null,
      "property2": null
    }
  }'

Responses

Created

Bodyapplication/json

idstring

Response

application/json

{
  "id": "string"
}

Get Order Shippings

Request

Get order shippings

Path

order_idstringrequired

Order identifier

Headers

x-merchantstringnon-emptyrequired

Merchant identifier.

Example: norce

x-channelstringnon-emptyrequired

Channel identifier

Example: 1

x-adapteridstring

Optional adapter identifier. When provided, hooks belonging to this adapter will not be triggered for changes made by the adapter itself.

Example: qliro_checkout_adapter

curl -i -X GET \
  'https://customer-slug.api-se.playground.norce.tech/checkout/order/api/v0/checkout/orders/{order_id}/shippings' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce'

Responses

Bodyapplication/jsonArray [

idstringread-only

Unique identifier for the shipping.

Example: "s_pmHreuEBboeezpixrHMDPQlazU"

merchantstring

Merchant identifier.

Example: "norce"

channelstring

Channel identifier

Example: "1"

statestring

Current state of the shipping.

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

referencestring

External reference to shipping.

Example: "e8ed2091-c34c-4837-a3a8-bc827b0dc183"

tmsReferencestring

TMS Reference.

Example: "a935a628-f70c-47a4-a9f6-98c6d08c2ba3"

orderIdstring

ID of the order.

Example: "o_DhZSbDfVzNzuxOzHyCFskzGzaJ"

adapterIdstring

Adapter ID

Example: "ingrid-shipping-adapter"

namestring

Descriptive name of the shipping.

Example: "PostNord MyPack Home"

totalobjectrequired

Total price of the shipping.

total.includingVatnumber(double)

Total price including vat in the checkout specified currency. Amount in major unit currency.

Example: 1234

total.excludingVatnumber(double)

Total price excluding vat in the checkout specified currency. Amount in major unit currency.

Example: 987.2

vatRatenumber(double)required

Value-added tax. 25% would be input as 0.25.

Example: 0.25

deliveryDetailsobject

Delivery details.

addonsArray of objects(Addon)

Shipping addons.

attributesobject

Allows you to store any custom attributes for the shipping.

]

Response

application/json

[
  {
    "id": "s_pmHreuEBboeezpixrHMDPQlazU",
    "merchant": "norce",
    "channel": "1",
    "state": "intent",
    "reference": "e8ed2091-c34c-4837-a3a8-bc827b0dc183",
    "tmsReference": "a935a628-f70c-47a4-a9f6-98c6d08c2ba3",
    "orderId": "o_DhZSbDfVzNzuxOzHyCFskzGzaJ",
    "adapterId": "ingrid-shipping-adapter",
    "name": "PostNord MyPack Home",
    "total": { … },
    "vatRate": 0.25,
    "deliveryDetails": { … },
    "addons": [ … ],
    "attributes": { … }
  }
]

Get Order Shipping

Request

Get order shipping

Path

order_idstringrequired

Order identifier

shipping_idstringrequired

Shipping identifier

Headers

x-merchantstringnon-emptyrequired

Merchant identifier.

Example: norce

x-channelstringnon-emptyrequired

Channel identifier

Example: 1

x-adapteridstring

Optional adapter identifier. When provided, hooks belonging to this adapter will not be triggered for changes made by the adapter itself.

Example: qliro_checkout_adapter

curl -i -X GET \
  'https://customer-slug.api-se.playground.norce.tech/checkout/order/api/v0/checkout/orders/{order_id}/shippings/{shipping_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce'

Responses

Bodyapplication/json

idstringread-only

Unique identifier for the shipping.

Example: "s_pmHreuEBboeezpixrHMDPQlazU"

merchantstring

Merchant identifier.

Example: "norce"

channelstring

Channel identifier

Example: "1"

statestring

Current state of the shipping.

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

referencestring

External reference to shipping.

Example: "e8ed2091-c34c-4837-a3a8-bc827b0dc183"

tmsReferencestring

TMS Reference.

Example: "a935a628-f70c-47a4-a9f6-98c6d08c2ba3"

orderIdstring

ID of the order.

Example: "o_DhZSbDfVzNzuxOzHyCFskzGzaJ"

adapterIdstring

Adapter ID

Example: "ingrid-shipping-adapter"

namestring

Descriptive name of the shipping.

Example: "PostNord MyPack Home"

totalobjectrequired

Total price of the shipping.

total.includingVatnumber(double)

Total price including vat in the checkout specified currency. Amount in major unit currency.

Example: 1234

total.excludingVatnumber(double)

Total price excluding vat in the checkout specified currency. Amount in major unit currency.

Example: 987.2

vatRatenumber(double)required

Value-added tax. 25% would be input as 0.25.

Example: 0.25

deliveryDetailsobject

Delivery details.

addonsArray of objects(Addon)

Shipping addons.

attributesobject

Allows you to store any custom attributes for the shipping.

Response

application/json

{
  "id": "s_pmHreuEBboeezpixrHMDPQlazU",
  "merchant": "norce",
  "channel": "1",
  "state": "intent",
  "reference": "e8ed2091-c34c-4837-a3a8-bc827b0dc183",
  "tmsReference": "a935a628-f70c-47a4-a9f6-98c6d08c2ba3",
  "orderId": "o_DhZSbDfVzNzuxOzHyCFskzGzaJ",
  "adapterId": "ingrid-shipping-adapter",
  "name": "PostNord MyPack Home",
  "total": {
    "includingVat": 1234,
    "excludingVat": 987.2
  },
  "vatRate": 0.25,
  "deliveryDetails": {
    "carrier": "string",
    "carrierProductId": "string",
    "class": "string",
    "product": { … },
    "pickupLocation": { … }
  },
  "addons": [
    { … }
  ],
  "attributes": {
    "property1": null,
    "property2": null
  }
}

Update Order Shipping

Request

Update order shipping

Path

order_idstringrequired

Order identifier

shipping_idstringrequired

Shipping identifier

Headers

x-merchantstringnon-emptyrequired

Merchant identifier.

Example: norce

x-channelstringnon-emptyrequired

Channel identifier

Example: 1

x-adapteridstring

Optional adapter identifier. When provided, hooks belonging to this adapter will not be triggered for changes made by the adapter itself.

Example: qliro_checkout_adapter

Bodyapplication/json

merchantstring

Merchant identifier.

Example: "norce"

channelstring

Channel identifier

Example: "1"

statestring

Current state of the shipping.

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

referencestring

External reference to shipping.

Example: "e8ed2091-c34c-4837-a3a8-bc827b0dc183"

tmsReferencestring

TMS Reference.

Example: "a935a628-f70c-47a4-a9f6-98c6d08c2ba3"

orderIdstring

ID of the order.

Example: "o_DhZSbDfVzNzuxOzHyCFskzGzaJ"

adapterIdstring

Adapter ID

Example: "ingrid-shipping-adapter"

namestring

Descriptive name of the shipping.

Example: "PostNord MyPack Home"

totalobjectrequired

Total price of the shipping.

total.includingVatnumber(double)

Total price including vat in the checkout specified currency. Amount in major unit currency.

Example: 1234

total.excludingVatnumber(double)

Total price excluding vat in the checkout specified currency. Amount in major unit currency.

Example: 987.2

vatRatenumber(double)required

Value-added tax. 25% would be input as 0.25.

Example: 0.25

deliveryDetailsobject

Delivery details.

addonsArray of objects(Addon)

Shipping addons.

attributesobject

Allows you to store any custom attributes for the shipping.

curl -i -X PUT \
  'https://customer-slug.api-se.playground.norce.tech/checkout/order/api/v0/checkout/orders/{order_id}/shippings/{shipping_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce' \
  -d '{
    "merchant": "norce",
    "channel": "1",
    "state": "intent",
    "reference": "e8ed2091-c34c-4837-a3a8-bc827b0dc183",
    "tmsReference": "a935a628-f70c-47a4-a9f6-98c6d08c2ba3",
    "orderId": "o_DhZSbDfVzNzuxOzHyCFskzGzaJ",
    "adapterId": "ingrid-shipping-adapter",
    "name": "PostNord MyPack Home",
    "total": {
      "includingVat": 1234,
      "excludingVat": 987.2
    },
    "vatRate": 0.25,
    "deliveryDetails": {
      "carrier": "string",
      "carrierProductId": "string",
      "class": "string",
      "product": {
        "reference": "string",
        "name": "string"
      },
      "pickupLocation": {
        "reference": "string",
        "name": "string",
        "address": {
          "streetAddress": "Adaptivevägen 18",
          "city": "Boden",
          "postalCode": "955 60",
          "country": "SE"
        }
      }
    },
    "addons": [
      {
        "reference": "string",
        "price": 0.1
      }
    ],
    "attributes": {
      "property1": null,
      "property2": null
    }
  }'

Responses

Bodyapplication/json

idstringread-only

Unique identifier for the shipping.

Example: "s_pmHreuEBboeezpixrHMDPQlazU"

merchantstring

Merchant identifier.

Example: "norce"

channelstring

Channel identifier

Example: "1"

statestring

Current state of the shipping.

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

referencestring

External reference to shipping.

Example: "e8ed2091-c34c-4837-a3a8-bc827b0dc183"

tmsReferencestring

TMS Reference.

Example: "a935a628-f70c-47a4-a9f6-98c6d08c2ba3"

orderIdstring

ID of the order.

Example: "o_DhZSbDfVzNzuxOzHyCFskzGzaJ"

adapterIdstring

Adapter ID

Example: "ingrid-shipping-adapter"

namestring

Descriptive name of the shipping.

Example: "PostNord MyPack Home"

totalobjectrequired

Total price of the shipping.

total.includingVatnumber(double)

Total price including vat in the checkout specified currency. Amount in major unit currency.

Example: 1234

total.excludingVatnumber(double)

Total price excluding vat in the checkout specified currency. Amount in major unit currency.

Example: 987.2

vatRatenumber(double)required

Value-added tax. 25% would be input as 0.25.

Example: 0.25

deliveryDetailsobject

Delivery details.

addonsArray of objects(Addon)

Shipping addons.

attributesobject

Allows you to store any custom attributes for the shipping.

Response

application/json

{
  "id": "s_pmHreuEBboeezpixrHMDPQlazU",
  "merchant": "norce",
  "channel": "1",
  "state": "intent",
  "reference": "e8ed2091-c34c-4837-a3a8-bc827b0dc183",
  "tmsReference": "a935a628-f70c-47a4-a9f6-98c6d08c2ba3",
  "orderId": "o_DhZSbDfVzNzuxOzHyCFskzGzaJ",
  "adapterId": "ingrid-shipping-adapter",
  "name": "PostNord MyPack Home",
  "total": {
    "includingVat": 1234,
    "excludingVat": 987.2
  },
  "vatRate": 0.25,
  "deliveryDetails": {
    "carrier": "string",
    "carrierProductId": "string",
    "class": "string",
    "product": { … },
    "pickupLocation": { … }
  },
  "addons": [
    { … }
  ],
  "attributes": {
    "property1": null,
    "property2": null
  }
}

Norce Checkout - Order Management API (0.1)

Schemas

Checkout

Checkout Payment

Checkout Shipping

Create Order Shipping

Request

Responses

Did the information on the page help you?

Get Order Shippings

Request

Responses

Did the information on the page help you?

Get Order Shipping

Request

Responses

Did the information on the page help you?

Update Order Shipping

Request

Responses

Did the information on the page help you?

Norce Checkout - Order Management API (0.1)

Schemas

Checkout

Checkout Payment

Checkout Shipping

Create Order Shipping

RequestExpand all

Responses

Did the information on the page help you?

Get Order Shippings

Request

Responses

Did the information on the page help you?

Get Order Shipping

Request

Responses

Did the information on the page help you?

Update Order Shipping

RequestExpand all

Responses

Did the information on the page help you?

Request

Request