List order channels

TypeScript

import { Configuration, OrderChannelsApi } from "@zippendo/sdk"

const api = new OrderChannelsApi(new Configuration({ accessToken: process.env.ZIPPENDO_API_TOKEN }))
const result = await api.listOrderChannels({ orgId: "..." })

import os
import zippendo

config = zippendo.Configuration(access_token=os.environ["ZIPPENDO_API_TOKEN"])
with zippendo.ApiClient(config) as client:
    result = zippendo.OrderChannelsApi(client).list_order_channels("...")

<?php
$config = Zippendo\Sdk\Configuration::getDefaultConfiguration()->setAccessToken(getenv("ZIPPENDO_API_TOKEN"));
$api = new Zippendo\Sdk\Api\OrderChannelsApi(new GuzzleHttp\Client(), $config);
$result = $api->listOrderChannels("...");

client := zippendo.NewAPIClient(zippendo.NewConfiguration())
ctx := context.WithValue(context.Background(), zippendo.ContextAccessToken, os.Getenv("ZIPPENDO_API_TOKEN"))
result, _, err := client.OrderChannelsAPI.ListOrderChannels(ctx, "...").Execute()

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.zippendo.com/orgs/{orgId}/order-channels', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": [
    {
      "id": "clz9k2f0a0001abcd1234efgh",
      "name": "Anna's Shopify Store",
      "type": "shopify",
      "enabled": true,
      "brandId": "brnd_8f3kd92ld0",
      "hasCredentials": true,
      "settings": {
        "useWebhooks": true,
        "autoSync": false,
        "syncIntervalMinutes": 15,
        "autoShipOnCreate": false,
        "syncOnlyUnfulfilled": true,
        "servicePointCount": 6,
        "webhookId": "gid://shopify/WebhookSubscription/12345",
        "webhookIds": [
          12,
          13,
          14
        ],
        "webhookSecretCreatedAt": "2026-06-22T14:30:00.000Z",
        "siteUrl": "https://butik.dk",
        "autoFulfill": true,
        "checkoutTokenCreatedAt": "2026-06-22T14:30:00.000Z",
        "defaultCarrierId": "clz9k2f0a0006abcd1357yzab",
        "defaultProductId": "postnord-home-delivery",
        "defaultAddressId": "clz9k2f0a0005abcd7890uvwx",
        "shippingMethodMappings": [
          {
            "match": "GLS Hjemmelevering",
            "shippingRuleId": "clz9k2f0a0007abcd2468qrst"
          }
        ],
        "syncOrdersSince": "2026-05-22T00:00:00.000Z"
      },
      "orgId": "clz9k2f0a0000abcd0000zzzz",
      "createdAt": "2026-06-22T14:30:00.000Z",
      "updatedAt": "2026-06-22T14:30:00.000Z",
      "webhooksEnabled": true,
      "lastSyncAt": "2026-06-22T14:30:00.000Z",
      "lastSyncError": "Invalid API credentials",
      "shippingRuleIds": [
        "clz9k2f0a0002abcd5678ijkl"
      ]
    }
  ],
  "total": 137,
  "page": 1,
  "limit": 20,
  "totalPages": 7
}

{
  "error": "Bad Request",
  "message": "Failed to create address",
  "code": "CARRIER_GLS_WRONG_ADDRESS"
}

{
  "error": "Bad Request",
  "message": "Failed to create address",
  "code": "CARRIER_GLS_WRONG_ADDRESS"
}

GET

orgs

{orgId}

order-channels

TypeScript

import { Configuration, OrderChannelsApi } from "@zippendo/sdk"

const api = new OrderChannelsApi(new Configuration({ accessToken: process.env.ZIPPENDO_API_TOKEN }))
const result = await api.listOrderChannels({ orgId: "..." })

import os
import zippendo

config = zippendo.Configuration(access_token=os.environ["ZIPPENDO_API_TOKEN"])
with zippendo.ApiClient(config) as client:
    result = zippendo.OrderChannelsApi(client).list_order_channels("...")

<?php
$config = Zippendo\Sdk\Configuration::getDefaultConfiguration()->setAccessToken(getenv("ZIPPENDO_API_TOKEN"));
$api = new Zippendo\Sdk\Api\OrderChannelsApi(new GuzzleHttp\Client(), $config);
$result = $api->listOrderChannels("...");

client := zippendo.NewAPIClient(zippendo.NewConfiguration())
ctx := context.WithValue(context.Background(), zippendo.ContextAccessToken, os.Getenv("ZIPPENDO_API_TOKEN"))
result, _, err := client.OrderChannelsAPI.ListOrderChannels(ctx, "...").Execute()

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.zippendo.com/orgs/{orgId}/order-channels', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": [
    {
      "id": "clz9k2f0a0001abcd1234efgh",
      "name": "Anna's Shopify Store",
      "type": "shopify",
      "enabled": true,
      "brandId": "brnd_8f3kd92ld0",
      "hasCredentials": true,
      "settings": {
        "useWebhooks": true,
        "autoSync": false,
        "syncIntervalMinutes": 15,
        "autoShipOnCreate": false,
        "syncOnlyUnfulfilled": true,
        "servicePointCount": 6,
        "webhookId": "gid://shopify/WebhookSubscription/12345",
        "webhookIds": [
          12,
          13,
          14
        ],
        "webhookSecretCreatedAt": "2026-06-22T14:30:00.000Z",
        "siteUrl": "https://butik.dk",
        "autoFulfill": true,
        "checkoutTokenCreatedAt": "2026-06-22T14:30:00.000Z",
        "defaultCarrierId": "clz9k2f0a0006abcd1357yzab",
        "defaultProductId": "postnord-home-delivery",
        "defaultAddressId": "clz9k2f0a0005abcd7890uvwx",
        "shippingMethodMappings": [
          {
            "match": "GLS Hjemmelevering",
            "shippingRuleId": "clz9k2f0a0007abcd2468qrst"
          }
        ],
        "syncOrdersSince": "2026-05-22T00:00:00.000Z"
      },
      "orgId": "clz9k2f0a0000abcd0000zzzz",
      "createdAt": "2026-06-22T14:30:00.000Z",
      "updatedAt": "2026-06-22T14:30:00.000Z",
      "webhooksEnabled": true,
      "lastSyncAt": "2026-06-22T14:30:00.000Z",
      "lastSyncError": "Invalid API credentials",
      "shippingRuleIds": [
        "clz9k2f0a0002abcd5678ijkl"
      ]
    }
  ],
  "total": 137,
  "page": 1,
  "limit": 20,
  "totalPages": 7
}

{
  "error": "Bad Request",
  "message": "Failed to create address",
  "code": "CARRIER_GLS_WRONG_ADDRESS"
}

{
  "error": "Bad Request",
  "message": "Failed to create address",
  "code": "CARRIER_GLS_WRONG_ADDRESS"
}

Authorizations

Authorization

string

header

required

JWT access token or API token (prefixed with zipp_)

Path Parameters

orgId

string

required

Organization ID

Example:

"org_8f3kd92ld0"

Query Parameters

page

integer

default:1

Page number (1-based)

Required range: 1 <= x <= 9007199254740991

Example:

1

limit

integer

default:20

Items per page (max 100)

Required range: 1 <= x <= 100

Example:

20

brandId

string

Filter by brand. Pass a brand ID, or "none" for records not assigned to any brand.

Example:

"brnd_8f3kd92ld0"

brandScope

enum<string>

How the brand context narrows this list: "own" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), "shared" returns only unassigned organization-wide rows, "both" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with "shared" returns no rows, since those records are never visible organization-wide from within a brand context.

Available options:

own,

shared,

both

Example:

"own"

type

enum<string>

Filter by channel type.

Available options:

shopify,

woocommerce,

manual,

custom

Example:

"shopify"

enabled

string

Filter by enabled state.

Example:

true

string

Search by channel name.

Example:

"Anna's Shopify Store"

Response

Default Response

data

object[]

required

Page of results

Show child attributes

total

number

required

Total matching items across all pages

Example:

137

page

number

required

Current page number (1-based)

Example:

1

limit

number

required

Items per page

Example:

20

totalPages

number

required

Total number of pages

Example:

7

Overview

SDKs

MCP server

System

Tokens

Orgs

Brands

Addresses

Carriers

Rules

Quotes

Shipments

Orders

Order Channels

Carrier Catalog

Billing

Webhooks

List order channels

Authorizations

Path Parameters

Query Parameters

Response