Norce.Checkout.Notification

Version: Created: 10/28/2025 14:04:04

Related Documentation

For conceptual documentation and usage guides, see:

• NCO Notification - Understanding NCO notifications and events
• NCO Introduction - Getting started with Norce Checkout

Base URLs

• https://norce-open-beta.api-se.playground.norce.tech/checkout/notification - Public
• https://notification.checkout.test.internal.norce.tech - Internal Test
• https://notification.checkout.playground.internal.norce.tech - Internal Playground
• https://notification.checkout.stage.internal.norce.tech - Internal Stage
• https://notification.checkout.prod.internal.norce.tech - Internal Production

Authentication

Bearer

• Type: apiKey
• Description: Authorization header using the bearer scheme. Example: 'Bearer a3bcdABCaB12abc3AbCDAB5AbcABCaBcABC5ab3c5A0='

Endpoints

GET /api/v1/events

Parameters

• x-merchant (header) required
  • Type: string
• channel (query)
  • Type: string
• adapter_id (query)
  • Type: string
• reference (query)
  • Type: string
• order_id (query)
  • Type: string
• offset (query)
  • Pagination offset
  • Type: integer
• limit (query)
  • Pagination limit
  • Type: integer

Responses

200

OK

Content-Type: application/json

Schema: NotificationEventPaginationSet

GET /api/v1/events/{event_id}

Parameters

• x-merchant (header) required
  • Type: string
• event_id (path) required
  • Type: string

Responses

200

OK

Content-Type: application/json

Schema: NotificationEvent

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

Parameters

• x-merchant (header) required
  • Type: string
• event_id (path) required
  • Type: string

Responses

200

OK

Schemas

Addon

Properties

• reference (string)
  • Shipping addon reference.
• price (number)
  • Cost of addon. Amount in major unit currency.

Address

Properties

• type
  • The type of customer
  • Example: "Person"
• givenName (string)
  • Given name or first name.
  • Example: "Rosalinainho"
• familyName (string)
  • Family name or last name.
  • Example: "Undulatsson"
• careOf (string)
  • Care of.
  • Example: "Olleinho Jyckesson"
• reference (string)
  • Reference to the customer
• organizationName (string)
  • Name of the Organization
  • Example: "Storm"
• streetAddress (string)
  • Address or street name, first line.
  • Example: "Adaptivevägen 18"
• streetAddress2 (string)
  • Address or street name, second line.
  • Example: "Lgh 1203"
• postalCode (string)
  • Postal code, zip or post code.
  • Example: "955 60"
• city (string)
  • City.
  • Example: "Boden"
• region (string)
  • State or region.
  • Example: "Norrbotten"
• country (string)
  • Country. ISO 3166 alpha-2.
  • Example: "SE"
• phone (string)
  • Phone number.
  • Example: "0753892233"
• email (string)
  • E-mail address.
  • Example: "rosalinainho.undulatsson@example.com"
• nationalIdentificationNumber (string)
  • Number used to identify individuals. Eg. could be used for Personal identity number (personnummer) in Sweden.
  • Example: "890201-3286"
• organizationIdentificationNumber (string)
  • Number used to identify organizations or legal persons. Eg. could be used for Corporate identity number (organisationsnummer) in Sweden.
  • Example: "212000-1355"
• attributes (object)
  • Allows you to store any custom attributes for the address.

Callback

Properties

• id (string)
  • Unique ID for the callback.
  • Example: "oc_BaDIudFOjBEuFmLlmDExePUFTh"
• adapterId (string)
  • Callback Adapter ID.
  • Example: "jetshop_adapter"
• url (string)
  • 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"

Cart

Properties

• reference (string)
  • Cart Reference
• items (array) - Array of Item
  • List of Items
• discounts (array) - Array of Discount
  • List of Discounts
• total
  • Cart total excluding shipping fees
• attributes (object)
  • Allows you to store any custom attributes for cart.

Consent

Properties

• id (string)
  • Unique ID for the consent item.
  • Example: "ci_newsleter"
• checked (boolean)
  • Consent checked status.
• text (string)
  • Consent description.
• required (boolean)
  • Required for transition order state to processing

Customer

Properties

• billing
  • Billing address to the customer
• shipping
  • Shipping address to the customer
• type required
  • The type of customer
  • Example: "Person"
• attributes (object)
  • Allows you to store any custom attributes for the customer.

CustomerType

DeliveryDetails

Properties

• carrier (string)
  • Carrier name.
• class (string)
  • Shipping class.
• product
  • Shipping product.
• pickupLocation
  • Pickup location.

Discount

Properties

• type
  • Indicates if the discount applies to items or shipping.
• name (string)
  • Name of the discount.
• code (string)
  • Discount code.
• value
  • Total sum of discount.
• attributes (object)
  • Allows you to store any custom attributes for the discount.

DiscountType

Hook

Properties

• id (string)
  • Unique ID for the callback.
  • Example: "oc_BaDIudFOjBEuFmLlmDExePUFTh"
• adapterId (string)
  • Callback Adapter ID.
  • Example: "jetshop_adapter"
• subscribeTo (string)
  • Callback event.
• target (string)
  • Callback event.
• invoke (string)
  • 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"

Item

Properties

• id (string)
  • Unique identifier for the order
  • Example: "ci_FpEzyBvBBUyKxkeNriFUxZOCje"
• reference (string)
  • Optional. Platform cart item reference.
• name (string)
  • Descriptive name of the item.
  • Example: "T-Shirt XL"
• sku (string)
  • SKU or article number.
  • Example: "A000123"
• url (string)
  • URL to the product page.
  • Example: "https://example.com/products/A000123"
• imageUrl (string)
  • URL to an image showing the item.
  • Example: "https://example.com/products/A000123/images/1"
• quantity (integer)
  • Quantity of the item.
  • Example: 2
• unit (string)
  • Unit used to describe the quantity. Ex. st, kg
  • Example: "st"
• price
  • Unit price, excluding discount
• total
  • Total sum for all quantities including discount.
• originalTotal
  • Total sum for all quantities excluding discount.
• vatRate (number)
  • Value-added tax. 25% would be input as 0.25.
  • Example: 0.25
• discounts (array) - Array of Discount
  • Discounts applied to item.
• attributes (object)
  • Allows you to store any custom attributes for the item.

Notification

Properties

• id (string) required
  • Unique ID for the Notification
  • Example: "ocGooDddTOjKOuFmNnkEozEpfuTh"
• adapterId (string)
  • 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"
• reference (string) required
  • Reference for the Notification. Should (but not required to) be unique for the order. Used to track notifications across different orders.
  • Example: "PuXCudQEiWTOHvquGGolFUVOuy"
• description (string)
  • Purpose or effect of the notification.
  • Example: "Export payment information to Jetshop when order has been completed."
• scope (string) required
  • Valid json path inside the order. Does not support scope inside arrays.
  • Example: "/state/currentStatus"
• schema (object)
  • 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"}
• invoke (string) required
  • 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"

NotificationEvent

Notification event model in the context of an audit log

Properties

• id (string) required
  • Unique identifier of the event message. Supplied by service bus.
  • Example: "018f1ac8-7409-724b-b864-0a0a049719e2"
• createdAt (string) required
  • The time the event was created. Supplied by service bus.
  • Example: "2024-04-26T09:09:14.382889Z"
• merchant (string) required
  • Merchant identifier.
  • Example: "norce-checkout-demo"
• channel (string) required
  • Merchant channel.
  • Example: "b2c"
• orderId (string) required
  • Order Id.
  • Example: "oanzNtkz"
• adapterId (string)
  • Adapter Id.
  • Example: "norce-commerce-adapter"
• reference (string) required
  • Notification Reference.
  • Example: "norce-commerce-adapter-export-on-accepted"
• description (string)
  • Notification Description.
  • Example: "Export the order to Norce Commerce when order status reaches Accepted"
• payload required
  • The message payload of the event.
• attempts (array) - Array of NotificationEventAttempt required
  • The attempts made to process the event.

NotificationEventAttempt

Properties

• id (string) required
  • Generated id for the specific attempt made.
  • Example: "a55f104a-18ca-4596-b813-f232a0aecb28"
• timestamp (string) required
  • Timestamp for when the attempt was made.
  • Example: "2024-04-26T09:09:15.174893Z"
• statusCode (integer) required
  • Status Code received in response.
  • Example: 200
• responseBody
  • ProblemDetails if supplied on non-successful response, null otherwise.
• responseHeaders (object)
  • Headers received in response.
  • Example: {"date":["Fri, 26 Apr 2024 09:09:15 GMT"]}

NotificationEventPaginationSet

Properties

• data (array) - Array of NotificationEvent
  • Data set
• pagination
  • Pagination meta data

NotificationEventPayload

Properties

• notification required
  • Notification as it appeared on the order at the time when the event occured.
• order required
  • Order as it appeared at the time when the event occured.

Order

Properties

• id (string)
  • Unique identifier for the order.
  • Example: "o_yClTSySjyAuuBjmiBlHCjuEcTf"
• merchant (string) required
  • Merchant identifier.
• channel (string) required
  • Merchant channel.
• reference (string)
  • External order reference
• created (string)
  • Order creation date time
• lastModified (string)
  • Order last modified date time
• state
  • Order state
• culture (string)
  • Order Culture
• currency (string)
  • Order Currency
• country (string)
  • Order Country
• cart
  • Order cart
• shippings (array) - Array of Shipping
  • Shippings related to the order
• payments (array) - Array of Payment
  • Payments related to the order
• customer
  • Customer information
• consents (array) - Array of Consent
  • Order consents
• validations (array) - Array of 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.
• hooks (array) - Array of Hook
  • Hooks, added by a separate endpoint.
• notifications (array) - Array of Notification
  • Order notifications are called after an event has occurred, such as order reaching 'Completed' state.
• total
  • Order total including shipping fees
• attributes (object)
  • Allows you to store any custom attributes for the order.

OrderStatus

Pagination

Properties

• offset (integer)
  • Query offset
• limit (integer)
  • Query limit
• size (integer)
  • Size of Data
• totalSize (integer)
  • Total size of available set

Payment

Properties

• id (string)
  • Unique ID of the payment.
  • Example: "p_KBiXuYjvYxsezKCQAMuuSKGDaT"
• adapterId (string)
  • Adapter ID
  • Example: "klarna-checkout"
• name (string)
  • Payment service provider name
• merchant (string)
  • Merchant identifier.
  • Example: "norce"
• channel (string)
  • Merchant channel.
• currency (string)
  • Currency of the purchase. ISO 4217.
  • Example: "SEK"
• type
  • Type of payment.
  • Example: "default"
• orderId (string)
  • ID of the order.
  • Example: "o_DhZSbDfVzNzuxOzHyCFskzGzaJ"
• amount (number)
  • The amount to be covered by the payment. Amount in major unit currency.
  • Example: 10
• upperLimitAmount (number)
  • The upper limit to be used by this payment. For example the amount available on a voucher. Amount in major unit currency.
  • Example: 100
• state
  • The state of the payment.
  • Example: "Intent"
• reference (string)
  • External reference to payment service provider.
  • Example: "7d31e2cf-2d46-4db0-b87d-d65dfaae298f"
• attributes (object)
  • Allows you to store any custom attributes for the payment.
• actions (array) - Array of PaymentAction
  • After payment actions

PaymentAction

Properties

• id (string)
• adapterId (string) required
• type (string) required
• url (string) required

PaymentState

PaymentType

PickupLocation

Properties

• reference (string)
  • Pickup location reference.
• name (string)
  • Name of pickup location.
• address
  • Pickup location address.

PickupLocationAddress

Properties

• streetAddress (string)
  • Address or street name, first line.
  • Example: "Adaptivevägen 18"
• city (string)
  • City.
  • Example: "Boden"
• postalCode (string)
  • Postal code, zip or post code.
  • Example: "955 60"
• country (string)
  • Country. ISO 3166 alpha-2.
  • Example: "SE"

Price

Properties

• includingVat (number)
  • Total price including vat in the checkout specified currency. Amount in major unit currency.
  • Example: 1234
• excludingVat (number)
  • Total price excluding vat in the checkout specified currency. Amount in major unit currency.
  • Example: 987.2

ProblemDetails

Properties

• detail (string)
  • A human-readable explanation specific to this occurrence of the problem.
• instance (string)
  • A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information. if dereferenced.
• status (integer) required
  • The HTTP status code generated by the origin server for this occurrence of the problem.
• title (string)
  • A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization(e.g., using proactive content negotiation; see[RFC7231], Section 3.4).
• type (string)
  • A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be "about:blank".

Product

Properties

• reference (string)
  • Product reference.
• name (string)
  • Carrier product name.

Shipping

Properties

• id (string)
  • Unique identifier for the shipping.
  • Example: "s_pmHreuEBboeezpixrHMDPQlazU"
• merchant (string)
  • Merchant identifier.
  • Example: "norce"
• channel (string)
  • Channel identifier
  • Example: "1"
• state
  • Current state of the shipping.
• reference (string)
  • External reference to shipping.
  • Example: "e8ed2091-c34c-4837-a3a8-bc827b0dc183"
• tmsReference (string)
  • TMS Reference.
  • Example: "a935a628-f70c-47a4-a9f6-98c6d08c2ba3"
• orderId (string)
  • ID of the order.
  • Example: "o_DhZSbDfVzNzuxOzHyCFskzGzaJ"
• adapterId (string)
  • Adapter ID
  • Example: "ingrid-shipping-adapter"
• name (string)
  • Descriptive name of the shipping.
  • Example: "PostNord MyPack Home"
• total required
  • Total price of the shipping.
• vatRate (number) required
  • Value-added tax. 25% would be input as 0.25.
  • Example: 0.25
• deliveryDetails
  • Delivery details.
• addons (array) - Array of Addon
  • Shipping addons.
• attributes (object)
  • Allows you to store any custom attributes for the shipping.

ShippingState

State

Properties

• currentStatus
  • State of the order.
• transitions (array) - Array of Transition
  • State transitions.

Transition

Properties

• status
  • State of the order.
• timeStamp (string)
  • UTC Time when state was set.