Skip to main content
POST
TypeScript

Authorizations

Authorization
string
header
required

JWT access token or API token (prefixed with zipp_)

Path Parameters

orgId
string
required

Organization ID

Example:

"org_8f3kd92ld0"

Body

application/json
name
string
required

Display name for the channel.

Required string length: 1 - 100
Example:

"Anna's webshop"

type
enum<string>
required

Type of the order channel. Platform channels (Shopify, WooCommerce) are created via their connect flows.

Available options:
manual,
custom
Example:

"custom"

brandId
string | null

Brand this channel belongs to; null for organization-wide

Example:

"brnd_8f3kd92ld0"

enabled
boolean
default:true

Whether the channel is active.

Example:

true

settings
object

Response

Default Response

id
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).

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: