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

Download OpenAPI description
Languages
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

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)

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.

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

OrderStatus

string(OrderStatus)
Enum"checkout""processing""accepted""completed""declined""removed"
"checkout"

Pagination

offsetinteger(int32)read-only

Query offset

limitinteger(int32)read-only

Query limit

sizeinteger(int32)read-only

Size of Data

totalSizeinteger(int32)read-only

Total size of available set

{ "offset": 0, "limit": 0, "size": 0, "totalSize": 0 }

Events

Operations