Skip to main content

CreateSalesChannelInput

Autogenerated input type of CreateSalesChannel

input CreateSalesChannelInput {
  allocateToExternal: Boolean
  approveOrders: Boolean
  autoFulfill: Boolean
  brandId: ID
  channelType: SalesChannelTypeEnum
  clientMutationId: String
  codeName: String
  customPackingSlip: Boolean
  defaultChannel: Boolean
  defaultTemplateId: ID
  description: String
  fulfillUnpaid: Boolean
  localRouting: Boolean
  logoUrl: Url
  name: String!
  origin: SalesChannelOriginEnum
  retrieveCartonLevelData: Boolean
  routingStrategy: [RoutingStrategyEnum!]
  status: StatusEnum
}

Fields​

CreateSalesChannelInput.allocateToExternal ● Boolean scalar​

If enabled, orders created through this sales channel can be allocated to read-only buildings.

CreateSalesChannelInput.approveOrders ● Boolean scalar​

Controls whether pending orders are auto-approved when problems are resolved (true) or require manual approval (false).

CreateSalesChannelInput.autoFulfill ● Boolean scalar​

Whether orders from this sales channel should be automatically fulfilled.

CreateSalesChannelInput.brandId ● ID scalar​

The brand that the sales channel belongs to. If not provided, the header X-Brand-Id will be used.

CreateSalesChannelInput.channelType ● SalesChannelTypeEnum enum​

The type of sales channel.

CreateSalesChannelInput.clientMutationId ● String scalar​

A unique identifier for the client performing the mutation.

CreateSalesChannelInput.codeName ● String scalar​

A unique code name for the sales channel, used for programmatic identification.

CreateSalesChannelInput.customPackingSlip ● Boolean scalar​

Whether this channel uses custom packing slips for shipments.

CreateSalesChannelInput.defaultChannel ● Boolean scalar​

Whether this is the default sales channel for the brand. If this options is set to true, the default sales channel for the brand will be updated.

CreateSalesChannelInput.defaultTemplateId ● ID scalar​

The default template ID for special orders created in this channel. Orders created in this channel will use this template by default.

CreateSalesChannelInput.description ● String scalar​

A detailed description of the sales channel's purpose and characteristics.

CreateSalesChannelInput.fulfillUnpaid ● Boolean scalar​

If enabled, orders from this sales channel will be fulfilled even if they are not paid.

CreateSalesChannelInput.localRouting ● Boolean scalar​

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

CreateSalesChannelInput.logoUrl ● Url scalar​

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

CreateSalesChannelInput.name ● String! non-null scalar​

The name of the sales channel. Must be between 1 and 50 characters.

CreateSalesChannelInput.origin ● SalesChannelOriginEnum enum​

How orders are typically created in this channel.

CreateSalesChannelInput.retrieveCartonLevelData ● Boolean scalar​

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

CreateSalesChannelInput.routingStrategy ● [RoutingStrategyEnum!] list enum​

The routing strategy to be used for this sales channel. If not provided, the default routing strategy will be used.

CreateSalesChannelInput.status ● StatusEnum enum​

The operational status of the sales channel.

Member Of​

createSalesChannel mutation