Get Channel Links

This endpoint will return all the channel links that exist under the locations linked to your partner account. You can add additional queries to specify a single account.

Within the response, you will find information about the location ids, channel names, address details, contacts and more. As results can potentially be paginated, please reference the link below which shows how to correctly handle this.

▶ Guide on Query Parameters
STATUS IDCHANNEL STATUS
0INACTIVE
1SUSPENDED
2TESTING
3SUBSCRIBED
4ONBOARDING
{
    "_items": [
        {
            "_id": "62fd*************2ddaf0b",
            "name": "OrderWeb",
            "channelSettings": {
                "storeUrl": "",
                "storeId": ""
            },
            "location": "5c74*************44b8",
            "channel": 1,
            "posSystemId": 1,
            "posSettings": {
                "generic": {}
            },
            "status": 0,
            "account": "5be9****************46d4",
            "_updated": "2023-03-01T11:31:58.688000Z",
            "_created": "2022-08-18T08:04:59.000000Z",
            "_deleted": false,
            "reportingEndpoints": [],
            "enabledDMA": true,
            "bufferOrders": false,
            "ignorePOSOrderStatuses": true,
            "posSystem": "Generic",
            "menuUrl": "",
            "brandId": "602a4*************27a76b",
            "_etag": "2d1ef5**d5f8f59f",
            "openingHours": [],
            "defaultPreparationTime": 15,
            "_links": {
                "self": {
                    "title": "channelLink",
                    "href": "channelLinks/62fd*************2ddaf0b"
                },
                "related": {
                    "account": {
                        "title": "accounts",
                        "href": "accounts/5be9****************46d4"
                    },
                    "location": {
                        "title": "Locations",
                        "href": "locations/5c74*************44b8"
                    },
                    "brandId": {
                        "title": "accounts",
                        "href": "accounts/5be9****************46d4"
                    }
                }
            }
        }

    ],
   "_links": {
        "parent": {
            "title": "home",
            "href": "/"
        },
        "self": {
            "title": "channelLinks",
            "href": "channelLinks"
        },
        "next": {
            "title": "next page",
            "href": "channelLinks?page=2"
        },
        "last": {
            "title": "last page",
            "href": "channelLinks?page=5954"
        }
    },
    "_meta": {
        "page": 1,
        "max_results": 25,
        "total": 148850
    }
}

📘

Get the channel links for a specific location.

In order to find the channel links of a specific location, you need to add the locationId in the URL path.
https://api.staging.deliverect.com/locations/{locationId}?embedded={"channelLinks":1}

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