Register Channel

Any channel integrator will provide a standardised registration URL to facilitate customer onboarding/offboarding

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

StatusEvent purpose
registerA new store/location needs to establish a connection between Deliverect and a channel platform
activeA new store/location is ready to start receiving orders into Deliverect from the channel platform
inactiveA customer wants to stop receiving orders to this store/location from the channel platfor

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

AttributePurposeType
statusUpdateURLReceive order status update eventsstring
menuUpdateURLReceive menu update requestsstring
snoozeUnsnoozeURLReceive both snooze and unsnooze requestsstring
busyModeURLReceive busy mode requests (paused/online)string
updatePrepTimeURLReceive preparation time update requestsstring
courierUpdateURLReceive courier update eventsstring
paymentUpdateURLReceived payment update eventsstring

Request parameters

ParameterMeaningType
statusregister Indicates the registration of the channel.
active Denotes the activation of the channel.
inactive Signifies the disabling of the channel.
string
channelLocationIdThe unique id of the Merchant in the channel platformstring
channelLinkIdThe channel link id generated in Deliverect when it's added to the Location.string
locationIdThe location id generated in the Deliverect portal when it's created in Deliverect.string
channelLinkNameThe 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/orderstatusUpdate",
    "menuUpdateURL": "https://integrator.com/menuUpdate",
    "snoozeUnsnoozeURL": "https://integrator.com/snoozeUnsnooze",
    "busyModeURL": "https://integrator.com/busyMode",
    "updatePrepTimeURL": "https://integrator.com/updatePrepTimeURL",
    "courierUpdateURL": "https://integrator.com/courierUpdateURL"
}

📘 Please note, the expected response is case-sensitive

Language
Click Try It! to start a request and see the response here!