NORCE CHECKOUT
/
CORE
/
Order
/
Schemas
/
Recurring

Norce Checkout - Order Management API (1.0)

Build 2026-10-07 13:08:32

The Order Management API is used to create and handle orders

Download OpenAPI description
order-v1.json
order-v1.yaml
Languages
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

ProductType

string(ProductType)
Enum"physical""digital""giftCard""bundle""placeholder"
"physical"

Recurring

tokenstringnon-emptyrequired
descriptionstring
attributesobject
{
  "token": "string",
  "description": "string",
  "attributes": {
    "property1": null,
    "property2": null
  }
}

Shipping

idstringread-only

Unique identifier for the shipping.

Example: "s_pmHreuEBboeezpixrHMDPQlazU"
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.

deliveriesArray of objects(Delivery)

Individual deliveries when items are split into multiple shipments. When populated, each delivery has its own reference, delivery details, and price. The shipping Total should equal the sum of all delivery prices.

attributesobject

Allows you to store any custom attributes for the shipping.

{
  "id": "s_pmHreuEBboeezpixrHMDPQlazU",
  "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": [
    { … }
  ],
  "deliveries": [
    { … }
  ],
  "attributes": {
    "property1": null,
    "property2": null
  }
}

Checkout

Operations

Checkout Payment

Operations

Checkout Shipping

Operations