Show more

Use to navigate results, ENTER to select one, ESC to close

Type in any word to easily find the endpoint, property or group of operations you are looking for.

Deliverect APIs hub
  • Coupons
  • Giftcard API
  • KDS API
  • Loyalty API
  • Restaurant POS API
Back to hub page
API Explorer API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
Restaurant POS API logo Restaurant POS API logo dark

Topics

  • Introduction
  • Authentication

Endpoints

  • Authentication
    • Machine 2 Machine Access Token POST
  • Endpoints
    • Insert/update products and categories POST
    • Categories for account GET
    • Integrated channels GET
    • Allergens and tags GET
    • Account Brands GET
    • Bill Update POST
    • Update order status POST
    • Update order Preparation Time POST
    • Get linked accounts GET
    • Get locations of the account GET
    • Channel Links GET

Webhooks

  • Partner Webhooks
    • Register POS POST
    • Register POS POST
    • Get products GET
    • Sync Tables GET
    • Sync Floors GET
Powered by Bump.sh
Deliverect APIs hub
  • Coupons
  • Giftcard API
  • KDS API
  • Loyalty API
  • Restaurant POS API
Back to hub page
API Explorer API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
Restaurant POS API logo Restaurant POS API logo dark

Channel Links Run in API Explorer

Ask AI
  • Open in ChatGPT
  • Open in Claude

  • View as Markdown
  • Copy as Markdown
GET /channelLinks
Bearer auth

Query parameters

  • where string

Responses

  • 200 application/json

    Ok

GET /channelLinks
curl \
 --request GET 'https://api.staging.deliverect.com/channelLinks' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "_items": [
    {
      "_id": "65********************07",
      "name": "Test channel",
      "tags": [],
      "_etag": "db********************0f",
      "APIKey": "",
      "_links": {
        "self": {
          "href": "channelLinks/65********************07",
          "title": "channelLink"
        },
        "related": {
          "account": {
            "href": "accounts/65********************6f",
            "title": "accounts"
          },
          "brandId": {
            "href": "accounts/65********************6e",
            "title": "accounts"
          },
          "location": {
            "href": "locations/65********************fd",
            "title": "Locations"
          }
        }
      },
      "logPOS": true,
      "status": 2,
      "account": "65********************6f",
      "brandId": "65********************6e",
      "channel": 1,
      "menuUrl": "",
      "mockPOS": false,
      "taxExcl": false,
      "_created": "YYYY-MM-DDTHH:mm:ss.SSSSSSZ",
      "_deleted": false,
      "_updated": "YYYY-MM-DDTHH:mm:ss.SSSSSSZ",
      "location": "65********************fd",
      "timezone": "",
      "kdsSystem": 0,
      "posSystem": "Generic POS",
      "enabledDMA": false,
      "application": "",
      "kdsSettings": {},
      "mockChannel": false,
      "posSettings": {
        "generic": {
          "logOps": true,
          "sendTip": true,
          "readonly": false,
          "bagFeePLU": "",
          "locationId": "",
          "sendRebate": false,
          "discountPLU": "",
          "registerUrl": "",
          "bufferOrders": false,
          "forcePayment": 0,
          "sendDiscount": true,
          "customHeaders": "",
          "sortModifiers": 0,
          "dontSendCancel": false,
          "sendDeliveryFee": true,
          "syncProductsURL": "",
          "orderItemRemarks": "intactItemRemarks",
          "ordersWebhookURL": "",
          "sendStreetNumber": false,
          "anonymizeCustomer": false,
          "orderNoteTemplate": "",
          "sendServiceCharge": true,
          "averageDeliveryTime": 15,
          "separateSameProducts": false,
          "averagePreparationTime": 15,
          "priceLevelSettingsEatIn": "lvl_2",
          "sendDeliveryFeeCondition": 0,
          "deliveryByChannelIsPickup": false,
          "hasDirectTableIntegration": true,
          "ignoreUnknownOrderStatuses": false,
          "priceLevelSettingsDelivery": "lvl_1",
          "priceLevelSettingsTakeaway": "lvl_3",
          "alwaysSendAllSnoozedProducts": true
        }
      },
      "posSystemId": 10000,
      "bufferOrders": false,
      "openingHours": [
        {
          "endTime": "23:59",
          "dayOfWeek": 1,
          "startTime": "00:00"
        },
        {
          "endTime": "23:59",
          "dayOfWeek": 2,
          "startTime": "00:00"
        },
        {
          "endTime": "23:59",
          "dayOfWeek": 3,
          "startTime": "00:00"
        },
        {
          "endTime": "23:59",
          "dayOfWeek": 4,
          "startTime": "00:00"
        },
        {
          "endTime": "23:59",
          "dayOfWeek": 5,
          "startTime": "00:00"
        },
        {
          "endTime": "23:59",
          "dayOfWeek": 6,
          "startTime": "00:00"
        },
        {
          "endTime": "23:59",
          "dayOfWeek": 7,
          "startTime": "00:00"
        }
      ],
      "isTestChannel": true,
      "posLocationId": "",
      "sortModifiers": 0,
      "validationInfo": {
        "lastResult": {
          "connectionOK": false,
          "sampleCallOK": false,
          "credentialsOK": false,
          "connectionResponse": "",
          "sampleCallResponse": "",
          "credentialsResponse": ""
        },
        "isUnHealthy": false
      },
      "channelSettings": {
        "locationId": "",
        "coreFlatten": false,
        "defaultTableId": "123",
        "sendRejectStatus": false,
        "snoozeBatchWindow": 0,
        "isSnoozeRestricted": false,
        "applyDefaultTableId": false,
        "isMenuPushRestricted": false,
        "allowUpdateMenuPrepTime": true,
        "insertPosOrderAfterDmaAccept": false
      },
      "discountMapping": [],
      "externalMenuIds": [],
      "sendOrdersToKDS": false,
      "isLoyaltyEnabled": false,
      "ssuLinkedMenuIds": [],
      "anonymizeCustomer": false,
      "orderNoteTemplate": "",
      "fulfillmentEnabled": false,
      "priceLevelSettings": {
        "eatIn": "lvl_0",
        "delivery": "lvl_1",
        "takeaway": "lvl_1"
      },
      "reportingEndpoints": [],
      "averageDeliveryTime": 15,
      "storeConfigurations": {},
      "defaultPreparationTime": 15,
      "ignorePOSOrderStatuses": false,
      "rejectOnDispatchFailure": false,
      "sendCourierUpdatesToChannel": false,
      "useIntegratedOOFulfilmentFlow": false
    }
  ]
}