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

Request

Create validation

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

Validation callback

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"
curl -i -X POST \
  'https://customer-slug.api-se.playground.norce.tech/checkout/order/api/v1/checkout/orders/{orderId}/validations' \
  -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": "Validates that all items are currently in stock.",
    "invoke": "{config.adapter.publicUrl}/api/v1/orders/{order.id}/some-validation"
  }'

Responses

OK

Response
No content

Update validation

Request

Update validation

Path
orderIdstringrequired

Order identifier

validationIdstringrequired

Validation 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

Validation callback

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"
curl -i -X PUT \
  'https://customer-slug.api-se.playground.norce.tech/checkout/order/api/v1/checkout/orders/{orderId}/validations/{validationId}' \
  -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": "Validates that all items are currently in stock.",
    "invoke": "{config.adapter.publicUrl}/api/v1/orders/{order.id}/some-validation"
  }'

Responses

OK

Response
No content

Remove validation

Request

Remove validation

Path
orderIdstringrequired

Order identifier

validationIdstringrequired

Validation 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}/validations/{validationId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce'

Responses

OK

Response
No content

Checkout Payment

Operations

Checkout Shipping

Operations