searchSubscriptionOrders
Searches subscription orders. The matches are in the subscriptionOrders field of the result.
searchSubscriptionOrders(
customerIds: [SharedGlobalID!]
filter: SubscriptionOrderFilter
flagged: Boolean
paymentStatus: [SubscriptionOrderPaymentStatus!]
query: String
sortDirection: SortDirection
sortKey: SubscriptionOrderSortKey
status: [SubscriptionOrderStatus!]
subscriptionId: GlobalID
subscriptionPlanId: GlobalID
): SearchResult
Arguments
searchSubscriptionOrders.customerIds ● [SharedGlobalID!] deprecated list scalar types
Use filter.customerIds instead.
Return only subscription orders for these customers.
searchSubscriptionOrders.filter ● SubscriptionOrderFilter input types
Filters that narrow the subscription orders search. They take precedence over the matching top-level arguments.
searchSubscriptionOrders.flagged ● Boolean deprecated scalar types
Use filter.flagged instead.
Return only flagged subscription orders when true.
searchSubscriptionOrders.paymentStatus ● [SubscriptionOrderPaymentStatus!] deprecated list enum types
Use filter.paymentStatus instead.
Return only subscription orders with these payment statuses.
searchSubscriptionOrders.query ● String scalar types
Text to search for across identifiers, customer details, delivery names and phones, and order names and IDs. Results are ranked by relevance.
searchSubscriptionOrders.sortDirection ● SortDirection enum types
The direction to sort subscription orders in.
searchSubscriptionOrders.sortKey ● SubscriptionOrderSortKey enum types
The field to sort subscription orders by. It needs sortDirection, and is ignored when query is set.
searchSubscriptionOrders.status ● [SubscriptionOrderStatus!] deprecated list enum types
Use filter.status instead.
Return only subscription orders with these statuses.
searchSubscriptionOrders.subscriptionId ● GlobalID deprecated scalar types
Use filter.subscriptionId instead.
Return only subscription orders for this subscription.
searchSubscriptionOrders.subscriptionPlanId ● GlobalID deprecated scalar types
Use filter.subscriptionPlanId instead.
Return only subscription orders for this subscription plan.
Type
SearchResult object types
The results of a search, identified by its query arguments.