Create hook

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

Hook

adapterId	string Callback Adapter ID.
subscribeTo	string Callback event.
target	string Callback event.
invoke	string Full valid url to be called by POST. If the url contains the substring '{order_id}' it will be replaced with the orders id before call is performed.
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}/hooks

Request samples

Payload
curl

application/json

{"adapterId": "jetshop_adapter",
"subscribeTo": "string",
"target": "string",
"invoke": "http://specific-feature-adapter.norce.io/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."
}