SerializableDictionary(Of String, String)
Fields
Field Name | Data Type | Description |
Keys | String () | List of Keys - includes date range, customer name, order number, or SKU |
Values | String () | List of Values |
Filter Keys
SKU - Returns orders containing the Product ID
Company - Filters by Company ID
Companies - Filters by a list of Company IDs. Can be separated by comma, semicolon, pipe or empty space.
DateFrom and DateTo - Can filter the range of orders in specific time frame
Invoice - Filters orders by invoice status.
- -1 - All invoice statuses
- 0 - not-printed invoices
- 1 - printed invoices
ShipFromWarehouseID - filters by SellerCloud Warehouse ID.
Channel - Filters by SellerCloud channel ID. -1 will return all channels. List of channels can be found here. This list does not include any channels integrated by plugins - they all count as Website channels.
Location - Filters by location
- -1 - All locations
- 1 - Domestic
- 2 - International
BackOrderStatus - Filters by Back Order Status.
- -1 - All orders
- 1 - Orders with Back Order Status
- 2 - Orders without Back Order Status
ExportedStatus- Filters orders by exported status
- -1 - All statuses
- 1 - Orders with exported status
- 2 - Orders with not-exported status
CustomerName - Filters by customer name
OrderNo - Filters by SellerCloud Order ID
Rush - Will return only Rush Orders
CusNote - Will return orders with or without customer notes
- -1 - All orders
- 0 - Orders without customer notes
- 1 - Orders with customer notes
MultiItems - returns orders based on the number of products
- -1 - All Orders
- 1 - Orders with single item
- 2 - Multi-item orders
MultiPackage - returns orders based on the number of packages
- -1 - All orders
- 1 - Single package orders
- 0 - Multiple package orders
Gift - Will return orders marked as Gift Orders
- -1 - All orders
- 1 - Gift Orders
- 0 - Non-Gift Orders
Wrap - Returns Gift Wrap orders
- -1 - All orders
- 1 - Wrap orders
- 0 - Non-Wrap orders
OrderNoRangeEnd - Returns orders with IDs up to this number
ShippedBy - Filters by shipping user ID
ReadyForPickup - Filters by pickup status
- -1 - All orders
- 1 - Pickup only
- 0 - Non-Pickup only
ShipCarrierNew - Filters by ship carrier. Send ALL for all carriers.
ShipServiceNew - Filters by shipping service. Send ALL for all services.
FilterKit - Filters orders with kit items. 1 or 0
LocNotesOp - Works with the LocNotes filter.
- 0 - means the note is different than the LocNotes
- 1 - matches the location note as string
- 2 - looks for notes that start with this string
LocNotes - Filters by Location note. Works with LocNotesOp filter
SortForScanShip - Sorts for scan and ship. 1 or 0
ScanShipSortDate - Works with SortForScanShip filter. 1 or 0. Will sort single items first then multi items alphabetically.
CustomerServiceStatus - Filters by customer services status
Picklist - Includes orders related to specified Picklist ID
CompanyName - Can filter by company name instead of ID
ExclusiveSku - filters by exclusive SKU.
OrderGroupID - Filters by Order group ID
ProductGroupID - Filters by product group ID
SavedSearch - Filters by Saved Search ID. Very useful as you can apply all the needed filters in the interface, save them and then just use that saved search.
OrderUserID - Filters by Order User ID
DownloadedFlag - Filters orders by downloaded status
- -1 - All orders
- 1 - downloaded
- 0 - not downloaded
ReturnProductInfo - Includes product info. 1 or 0
ReadyToShip - Filters orders by Ready To Ship status.
DollarAmount - Filters by dollar amount. See next filter for more info.
DollarAmountOperation - Works with the filter DollarAmount
- >= - Greater or Equal
- <= - Less or Equal
AmazonPrime - Only Amazon Prime Orders
PaymentStatus - Filters by payment status
- 10 - No Payment
- 20 - Authorized
- 30 - Charged
- 40 - Uncleared
- 50 - Partially Refunded
- 60 - Full Refund
- 70 - Partial Payment
- 80 - eBay Paid
- 99 - Payment Error
ShippingStatusKind - Filters by shipping status
- -1 - All orders
- 0 - Unknown
- 1 - Unshipped
- 2 - Partially Shipped
- 3 - Fully Shipped
- 4 - Ready For Pickup
IsConfirmed - Returns orders based on their Confirmed Status. 1 or 0
IncludeDS - Include DropShip status. 1 or 0
PickingStatus - Filters based on order picking status
- 0 - None
- 1 - Partially Picked
- 2 - Fully Picked
- 3 - Over Picked
ConfirmationLabelPrinted - Filters based on confirmation label printed
- -1 - All orders
- 0 - Not printed only
- 1 - Printed only