Skip to main content
GET
/
channel
Get channel
curl --request GET \
  --url https://api.atlas.kitchen/storefronts/v1/channel \
  --header 'X-Channel-Id: <api-key>'
{
  "config": {
    "country": "SG",
    "currency": "SGD",
    "time_zone": "Asia/Singapore",
    "tax_rates": {},
    "tax_inclusive_prices": true,
    "features": {
      "use_dish_notes_on_item": true,
      "hide_cutlery_required": true,
      "show_language_selector": true,
      "push_disabled_sections_to_bottom": true
    },
    "ui_definitions": [
      {}
    ]
  },
  "outlets": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>",
      "uen": "<string>",
      "address": "<string>",
      "postal_code": "<string>",
      "contact_number": "<string>",
      "coordinates": {
        "longitude": 123,
        "latitude": 123
      },
      "delivery_fee_config": {
        "base_distance": 123,
        "base_rate": 123,
        "per_km_rate": 123,
        "delivery_fee_waiver_cart_value": 123,
        "tiers": [
          {
            "base_distance": 123,
            "max_distance": 123,
            "base_rate": 123,
            "per_km_rate": 123
          }
        ],
        "subsidy_tiers": [
          {
            "subsidy_value": 123,
            "subsidy_value_type": "PERCENTAGE",
            "minimum_order_value": 123,
            "maximum_order_value": 123
          }
        ]
      },
      "general_service_hours": {
        "delivery": [
          {
            "day_of_week": 123,
            "closed": true,
            "message": "<string>",
            "service_hours": [
              {
                "name": "<string>",
                "service_start": 123,
                "service_end": 123,
                "service_range": "10:00 AM - 11:00 PM",
                "lead_time": 123,
                "timeslots": [
                  {
                    "type": "asap",
                    "seconds_start": 123,
                    "seconds_end": 123,
                    "range": "<string>",
                    "available_before": 123,
                    "available_from": 123
                  }
                ]
              }
            ]
          }
        ],
        "pickup": [
          {
            "day_of_week": 123,
            "closed": true,
            "message": "<string>",
            "service_hours": [
              {
                "name": "<string>",
                "service_start": 123,
                "service_end": 123,
                "service_range": "10:00 AM - 11:00 PM",
                "lead_time": 123,
                "timeslots": [
                  {
                    "type": "asap",
                    "seconds_start": 123,
                    "seconds_end": 123,
                    "range": "<string>",
                    "available_before": 123,
                    "available_from": 123
                  }
                ]
              }
            ]
          }
        ]
      },
      "special_hours": [
        {
          "name": "<string>",
          "message": "<string>",
          "closed": true,
          "as_usual_hours": true,
          "start_date": "2023-12-25",
          "end_date": "2023-12-25",
          "service_hours": [
            {
              "name": "<string>",
              "service_start": 123,
              "service_end": 123,
              "service_range": "10:00 AM - 11:00 PM",
              "lead_time": 123,
              "timeslots": [
                {
                  "type": "asap",
                  "seconds_start": 123,
                  "seconds_end": 123,
                  "range": "<string>",
                  "available_before": 123,
                  "available_from": 123
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "referral": {
    "id": 123,
    "label": "<string>",
    "sidebar_label": "<string>",
    "description": "<string>",
    "short_description": "<string>",
    "terms": "<string>"
  },
  "point_program": {
    "label": "<string>",
    "is_custom_currency": true,
    "currency_value_in_cents": 123,
    "currency_names": {},
    "colors": {},
    "currency_icon_url": "<string>",
    "banner_image_url": "<string>",
    "outlets": [
      123
    ]
  }
}

Authorizations

X-Channel-Id
string
header
required

Channel identifier. A second header X-Session-Id is also required.

Response

Channel configuration

config
object
outlets
object[]
referral
object
point_program
object