NORCE CHECKOUT

CORE

Order

Item

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

Hook

idstringread-only

Unique ID for the callback.

Example: "oc_BaDIudFOjBEuFmLlmDExePUFTh"

adapterIdstring

Example: "jetshop_adapter"

subscribeTostring

targetstring

invokestring

Full valid url to be called by POST. If the url contains the substring '{order_id}' it will be replaced with the orders id before call is performed.

Example: "http://specific-feature-adapter.norce.io/api/v1/callbacks/orders/{order_id}/specific-callback"

versionstring

The version of the order body you expect to receive in the callback.

Enum"v0""v1"

{
  "id": "oc_BaDIudFOjBEuFmLlmDExePUFTh",
  "adapterId": "jetshop_adapter",
  "subscribeTo": "string",
  "target": "string",
  "invoke": "http://specific-feature-adapter.norce.io/api/v1/callbacks/orders/{order_id}/specific-callback",
  "version": "v0"
}

Item

idstring

Unique identifier for the order

Example: "ci_FpEzyBvBBUyKxkeNriFUxZOCje"

referencestring

Optional. Platform cart item reference.

namestring

Descriptive name of the item.

Example: "T-Shirt XL"

skustring

SKU or article number.

Example: "A000123"

productTypestring

Product type, physical is the default. Other options include Digital, GiftCard and Bundle.

Enum"physical""digital""giftCard""bundle"

itemsArray of objects(Item)

A List of items, useful for when this item is a bundle containing other items.

urlstring

URL to the product page.

Example: "https://example.com/products/A000123"

imageUrlstring

URL to an image showing the item.

Example: "https://example.com/products/A000123/images/1"

quantityinteger(int32)

Quantity of the item.

Example: 2

unitstring

Unit used to describe the quantity. Ex. st, kg

Example: "st"

priceobject

Unit price, excluding discount

totalobject

Total sum for all quantities including discount.

originalTotalobject

Total sum for all quantities excluding discount.

vatRatenumber(double)

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

Example: 0.25

discountsArray of objects(Discount)

Discounts applied to item.

logisticsobject

Logistics-related information for shipping and handling of the item.

upsellboolean

Indicates if item should be added after order has been accepted.

attributesobject

Allows you to store any custom attributes for the item.

{
  "id": "ci_FpEzyBvBBUyKxkeNriFUxZOCje",
  "reference": "string",
  "name": "T-Shirt XL",
  "sku": "A000123",
  "productType": "physical",
  "items": [
    {}
  ],
  "url": "https://example.com/products/A000123",
  "imageUrl": "https://example.com/products/A000123/images/1",
  "quantity": 2,
  "unit": "st",
  "price": {
    "includingVat": 1234,
    "excludingVat": 987.2
  },
  "total": {
    "includingVat": 1234,
    "excludingVat": 987.2
  },
  "originalTotal": {
    "includingVat": 1234,
    "excludingVat": 987.2
  },
  "vatRate": 0.25,
  "discounts": [
    { … }
  ],
  "logistics": {
    "weight": 2500,
    "height": 100,
    "width": 50,
    "length": 200,
    "tags": [ … ],
    "shippingDate": "2019-08-24T14:15:22Z"
  },
  "upsell": true,
  "attributes": {
    "property1": null,
    "property2": null
  }
}

Logistics

weightinteger(int32)

Weight of the item in grams.

Example: 2500

heightinteger(int32)

Height of the item in millimeters.

Example: 100

widthinteger(int32)

Width of the item in millimeters.

Example: 50

lengthinteger(int32)

Length of the item in millimeters.

Example: 200

tagsArray of strings

Tags that can be used to setup custom delivery rules in delivery modules.

shippingDatestring(date-time)

{
  "weight": 2500,
  "height": 100,
  "width": 50,
  "length": 200,
  "tags": [
    "string"
  ],
  "shippingDate": "2019-08-24T14:15:22Z"
}

Checkout

Operations

Checkout Payment

Operations

Checkout Shipping

Operations