Update order channel

TypeScript

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

const api = new OrderChannelsApi(new Configuration({ accessToken: process.env.ZIPPENDO_API_TOKEN }))
const result = await api.updateOrderChannel({ orgId: "...", channelId: "...", updateOrderChannelRequest: { /* ... */ } })

import os
import zippendo

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

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

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

require "zippendo"

Zippendo.configure { |c| c.access_token = ENV["ZIPPENDO_API_TOKEN"] }
result = Zippendo::OrderChannelsApi.new.update_order_channel("...", "...", Zippendo::UpdateOrderChannelRequest.new)

curl --request PATCH \
  --url https://api.zippendo.com/orgs/{orgId}/order-channels/{channelId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "brandId": "brnd_8f3kd92ld0",
  "name": "Anna's Shopify Store",
  "enabled": true,
  "credentials": {},
  "settings": {
    "useWebhooks": true,
    "siteUrl": "https://butik.dk",
    "autoFulfill": true,
    "autoSync": false,
    "syncIntervalMinutes": 15,
    "autoShipOnCreate": false,
    "defaultCarrierId": "clz9k2f0a0006abcd1357yzab",
    "defaultProductId": "postnord-home-delivery",
    "defaultAddressId": "clz9k2f0a0005abcd7890uvwx",
    "shippingMethodMappings": [
      {
        "match": "GLS Hjemmelevering",
        "shippingRuleId": "clz9k2f0a0007abcd2468qrst"
      }
    ],
    "syncOnlyUnfulfilled": true,
    "syncOrdersSince": "2026-05-22T00:00:00.000Z",
    "servicePointCount": 6
  },
  "shippingRuleIds": [
    "clz9k2f0a0002abcd5678ijkl"
  ]
}
EOF

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    brandId: 'brnd_8f3kd92ld0',
    name: 'Anna\'s Shopify Store',
    enabled: true,
    credentials: {},
    settings: {
      useWebhooks: true,
      siteUrl: 'https://butik.dk',
      autoFulfill: true,
      autoSync: false,
      syncIntervalMinutes: 15,
      autoShipOnCreate: false,
      defaultCarrierId: 'clz9k2f0a0006abcd1357yzab',
      defaultProductId: 'postnord-home-delivery',
      defaultAddressId: 'clz9k2f0a0005abcd7890uvwx',
      shippingMethodMappings: [{match: 'GLS Hjemmelevering', shippingRuleId: 'clz9k2f0a0007abcd2468qrst'}],
      syncOnlyUnfulfilled: true,
      syncOrdersSince: '2026-05-22T00:00:00.000Z',
      servicePointCount: 6
    },
    shippingRuleIds: ['clz9k2f0a0002abcd5678ijkl']
  })
};

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

HttpResponse<String> response = Unirest.patch("https://api.zippendo.com/orgs/{orgId}/order-channels/{channelId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"brandId\": \"brnd_8f3kd92ld0\",\n  \"name\": \"Anna's Shopify Store\",\n  \"enabled\": true,\n  \"credentials\": {},\n  \"settings\": {\n    \"useWebhooks\": true,\n    \"siteUrl\": \"https://butik.dk\",\n    \"autoFulfill\": true,\n    \"autoSync\": false,\n    \"syncIntervalMinutes\": 15,\n    \"autoShipOnCreate\": false,\n    \"defaultCarrierId\": \"clz9k2f0a0006abcd1357yzab\",\n    \"defaultProductId\": \"postnord-home-delivery\",\n    \"defaultAddressId\": \"clz9k2f0a0005abcd7890uvwx\",\n    \"shippingMethodMappings\": [\n      {\n        \"match\": \"GLS Hjemmelevering\",\n        \"shippingRuleId\": \"clz9k2f0a0007abcd2468qrst\"\n      }\n    ],\n    \"syncOnlyUnfulfilled\": true,\n    \"syncOrdersSince\": \"2026-05-22T00:00:00.000Z\",\n    \"servicePointCount\": 6\n  },\n  \"shippingRuleIds\": [\n    \"clz9k2f0a0002abcd5678ijkl\"\n  ]\n}")
  .asString();

{
  "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"
  ]
}

{
  "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"
}

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

PATCH

orgs

{orgId}

order-channels

{channelId}

TypeScript

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

const api = new OrderChannelsApi(new Configuration({ accessToken: process.env.ZIPPENDO_API_TOKEN }))
const result = await api.updateOrderChannel({ orgId: "...", channelId: "...", updateOrderChannelRequest: { /* ... */ } })

import os
import zippendo

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

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

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

require "zippendo"

Zippendo.configure { |c| c.access_token = ENV["ZIPPENDO_API_TOKEN"] }
result = Zippendo::OrderChannelsApi.new.update_order_channel("...", "...", Zippendo::UpdateOrderChannelRequest.new)

curl --request PATCH \
  --url https://api.zippendo.com/orgs/{orgId}/order-channels/{channelId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "brandId": "brnd_8f3kd92ld0",
  "name": "Anna's Shopify Store",
  "enabled": true,
  "credentials": {},
  "settings": {
    "useWebhooks": true,
    "siteUrl": "https://butik.dk",
    "autoFulfill": true,
    "autoSync": false,
    "syncIntervalMinutes": 15,
    "autoShipOnCreate": false,
    "defaultCarrierId": "clz9k2f0a0006abcd1357yzab",
    "defaultProductId": "postnord-home-delivery",
    "defaultAddressId": "clz9k2f0a0005abcd7890uvwx",
    "shippingMethodMappings": [
      {
        "match": "GLS Hjemmelevering",
        "shippingRuleId": "clz9k2f0a0007abcd2468qrst"
      }
    ],
    "syncOnlyUnfulfilled": true,
    "syncOrdersSince": "2026-05-22T00:00:00.000Z",
    "servicePointCount": 6
  },
  "shippingRuleIds": [
    "clz9k2f0a0002abcd5678ijkl"
  ]
}
EOF

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    brandId: 'brnd_8f3kd92ld0',
    name: 'Anna\'s Shopify Store',
    enabled: true,
    credentials: {},
    settings: {
      useWebhooks: true,
      siteUrl: 'https://butik.dk',
      autoFulfill: true,
      autoSync: false,
      syncIntervalMinutes: 15,
      autoShipOnCreate: false,
      defaultCarrierId: 'clz9k2f0a0006abcd1357yzab',
      defaultProductId: 'postnord-home-delivery',
      defaultAddressId: 'clz9k2f0a0005abcd7890uvwx',
      shippingMethodMappings: [{match: 'GLS Hjemmelevering', shippingRuleId: 'clz9k2f0a0007abcd2468qrst'}],
      syncOnlyUnfulfilled: true,
      syncOrdersSince: '2026-05-22T00:00:00.000Z',
      servicePointCount: 6
    },
    shippingRuleIds: ['clz9k2f0a0002abcd5678ijkl']
  })
};

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

HttpResponse<String> response = Unirest.patch("https://api.zippendo.com/orgs/{orgId}/order-channels/{channelId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"brandId\": \"brnd_8f3kd92ld0\",\n  \"name\": \"Anna's Shopify Store\",\n  \"enabled\": true,\n  \"credentials\": {},\n  \"settings\": {\n    \"useWebhooks\": true,\n    \"siteUrl\": \"https://butik.dk\",\n    \"autoFulfill\": true,\n    \"autoSync\": false,\n    \"syncIntervalMinutes\": 15,\n    \"autoShipOnCreate\": false,\n    \"defaultCarrierId\": \"clz9k2f0a0006abcd1357yzab\",\n    \"defaultProductId\": \"postnord-home-delivery\",\n    \"defaultAddressId\": \"clz9k2f0a0005abcd7890uvwx\",\n    \"shippingMethodMappings\": [\n      {\n        \"match\": \"GLS Hjemmelevering\",\n        \"shippingRuleId\": \"clz9k2f0a0007abcd2468qrst\"\n      }\n    ],\n    \"syncOnlyUnfulfilled\": true,\n    \"syncOrdersSince\": \"2026-05-22T00:00:00.000Z\",\n    \"servicePointCount\": 6\n  },\n  \"shippingRuleIds\": [\n    \"clz9k2f0a0002abcd5678ijkl\"\n  ]\n}")
  .asString();

{
  "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"
  ]
}

{
  "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"
}

{
  "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:

"clz9k2f0a0000abcd0000zzzz"

channelId

string

required

Order channel ID.

Example:

"clz9k2f0a0001abcd1234efgh"

Body

application/json

brandId

string | null

Brand this channel belongs to; null for organization-wide

Example:

"brnd_8f3kd92ld0"

name

string

Display name for the channel.

Required string length: 1 - 100

Example:

"Anna's Shopify Store"

enabled

boolean

Whether the channel is active.

Example:

true

credentials

object | null

Type-specific platform credentials.

Show child attributes

settings

object

Partial channel settings to merge into existing settings. Server-managed fields (webhook secret/ids, checkout token) cannot be set here.

Show child attributes

shippingRuleIds

string[]

IDs of shipping rules linked to this channel.

Example:

["clz9k2f0a0002abcd5678ijkl"]

Response

Default Response

string

required

Unique order channel ID.

Example:

"clz9k2f0a0001abcd1234efgh"

name

string

required

Display name of the channel.

Example:

"Anna's Shopify Store"

type

enum<string>

required

Type of the order channel (sales platform).

Available options:

shopify,

woocommerce,

manual,

custom

Example:

"shopify"

enabled

boolean

required

Whether the channel is active.

Example:

true

brandId

string | null

required

Brand this channel belongs to, or null for organization-wide. Orders synced from this channel inherit it, and so do the shipments and documents made from them.

Example:

"brnd_8f3kd92ld0"

hasCredentials

boolean

required

Whether credentials are configured (values are never exposed).

Example:

true

settings

object

required

Channel settings (webhook secret and checkout token hash omitted).

Show child attributes

orgId

string

required

Owning organization ID.

Example:

"clz9k2f0a0000abcd0000zzzz"

createdAt

string

required

Creation timestamp (ISO 8601).

Example:

"2026-06-22T14:30:00.000Z"

updatedAt

string

required

Last update timestamp (ISO 8601).

Example:

"2026-06-22T14:30:00.000Z"

webhooksEnabled

boolean

Whether real-time webhooks are enabled.

Example:

true

lastSyncAt

string<date-time> | null

Timestamp of the last successful sync.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Example:

"2026-06-22T14:30:00.000Z"

lastSyncError

string | null

Error message from the last failed sync.

Example:

"Invalid API credentials"

shippingRuleIds

string[]

IDs of shipping rules linked to this channel.

Example:

["clz9k2f0a0002abcd5678ijkl"]

Overview

SDKs

MCP server

System

Tokens

Orgs

Brands

Addresses

Carriers

Rules

Quotes

Shipments

Orders

Order Channels

Carrier Catalog

Billing

Webhooks

Update order channel

Authorizations

Path Parameters

Body

Response