NORCE CHECKOUT

CORE

Notification

NotificationEventPayload

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

NotificationEventPaginationSet

dataArray of objects(NotificationEvent)read-only

Data set

paginationobjectread-only

Pagination meta data

{
  "data": [
    { … }
  ],
  "pagination": {
    "offset": 0,
    "limit": 0,
    "size": 0,
    "totalSize": 0
  }
}

NotificationEventPayload

notificationobjectrequired

Notification as it appeared on the order at the time when the event occured.

notification.idstringnon-emptyrequired

Unique ID for the Notification

Example: "ocGooDddTOjKOuFmNnkEozEpfuTh"

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

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

notification.descriptionstring

Purpose or effect of the notification.

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

notification.scopestringnon-emptyrequired

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

Example: "/state/currentStatus"

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

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

orderobjectrequired

Order as it appeared at the time when the event occured.

order.idstringread-only

Unique identifier for the order.

Example: "o_yClTSySjyAuuBjmiBlHCjuEcTf"

order.merchantstringnon-emptyrequired

Merchant identifier.

order.channelstringnon-emptyrequired

Merchant channel.

order.referencestring

External order reference

order.createdstring(date-time)read-only

Order creation date time

order.lastModifiedstring(date-time)read-only

Order last modified date time

order.stateobject

Order state

order.culturestring

Order Culture

order.currencystring

Order Currency

order.countrystring

Order Country

order.cartobject

Order cart

order.shippingsArray of objects(Shipping)read-only

Shippings related to the order

order.paymentsArray of objects(Payment)read-only

Payments related to the order

order.customerobject

Customer information

order.consentsArray of objects(Consent)

Order consents

order.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 (eg. http status code 400), note however that in case of a time constraint the action might be completed without a successful response.

order.hooksArray of objects(Hook)

Hooks, added by a separate endpoint.

order.notificationsArray of objects(Notification)

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

order.totalobject

Order total including shipping fees

order.attributesobject

Allows you to store any custom attributes for the order.

{
  "notification": {
    "id": "ocGooDddTOjKOuFmNnkEozEpfuTh",
    "adapterId": "jetshop_adapter",
    "reference": "PuXCudQEiWTOHvquGGolFUVOuy",
    "description": "Export payment information to Jetshop when order has been completed.",
    "scope": "/state/currentStatus",
    "schema": { … },
    "invoke": "{configuration.adapter.internalUrl}/api/v1/callbacks/orders/{order.id}/specific-callback"
  },
  "order": {
    "id": "o_yClTSySjyAuuBjmiBlHCjuEcTf",
    "merchant": "string",
    "channel": "string",
    "reference": "string",
    "created": "2019-08-24T14:15:22Z",
    "lastModified": "2019-08-24T14:15:22Z",
    "state": { … },
    "culture": "string",
    "currency": "string",
    "country": "string",
    "cart": { … },
    "shippings": [ … ],
    "payments": [ … ],
    "customer": { … },
    "consents": [ … ],
    "validations": [ … ],
    "hooks": [ … ],
    "notifications": [ … ],
    "total": { … },
    "attributes": { … }
  }
}

Order

idstringread-only

Unique identifier for the order.

Example: "o_yClTSySjyAuuBjmiBlHCjuEcTf"

merchantstringnon-emptyrequired

Merchant identifier.

channelstringnon-emptyrequired

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

Order Culture

currencystring

Order Currency

countrystring

Order Country

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)

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

Events

Operations