NORCE CHECKOUT

CORE

Order

Notification

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

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"
}

Notification

idstring

Unique ID for the Notification

Example: "ocGooDddTOjKOuFmNnkEozEpfuTh"

adapterIdstring

Identifier for the system responsible for this notification. If any reference to configuration is made inside curly braces in Invoke the configuration is found using this identifier.

Example: "jetshop_adapter"

referencestring

Reference for the Notification. Should (but not required to) be unique for the order. Used to track notifications across different orders.

Example: "PuXCudQEiWTOHvquGGolFUVOuy"

descriptionstring

Purpose or effect of the notification.

Example: "Export payment information to Jetshop when order has been completed."

scopestring

Valid json path inside the order. Does not support scope inside arrays.

Example: "/state/currentStatus"

schemaobject

Json schema (https://json-schema.org/draft/2020-12/schema) on the scope. Notification triggers when a change occurs on the scope and the schema is valid for the scope.

Example: {"const":"completed"}

invokestring

Url to invoke on notification trigger. Can include references to adapter configuration and order inside curly braces.

Example: "{configuration.adapter.internalUrl}/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"

delayinteger(int32)

The delay in ms before the notification is sent.

{
  "id": "ocGooDddTOjKOuFmNnkEozEpfuTh",
  "adapterId": "jetshop_adapter",
  "reference": "PuXCudQEiWTOHvquGGolFUVOuy",
  "description": "Export payment information to Jetshop when order has been completed.",
  "scope": "/state/currentStatus",
  "schema": {
    "const": "completed"
  },
  "invoke": "{configuration.adapter.internalUrl}/api/v1/callbacks/orders/{order.id}/specific-callback",
  "version": "v0",
  "delay": 0
}

Order

idstringread-only

Unique identifier for the order

Example: "o_yClTSySjyAuuBjmiBlHCjuEcTf"

merchantstringnon-emptyread-onlyrequired

Merchant identifier

channelstringnon-emptyread-onlyrequired

Merchant channel

referencestring

External order reference

createdstring(date-time)read-only

Order creation date time

lastModifiedstring(date-time)read-only

Order last modified date time

stateobject

Order state

culturestring^[A-Za-z]{2,3}(?:-[A-Za-z]{2,2})*$

Order Culture, RFC-1766

currencystring^[A-Za-z]{3,3}$

Order Currency, ISO 4217 alpha-3.

countrystring^[A-Za-z]{2,2}$

Order Country. ISO 3166 alpha-2.

cartobject

Order cart

shippingsArray of objects(Shipping)read-only

Shippings related to the order

paymentsArray of objects(Payment)read-only

Payments related to the order

customerobject

Customer information

consentsArray of objects(Consent)

Order consents

validationsArray of objects(Callback)

Order actions are called in order to complete an action, such as 'Validate'. If provided the action is not completed if the response is not successful (e.g. http status code 400), note however that in case of a time constraint the action might be completed without a successful response.

hooksArray of objects(Hook)

Hooks, added by a separate endpoint.

notificationsArray of objects(Notification)

Order notifications are called after an event has occurred, such as order reaching 'Completed' state.

totalobject

Order total including shipping fees

attributesobject

Allows you to store any custom attributes for the order.

{
  "id": "o_yClTSySjyAuuBjmiBlHCjuEcTf",
  "merchant": "string",
  "channel": "string",
  "reference": "string",
  "created": "2019-08-24T14:15:22Z",
  "lastModified": "2019-08-24T14:15:22Z",
  "state": {
    "currentStatus": "checkout",
    "transitions": [ … ]
  },
  "culture": "string",
  "currency": "string",
  "country": "string",
  "cart": {
    "reference": "string",
    "items": [ … ],
    "discounts": [ … ],
    "total": { … },
    "attributes": { … }
  },
  "shippings": [
    { … }
  ],
  "payments": [
    { … }
  ],
  "customer": {
    "billing": { … },
    "shipping": { … },
    "type": "Person",
    "attributes": { … }
  },
  "consents": [
    { … }
  ],
  "validations": [
    { … }
  ],
  "hooks": [
    { … }
  ],
  "notifications": [
    { … }
  ],
  "total": {
    "includingVat": 1234,
    "excludingVat": 987.2
  },
  "attributes": {
    "property1": null,
    "property2": null
  }
}

Checkout

Operations

Checkout Payment

Operations

Checkout Shipping

Operations