Skip to content

channel object

A channel object contains the properties that define one channel of a connection.

When a connection is created, its applicable channel objects are created automatically.

Channel objects are managed by the /connections/{id}/channels endpoint.

channel properties

The following are the properties of a channel object.

id

Propertyid
Data typeinteger
DescriptionUnique ID, assigned when the parent connection object is created
NoteIn other contexts, "channel_id" refers to this property
Example12345

enabled_at

Propertyenabled_at
Data typedateString
DescriptionDate when the channel was last enabled, or null if currently disabled
More info
  • Set this value to a dateString to enable the channel
  • Set this value to null to disable the channel
Example"2020-08-19T14:57:20.000Z"

type

Propertytype
Data typestring
DescriptionThe channel type
Values
  • "sales_order_return" — Sales Order Return channel
  • "sales_order" — Sales Order channel
  • "shipment" — Shipment channel
  • "inventory" — Inventory channel
  • "catalog" — Catalog channel
  • "purchase_order" — Purchase Order channel
  • "advanced_ship_notice" — Advanced Shipment Notice channel

Example channel object

{
    "id": 17529,
    "enabled_at": "2019-08-08T17:42:29.000Z",
    "type": "sales_order"
}