Create notification

SecurityBearer

Request

path Parameters

order_id

required

string

Order identifier

header Parameters

x-merchant required	string non-empty Merchant identifier. Example: norce
x-channel required	string non-empty Channel identifier Example: 1

Request Body schema: application/json

Notification

id	string Unique ID for the Notification
adapterId	string 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.
reference	string Reference for the Notification. Should (but not required to) be unique for the order. Used to track notifications across different orders.
description	string Purpose or effect of the notification.
scope	string Valid json path inside the order. Does not support scope inside arrays.
	object 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.
invoke	string Url to invoke on notification trigger. Can include references to adapter configuration and order inside curly braces.
version	string The version of the order body you expect to receive in the callback. Enum: "v0" "v1"

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

post/api/v0/checkout/orders/{order_id}/notifications

Request samples

Payload
curl

application/json

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

Response samples

application/json

{"code": "order-not-found",
"message": "Order with id:{id} not found."
}