Skip to main content

searchPresaleCampaigns

Searches presale campaigns. Read the matches from the result's presaleCampaigns field.

searchPresaleCampaigns(
  allocationStatus: [CampaignAllocationStatus!]
  isAllocating: Boolean
  isArchived: Boolean
  productIds: [SharedGlobalID!]
  productVariantIds: [SharedGlobalID!]
  query: String
  sortDirection: SortDirection
  sortKey: PresaleCampaignSortKey
  status: [CampaignStatus!]
): SearchResult

Arguments​

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

Return only campaigns with any of these allocation statuses.

searchPresaleCampaigns.isAllocating ● Boolean scalar types​

Filter by whether the campaign is allocating inventory.

searchPresaleCampaigns.isArchived ● Boolean scalar types​

Filter by whether the campaign is archived.

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

Return only campaigns that include any of these products.

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

Return only campaigns that include any of these product variants.

searchPresaleCampaigns.query ● String scalar types​

A search query matching a campaign's ID, name, reference or identifier, such as #1486, or the name of a product or variant it sells. Results are ordered by relevance and sortKey is ignored.

searchPresaleCampaigns.sortDirection ● SortDirection enum types​

The direction to sort campaigns in. Defaults to ascending.

searchPresaleCampaigns.sortKey ● PresaleCampaignSortKey enum types​

The field to sort campaigns by. Defaults to ID.

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