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.

{
  "_items": [
    {
      "_id": "5ffc3bbb5fea9cdde511bd22",
      "name": "Channel Location 1",
      "address": {
        "restaurantName": "",
        "city": "",
        "postalCode": "",
        "street": "",
        "houseNumber": "",
        "remarks": "",
        "phoneNumber": ""
      },
      "contact": {
        "email": "",
        "firstName": "",
        "lastName": "",
        "phoneNumber": ""
      },
      "comment": "",
      "status": "TESTING",
      "posSystemId": 10000,
      "ignorePOSOrderStatuses": false,
      "enableOutOfStock": false,
      "posSettings": {
        "generic": {
          "ordersWebhookURL": "",
          "hasProductSync": false,
          "orderItemRemarks": "intactItemRemarks"
        }
      },
      "account": "5ff6eba14c5c3fb61e9e6dc1",
      "_updated": "2021-03-16T10:29:45.000000Z",
      "_created": "2021-01-11T11:51:23.000000Z",
      "_deleted": false,
      "_etag": "ea166f6802c34e14226c5d549352682954576fa8",
      "channelLinks": [
        "5ffc3bbc6234b8cfc906a47c",
        "5ffc3bfa5fea9cdde511bd5a"
      ],
      "region": "unknown",
      "enabledDMA": true,
      "_links": {
        "self": {
          "title": "Locations",
          "href": "locations/5ffc3bbb5fea9cdde511bd22"
        },
        "related": {
          "account": {
            "title": "accounts",
            "href": "accounts/5ff6eba14c5c3fb61e9e6dc1"
          },
          "channelLinks": [
            {
              "title": "channelLink",
              "href": "channelLinks/5ffc3bbc6234b8cfc906a47c"
            },
            {
              "title": "channelLink",
              "href": "channelLinks/5ffc3bfa5fea9cdde511bd5a"
            }
          ]
        }
      }
    },

📘

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
Authentication
OAuth2
Click Try It! to start a request and see the response here!