Skip to main content

searchCrowdfundingCampaigns

Searches crowdfunding campaigns. Read the matches from the result's crowdfundingCampaigns field.

searchCrowdfundingCampaigns(
  allocationStatus: [CampaignAllocationStatus!]
  goalType: [CrowdfundingGoalType!]
  isAllocating: Boolean
  isArchived: Boolean
  productIds: [SharedGlobalID!]
  productVariantIds: [SharedGlobalID!]
  query: String
  sortDirection: SortDirection
  sortKey: CrowdfundingCampaignSortKey
  status: [CampaignStatus!]
): SearchResult

Arguments​

searchCrowdfundingCampaigns.allocationStatus ● [CampaignAllocationStatus!] list enum types​

Return only campaigns with any of these allocation statuses.

searchCrowdfundingCampaigns.goalType ● [CrowdfundingGoalType!] list enum types​

Return only campaigns with any of these goal types.

searchCrowdfundingCampaigns.isAllocating ● Boolean scalar types​

Filter by whether the campaign is allocating inventory.

searchCrowdfundingCampaigns.isArchived ● Boolean scalar types​

Filter by whether the campaign is archived.

searchCrowdfundingCampaigns.productIds ● [SharedGlobalID!] list scalar types​

Return only campaigns that include any of these products.

searchCrowdfundingCampaigns.productVariantIds ● [SharedGlobalID!] list scalar types​

Return only campaigns that include any of these product variants.

searchCrowdfundingCampaigns.query ● String scalar types​

A search query to filter campaigns by. It matches the campaign's ID, reference or identifier, such as #1486, and matching products or product variants.

searchCrowdfundingCampaigns.sortDirection ● SortDirection enum types​

The direction to sort campaigns in. Defaults to ascending.

searchCrowdfundingCampaigns.sortKey ● CrowdfundingCampaignSortKey enum types​

The field to sort campaigns by. Defaults to ID.

searchCrowdfundingCampaigns.status ● [CampaignStatus!] list enum types​

Return only campaigns with any of these statuses.

Type​

SearchResult object types​

The results of a search, identified by its query arguments.