NORCE CHECKOUT

CORE

Order

DiscountType

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

Discount

typestring

Indicates if the discount applies to items or shipping.

Enum"item""shipping"

namestring

Name of the discount.

referencestring

Discount reference.

descriptionstring

Description of the discount.

codestring

Discount code.

valueobject

Total sum of discount.

attributesobject

Allows you to store any custom attributes for the discount.

{
  "type": "item",
  "name": "string",
  "reference": "string",
  "description": "string",
  "code": "string",
  "value": {
    "includingVat": 1234,
    "excludingVat": 987.2
  },
  "attributes": {
    "property1": null,
    "property2": null
  }
}

DiscountType

string(DiscountType)

Enum"item""shipping"

"item"

Hook

idstringread-only

Unique ID for the callback.

Example: "oc_BaDIudFOjBEuFmLlmDExePUFTh"

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"

{
  "id": "oc_BaDIudFOjBEuFmLlmDExePUFTh",
  "adapterId": "jetshop_adapter",
  "reference": "string",
  "description": "string",
  "scope": "string",
  "target": "string",
  "invoke": "{config.adapter.publicUrl}/api/v1/orders/{order.id}/some-hook",
  "version": "v0"
}

Checkout

Operations

Checkout Payment

Operations

Checkout Shipping

Operations