SalesChannel

View normalized Markdown

SalesChannel data available to a scoped Management API integration.

graphql
type SalesChannel {
  createdAt: DateTime!
  discardedAt: DateTime
  id: ID!
  isOnlinePos: Boolean
  isTelephonePos: Boolean
  name: String
  number: String
  orderChannelId: ID
  tombstone: Boolean!
  updatedAt: DateTime!
}

Fields

SalesChannel.createdAt · DateTime! non-null scalar

Record creation timestamp.

SalesChannel.discardedAt · DateTime scalar

When the record was discarded; null for an active record.

SalesChannel.id · ID! non-null scalar

Stable record identifier.

SalesChannel.isOnlinePos · Boolean scalar

Is online pos.

SalesChannel.isTelephonePos · Boolean scalar

Is telephone pos.

SalesChannel.name · String scalar

Display name when the resource provides one.

SalesChannel.number · String scalar

External-facing record number when the resource provides one.

SalesChannel.orderChannelId · ID scalar

Order channel id.

SalesChannel.tombstone · Boolean! non-null scalar

True when the discarded record represents a removal to propagate locally.

SalesChannel.updatedAt · DateTime! non-null scalar

Timestamp used for incremental synchronization and cursor ordering.

Returned By

salesChannel query

Member Of

SalesChannelCollection object

Ready to Get Started?

Book a free demo or reach out — we’d love to hear from you.