Skip to main content

searchCampaignOrders

Searches campaign orders. Read the matches from the result's campaignOrders field.

searchCampaignOrders(
  campaignId: GlobalID
  campaignType: CampaignType
  customerId: [SharedGlobalID!]
  fulfilmentStatus: [CampaignOrderFulfilmentStatus!]
  paymentStatus: [CampaignOrderPaymentStatus!]
  productVariantId: [SharedGlobalID!]
  query: String
  sortDirection: SortDirection
  sortKey: CampaignOrderSortKey
  status: [CampaignOrderStatus!]
): SearchResult

Arguments​

searchCampaignOrders.campaignId ● GlobalID scalar types​

Return only campaign orders for this campaign.

searchCampaignOrders.campaignType ● CampaignType enum types​

Return only campaign orders for this type of campaign.

searchCampaignOrders.customerId ● [SharedGlobalID!] list scalar types​

Return only campaign orders for any of these customers.

searchCampaignOrders.fulfilmentStatus ● [CampaignOrderFulfilmentStatus!] list enum types​

Return only campaign orders with any of these fulfilment statuses.

searchCampaignOrders.paymentStatus ● [CampaignOrderPaymentStatus!] list enum types​

Return only campaign orders with any of these payment statuses.

searchCampaignOrders.productVariantId ● [SharedGlobalID!] list scalar types​

Return only campaign orders for any of these product variants.

searchCampaignOrders.query ● String scalar types​

A search query to filter campaign orders by. It matches the order's ID or identifier, its campaign's reference, and matching customers or product variants.

searchCampaignOrders.sortDirection ● SortDirection enum types​

The direction to sort campaign orders in. Defaults to ascending.

searchCampaignOrders.sortKey ● CampaignOrderSortKey enum types​

The field to sort campaign orders by. Defaults to ID.

searchCampaignOrders.status ● [CampaignOrderStatus!] list enum types​

Return only campaign orders with any of these statuses.

Type​

SearchResult object types​

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