LoyaltyRewardVoucher

LoyaltyPromotion

Represents a promotion within a loyalty program.

idstring

Unique identifier for the promotion.

Example: "promo-456"

externalCodestring

External code for the promotion.

Example: "ext-promo-789"

namestring

Name of the promotion.

Example: "Summer Sale 2026"

{
  "id": "promo-456",
  "externalCode": "ext-promo-789",
  "name": "Summer Sale 2026"
}

LoyaltyRewardVoucher

Represents a reward voucher within a loyalty program.

idstring

Unique identifier for the reward voucher.

Example: "voucher-101"

namestring

Name of the reward voucher.

Example: "10% Off Next Purchase"

voucherNumberstring

Voucher number used for redemption.

Example: "VCH-2026-ABC123"

externalCodestring

External code for the reward voucher.

Example: "ext-voucher-202"

{
  "id": "voucher-101",
  "name": "10% Off Next Purchase",
  "voucherNumber": "VCH-2026-ABC123",
  "externalCode": "ext-voucher-202"
}

Notification

idstringread-only

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

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

Norce Checkout - Order Management API (1.0)

Schemas

LoyaltyPromotion

LoyaltyRewardVoucher

Notification

Checkout

Checkout Payment

Checkout Shipping