Skip to main content
GET
/
api
/
v1
/
external
/
channels
/
config
GET https://app.fire.rest/api/v1/external/channels/config
x-api-key: <your_api_key>

{
  "accountId": "550e8400-e29b-41d4-a716-446655440000",
  "countries": [
    {
      "countryCode": "EC",
      "vendors": [
        {
          "vendorId": "100.1.10",
          "vendorName": "Sandbox Ecuador",
          "channels": [
            {
              "uuid": "9f3a-...-e1",
              "code": "APP",
              "name": "Mobile App",
              "description": "Mobile-app sales channel",
              "enabled": true,
              "fulfillmentTypes": [
                {
                  "uuid": "abcf-...-2d",
                  "code": "DELIVERY",
                  "name": "Delivery",
                  "referenceName": "DELIVERY",
                  "description": null,
                  "enabled": true
                }
              ]
            },
            {
              "uuid": "7e2b-...-c8",
              "code": "KIOSK",
              "name": "Kiosk",
              "description": null,
              "enabled": true,
              "fulfillmentTypes": []
            }
          ]
        }
      ]
    }
  ]
}
Returns the full sales-channel configuration for the vendor bound to your API key, enriched with global catalog data (uuid, name, description) and the fulfillment types configured for each channel. The endpoint takes no query parameters — accountId and vendorId are derived from the API key. Only channels with enabled !== false are returned. Channels in the account JSONB that have no match in the catalog are excluded from the response.

​
Authentication

​
x-api-key
string
required
Your Fire API key with the channels:read scope. The key must be vendor-scoped (account + vendor binding) — keys without a vendorId are rejected with 403.

​
Request

GET https://app.fire.rest/api/v1/external/channels/config
x-api-key: <your_api_key>

​
Response

​
accountId
string
UUID of the account the API key belongs to.
​
countries
object[]
{
  "accountId": "550e8400-e29b-41d4-a716-446655440000",
  "countries": [
    {
      "countryCode": "EC",
      "vendors": [
        {
          "vendorId": "100.1.10",
          "vendorName": "Sandbox Ecuador",
          "channels": [
            {
              "uuid": "9f3a-...-e1",
              "code": "APP",
              "name": "Mobile App",
              "description": "Mobile-app sales channel",
              "enabled": true,
              "fulfillmentTypes": [
                {
                  "uuid": "abcf-...-2d",
                  "code": "DELIVERY",
                  "name": "Delivery",
                  "referenceName": "DELIVERY",
                  "description": null,
                  "enabled": true
                }
              ]
            },
            {
              "uuid": "7e2b-...-c8",
              "code": "KIOSK",
              "name": "Kiosk",
              "description": null,
              "enabled": true,
              "fulfillmentTypes": []
            }
          ]
        }
      ]
    }
  ]
}

​
Notes

  • uuid comes from the global channels catalog, not from the per-account JSONB.
  • fulfillmentTypes only includes types configured for that channel in the vendor. Types without a catalog match are excluded.
  • countries groups by country code from the JSONB. A vendor may appear in multiple countries if it is configured per-country.

Payment methods config

Companion endpoint to read configured payment methods.

Authentication

How vendor-scoped API keys and scopes work.