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 @deprecated
  brandId: ID @deprecated
  channelType: SalesChannelTypeEnum
  codeName: String
  createdAt: ISO8601DateTime!
  customPackingSlip: Boolean!
  defaultChannel: Boolean!
  defaultTemplateId: ID
  description: String
  fulfillUnpaid: Boolean!
  id: ID!
  integrationMappings: [SalesChannelIntegrationMapping!]
  localRouting: Boolean!
  logoUrl: Url
  name: String!
  origin: SalesChannelOriginEnum
  retrieveCartonLevelData: Boolean!
  routingConfiguration: RoutingConfiguration
  routingStrategy: [RoutingStrategyEnum!]!
  salesChannelWarehouses: [SalesChannelWarehouse!]!
  status: StatusEnum!
  updatedAt: ISO8601DateTime!
  warehouses: [Warehouse!]!
}

Fields​

SalesChannel.allocateToExternal ● Boolean! non-null scalar common​

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

SalesChannel.approveOrders ● Boolean! non-null scalar common​

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

SalesChannel.autoFulfill ● Boolean! non-null scalar common​

Whether orders from this channel should be automatically fulfilled.

SalesChannel.brand ● Brand deprecated object common​

DEPRECATED

This field will be removed in the future. Brand is becoming a product-only attribute.

The brand this sales channel belongs to.

SalesChannel.brandId ● ID deprecated scalar common​

DEPRECATED

This field will be removed in the future. Brand is becoming a product-only attribute.

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

SalesChannel.channelType ● SalesChannelTypeEnum enum sales-channels​

The type of sales channel.

SalesChannel.codeName ● String scalar common​

A unique code name for programmatic identification.

SalesChannel.createdAt ● ISO8601DateTime! non-null scalar common​

When the sales channel was created.

SalesChannel.customPackingSlip ● Boolean! non-null scalar common​

Whether this channel uses custom packing slips for shipments.

SalesChannel.defaultChannel ● Boolean! non-null scalar common​

Whether this is the default sales channel for the brand.

SalesChannel.defaultTemplateId ● ID scalar common​

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

SalesChannel.description ● String scalar common​

Detailed description of the sales channel's purpose.

SalesChannel.fulfillUnpaid ● Boolean! non-null scalar common​

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

SalesChannel.id ● ID! non-null scalar common​

Unique identifier for the sales channel.

SalesChannel.integrationMappings ● [SalesChannelIntegrationMapping!] list object sales-channels​

Integration mappings that link this sales channel to external identifiers in downstream systems.

SalesChannel.localRouting ● Boolean! non-null scalar common​

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 common​

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

SalesChannel.name ● String! non-null scalar common​

The name of the sales channel.

SalesChannel.origin ● SalesChannelOriginEnum enum sales-channels​

How orders are typically created in this channel.

SalesChannel.retrieveCartonLevelData ● Boolean! non-null scalar common​

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

SalesChannel.routingConfiguration ● RoutingConfiguration object orders​

Configuration for order fulfillment routing strategy and automatic fulfillment settings.

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

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.salesChannelWarehouses ● [SalesChannelWarehouse!]! non-null object sales-channels​

All warehouse configurations for this sales channel, including priority and exclusion status.

SalesChannel.status ● StatusEnum! non-null enum common​

The operational status of the sales channel.

SalesChannel.updatedAt ● ISO8601DateTime! non-null scalar common​

When the sales channel was last updated.

SalesChannel.warehouses ● [Warehouse!]! non-null object warehouses​

The warehouses available for fulfillment in this sales channel. Returns included warehouses ordered by priority.

Returned By​

createSalesChannel mutation ● salesChannel query ● updateSalesChannel mutation

Member Of​

Order object ● ProductSalesChannel object ● SalesChannelConnection object ● SalesChannelEdge object ● V2Order object

Implemented By​

ProductPriceable union