CrowdfundingCampaign

A campaign that takes orders towards a goal. Payment is captured only if the goal is met when the campaign ends.

type CrowdfundingCampaign {
  activeCampaignOrdersCount: Int!
  allocatedInventoryCount: Int!
  allocationStatus: CampaignAllocationStatus!
  appliedInventoryCount: Int!
  archivedAt: ISO8601DateTime
  campaignEndTotalUnits: Int
  campaignEndTotalValue: Money
  campaignInventoryItems: [CampaignInventoryItem!]!
  campaignItemType: CampaignItemType!
  campaignItems: [CampaignItem!]!
  campaignOrders(
    after: String
    before: String
    first: Int
    last: Int
  ): CampaignOrderConnection!
  campaignOrdersCount: Int!
  campaignRunningTotalUnits: Int
  campaignRunningTotalValue: Money
  cancelledAt: ISO8601DateTime
  channel: Channel!
  completedAt: ISO8601DateTime
  createdAt: ISO8601DateTime
  currency: CurrencyCode!
  description(interpolate: Boolean = true): String!
  dueAt: ISO8601DateTime!
  endAt: ISO8601DateTime!
  endedAt: ISO8601DateTime
  fulfilAt: ISO8601DateTime
  fulfillingAt: ISO8601DateTime
  goal: CrowdfundingGoal!
  goalProgress: Float!
  goalStatus: CrowdfundingGoalStatus!
  gracePeriodHours: Int!
  id: GlobalID!
  identifier: String!
  inventoryApplications: [InventoryApplication!]!
  launchAt: ISO8601DateTime!
  launchedAt: ISO8601DateTime
  limit: Int
  name(interpolate: Boolean = true): String!
  productVariants: [ProductVariant!]
  products: [Product!]
  reference: String!
  reservedItemsCount: Int!
  sequentialId: Int!
  status: CampaignStatus!
  updatedAt: ISO8601DateTime
}

Fields

CrowdfundingCampaign.activeCampaignOrdersCount ● Int! non-null scalar types

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

CrowdfundingCampaign.allocatedInventoryCount ● Int! non-null scalar types

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

CrowdfundingCampaign.allocationStatus ● CampaignAllocationStatus! non-null enum types

The allocation status of the campaign.

CrowdfundingCampaign.appliedInventoryCount ● Int! non-null scalar types

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

CrowdfundingCampaign.archivedAt ● ISO8601DateTime scalar types

The date and time when the crowdfunding campaign was archived.

CrowdfundingCampaign.campaignEndTotalUnits ● Int scalar types

The number of units on active orders when the campaign ended.

CrowdfundingCampaign.campaignEndTotalValue ● Money object types

The total value of active orders when the campaign ended.

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

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

CrowdfundingCampaign.campaignItemType ● CampaignItemType! non-null enum types

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

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

The campaign's items.

CrowdfundingCampaign.campaignOrders ● CampaignOrderConnection! non-null object types

The campaign's orders.

CrowdfundingCampaign.campaignOrders.after ● String scalar types

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

CrowdfundingCampaign.campaignOrders.before ● String scalar types

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

CrowdfundingCampaign.campaignOrders.first ● Int scalar types

Returns the first _n_ elements from the list.

CrowdfundingCampaign.campaignOrders.last ● Int scalar types

Returns the last _n_ elements from the list.

CrowdfundingCampaign.campaignOrdersCount ● Int! non-null scalar types

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

CrowdfundingCampaign.campaignRunningTotalUnits ● Int scalar types

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

CrowdfundingCampaign.campaignRunningTotalValue ● Money object types

The total value of the campaign's active orders, after discounts.

CrowdfundingCampaign.cancelledAt ● ISO8601DateTime scalar types

The date and time when the crowdfunding campaign was cancelled.

CrowdfundingCampaign.channel ● Channel! non-null object types

The sales channel the crowdfunding campaign belongs to.

CrowdfundingCampaign.completedAt ● ISO8601DateTime scalar types

The date and time when the crowdfunding campaign was completed.

CrowdfundingCampaign.createdAt ● ISO8601DateTime scalar types

The date and time when the crowdfunding campaign was created.

CrowdfundingCampaign.currency ● CurrencyCode! non-null enum types

The campaign's currency, taken from the channel's default currency.

CrowdfundingCampaign.description ● String! non-null scalar types

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

CrowdfundingCampaign.description.interpolate ● Boolean scalar types

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

CrowdfundingCampaign.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.

CrowdfundingCampaign.endAt ● ISO8601DateTime! non-null scalar types

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

CrowdfundingCampaign.endedAt ● ISO8601DateTime scalar types

The date and time when the crowdfunding campaign ended.

CrowdfundingCampaign.fulfilAt ● ISO8601DateTime scalar types

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

CrowdfundingCampaign.fulfillingAt ● ISO8601DateTime scalar types

The date and time when the crowdfunding campaign started fulfilling.

CrowdfundingCampaign.goal ● CrowdfundingGoal! non-null union types

The campaign's goal.

CrowdfundingCampaign.goalProgress ● Float! non-null scalar types

The campaign's progress towards its goal, as a percentage. It can exceed 100.

CrowdfundingCampaign.goalStatus ● CrowdfundingGoalStatus! non-null enum types

The campaign's goal status.

CrowdfundingCampaign.gracePeriodHours ● Int! non-null scalar types

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

CrowdfundingCampaign.id ● GlobalID! non-null scalar types

The crowdfunding campaign's ID.

CrowdfundingCampaign.identifier ● String! non-null scalar types

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

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

The campaign's inventory applications.

CrowdfundingCampaign.launchAt ● ISO8601DateTime! non-null scalar types

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

CrowdfundingCampaign.launchedAt ● ISO8601DateTime scalar types

The date and time when the crowdfunding campaign launched.

CrowdfundingCampaign.limit ● Int scalar types

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

CrowdfundingCampaign.name ● String! non-null scalar types

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

CrowdfundingCampaign.name.interpolate ● Boolean scalar types

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

CrowdfundingCampaign.productVariants ● [ProductVariant!] list object types

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

CrowdfundingCampaign.products ● [Product!] list object types

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

CrowdfundingCampaign.reference ● String! non-null scalar types

The merchant's reference for the campaign.

CrowdfundingCampaign.reservedItemsCount ● Int! non-null scalar types

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

CrowdfundingCampaign.sequentialId ● Int! non-null scalar types

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

CrowdfundingCampaign.status ● CampaignStatus! non-null enum types

The campaign's status.

CrowdfundingCampaign.updatedAt ● ISO8601DateTime scalar types

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

Returned By

crowdfundingCampaign query

Member Of

CrowdfundingCampaignApplyBulkInventoryPayload object ● CrowdfundingCampaignApplyInventoryPayload object ● CrowdfundingCampaignArchivePayload object ● CrowdfundingCampaignCancelPayload object ● CrowdfundingCampaignConnection object ● CrowdfundingCampaignCreatePayload object ● CrowdfundingCampaignEdge object ● CrowdfundingCampaignEndPayload object ● CrowdfundingCampaignFulfilPayload object ● CrowdfundingCampaignLaunchPayload object ● CrowdfundingCampaignUnarchivePayload object ● CrowdfundingCampaignUpdatePayload object

Implemented By

Campaign union