NORCE CHECKOUT
/
CORE
/
Order
/
Checkout
/
Delete hook

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

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

Validation Adapter ID.

Example: "jetshop_adapter"
referencestring

Reference for the hook. Should be the same across orders. Used to track hooks in event logs.

descriptionstring

Description of the hook purpose.

scopestring

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

targetstring

The path to the property in the order that the hooks might respond with patches to. Used to correctly determine the order to call each hook in.

invokestring

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

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

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

Enum"v0""v1"
curl -i -X POST \
  'https://customer-slug.api-se.playground.norce.tech/checkout/order/api/v1/checkout/orders/{orderId}/hooks' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce' \
  -d '{
    "adapterId": "jetshop_adapter",
    "reference": "string",
    "description": "string",
    "scope": "string",
    "target": "string",
    "invoke": "{config.adapter.publicUrl}/api/v1/orders/{order.id}/some-hook",
    "version": "v0"
  }'

Responses

OK

Response
No content

Delete hook

Request

Delete hook

Path
orderIdstringrequired

Order identifier

hookIdstringrequired

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/v1/checkout/orders/{orderId}/hooks/{hookId}' \
  -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
orderIdstringrequired

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

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 be the same across orders. Used to track notifications in event logs.

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: "{config.adapter.publicUrl}/api/v1/callbacks/orders/{order.id}/specific-callback"
versionstring

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

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/v1/checkout/orders/{orderId}/notifications' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce' \
  -d '{
    "adapterId": "jetshop_adapter",
    "reference": "PuXCudQEiWTOHvquGGolFUVOuy",
    "description": "Export payment information to Jetshop when order has been completed.",
    "scope": "/state/currentStatus",
    "schema": {
      "const": "completed"
    },
    "invoke": "{config.adapter.publicUrl}/api/v1/callbacks/orders/{order.id}/specific-callback",
    "version": "v0",
    "delay": 0
  }'

Responses

OK

Response
No content

Checkout Payment

Operations

Checkout Shipping

Operations