order_search shop_order_read Read
Search orders by date, ship-by date, status, channel, customer, address, SKU, total, tag, picking state, invoice state, or fulfillment error. Returns full order records; use order_get for one known order. 61 filters, grouped below.
ship_by_start_date / ship_by_end_dateoptional Ship-by date window: the required ship date on an Amazon Direct Fulfillment PO, the Expected Ship Date on a Walmart DSV PO, or any ship-by date the channel supplied. Format 2018-01-01 10:10:10 AM.estimated_ship_date_gteq / estimated_ship_date_lseqoptional Estimated ship date window.label_created_date_filter, label_created_start_date, label_created_end_dateoptional Set the filter to 1 and send both dates to select orders by the date a shipping label was created.date_created_greater_equal_than / date_created_less_equal_thanoptional Created-date window. Format 2018-01-01 10:10:10 AM.last_modified_start_date / last_modified_end_dateoptional Modified-date window; the start is exclusive.order_status_eq / order_status_neqoptional One of new, needs_review, in_process, pick_up_ready, pick_up_confirmed, closed, pending, canceled. eq keeps that status; neq drops it.order_source / order_source_eqoptional Channel exactly as stored, for example Amazon.com. Case does not matter; partial values match nothing. The two are the same filter.order_tag, coupon_codeoptional Filter on an order tag, or on the coupon code the order used.order_last_name_begins_with, order_email_likeoptional Customer last name prefix; partial match on customer email.search_term / text_searchoptional Partial match on InfiPlex order id, marketplace order number, or ship city. text_search also accepts additional info:field_name=value, for example additional info:netsuite_class_id=5. Neither searches SKUs or tracking numbers.product_sku / item_sku_eqoptional Orders containing this exact SKU. Partial SKUs match nothing.item_sku_neqoptional Orders with no line of this SKU; an order that has the SKU on any line is dropped whole.product_idoptional Orders containing this InfiPlex product id.order_city, order_state, order_zipoptional Matches the ship-to or the bill-to address.shipping_city, shipping_state, shipping_region, shipping_zip, shipping_countryoptional Exact match on the ship-to address.billing_city, billing_state, billing_region, billing_zip, billing_countryoptional Exact match on the bill-to address.fully_shippedoptional 1 for fully shipped only; 0 for not fully shipped, including partially shipped.is_canceled, is_seller_fulfilled_primeoptional Set to 1 to restrict.has_trackingoptional 1 for orders with at least one tracking number, 0 for orders with none.picking_statusoptional 0 not picking, 1 being picked, 2 fully picked.marketplace_fulfillment_erroroptional 1 for orders the channel rejected a fulfillment on (tracking, confirmation), 0 for orders without one.invoice_flagoptional 0 no invoice, 1 open invoice, 2 closed invoice, 10 open or closed, 30 open invoice with tracking.minimum_order_number / maximum_order_number, order_id_greateroptional Order id range, inclusive; order_id_greater is exclusive.order_min_total / order_max_totaloptional Order total range.filter_items_after_query_by_warehouse_identsoptional Comma separated warehouse identifiers, for example main,west. After the search, each order's lines are narrowed to those warehouses.include_order_notes, include_order_additional_info, include_pick_info_data, include_invoice_base_data, include_drop_shipper_dataoptional Set to 1 to add that block to each order; additional info makes results much larger.just_basic_order_data_resultsoptional Set to 1 for much smaller results: each order comes back without tracking_numbers, order_automation, order_used_warehouses, shipping_tags, pick_info, additional_info, invoice_base_data, drop_shipper_data, and order_packing_slip_url.just_countoptional Set to 1 to return only the count.sortoptional Sort expression, default shop_orderid DESC.limit / limit_startoptional Paging, maximum 100 per call.
- Use just_count for how-many questions instead of paging, and just_basic_order_data_results 1 whenever shipments and extras are not needed.
- Ship-by date is the deadline query: ship_by_end_date set to today with fully_shipped 0 is the Direct Fulfillment or DSV due-out list.
- The assistant is told to read order_source from earlier output rather than guess the stored value.
