Order Channels

Customers may order through different order channels like 'In-Store', 'Delivery' etc. On this page, we’ll dive into the different order channels endpoints you can use to manage your order channels list. We'll look at how to upload and update order channel types.

The Order Channel model

The order channel model contains all the information about this order channel parameters, including the order channel name and code.

Properties

Name
code
Type
number
Description
Unique identifier for the order channel.
Name
name
Type
string
Description
The name of the order channel.

POST/integrations/orderChannels

Update all order channels

This endpoint allows you to upload all your order channel types. It replaces all the existing orde channels with uploaded ones. See the code examples for how to upload your Order Channels through ProShedule API.

Required attributes

Name
body
Type
Array<orderChanel>
Description
An array of orderChanel objects.

Request

POST

/integrations/orderChannels

curl https://api.proschedule.ambraisoft.com/integrations/orderChannels \
  --header "Content-Type: application/json" \
  --header "Authorization: Bearer {token}" \
  --data-raw '[
    {
        "code": 0,
        "name": "Dine-In"
    },
    {
        "code": 1,
        "name": "Takeaway"
        
    },
    {
        "code": 2,
        "name": "Delivery"
    }
  ]'

Response

  {
      "message": "3 order channel(s) uploaded",
      "status": 200
  }