Skip to main content

presaleCampaignPagination

Returns pages of presale campaigns that match the arguments. Page with the result's nextPresaleCampaigns and previousPresaleCampaigns fields.

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

Arguments​

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

Return only campaigns with any of these allocation statuses.

presaleCampaignPagination.isAllocating ● Boolean scalar types​

Filter by whether the campaign is allocating inventory.

presaleCampaignPagination.isArchived ● Boolean scalar types​

Filter by whether the campaign is archived.

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

Return only campaigns that include any of these products.

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

Return only campaigns that include any of these product variants.

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

presaleCampaignPagination.sortDirection ● SortDirection enum types​

The direction to sort campaigns in. Defaults to ascending.

presaleCampaignPagination.sortKey ● PresaleCampaignSortKey enum types​

The field to sort campaigns by. Defaults to ID.

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

Return only campaigns with any of these statuses.

Type​

PaginationResult object types​

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