Creates a notifier for an order

POST

/api/v1/product/notifier/{orderId}/{type}/{uri}

v1-product

Create a notifier for a particular order. Parameters can be supplied in the path

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.kompany.com//api/v1/product/notifier///'

Response Example

200 - Example 1

{
    "callback": "string",
    "identity": "string",
    "lastCallTime": {},
    "lastResponseCode": 0,
    "notifierType": "string",
    "productOrderIdentity": "string"
}

Request

Path Params

orderId

string

required

ID of the ProductOrder as returned from a /product/buy call - 32 character hex value

type

string

required

Type of the notifier - indicates the action the notifier will perform. Currently GET and POST are supported which performs an http(s) GET/POST to the supplied uri with appended notifierId= and orderId= parameters when the order processing is completed. Upon the POST request the order object is sent as a JSON body

uri

string

required

URI of the notifier for the 'complete' action. Currently only a GET method HTTP(s) URL is supported. 1 to 250 characters long. Every slash in the URI must be replaced by a ~

Responses

🟢200Details of configured product order notification

application/json

Body

callback

string

required

identity

string

optional

lastCallTime

object

required

lastResponseCode

integer

required

notifierType

string

required

productOrderIdentity

string

required

🔴500500

Returns metadata for a notifier

Places a concierge order