Norce Checkout - Order Management API (1.0)

Build 2026-10-07 13:08:32

The Order Management API is used to create and handle orders

Download OpenAPI description

order-v1.json

order-v1.yaml

Servers

Playground

https://{slug}.api-se.playground.norce.tech/checkout/order/

Stage

https://{slug}.api-se.stage.norce.tech/checkout/order/

Production

https://{slug}.api-se.norce.tech/checkout/order/

Schemas

UpsellState

string(UpsellState)

Enum"created""actionRequired""completed""failed"

"created"

UpsellTransaction

idstring

Provider-specific id for referencing the upsell transaction (e.g. Qliro upsellId, Walley checkout reference)

statestring

State derived from provider status mapping

Enum"created""actionRequired""completed""failed"

itemIdsArray of strings

The IDs of the cart items represented by this upsell transaction

attributesobject

Metadata that may vary between PSPs (items, URLs, constraints, ...)

{
  "id": "string",
  "state": "created",
  "itemIds": [
    "string"
  ],
  "attributes": {
    "property1": null,
    "property2": null
  }
}

Validation

idstringread-only

Unique ID for the callback.

Example: "oc_BaDIudFOjBEuFmLlmDExePUFTh"

adapterIdstring

Validation Adapter ID.

Example: "jetshop_adapter"

referencestring

Reference for the callback. Should be the same across orders. Used to track callbacks in event logs.

descriptionstring

Description of the callback purpose.

Example: "Validates that all items are currently in stock."

invokestring

Url to invoke on callback trigger. Can include references to adapter configuration and order inside curly braces.

Example: "{config.adapter.publicUrl}/api/v1/orders/{order.id}/some-validation"

{
  "id": "oc_BaDIudFOjBEuFmLlmDExePUFTh",
  "adapterId": "jetshop_adapter",
  "reference": "string",
  "description": "Validates that all items are currently in stock.",
  "invoke": "{config.adapter.publicUrl}/api/v1/orders/{order.id}/some-validation"
}

Checkout

Operations

Checkout Payment

Operations

Checkout Shipping

Operations