Skip to main content

SalesChannel

Sales Channel​

Represents a sales channel within a brand. Sales channels define different sources through which orders can be placed and managed, including configuration for routing, fulfillment, and order processing behavior.

type SalesChannel {
  allocateToExternal: Boolean!
  approveOrders: Boolean!
  autoFulfill: Boolean!
  brand: Brand!
  brandId: ID!
  channelType: SalesChannelTypeEnum
  codeName: String
  createdAt: ISO8601DateTime!
  customPackingSlip: Boolean!
  defaultChannel: Boolean!
  defaultTemplateId: ID
  description: String
  fulfillUnpaid: Boolean!
  id: ID!
  localRouting: Boolean!
  logoUrl: Url
  name: String!
  origin: SalesChannelOriginEnum
  retrieveCartonLevelData: Boolean!
  routingStrategy: [RoutingStrategyEnum!]!
  status: StatusEnum!
  updatedAt: ISO8601DateTime!
}

Fields​

SalesChannel.allocateToExternal ● Boolean! non-null scalar​

Whether orders from this channel can be allocated to read-only buildings.

SalesChannel.approveOrders ● Boolean! non-null scalar​

Whether pending orders are auto-approved when problems are resolved or require manual approval.

SalesChannel.autoFulfill ● Boolean! non-null scalar​

Whether orders from this channel should be automatically fulfilled.

SalesChannel.brand ● Brand! non-null object​

The brand this sales channel belongs to.

SalesChannel.brandId ● ID! non-null scalar​

The unique identifier of the brand this sales channel belongs to.

SalesChannel.channelType ● SalesChannelTypeEnum enum​

The type of sales channel.

SalesChannel.codeName ● String scalar​

A unique code name for programmatic identification.

SalesChannel.createdAt ● ISO8601DateTime! non-null scalar​

When the sales channel was created.

SalesChannel.customPackingSlip ● Boolean! non-null scalar​

Whether this channel uses custom packing slips for shipments.

SalesChannel.defaultChannel ● Boolean! non-null scalar​

Whether this is the default sales channel for the brand.

SalesChannel.defaultTemplateId ● ID scalar​

The default template ID for special orders created in this channel.

SalesChannel.description ● String scalar​

Detailed description of the sales channel's purpose.

SalesChannel.fulfillUnpaid ● Boolean! non-null scalar​

Whether orders from this channel will be fulfilled even if they are not paid.

SalesChannel.id ● ID! non-null scalar​

Unique identifier for the sales channel.

SalesChannel.localRouting ● Boolean! non-null scalar​

Whether the routing strategy is local or global. If true, Endless Commerce will manage the routing for orders from this sales channel. If false, the routing strategy will be managed by the external system integrated with Endless Commerce.

SalesChannel.logoUrl ● Url scalar​

URL for the sales channel's logo or branding image.

SalesChannel.name ● String! non-null scalar​

The name of the sales channel.

SalesChannel.origin ● SalesChannelOriginEnum enum​

How orders are typically created in this channel.

SalesChannel.retrieveCartonLevelData ● Boolean! non-null scalar​

When enabled, Endless will check for any carton-level data (such as contents and container codes) associated with an order shipment.

SalesChannel.routingStrategy ● [RoutingStrategyEnum!]! non-null enum​

The routing strategy used for orders from this channel. This strategy is applied when local_routing is true. The list represents routing rules applied in order.

SalesChannel.status ● StatusEnum! non-null enum​

The operational status of the sales channel.

SalesChannel.updatedAt ● ISO8601DateTime! non-null scalar​

When the sales channel was last updated.

Returned By​

createSalesChannel mutation ● salesChannel query ● updateSalesChannel mutation

Member Of​

Order object ● SalesChannelConnection object ● SalesChannelEdge object

Implemented By​

ProductPriceable union