NORCE CHECKOUT

CORE

Notification

Item

Norce.Checkout.Notification (Created: 12/02/2025 08:33:13)

Download OpenAPI description

notification.json

notification.yaml

Servers

Public

https://norce-open-beta.api-se.playground.norce.tech/checkout/notification/

Internal Test

https://notification.checkout.test.internal.norce.tech/

Internal Playground

https://notification.checkout.playground.internal.norce.tech/

Internal Stage

https://notification.checkout.stage.internal.norce.tech/

Internal Production

https://notification.checkout.prod.internal.norce.tech/

Schemas

Hook

idstringread-only

Unique ID for the callback.

Example: "oc_BaDIudFOjBEuFmLlmDExePUFTh"

adapterIdstring

Callback Adapter ID.

Example: "jetshop_adapter"

subscribeTostring

Callback event.

targetstring

Callback event.

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"

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

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"

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.

attributesobject

Allows you to store any custom attributes for the item.

{
  "id": "ci_FpEzyBvBBUyKxkeNriFUxZOCje",
  "reference": "string",
  "name": "T-Shirt XL",
  "sku": "A000123",
  "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": [
    { … }
  ],
  "attributes": {
    "property1": null,
    "property2": null
  }
}

Notification

idstringnon-emptyrequired

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"

referencestringnon-emptyrequired

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

scopestringnon-emptyrequired

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

invokestringnon-emptyrequired

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"

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

Events

Operations