Get order channel
Returns a single order channel by ID, including its linked shipping rules.
Authorizations
JWT access token or API token (prefixed with zipp_)
Path Parameters
Organization ID.
"clz9k2f0a0000abcd0000zzzz"
Order channel ID.
"clz9k2f0a0001abcd1234efgh"
Response
Default Response
Unique order channel ID.
"clz9k2f0a0001abcd1234efgh"
Display name of the channel.
"Anna's Shopify Store"
Type of the order channel (sales platform).
shopify, woocommerce, manual, custom "shopify"
Whether the channel is active.
true
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.
"brnd_8f3kd92ld0"
Whether credentials are configured (values are never exposed).
true
Channel settings (webhook secret and checkout token hash omitted).
Owning organization ID.
"clz9k2f0a0000abcd0000zzzz"
Creation timestamp (ISO 8601).
"2026-06-22T14:30:00.000Z"
Last update timestamp (ISO 8601).
"2026-06-22T14:30:00.000Z"
Whether real-time webhooks are enabled.
true
Timestamp of the last successful sync.
^(?:(?:\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))$"2026-06-22T14:30:00.000Z"
Error message from the last failed sync.
"Invalid API credentials"
IDs of shipping rules linked to this channel.