NORCE CHECKOUT
/
CORE
/
Notification
/
Schemas
/
ShippingState

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

Download OpenAPI description
notification.json
notification.yaml
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

Shipping

idstringread-only

Unique identifier for the shipping.

Example: "s_pmHreuEBboeezpixrHMDPQlazU"
merchantstring

Merchant identifier.

Example: "norce"
channelstring

Channel identifier

Example: "1"
statestring

Current state of the shipping.

Enum"intent""removed""processing""failed""confirmed"
referencestring

External reference to shipping.

Example: "e8ed2091-c34c-4837-a3a8-bc827b0dc183"
tmsReferencestring

TMS Reference.

Example: "a935a628-f70c-47a4-a9f6-98c6d08c2ba3"
orderIdstring

ID of the order.

Example: "o_DhZSbDfVzNzuxOzHyCFskzGzaJ"
adapterIdstring

Adapter ID

Example: "ingrid-shipping-adapter"
namestring

Descriptive name of the shipping.

Example: "PostNord MyPack Home"
totalobjectrequired

Total price of the shipping.

total.​includingVatnumber(double)

Total price including vat in the checkout specified currency. Amount in major unit currency.

Example: 1234
total.​excludingVatnumber(double)

Total price excluding vat in the checkout specified currency. Amount in major unit currency.

Example: 987.2
vatRatenumber(double)required

Value-added tax. 25% would be input as 0.25.

Example: 0.25
deliveryDetailsobject

Delivery details.

addonsArray of objects(Addon)

Shipping addons.

attributesobject

Allows you to store any custom attributes for the shipping.

{
  "id": "s_pmHreuEBboeezpixrHMDPQlazU",
  "merchant": "norce",
  "channel": "1",
  "state": "intent",
  "reference": "e8ed2091-c34c-4837-a3a8-bc827b0dc183",
  "tmsReference": "a935a628-f70c-47a4-a9f6-98c6d08c2ba3",
  "orderId": "o_DhZSbDfVzNzuxOzHyCFskzGzaJ",
  "adapterId": "ingrid-shipping-adapter",
  "name": "PostNord MyPack Home",
  "total": {
    "includingVat": 1234,
    "excludingVat": 987.2
  },
  "vatRate": 0.25,
  "deliveryDetails": {
    "carrier": "string",
    "class": "string",
    "product": { … },
    "pickupLocation": { … }
  },
  "addons": [
    { … }
  ],
  "attributes": {
    "property1": null,
    "property2": null
  }
}

ShippingState

string(ShippingState)
Enum"intent""removed""processing""failed""confirmed"
"intent"

State

currentStatusstring

State of the order.

Enum"checkout""processing""accepted""completed""declined""removed"
transitionsArray of objects(Transition)read-only

State transitions.

{
  "currentStatus": "checkout",
  "transitions": [
    { … }
  ]
}

Events

Operations