NORCE CHECKOUT
/
CORE
/
Order
/
Checkout
/
Delete hook

Norce Checkout - Order Management API (0.1)

Build 2026-01-12 08:21:29

The Order Management API is used to create and handle orders

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

Checkout

Operations

Create hook

Request

Create hook

Path
order_idstringrequired

Order identifier

Headers
x-merchantstringnon-emptyrequired

Merchant identifier.

Example: norce
x-channelstringnon-emptyrequired

Channel identifier

Example: 1
x-adapteridstring

Optional adapter identifier. When provided, hooks belonging to this adapter will not be triggered for changes made by the adapter itself.

Example: qliro_checkout_adapter
Bodyapplication/jsonrequired

Hook

adapterIdstring
Example: "jetshop_adapter"
subscribeTostring
targetstring
invokestring

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"
versionstring

The version of the order body you expect to receive in the callback.

Enum"v0""v1"
curl -i -X POST \
  'https://customer-slug.api-se.playground.norce.tech/checkout/order/api/v0/checkout/orders/{order_id}/hooks' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce' \
  -d '{
    "adapterId": "jetshop_adapter",
    "subscribeTo": "string",
    "target": "string",
    "invoke": "http://specific-feature-adapter.norce.io/api/v1/callbacks/orders/{order_id}/specific-callback",
    "version": "v0"
  }'

Responses

OK

Response
No content

Delete hook

Request

Delete hook

Path
order_idstringrequired

Order identifier

hook_idstringrequired

Hook identifier

Headers
x-merchantstringnon-emptyrequired

Merchant identifier.

Example: norce
x-channelstringnon-emptyrequired

Channel identifier

Example: 1
x-adapteridstring

Optional adapter identifier. When provided, hooks belonging to this adapter will not be triggered for changes made by the adapter itself.

Example: qliro_checkout_adapter
curl -i -X DELETE \
  'https://customer-slug.api-se.playground.norce.tech/checkout/order/api/v0/checkout/orders/{order_id}/hooks/{hook_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce'

Responses

OK

Response
No content

Create notification

Request

Create notification

Path
order_idstringrequired

Order identifier

Headers
x-merchantstringnon-emptyrequired

Merchant identifier.

Example: norce
x-channelstringnon-emptyrequired

Channel identifier

Example: 1
x-adapteridstring

Optional adapter identifier. When provided, hooks belonging to this adapter will not be triggered for changes made by the adapter itself.

Example: qliro_checkout_adapter
Bodyapplication/jsonrequired

Notification

idstring

Unique ID for the Notification

Example: "ocGooDddTOjKOuFmNnkEozEpfuTh"
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"
referencestring

Reference for the Notification. Should (but not required to) be unique for the order. Used to track notifications across different orders.

Example: "PuXCudQEiWTOHvquGGolFUVOuy"
descriptionstring

Purpose or effect of the notification.

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

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

Example: "/state/currentStatus"
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"}
invokestring

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"
versionstring

The version of the order body you expect to receive in the callback.

Enum"v0""v1"
delayinteger(int32)

The delay in ms before the notification is sent.

curl -i -X POST \
  'https://customer-slug.api-se.playground.norce.tech/checkout/order/api/v0/checkout/orders/{order_id}/notifications' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce' \
  -d '{
    "id": "ocGooDddTOjKOuFmNnkEozEpfuTh",
    "adapterId": "jetshop_adapter",
    "reference": "PuXCudQEiWTOHvquGGolFUVOuy",
    "description": "Export payment information to Jetshop when order has been completed.",
    "scope": "/state/currentStatus",
    "schema": {
      "const": "completed"
    },
    "invoke": "{configuration.adapter.internalUrl}/api/v1/callbacks/orders/{order.id}/specific-callback",
    "version": "v0",
    "delay": 0
  }'

Responses

OK

Response
No content

Checkout Payment

Operations

Checkout Shipping

Operations