Skip to main content

UpdateSalesChannelInput

Autogenerated input type of UpdateSalesChannel

input UpdateSalesChannelInput {
allocateToExternal: Boolean
approveOrders: Boolean
autoFulfill: Boolean
channelType: SalesChannelTypeEnum
clientMutationId: String
customPackingSlip: Boolean
defaultChannel: Boolean
defaultTemplateId: ID
description: String
fulfillUnpaid: Boolean
id: ID!
integrationId: ID
localRouting: Boolean
logoUrl: Url
name: String
origin: SalesChannelOriginEnum
retrieveCartonLevelData: Boolean
routingConfig: RoutingConfigurationInput
routingStrategy: [RoutingStrategyEnum!]
status: StatusEnum
warehouseConfigs: [SalesChannelWarehouseConfigInput!]
}

Fields

UpdateSalesChannelInput.allocateToExternal ● Boolean scalar common

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

UpdateSalesChannelInput.approveOrders ● Boolean scalar common

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

UpdateSalesChannelInput.autoFulfill ● Boolean scalar common

Whether orders from this sales channel should be automatically fulfilled.

UpdateSalesChannelInput.channelType ● SalesChannelTypeEnum enum sales-channels

The type of sales channel.

UpdateSalesChannelInput.clientMutationId ● String scalar common

A unique identifier for the client performing the mutation.

UpdateSalesChannelInput.customPackingSlip ● Boolean scalar common

Whether this channel uses custom packing slips for shipments.

UpdateSalesChannelInput.defaultChannel ● Boolean scalar common

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

UpdateSalesChannelInput.defaultTemplateId ● ID scalar common

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

UpdateSalesChannelInput.description ● String scalar common

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

UpdateSalesChannelInput.fulfillUnpaid ● Boolean scalar common

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

UpdateSalesChannelInput.id ● ID! non-null scalar common

The unique identifier of the sales channel to update.

UpdateSalesChannelInput.integrationId ● ID scalar common

Sales channels can be integrated with external systems. This ID represents an integration already configured in the system.

UpdateSalesChannelInput.localRouting ● Boolean scalar common

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.

UpdateSalesChannelInput.logoUrl ● Url scalar common

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

UpdateSalesChannelInput.name ● String scalar common

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

UpdateSalesChannelInput.origin ● SalesChannelOriginEnum enum sales-channels

How orders are typically created in this channel.

UpdateSalesChannelInput.retrieveCartonLevelData ● Boolean scalar common

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

UpdateSalesChannelInput.routingConfig ● RoutingConfigurationInput input orders

Configuration for order fulfillment routing strategy and automatic fulfillment settings.

UpdateSalesChannelInput.routingStrategy ● [RoutingStrategyEnum!] list enum common

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

UpdateSalesChannelInput.status ● StatusEnum enum common

The operational status of the sales channel.

UpdateSalesChannelInput.warehouseConfigs ● [SalesChannelWarehouseConfigInput!] list input sales-channels

Array of warehouse configurations for this sales channel. Each config specifies a warehouse ID, priority, and exclusion status.

Member Of

updateSalesChannel mutation