NORCE CHECKOUT

CORE

Notification

/api/v1/events

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

Events

Operations

/api/v1/events

Request

Query

channelstring

adapter_idstring

referencestring

order_idstring

offsetinteger(int32)

Pagination offset

Default 0

limitinteger(int32)

Pagination limit

Default 10

Headers

x-merchantstringrequired

curl -i -X GET \
  https://norce-open-beta.api-se.playground.norce.tech/checkout/notification/api/v1/events \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-merchant: string'

Responses

Bodyapplication/json

dataArray of objects(NotificationEvent)read-only

Data set

paginationobjectread-only

Pagination meta data

Response

application/json

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

/api/v1/events/{event_id}

Request

Path

event_idstringrequired

Headers

x-merchantstringrequired

curl -i -X GET \
  'https://norce-open-beta.api-se.playground.norce.tech/checkout/notification/api/v1/events/{event_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-merchant: string'

Responses

Bodyapplication/json

idstringnon-emptyrequired

Unique identifier of the event message. Supplied by service bus.

Example: "018f1ac8-7409-724b-b864-0a0a049719e2"

createdAtstringnon-emptyrequired

The time the event was created. Supplied by service bus.

Example: "2024-04-26T09:09:14.382889Z"

merchantstringnon-emptyrequired

Merchant identifier.

Example: "norce-checkout-demo"

channelstringnon-emptyrequired

Merchant channel.

Example: "b2c"

orderIdstringnon-emptyrequired

Order Id.

Example: "oanzNtkz"

adapterIdstring

Adapter Id.

Example: "norce-commerce-adapter"

referencestringnon-emptyrequired

Notification Reference.

Example: "norce-commerce-adapter-export-on-accepted"

descriptionstring

Notification Description.

Example: "Export the order to Norce Commerce when order status reaches Accepted"

payloadobjectrequired

The message payload of the event.

payload.notificationobjectrequired

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

payload.notification.idstringnon-emptyrequired

Unique ID for the Notification

Example: "ocGooDddTOjKOuFmNnkEozEpfuTh"

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

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

payload.notification.descriptionstring

Purpose or effect of the notification.

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

payload.notification.scopestringnon-emptyrequired

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

Example: "/state/currentStatus"

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

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

payload.orderobjectrequired

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

payload.order.idstringread-only

Unique identifier for the order.

Example: "o_yClTSySjyAuuBjmiBlHCjuEcTf"

payload.order.merchantstringnon-emptyrequired

Merchant identifier.

payload.order.channelstringnon-emptyrequired

Merchant channel.

payload.order.referencestring

External order reference

payload.order.createdstring(date-time)read-only

Order creation date time

payload.order.lastModifiedstring(date-time)read-only

Order last modified date time

payload.order.stateobject

Order state

payload.order.culturestring

Order Culture

payload.order.currencystring

Order Currency

payload.order.countrystring

Order Country

payload.order.cartobject

Order cart

payload.order.shippingsArray of objects(Shipping)read-only

Shippings related to the order

payload.order.paymentsArray of objects(Payment)read-only

Payments related to the order

payload.order.customerobject

Customer information

payload.order.consentsArray of objects(Consent)

Order consents

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

payload.order.hooksArray of objects(Hook)

Hooks, added by a separate endpoint.

payload.order.notificationsArray of objects(Notification)

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

payload.order.totalobject

Order total including shipping fees

payload.order.attributesobject

Allows you to store any custom attributes for the order.

attemptsArray of objects(NotificationEventAttempt)required

The attempts made to process the event.

attempts[].idstringnon-emptyrequired

Generated id for the specific attempt made.

Example: "a55f104a-18ca-4596-b813-f232a0aecb28"

attempts[].timestampstringnon-emptyrequired

Timestamp for when the attempt was made.

Example: "2024-04-26T09:09:15.174893Z"

attempts[].statusCodeinteger(int32)required

Status Code received in response.

Example: 200

attempts[].responseBodyobject

ProblemDetails if supplied on non-successful response, null otherwise.

attempts[].responseHeadersobject

Headers received in response.

Example: {"date":["Fri, 26 Apr 2024 09:09:15 GMT"]}

Response

application/json

{
  "id": "018f1ac8-7409-724b-b864-0a0a049719e2",
  "createdAt": "2024-04-26T09:09:14.382889Z",
  "merchant": "norce-checkout-demo",
  "channel": "b2c",
  "orderId": "oanzNtkz",
  "adapterId": "norce-commerce-adapter",
  "reference": "norce-commerce-adapter-export-on-accepted",
  "description": "Export the order to Norce Commerce when order status reaches Accepted",
  "payload": {
    "notification": { … },
    "order": { … }
  },
  "attempts": [
    { … }
  ]
}

/api/v1/events/{event_id}/retry

Request

Path

event_idstringrequired

Headers

x-merchantstringrequired

curl -i -X POST \
  'https://norce-open-beta.api-se.playground.norce.tech/checkout/notification/api/v1/events/{event_id}/retry' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-merchant: string'

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

Schemas

Events

/api/v1/events

Request

Responses

Did the information on the page help you?

/api/v1/events/{event_id}

Request

Responses

Did the information on the page help you?

/api/v1/events/{event_id}/retry

Request

Responses

Did the information on the page help you?