Channel Registration

This endpoint gets called in any one of the three scenarios as follows;

Status	Event purpose
`register`	A new store/location needs to establish a connection between Deliverect and a channel platform
`active`	A new store/location is ready to start receiving orders into Deliverect from the channel platform
`inactive`	A customer wants to stop receiving orders to this store/location from the channel platform

We always expect a JSON result which contains the endpoints shown in the table below;

Attribute	Purpose	Type
`statusUpdateURL`	Receive order status update events	string
`menuUpdateURL`	Receive menu update requests	string
`snoozeUnsnoozeURL`	Receive both snooze and unsnooze requests	string
`busyModeURL`	Receive busy mode requests (paused/online)	string
`updatePrepTimeURL`	Receive preparation time update requests	string
`courierUpdateURL`	Receive courier update events	string
`paymentUpdateURL`	Received payment update events	string
`menuUrl`	Merchant Store URL / site URL	string

Request parameters

Parameter	Meaning	Type
`status`	`register` Indicates the registration of the channel. `active` Denotes the activation of the channel. `inactive` Signifies the disabling of the channel.	string
`channelLocationId`	The unique id of the Merchant in the channel platform	string
`channelLinkId`	The channel link id generated in Deliverect when it's added to the Location.	string
`locationId`	The location id generated in the Deliverect portal when it's created in Deliverect.	string
`channelLinkName`	The channel name displayed in Deliverect.	string

Request

{
    "status": "register",
    "channelLocationId": "{{externalChannelLocationId}}",
    "channelLinkId": "{{channelLinkId}}",
    "locationId": "{{locationId}}",
    "channelLinkName": "Order Boss"
}

{
    "status": "active",
    "channelLocationId": "{{externalChannelLocationId}}",
    "channelLinkId": "{{channelLinkId}}",
    "locationId": "{{locationId}}",
    "channelLinkName": "Order Boss"
}

{
    "status": "inactive",
    "channelLocationId": "{{externalChannelLocationId}}",
    "channelLinkId": "{{channelLinkId}}",
    "locationId": "{{locationId}}",
    "channelLinkName": "Order Boss"
}

Response

{
    "statusUpdateURL": "https://integrator.com/statusUpdate",
    "menuUpdateURL": "https://integrator.com/menuUpdate",
    "snoozeUnsnoozeURL": "https://integrator.com/snoozeUnsnooze",
    "busyModeURL": "https://integrator.com/busyMode",
    "updatePrepTimeURL": "https://integrator.com/updatePrepTimeURL",
    "paymentUpdateURL":"https://yourwebhook.com/payment_update",
    "courierUpdateURL":"https://yourwebhook.com/courier_update",
    "menuUrl":"https://integrator.com/store"
}

📘 Please note, the expected response is case-sensitive