OrdersFiltersInput Input

Description

Input fields for filtering and paginating orders. Supports filtering by date range, origin, status, billing status, shipping status, payment methods, and search terms. Used by the orders, ordersStatistics, and ordersReport queries.

Declaration

input OrdersFiltersInput {
    page: Int
    limit: Int
    sort: String
    order: Int
    from: Date
    to: Date
    dateFilter: String
    origin: [String!]
    status: [String!]
    billingStatus: [String!]
    shippingStatus: [String!]
    paymentMethods: [String!]
    itemRef: ID
    buyerRef: ID
    couponRef: ID
    giftCardRef: ID
    term: String
}

Fields

Name	Type	Description
page	Int	The requested page number. Defaults to 1 if not specified.
limit	Int	Number of orders per page. You can request a specific page size, and it will be used if it does not exceed the server-enforced maximum. If your requested size exceeds the maximum, the server will enforce the maximum limit.
sort	String	Field name to sort results by. Valid values include "createdDate" (sorts by creation date), "paymentDate" (sorts by payment date), or "total" (sorts by grand total). Defaults to "createdDate" if not specified.
order	Int	Sort order: 1 for ascending, -1 for descending.
from	Date	Start date for filtering orders. Used with the dateFilter field to specify which date field to filter by.
to	Date	End date for filtering orders. Used with the dateFilter field to specify which date field to filter by.
dateFilter	String	Date field to use for filtering when from or to are specified. Valid values include "created" (default), "billing.paymentDate", or other order date fields.
origin	[String!]	List of order origins to filter by. Valid values include "Online", "Shop", "Discogs", or "Bandcamp".
status	[String!]	List of order statuses to filter by. Valid values include "New Order", "Buyer Contacted", "Invoice Sent", "Payment Pending", "Payment Received", "Shipped", "Refund Sent", "Cancelled", "Cancelled (Non-Paying Buyer)", "Cancelled (Item Unavailable)", "Cancelled (Per Buyer's Request)", "Merged", or "Quote". If not specified, excludes cancelled, refunded, and merged orders.
billingStatus	[String!]	List of billing statuses to filter by. Valid values include "Pending", "Paid", "Partially Paid", "Refunded", or "Partially Refunded".
shippingStatus	[String!]	List of shipping statuses to filter by. Valid values include "Pending", "Shipped", "Collected", or "Packed".
paymentMethods	[String!]	List of payment methods to filter by. Valid values include "cash", "card", "stripe", "paypal", "cheque", "bankTransfer", or "creditNote".
itemRef	ID	Reference ID of a specific item to filter orders that contain this item.
buyerRef	ID	Reference ID of a specific buyer to filter orders by buyer.
couponRef	ID	Reference ID of a specific coupon/voucher to filter orders that used this coupon.
giftCardRef	ID	Reference ID of a specific gift card to filter orders that used this gift card as payment.
term	String	Search term to filter orders by. If the term matches the pattern "number-number", it searches by exact order ID. Otherwise, it performs a case-insensitive search on order descriptions and related fields.