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

Norce Checkout - Order Management API (1.0)

Schemas

DiscountType

Hook

HttpStatusCode

Checkout

Checkout Payment

Checkout Shipping