PresaleCampaign

A campaign that takes orders for products before they're in stock, optionally with a deposit at checkout.

type PresaleCampaign {
  activeCampaignOrdersCount: Int!
  allocatedInventoryCount: Int!
  allocationStatus: CampaignAllocationStatus!
  appliedInventoryCount: Int!
  archivedAt: ISO8601DateTime
  campaignInventoryItems: [CampaignInventoryItem!]!
  campaignItemType: CampaignItemType!
  campaignItems: [CampaignItem!]!
  campaignOrders(
    after: String
    before: String
    first: Int
    last: Int
  ): CampaignOrderConnection!
  campaignOrdersCount: Int!
  cancelledAt: ISO8601DateTime
  channel: Channel!
  completedAt: ISO8601DateTime
  createdAt: ISO8601DateTime
  deposit: CampaignDeposit
  description(interpolate: Boolean = true): String!
  dueAt: ISO8601DateTime!
  endAt: ISO8601DateTime!
  endedAt: ISO8601DateTime
  fulfilAt: ISO8601DateTime
  fulfillingAt: ISO8601DateTime
  gracePeriodHours: Int!
  id: GlobalID!
  identifier: String!
  inventoryApplications: [InventoryApplication!]!
  inventoryPolicy: PresaleInventoryPolicy!
  inventoryTrackingPolicy: PresaleInventoryTrackingPolicy!
  launchAt: ISO8601DateTime!
  launchedAt: ISO8601DateTime
  limit: Int
  name(interpolate: Boolean = true): String!
  productVariants: [ProductVariant!]
  products: [Product!]
  reference: String!
  reservedItemsCount: Int!
  sequentialId: Int!
  status: CampaignStatus!
  totalCampaignItemLimit: Int
  updatedAt: ISO8601DateTime
}

Fields

PresaleCampaign.activeCampaignOrdersCount ● Int! non-null scalar types

The number of the campaign's orders that aren't cancelled.

PresaleCampaign.allocatedInventoryCount ● Int! non-null scalar types

The number of units allocated to the campaign's orders.

PresaleCampaign.allocationStatus ● CampaignAllocationStatus! non-null enum types

The allocation status of the campaign.

PresaleCampaign.appliedInventoryCount ● Int! non-null scalar types

The number of units applied to the campaign through inventory applications.

PresaleCampaign.archivedAt ● ISO8601DateTime scalar types

The date and time when the presale campaign was archived.

PresaleCampaign.campaignInventoryItems ● [CampaignInventoryItem!]! non-null object types

The campaign's inventory items, one for each product variant that has been ordered.

PresaleCampaign.campaignItemType ● CampaignItemType! non-null enum types

Whether the campaign's items are products or product variants.

PresaleCampaign.campaignItems ● [CampaignItem!]! non-null object types

The campaign's items.

PresaleCampaign.campaignOrders ● CampaignOrderConnection! non-null object types

The campaign's orders.

PresaleCampaign.campaignOrders.after ● String scalar types

Returns the elements in the list that come after the specified cursor.

PresaleCampaign.campaignOrders.before ● String scalar types

Returns the elements in the list that come before the specified cursor.

PresaleCampaign.campaignOrders.first ● Int scalar types

Returns the first _n_ elements from the list.

PresaleCampaign.campaignOrders.last ● Int scalar types

Returns the last _n_ elements from the list.

PresaleCampaign.campaignOrdersCount ● Int! non-null scalar types

The number of the campaign's orders, including cancelled orders.

PresaleCampaign.cancelledAt ● ISO8601DateTime scalar types

The date and time when the presale campaign was cancelled.

PresaleCampaign.channel ● Channel! non-null object types

The sales channel the presale campaign belongs to.

PresaleCampaign.completedAt ● ISO8601DateTime scalar types

The date and time when the presale campaign was completed.

PresaleCampaign.createdAt ● ISO8601DateTime scalar types

The date and time when the presale campaign was created.

PresaleCampaign.deposit ● CampaignDeposit object types

The deposit collected at checkout for the campaign's orders.

PresaleCampaign.description ● String! non-null scalar types

The campaign's description. It defaults to the channel's template when not given.

PresaleCampaign.description.interpolate ● Boolean scalar types

Whether to replace date placeholders in the description with formatted dates.

PresaleCampaign.dueAt ● ISO8601DateTime! non-null scalar types

The date and time when payment for the campaign's orders is due. It is fulfilAt if set, otherwise endAt.

PresaleCampaign.endAt ● ISO8601DateTime! non-null scalar types

The date and time when the presale campaign is scheduled to end.

PresaleCampaign.endedAt ● ISO8601DateTime scalar types

The date and time when the presale campaign ended.

PresaleCampaign.fulfilAt ● ISO8601DateTime scalar types

The date and time when the presale campaign is scheduled to start fulfilling. If blank, it can start fulfilling once it ends.

PresaleCampaign.fulfillingAt ● ISO8601DateTime scalar types

The date and time when the presale campaign started fulfilling.

PresaleCampaign.gracePeriodHours ● Int! non-null scalar types

The number of hours a customer has to fix a failed payment before their campaign order is cancelled.

PresaleCampaign.id ● GlobalID! non-null scalar types

The presale campaign's ID.

PresaleCampaign.identifier ● String! non-null scalar types

The campaign's identifier, which is # followed by its sequential ID.

PresaleCampaign.inventoryApplications ● [InventoryApplication!]! non-null object types

The campaign's inventory applications.

PresaleCampaign.inventoryPolicy ● PresaleInventoryPolicy! non-null enum types

When the sales channel reserves inventory for the campaign's orders.

PresaleCampaign.inventoryTrackingPolicy ● PresaleInventoryTrackingPolicy! non-null enum types

How the campaign's inventory is tracked.

PresaleCampaign.launchAt ● ISO8601DateTime! non-null scalar types

The date and time when the presale campaign is scheduled to launch.

PresaleCampaign.launchedAt ● ISO8601DateTime scalar types

The date and time when the presale campaign launched.

PresaleCampaign.limit ● Int scalar types

The maximum number of units of the campaign's products that can be sold.

PresaleCampaign.name ● String! non-null scalar types

The campaign's name. It defaults to the channel's template when not given.

PresaleCampaign.name.interpolate ● Boolean scalar types

Whether to replace date placeholders in the name with formatted dates.

PresaleCampaign.productVariants ● [ProductVariant!] list object types

The product variants in the campaign. Empty when the campaign's items are products.

PresaleCampaign.products ● [Product!] list object types

The products in the campaign. Empty when the campaign's items are product variants.

PresaleCampaign.reference ● String! non-null scalar types

The merchant's reference for the campaign.

PresaleCampaign.reservedItemsCount ● Int! non-null scalar types

The number of units on the campaign's active orders.

PresaleCampaign.sequentialId ● Int! non-null scalar types

The campaign's sequential number within its channel, starting at 1000.

PresaleCampaign.status ● CampaignStatus! non-null enum types

The campaign's status.

PresaleCampaign.totalCampaignItemLimit ● Int scalar types

The sum of the campaign items' limits. Only set when the campaign uses Submarine inventory tracking.

PresaleCampaign.updatedAt ● ISO8601DateTime scalar types

The date and time when the presale campaign was last updated.

Returned By

presaleCampaign query

Member Of

PresaleCampaignApplyBulkInventoryPayload object ● PresaleCampaignApplyInventoryPayload object ● PresaleCampaignArchivePayload object ● PresaleCampaignCancelPayload object ● PresaleCampaignConnection object ● PresaleCampaignCreatePayload object ● PresaleCampaignEdge object ● PresaleCampaignEndPayload object ● PresaleCampaignFulfilPayload object ● PresaleCampaignLaunchPayload object ● PresaleCampaignUnarchivePayload object ● PresaleCampaignUpdatePayload object

Implemented By

Campaign union