Order Search
GET
{{api_url}}/shop/order/search?pre_built=top_selling_skus_by_qty_since_last_monthSearches orders in InfiPlex OMS. It returns full order records, including line items and shipments, plus the total number of matching orders. Filters can be combined, and an order must match all of them. Two parameters change the shape of the response: group_by returns counts per status, channel, day, or ship method instead of orders, and pre_built runs a canned 30-day report. Both are described below.
Results are sorted by shop_orderid, newest first, unless sort is set. Page with limit and limit_start. total_orders always reports the full match count, not the size of the current page.
Dates use 2026-09-01 12:00:00 AM, in your account's time zone. 24-hour time, such as 2026-09-01 13:00:00, is also accepted.
date_created is when the order entered InfiPlex. order_date is when the customer placed it on the sales channel, and it can be much earlier. The date_created_\\* filters use date_created.
Pulling new orders
To pull new orders on a schedule, set date_created_greater_equal_than to the time of your last pull. The bound is inclusive, so an order created in that same second can come back again. Skip any shop_orderid you already have.
When paging through a large pull, sort by shop_orderid ASC. Orders that arrive mid-pull then land at the end instead of shifting your pages.
Query parameters: dates
| Parameter | Type | Description |
|---|---|---|
date_created_greater_equal_than | string | Orders created in InfiPlex on or after this date and time. |
date_created_less_equal_than | string | Orders created in InfiPlex on or before this date and time. |
last_modified_start_date | string | Orders last modified after this date and time, not including it. |
last_modified_end_date | string | Orders last modified on or before this date and time. |
ship_by_start_date | string | Orders with a ship-by date on or after this date and time. |
ship_by_end_date | string | Orders with a ship-by date on or before this date and time. |
estimated_ship_date_gteq | string | Orders with an estimated ship date on or after this date and time. |
estimated_ship_date_lseq | string | Orders with an estimated ship date on or before this date and time. |
label_created_date_filter | integer | Set to 1 to filter by the date a shipping label was created. When you set it, you must also send label_created_start_date and label_created_end_date. |
label_created_start_date | string | With label_created_date_filter=1: orders with a label created on or after this date and time. |
label_created_end_date | string | With label_created_date_filter=1: orders with a label created on or before this date and time. |
Query parameters: order number and status
| Parameter | Type | Description |
|---|---|---|
minimum_order_number | integer | Orders with a shop_orderid greater than or equal to this value. |
maximum_order_number | integer | Orders with a shop_orderid less than or equal to this value. |
order_id_greater | integer | Orders with a shop_orderid greater than this value, not including it. |
order_status_eq | string | Orders in one status: new, needs_review, in_process, pick_up_ready, pick_up_confirmed, closed, pending, or canceled. |
order_status_neq | string | Orders in any status except this one. |
is_canceled | integer | 1 for canceled orders only. |
fully_shipped | integer | 1 for fully shipped orders only. 0 for orders not fully shipped, which includes partially shipped orders. |
has_tracking | integer | 1 for orders with at least one tracking number. 0 for orders with none. |
picking_status | integer | Orders in one picking state: 0 not picking, 1 being picked, 2 fully picked. |
marketplace_fulfillment_error | integer | 1 for orders with a marketplace fulfillment error. 0 for orders without one. |
is_seller_fulfilled_prime | integer | 1 for Seller Fulfilled Prime orders only. |
Query parameters: channel, customer, and text
| Parameter | Type | Description |
|---|---|---|
order_source | string | Orders from one sales channel. Must match the order's stored order_source exactly, for example Amazon.com. Amazon does not match. Case does not matter. |
order_source_eq | string | Same as order_source. |
order_tag | string | Orders with this exact tag. |
coupon_code | string | Orders that used this coupon code. |
order_last_name_begins_with | string | Orders whose customer last name begins with this text. |
order_email_like | string | Partial match against the customer's email. |
search_term | string | Partial match against order fields such as the InfiPlex order ID, the marketplace order number, or the ship city. Plain text only. For field-specific searches, use text_search. |
text_search | string | The same partial match as search_term, plus field-specific search strings. See Searching additional info with text_search below. It does not search SKUs or tracking numbers; use product_sku for a SKU. Customer name and email are not searchable on orders with encrypted customer data (pii_encrypted is 1). |
Query parameters: address
| Parameter | Type | Description |
|---|---|---|
order_city, order_state, order_zip | string | Orders whose ship-to or bill-to address has this city, state, or zip. Matches either address. |
shipping_city, shipping_state, shipping_region, shipping_zip, shipping_country | string | Orders whose ship-to address has exactly this city, state, region, zip, or country. |
billing_city, billing_state, billing_region, billing_zip, billing_country | string | Orders whose bill-to address has exactly this city, state, region, zip, or country. |
Query parameters: items and totals
| Parameter | Type | Description |
|---|---|---|
product_sku | string | Orders containing this exact SKU. A partial SKU matches nothing. |
item_sku_eq | string | Orders with a line item of exactly this SKU. |
item_sku_neq | string | Orders with no line item of this SKU. item_sku_neq=ABC leaves out every order that has an ABC line. |
product_id | integer | Orders containing the product with this InfiPlex product ID (shop_productid). |
order_min_total | number | Orders with an order_total greater than or equal to this value. |
order_max_total | number | Orders with an order_total less than or equal to this value. |
filter_items_after_query_by_warehouse_idents | string | Comma-separated warehouse identifiers, for example main,west. After the search runs, each order's line items are narrowed to the ones assigned to these warehouses. |
Query parameters: invoices
| Parameter | Type | Description |
|---|---|---|
invoice_flag | integer | Filter by invoice state: 0 has no invoice, 1 has an open invoice, 2 has a closed invoice, 10 has an open or closed invoice, 30 has an open invoice and tracking. |
Query parameters: extra data and result size
| Parameter | Type | Description |
|---|---|---|
include_order_notes | integer | Set to 1 to add notes to each order. |
include_order_additional_info | integer | Set to 1 to add additional_info to each order. |
include_pick_info_data | integer | Set to 1 to add pick_info to each order. |
include_invoice_base_data | integer | Set to 1 to add invoice_base_data to each order. |
include_drop_shipper_data | integer | Set to 1 to add drop_shipper_data to each order. |
just_basic_order_data_results | integer | Set to 1 for smaller responses. 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. |
Query parameters: sorting, paging, and counting
| Parameter | Type | Description |
|---|---|---|
sort | string | An order field followed by ASC or DESC, for example order_date DESC. Default: shop_orderid DESC. |
limit | integer | Number of orders to return. Default 100, maximum 100. A value of 100 or more returns the default of 100. |
limit_start | integer | Number of orders to skip before returning results. limit=100&limit_start=100 returns orders 101 through 200. |
just_count | integer | Set to 1 (or true) to return only total_orders instead of the orders themselves. |
group_by | string | Return counts per group instead of orders. One of order_status, order_source, order_source_and_status, marketplace_fulfillment_error, picking_status, invoice_flag, ship_label, order_date, estimated_ship_date. Any other value returns 204 No Content. All other filters still apply. See Grouped counts with group_by. |
pre_built | string | Run a canned report. When set, every other parameter except order_source is ignored. See Pre-built searches with pre_built. |
Searching additional info with text_search
text_search accepts a field-specific string that finds orders by an additional info field and its value:
additional info:some_add_field=111
That returns orders whose additional info field some_add_field has the value 111. URL-encode the string in the query:
{{api_url}}/shop/order/search?text_search=additional info:some_add_field=111
Examples
New Amazon orders since your last pull, oldest first:
{{api_url}}/shop/order/search?order_source=Amazon.com&date_created_greater_equal_than=2026-09-24 04:00:00 PM&sort=shop_orderid ASC&limit=100&limit_start=0
Orders that aren't fully shipped and have no tracking yet:
{{api_url}}/shop/order/search?fully_shipped=0&has_tracking=0&is_canceled=0
Orders fully picked and waiting to ship:
{{api_url}}/shop/order/search?picking_status=2&fully_shipped=0
Orders a marketplace rejected at fulfillment:
{{api_url}}/shop/order/search?marketplace_fulfillment_error=1
Orders due to ship by the end of today:
{{api_url}}/shop/order/search?ship_by_end_date=2026-09-25 11:59:59 PM&fully_shipped=0
Orders with no line of SKU ABC:
{{api_url}}/shop/order/search?item_sku_neq=ABC
Lighter results for a dashboard, with no shipments or extras:
{{api_url}}/shop/order/search?order_status_eq=new&just_basic_order_data_results=1
How many orders are in needs_review, without the orders:
{{api_url}}/shop/order/search?order_status_eq=needs_review&just_count=1
Grouped counts with group_by
Set group_by to get counts per group instead of orders. Every other filter still applies, so marketplace_fulfillment_error=1&group_by=order_source returns failed orders per channel, and ship_by_end_date=...&fully_shipped=0&group_by=order_status returns what is due today by status.
The response is a plain JSON array of group rows, with no orders and no total_orders. Every row has tcount, the number of distinct orders in that group, returned as a string, plus the group column(s) below. sort is ignored. The two date groups come back oldest first; the other groups come back in database order. limit and limit_start apply to the group rows.
group_by value | Row fields | Notes |
|---|---|---|
order_status | tcount, order_status | One row per status. |
order_source | tcount, order_source | One row per sales channel, exactly as stored. Useful for discovering the stored order_source values on an account. |
order_source_and_status | tcount, order_source, order_status | One row per channel and status pair. |
marketplace_fulfillment_error | tcount, marketplace_fulfillment_error | Two rows at most, 0 and 1. |
picking_status | tcount, picking_status | 0 not picking, 1 being picked, 2 fully picked. |
invoice_flag | tcount, invoice_flag | One row per stored invoice flag value. |
ship_label | tcount, ship_label | The shipping method text the channel sent with the order, for example UPS Ground, Standard, USE VRS/ShipIQ. Free text, different on every channel. An empty string is orders that arrived with none. |
order_date | tcount, order_total_sum, order_date | One row per calendar day of order_date, oldest first, with the sum of order_total for that day. |
estimated_ship_date | tcount, estimated_ship_date | One row per calendar day of estimated_ship_date, oldest first. |
Fulfillment errors per channel this month:
{{api_url}}/shop/order/search?marketplace_fulfillment_error=1&is_canceled=0&date_created_greater_equal_than=2026-09-01 12:00:00 AM&group_by=order_source
Response:
[
{ "tcount": "14", "order_source": "Walmart" },
{ "tcount": "3", "order_source": "Amazon.com" }
]
Orders and revenue by day for a channel:
{{api_url}}/shop/order/search?order_source=Amazon.com&date_created_greater_equal_than=2026-09-01 12:00:00 AM&group_by=order_date
Response:
[
{ "tcount": "41", "order_total_sum": "1873.55", "order_date": "2026-09-01" },
{ "tcount": "37", "order_total_sum": "1602.10", "order_date": "2026-09-02" }
]
Pre-built searches with pre_built
Set pre_built to run one of the canned reports below. When pre_built is set, every other parameter is ignored, including group_by, sort, limit, limit_start, and just_count. The one exception is order_source, which narrows the two searches marked with it.
All pre-built searches cover orders whose order_date is within the last 30 days (90 for the one 90-day variant), exclude canceled orders, and use today's date in your account's time zone. The response is a plain JSON array with no total_orders.
Searches that return order lists return full order records, the same shape as orders in a normal search. Searches that return a single count return one row, [{"tcount": "12"}].
pre_built value | Returns | Window |
|---|---|---|
fulfillment_errors_list_since_last_month | Orders with a marketplace fulfillment error. Accepts order_source. | Last 30 days through end of today. |
fulfillment_errors_count_by_marketplace_since_last_month | Rows of tcount, order_source: failed orders per channel. | Last 30 days through end of today. |
ship_by_date_list_since_last_month | Orders due to ship today. Accepts order_source. | Ship-by date is today. |
ship_by_date_list_by_marketplace_since_last_month | Rows of tcount, order_source: orders due to ship today, per channel. | Ship-by date is today. |
ship_by_date_past_due_list_all_since_last_month | Orders not fully shipped whose ship-by date has passed. | Ship-by date between 30 days ago and end of yesterday. |
ship_by_date_past_due_count_all_since_last_month | One row with tcount: the number of orders in the list above. | Same. |
ship_by_date_today_all_since_last_month | One row with tcount: orders due to ship today. | Ship-by date is today. |
ship_by_date_today_shipped_since_last_month | One row with tcount: orders due today that are already fully shipped. | Ship-by date is today. |
ship_by_date_one_day_forward_all_since_last_month | One row with tcount: orders due to ship tomorrow. | Ship-by date is tomorrow. |
ship_by_date_one_day_forward_shipped_since_last_month | One row with tcount: orders due tomorrow that are already fully shipped. | Ship-by date is tomorrow. |
ship_by_date_two_days_forward_all_since_last_month | One row with tcount: orders due to ship in two days. | Ship-by date is two days out. |
ship_by_date_two_days_forward_shipped_since_last_month | One row with tcount: orders due in two days that are already fully shipped. | Ship-by date is two days out. |
ship_by_date_three_days_forward_all_since_last_month | One row with tcount: orders due to ship in three days. | Ship-by date is three days out. |
ship_by_date_three_days_forward_shipped_since_last_month | One row with tcount: orders due in three days that are already fully shipped. | Ship-by date is three days out. |
top_selling_skus_by_qty_since_last_month | 10 rows of sku, qty_sold, highest quantity first. | Last 30 days through end of yesterday. |
top_selling_skus_by_sales_since_last_month | 10 rows of sku, total_sales, highest sales first. total_sales is quantity times unit price. | Last 30 days through end of yesterday. |
total_sold_skus_by_qty_since_last_month | One row with qty_sold, total units across every SKU. | Last 30 days through end of yesterday. |
total_sold_skus_by_sales_since_last_month | One row with total_sales, quantity times unit price across every SKU. | Last 30 days through end of yesterday. |
total_sales_by_day_since_last_month | One row per day with total_sales, orders_day, orders_month, orders_year, oldest first. | Last 30 days through end of yesterday. |
total_sales_by_order_source_since_since_last_30_days | Rows of tcount, order_source: order counts per channel. Counts, not dollar totals. | Last 30 days through end of today. |
total_sales_by_order_source_since_since_last_90_days | Rows of tcount, order_source: order counts per channel. Counts, not dollar totals. | Last 90 days through end of today. |
Failed orders per channel over the last 30 days:
{{api_url}}/shop/order/search?pre_built=fulfillment_errors_count_by_marketplace_since_last_month
Top 10 SKUs by units over the last 30 days:
{{api_url}}/shop/order/search?pre_built=top_selling_skus_by_qty_since_last_month
Response:
[
{ "sku": "ABC-123", "qty_sold": "412" },
{ "sku": "DEF-456", "qty_sold": "377" }
]
Orders due to ship today on one channel:
{{api_url}}/shop/order/search?pre_built=ship_by_date_list_since_last_month&order_source=Walmart
Precedence
pre_built overrides everything else. group_by overrides just_count, sort, and the normal orders + total_orders response shape. With neither set, the search behaves as described at the top.
Response fields
| Field | Description |
|---|---|
orders | The matching orders, up to limit. |
total_orders | The total number of orders matching the filters across all pages, returned as a string. |
With group_by or pre_built set, the response is a plain JSON array instead, with no orders or total_orders wrapper. See those sections above for the row fields.
Key order fields
Each order is the full order record, unless just_basic_order_data_results=1 removes the sections listed above. These are the fields most integrations use:
| Field | Description |
|---|---|
shop_orderid | The InfiPlex order ID. Use it as orderid in the other order endpoints. |
external_order_num | The order number on the sales channel. |
order_source | The sales channel, for example Amazon.com. |
order_date | When the customer placed the order on the sales channel. |
date_created | When the order entered InfiPlex. |
last_modified | When the order last changed in InfiPlex. |
order_status | new, needs_review, in_process, pick_up_ready, pick_up_confirmed, closed, pending, or canceled. |
is_canceled | 1 if the order is canceled. |
fully_shipped | 1 if every line is fully shipped. |
is_processed | 1 if the order is flagged processed. |
order_tag | The order's tag, or null. |
ship_\\*, bill_\\* | Shipping and billing name, company, and address fields. |
item_total, ship_total, tax_total, discount_total, order_total | Order totals, as decimal strings. |
order_currency | The order's currency code. |
order_items | The line items. Each has shop_order_itemid (the itemid used by Order Tracking Create), sku, product_name, quantity, price, quantity_shipped, and quantity_to_ship. |
tracking_numbers | The order's shipments. Each has tracking_num, carrier_name, carrier_method, and package_items. |
notes | Only with include_order_notes=1. The order's notes, or null when it has none. |
additional_info | Only with include_order_additional_info=1. An object of additional info field names and values, for example {"netsuite_class_id": "5"}. |
pick_info | Only with include_pick_info_data=1. The order's pick information. |
invoice_base_data | Only with include_invoice_base_data=1. The order's invoice data. |
drop_shipper_data | Only with include_drop_shipper_data=1. The order's drop shipper data. |
Count response
With just_count=1, the response contains a single field, total_orders: the number of orders matching the filters, returned as a string.
{
"total_orders": "37"
}
Authorization
Bearer token, sent in the Authorization header. Inherited from the collection.
Query Parameters
| Key | Value | Description |
|---|---|---|
date_created_greater_equal_than optional | Searches for orders created after the date sent. 2018-01-01 10:10:10 AM | |
date_created_less_equal_than optional | Searches for orders created before the date sent. 2018-01-01 10:10:10 AM | |
fully_shipped optional | Set to 1 for fully shipped orders only | |
is_seller_fulfilled_prime optional | Set to 1 for orders that are seller fulfilled prime | |
just_count optional | 1 | Set to 1 if you want a count of orders found |
last_modified_start_date optional | Searches for orders modified after the date sent. 2018-01-01 10:10:10 AM | |
last_modified_end_date optional | Searches for orders modified before the date sent. 2018-01-01 10:10:10 AM | |
limit optional | 2 | If this is set, then only this number of results will be returned. Default: 100. Maximum: 100 |
limit_start optional | If 100 results are returned and this is set to 25, the first 25 results will be omitted | |
maximum_order_number optional | Order ID must be less than or equal to this value. | |
minimum_order_number optional | Order ID must be greater than or equal to this value. | |
order_max_total optional | Total price for order must be less than or equal to this value | |
order_min_total optional | Total price for order must be greater than or equal to this value | |
order_source optional | If you want to filter for a specific order source, Amazon, Walmart, Target, etc..., enter it here | |
order_tag optional | The order tag you want to filter on | |
product_sku optional | Search for orders that contain a specific sku | |
sort optional | order_date DESC | Default is shop_orderid DESC |
text_search optional | ||
include_order_additional_info optional | 0 | If you want to include additional info from orders, set this to 1. |
order_status_eq optional | new | If you want to filter for a specific order status. Valid statuses are: new, needs_review, in_process, pick_up_ready, pick_up_confirmed, closed |
include_order_notes optional | 0 | If you want to include order notes from orders, set this to 1. |
is_canceled optional | 1 | Set to 1 for canceled orders only |
group_by optional | order_date | Return counts per group instead of orders: order_status, order_source, order_source_and_status, marketplace_fulfillment_error, picking_status, invoice_flag, ship_label, order_date, estimated_ship_date. Other filters still apply. Response is a plain array of {tcount, <group column>} rows. |
pre_built | top_selling_skus_by_qty_since_last_month | Run a canned 30-day report. Overrides every other parameter except order_source. See the description for the list of values and what each returns. |
Example Request
curl --location --request GET '{{api_url}}/shop/order/search?pre_built=top_selling_skus_by_qty_since_last_month' \
--header 'Authorization: Bearer {{auth_token}}'Example Responses
Orders Search
Request
curl --location --request GET 'https://example.com/api/admin/shop/order/search?order_source&just_count=0&limit=3' \
--header 'Authorization: Bearer YOUR_API_KEY'Response 200 OK
{
"orders": [
{
"shop_orderid": "101769",
"shop_order_siteareaid": "16",
"shop_order_uid": "0",
"order_key": "NWLd0q4Mahtl3SFNv3XRu1Byfxw68gKAiRQuooSMtf2FZNYwdKIv4xJ0WEHShgi42GUWjfqXPCy5DD7LFV218gmTSNPRKD2sWUArQL55s2kZYeufdQ6jp6b4X9PnCODwEuxKZZ8vqmcfcTsQPfCwii9CaipaPhGgcbDKIlLsmI",
"order_source": "Walmart",
"order_date": "2018-05-12 17:56:06",
"email": "",
"phone": "",
"ship_first_name": "Scott",
"ship_last_name": "Smith",
"ship_company": "",
"ship_street1": "1234 Another Road",
"ship_street2": "",
"ship_city": "Carol Stream",
"ship_state": "IL",
"ship_region": "",
"ship_zip": "60188",
"ship_country": "US",
"bill_first_name": "Scott",
"bill_last_name": "Smith",
"bill_company": "",
"bill_street1": "2914 Circle Road",
"bill_street2": "",
"bill_city": "Carol Stream",
"bill_state": "IL",
"bill_region": "",
"bill_zip": "60188",
"bill_country": "US",
"ship_price": "2.95",
"ship_handling": "0.00",
"ship_identifier": "",
"ship_type": "0",
"ship_label": "",
"ship_weight_total": "0.00",
"ship_speed": "1",
"item_total": "14.99",
"discount_total": "0.00",
"ship_total": "2.95",
"tax_total": "0.00",
"order_total": "17.94",
"cc_type": "",
"cc_num": null,
"cc_exp_mon": "",
"cc_exp_year": "",
"cc_last_four": "",
"is_processed": "0",
"external_order_num": "1000-048073-662360",
"external_order_source": null,
"fully_shipped": "1",
"is_amazon_payment": "0",
"is_paypal_payment": "0",
"is_canceled": "0",
"quickbooks_user_listid": null,
"is_saved_in_quickbooks": "0",
"is_queued_for_quickbooks_save": "0",
"quickbooks_invoice_listid": null,
"order_tag": null,
"in_process": "0",
"processed_by": null,
"processed_date": null,
"order_tak": null,
"order_referer": "",
"date_created": "2018-06-09 13:43:04",
"amazon_payment_order_id": null,
"po_number": null,
"session_id": null,
"user_unq_identifier": null,
"merchant_trans_id": null,
"merchant_customer_profile_id": null,
"merchant_customer_payment_profile_id": null,
"has_outstanding_pre_order_items": "0",
"pre_order_completed_date": null,
"pre_order_release_date": null,
"order_currency": "usd",
"order_currency_symbol": "$",
"last_modified": "2018-06-10 14:29:37",
"is_seller_fulfilled_prime": "0",
"gift_card_total": "0.00",
"qbo_order_needs_pulling": "1",
"qbo_sales_receipt_id": null,
"order_fully_saved": "1",
"outstanding_amazon_custom_prod": "0",
"needs_to_run_drop_shipper_processing": "1",
"is_walmart_dsv_ship_to_store": "0",
"additional_customer_order_id": null,
"payment_type": null,
"payment_note": null,
"merchant_name": null,
"is_channel_advisor_order": "0",
"channel_advisor_profile_id": null,
"external_external_order_num": null,
"external_external_order_source": null,
"estimated_ship_date": null,
"estimated_delivery_date": null,
"tracking_numbers": [
{
"shop_order_ship_trackingid": "1086",
"sost_orderid": "101769",
"tracking_num": "123456789",
"date_created": "2018-06-10 14:29:37",
"email_sent": null,
"email_sent_date": null,
"balancemaxx_tracking_sent": "0",
"balancemaxx_tracking_sent_date": null,
"label_cost": null,
"label_img": null,
"overload_ship_weight_total": null,
"length_inches": "0",
"width_inches": "0",
"height_inches": "0",
"carrier_name": "FedEx",
"carrier_method": "NextDay",
"is_amazon_fba": "0",
"is_residential": "0",
"use_negotiated": "0",
"worldship_downloaded": "0",
"standard_downloaded": "0",
"signature_type": null,
"is_delivered": "0",
"estimated_delivery": null,
"delivery_time": null,
"tracking_activity_summary": null,
"is_ups": "0",
"is_fedex": "0",
"is_stamps": "0",
"should_still_check_tracking": "1",
"last_tracking_activity_check": "2018-06-10 14:29:37",
"carrier_will_pick_up": "0",
"declared_value": null,
"external_shipment_id": null,
"is_walmart_dsv_ship_to_store": "0",
"walmart_asn": null,
"usps_zone": null,
"package_size_name": null,
"packing_slip_id": null,
"order_source": "Walmart",
"external_order_num": "1000-048073-662360",
"shop_order_siteareaid": "16",
"package_items": [
{
"shop_order_ship_tracking_itemid": "1168",
"sosti_trackingid": "1086",
"sosti_itemid": "1110",
"quantity_shipped": "1",
"product_name": "Twinings Earl Grey Tea 24 ct",
"ship_weight": "0.00",
"external_itemid": "155239",
"sku": "08756-1",
"ship_length_inches": "0.00",
"ship_width_inches": "0.00",
"ship_height_inches": "0.00",
"quantity": "1",
"item_upc": null,
"item_isbn": null,
"item_asin": null,
"item_gtin": null,
"item_ean": null,
"item_additional_id": null,
"sku_custom_data": null
}
],
"tracking_activity": null
}
],
"order_items": [
{
"shop_order_itemid": "1110",
"shop_order_item_orderid": "101769",
"shop_order_item_productid": "116",
"shop_order_item_skuid": null,
"shop_order_item_clientid": null,
"product_name": "Twinings Earl Grey Tea 24 ct",
"product_description": "",
"sku": "08756-1",
"sku_description": "",
"out_of_stock_message": null,
"price": "14.99",
"quantity": "1",
"ship_weight": "0.00",
"ship_weight_total": "0.00",
"ship_total": "2.95",
"tax_total": "0.00",
"discount_total": "0.00",
"item_total": "14.99",
"tax_name": "",
"tax_rate": "0.000",
"external_itemid": "155239",
"quickbooks_listid": null,
"is_queued_for_quickbooks_save": "0",
"ship_length_inches": "0.00",
"ship_width_inches": "0.00",
"ship_height_inches": "0.00",
"item_cost": null,
"pre_order_amount_remaining": "0.00",
"pre_order_completed_date": null,
"pre_order_release_date": null,
"amazon_custom_prod": "0",
"amazon_custom_prod_processed": "0",
"is_amazon_fba": 0,
"item_note": null,
"item_upc": null,
"item_isbn": null,
"item_asin": null,
"item_gtin": null,
"item_ean": null,
"item_additional_id": null,
"option_info": null,
"input_option_info": null,
"warehouse": [
{
"shop_order_item_warehouse": "698",
"soiw_itemid": "1110",
"warehouse_name": "Secondary Warehouse",
"warehouse_identifier": "secondary",
"quantity": "1",
"bin_location": null,
"drop_shipper_id": "1"
}
],
"quantity_shipped": "1",
"quantity_to_ship": 0,
"quantity_returned": 0,
"quantity_to_return": "1",
"customization_info": null,
"friendly_url": "",
"images": null
}
]
},
{
"shop_orderid": "101768",
"shop_order_siteareaid": "16",
"shop_order_uid": "0",
"order_key": "rNwRioCbkHsPDJ4ENCblJk2rBzl33OMMppBpr3w1ghpFByKnFaeQs13Ubm4yapA72Dc0aYKTV9eMGhthSlGlCrPINjqnqF2SLJxHouEe6fdlJKLYN9XFZsnnUMryL2Xewn4wPsLgoxsHMU8lqKbTS2NmvzxwP6TCSKVZw2FeKm",
"order_source": "Amazon",
"order_date": "2016-05-12 17:48:38",
"email": "",
"phone": "",
"ship_first_name": "Scott",
"ship_last_name": "Swoboda",
"ship_company": "",
"ship_street1": "25W560 Geneva Rd. Suite 1",
"ship_street2": "",
"ship_city": "Carol Stream",
"ship_state": "IL",
"ship_region": "",
"ship_zip": "60188",
"ship_country": "US",
"bill_first_name": "Scott",
"bill_last_name": "Smith",
"bill_company": "",
"bill_street1": "0987 Street St.",
"bill_street2": "",
"bill_city": "Chicago",
"bill_state": "IL",
"bill_region": "",
"bill_zip": "60188",
"bill_country": "US",
"ship_price": "2.95",
"ship_handling": "0.00",
"ship_identifier": "",
"ship_type": "0",
"ship_label": "",
"ship_weight_total": "0.00",
"ship_speed": "1",
"item_total": "18.99",
"discount_total": "0.00",
"ship_total": "2.95",
"tax_total": "0.00",
"order_total": "21.94",
"cc_type": "",
"cc_num": null,
"cc_exp_mon": "",
"cc_exp_year": "",
"cc_last_four": "",
"is_processed": "0",
"external_order_num": "1000-048073-254194",
"external_order_source": null,
"fully_shipped": "1",
"is_amazon_payment": "0",
"is_paypal_payment": "0",
"is_canceled": "0",
"quickbooks_user_listid": null,
"is_saved_in_quickbooks": "0",
"is_queued_for_quickbooks_save": "0",
"quickbooks_invoice_listid": null,
"order_tag": null,
"in_process": "0",
"processed_by": null,
"processed_date": null,
"order_tak": null,
"order_referer": "",
"date_created": "2018-06-09 13:43:03",
"amazon_payment_order_id": null,
"po_number": null,
"session_id": null,
"user_unq_identifier": null,
"merchant_trans_id": null,
"merchant_customer_profile_id": null,
"merchant_customer_payment_profile_id": null,
"has_outstanding_pre_order_items": "0",
"pre_order_completed_date": null,
"pre_order_release_date": null,
"order_currency": "usd",
"order_currency_symbol": "$",
"last_modified": "2018-06-10 14:25:30",
"is_seller_fulfilled_prime": "0",
"gift_card_total": "0.00",
"qbo_order_needs_pulling": "1",
"qbo_sales_receipt_id": null,
"order_fully_saved": "1",
"outstanding_amazon_custom_prod": "0",
"needs_to_run_drop_shipper_processing": "1",
"is_walmart_dsv_ship_to_store": "0",
"additional_customer_order_id": null,
"payment_type": null,
"payment_note": null,
"merchant_name": null,
"is_channel_advisor_order": "0",
"channel_advisor_profile_id": null,
"external_external_order_num": null,
"external_external_order_source": null,
"estimated_ship_date": null,
"estimated_delivery_date": null,
"tracking_numbers": [
{
"shop_order_ship_trackingid": "1085",
"sost_orderid": "101768",
"tracking_num": "0987654321",
"date_created": "2018-06-09 14:25:30",
"email_sent": null,
"email_sent_date": null,
"balancemaxx_tracking_sent": "0",
"balancemaxx_tracking_sent_date": null,
"label_cost": null,
"label_img": null,
"overload_ship_weight_total": null,
"length_inches": "0",
"width_inches": "0",
"height_inches": "0",
"carrier_name": "UPS",
"carrier_method": "Ground",
"is_amazon_fba": "0",
"is_residential": "0",
"use_negotiated": "0",
"worldship_downloaded": "0",
"standard_downloaded": "0",
"signature_type": null,
"is_delivered": "0",
"estimated_delivery": null,
"delivery_time": null,
"tracking_activity_summary": null,
"is_ups": "0",
"is_fedex": "0",
"is_stamps": "0",
"should_still_check_tracking": "1",
"last_tracking_activity_check": "2018-06-10 14:25:30",
"carrier_will_pick_up": "0",
"declared_value": null,
"external_shipment_id": null,
"is_walmart_dsv_ship_to_store": "0",
"walmart_asn": null,
"usps_zone": null,
"package_size_name": null,
"packing_slip_id": null,
"order_source": "Amazon",
"external_order_num": "1000-048073-254194",
"shop_order_siteareaid": "16",
"package_items": [
{
"shop_order_ship_tracking_itemid": "1167",
"sosti_trackingid": "1085",
"sosti_itemid": "1109",
"quantity_shipped": "1",
"product_name": "Wolfgang Puck Jamaican Me Crazy 24 ct",
"ship_weight": "0.00",
"external_itemid": "155245",
"sku": "3774000-1",
"ship_length_inches": "0.00",
"ship_width_inches": "0.00",
"ship_height_inches": "0.00",
"quantity": "1",
"item_upc": null,
"item_isbn": null,
"item_asin": null,
"item_gtin": null,
"item_ean": null,
"item_additional_id": null,
"sku_custom_data": null
}
],
"tracking_activity": null
}
],
"order_items": [
{
"shop_order_itemid": "1109",
"shop_order_item_orderid": "101768",
"shop_order_item_productid": "115",
"shop_order_item_skuid": null,
"shop_order_item_clientid": null,
"product_name": "Wolfgang Puck Jamaican Me Crazy 24 ct",
"product_description": "",
"sku": "3774000-1",
"sku_description": "",
"out_of_stock_message": null,
"price": "18.99",
"quantity": "1",
"ship_weight": "0.00",
"ship_weight_total": "0.00",
"ship_total": "2.95",
"tax_total": "0.00",
"discount_total": "0.00",
"item_total": "18.99",
"tax_name": "",
"tax_rate": "0.000",
"external_itemid": "155245",
"quickbooks_listid": null,
"is_queued_for_quickbooks_save": "0",
"ship_length_inches": "0.00",
"ship_width_inches": "0.00",
"ship_height_inches": "0.00",
"item_cost": null,
"pre_order_amount_remaining": "0.00",
"pre_order_completed_date": null,
"pre_order_release_date": null,
"amazon_custom_prod": "0",
"amazon_custom_prod_processed": "0",
"is_amazon_fba": 0,
"item_note": null,
"item_upc": null,
"item_isbn": null,
"item_asin": null,
"item_gtin": null,
"item_ean": null,
"item_additional_id": null,
"option_info": null,
"input_option_info": null,
"warehouse": [
{
"shop_order_item_warehouse": "697",
"soiw_itemid": "1109",
"warehouse_name": "Secondary Warehouse",
"warehouse_identifier": "secondary",
"quantity": "1",
"bin_location": null,
"drop_shipper_id": "1"
}
],
"quantity_shipped": "1",
"quantity_to_ship": 0,
"quantity_returned": 0,
"quantity_to_return": "1",
"customization_info": null,
"friendly_url": "",
"images": null
}
]
},
{
"shop_orderid": "101767",
"shop_order_siteareaid": "16",
"shop_order_uid": "0",
"order_key": "vc7rYwQp16AgLaKnYeR2UTISORwI8RXj8fDd54QEHEbYpC0fPIf41qPrXvCfl6wlEx4uA5rKw0wcO11oARjs62yOugtxIqJBHB5ZDck2gDvzXSw4iyW1SJrSEZD4OnFFRJUEKzMBXX8Su0lFs35Dr8yI0gHDN1K3bzEqLLNQna",
"order_source": "InfiPlex",
"order_date": "2016-08-10 00:00:00",
"email": "",
"phone": "",
"ship_first_name": "EDI",
"ship_last_name": "Help Desk",
"ship_company": "",
"ship_street1": "7000 Target Parkway, NCC-03620",
"ship_street2": "",
"ship_city": "Brooklyn Park",
"ship_state": "MN",
"ship_region": "",
"ship_zip": "55445",
"ship_country": "US",
"bill_first_name": "EDI",
"bill_last_name": "Help Desk",
"bill_company": "",
"bill_street1": "7000 Target Parkway, NCC-03620",
"bill_street2": "",
"bill_city": "Brooklyn Park",
"bill_state": "MN",
"bill_region": "",
"bill_zip": "55445",
"bill_country": "US",
"ship_price": "0.00",
"ship_handling": "0.00",
"ship_identifier": "UPS - Standard Service",
"ship_type": "0",
"ship_label": "UPS - Standard Service",
"ship_weight_total": "0.00",
"ship_speed": "1",
"item_total": "84.91",
"discount_total": "0.00",
"ship_total": "0.00",
"tax_total": "0.00",
"order_total": "84.91",
"cc_type": "",
"cc_num": null,
"cc_exp_mon": "",
"cc_exp_year": "",
"cc_last_four": "",
"is_processed": "0",
"external_order_num": "101736",
"external_order_source": "Target",
"fully_shipped": "1",
"is_amazon_payment": "0",
"is_paypal_payment": "0",
"is_canceled": "0",
"quickbooks_user_listid": null,
"is_saved_in_quickbooks": "0",
"is_queued_for_quickbooks_save": "0",
"quickbooks_invoice_listid": null,
"order_tag": null,
"in_process": "0",
"processed_by": null,
"processed_date": null,
"order_tak": null,
"order_referer": "",
"date_created": "2018-05-31 11:17:43",
"amazon_payment_order_id": null,
"po_number": null,
"session_id": null,
"user_unq_identifier": null,
"merchant_trans_id": null,
"merchant_customer_profile_id": null,
"merchant_customer_payment_profile_id": null,
"has_outstanding_pre_order_items": "0",
"pre_order_completed_date": null,
"pre_order_release_date": null,
"order_currency": "usd",
"order_currency_symbol": "$",
"last_modified": "2018-05-31 14:25:56",
"is_seller_fulfilled_prime": "0",
"gift_card_total": "0.00",
"qbo_order_needs_pulling": "1",
"qbo_sales_receipt_id": null,
"order_fully_saved": "1",
"outstanding_amazon_custom_prod": "0",
"needs_to_run_drop_shipper_processing": "1",
"is_walmart_dsv_ship_to_store": "0",
"additional_customer_order_id": null,
"payment_type": null,
"payment_note": null,
"merchant_name": null,
"is_channel_advisor_order": "0",
"channel_advisor_profile_id": null,
"external_external_order_num": "1016085998540",
"external_external_order_source": null,
"estimated_ship_date": "2016-08-12 00:00:00",
"estimated_delivery_date": "2016-08-19 00:00:00",
"tracking_numbers": [
{
"shop_order_ship_trackingid": "1081",
"sost_orderid": "101767",
"tracking_num": "33332222",
"date_created": "2018-05-31 14:25:21",
"email_sent": null,
"email_sent_date": null,
"balancemaxx_tracking_sent": "0",
"balancemaxx_tracking_sent_date": null,
"label_cost": null,
"label_img": null,
"overload_ship_weight_total": null,
"length_inches": "0",
"width_inches": "0",
"height_inches": "0",
"carrier_name": "UPS",
"carrier_method": "3rd Day",
"is_amazon_fba": "0",
"is_residential": "0",
"use_negotiated": "0",
"worldship_downloaded": "0",
"standard_downloaded": "0",
"signature_type": null,
"is_delivered": "0",
"estimated_delivery": null,
"delivery_time": null,
"tracking_activity_summary": null,
"is_ups": "0",
"is_fedex": "0",
"is_stamps": "0",
"should_still_check_tracking": "1",
"last_tracking_activity_check": "2018-05-31 14:25:21",
"carrier_will_pick_up": "0",
"declared_value": null,
"external_shipment_id": null,
"is_walmart_dsv_ship_to_store": "0",
"walmart_asn": null,
"usps_zone": null,
"package_size_name": null,
"packing_slip_id": null,
"order_source": "Target",
"external_order_num": "101736",
"shop_order_siteareaid": "16",
"package_items": [
{
"shop_order_ship_tracking_itemid": "1159",
"sosti_trackingid": "1081",
"sosti_itemid": "1107",
"quantity_shipped": "2",
"product_name": "WR CARGO SHO 38 BLK SOLID",
"ship_weight": "0.00",
"external_itemid": "1077",
"sku": "083622553529",
"ship_length_inches": "0.00",
"ship_width_inches": "0.00",
"ship_height_inches": "0.00",
"quantity": "3",
"item_upc": "083622553529",
"item_isbn": null,
"item_asin": null,
"item_gtin": "50428657",
"item_ean": null,
"item_additional_id": "042-00-0611",
"sku_custom_data": null
},
{
"shop_order_ship_tracking_itemid": "1160",
"sosti_trackingid": "1081",
"sosti_itemid": "1108",
"quantity_shipped": "3",
"product_name": "WR CARGO SHO 39 BLK SOLID",
"ship_weight": "0.00",
"external_itemid": "1078",
"sku": "083622553530",
"ship_length_inches": "0.00",
"ship_width_inches": "0.00",
"ship_height_inches": "0.00",
"quantity": "4",
"item_upc": "083622553530",
"item_isbn": null,
"item_asin": null,
"item_gtin": "50428658",
"item_ean": null,
"item_additional_id": "042-00-0611",
"sku_custom_data": null
}
],
"tracking_activity": null
},
{
"shop_order_ship_trackingid": "1082",
"sost_orderid": "101767",
"tracking_num": "11111ONLY1",
"date_created": "2018-05-31 14:25:34",
"email_sent": null,
"email_sent_date": null,
"balancemaxx_tracking_sent": "0",
"balancemaxx_tracking_sent_date": null,
"label_cost": null,
"label_img": null,
"overload_ship_weight_total": null,
"length_inches": "0",
"width_inches": "0",
"height_inches": "0",
"carrier_name": "UPS",
"carrier_method": "Ground",
"is_amazon_fba": "0",
"is_residential": "0",
"use_negotiated": "0",
"worldship_downloaded": "0",
"standard_downloaded": "0",
"signature_type": null,
"is_delivered": "0",
"estimated_delivery": null,
"delivery_time": null,
"tracking_activity_summary": null,
"is_ups": "0",
"is_fedex": "0",
"is_stamps": "0",
"should_still_check_tracking": "1",
"last_tracking_activity_check": "2018-05-31 14:25:34",
"carrier_will_pick_up": "0",
"declared_value": null,
"external_shipment_id": null,
"is_walmart_dsv_ship_to_store": "0",
"walmart_asn": null,
"usps_zone": null,
"package_size_name": null,
"packing_slip_id": null,
"order_source": "InfiPlex",
"external_order_num": "101736",
"shop_order_siteareaid": "16",
"package_items": [
{
"shop_order_ship_tracking_itemid": "1161",
"sosti_trackingid": "1082",
"sosti_itemid": "1107",
"quantity_shipped": "1",
"product_name": "WR CARGO SHO 38 BLK SOLID",
"ship_weight": "0.00",
"external_itemid": "1077",
"sku": "083622553529",
"ship_length_inches": "0.00",
"ship_width_inches": "0.00",
"ship_height_inches": "0.00",
"quantity": "3",
"item_upc": "083622553529",
"item_isbn": null,
"item_asin": null,
"item_gtin": "50428657",
"item_ean": null,
"item_additional_id": "042-00-0611",
"sku_custom_data": null
},
{
"shop_order_ship_tracking_itemid": "1162",
"sosti_trackingid": "1082",
"sosti_itemid": "1108",
"quantity_shipped": "1",
"product_name": "WR CARGO SHO 39 BLK SOLID",
"ship_weight": "0.00",
"external_itemid": "1078",
"sku": "083622553530",
"ship_length_inches": "0.00",
"ship_width_inches": "0.00",
"ship_height_inches": "0.00",
"quantity": "4",
"item_upc": "083622553530",
"item_isbn": null,
"item_asin": null,
"item_gtin": "50428658",
"item_ean": null,
"item_additional_id": "042-00-0611",
"sku_custom_data": null
}
],
"tracking_activity": null
}
],
"order_items": [
{
"shop_order_itemid": "1107",
"shop_order_item_orderid": "101767",
"shop_order_item_productid": "109",
"shop_order_item_skuid": null,
"shop_order_item_clientid": null,
"product_name": "WR CARGO SHO 38 BLK SOLID",
"product_description": "",
"sku": "083622553529",
"sku_description": "",
"out_of_stock_message": null,
"price": "12.13",
"quantity": "3",
"ship_weight": "0.00",
"ship_weight_total": "0.00",
"ship_total": "0.00",
"tax_total": "0.00",
"discount_total": "0.00",
"item_total": "36.39",
"tax_name": "",
"tax_rate": "0.000",
"external_itemid": "1077",
"quickbooks_listid": null,
"is_queued_for_quickbooks_save": "0",
"ship_length_inches": "0.00",
"ship_width_inches": "0.00",
"ship_height_inches": "0.00",
"item_cost": "0.00",
"pre_order_amount_remaining": "0.00",
"pre_order_completed_date": null,
"pre_order_release_date": null,
"amazon_custom_prod": "0",
"amazon_custom_prod_processed": "0",
"is_amazon_fba": 0,
"item_note": null,
"item_upc": "083622553529",
"item_isbn": null,
"item_asin": null,
"item_gtin": "50428657",
"item_ean": null,
"item_additional_id": "042-00-0611",
"option_info": null,
"input_option_info": null,
"warehouse": [
{
"shop_order_item_warehouse": "695",
"soiw_itemid": "1107",
"warehouse_name": "Main Warehouse",
"warehouse_identifier": "main",
"quantity": "3",
"bin_location": null,
"drop_shipper_id": "2"
}
],
"quantity_shipped": "3",
"quantity_to_ship": 0,
"quantity_returned": 0,
"quantity_to_return": "3",
"customization_info": null,
"friendly_url": "",
"images": null
},
{
"shop_order_itemid": "1108",
"shop_order_item_orderid": "101767",
"shop_order_item_productid": "110",
"shop_order_item_skuid": null,
"shop_order_item_clientid": null,
"product_name": "WR CARGO SHO 39 BLK SOLID",
"product_description": "",
"sku": "083622553530",
"sku_description": "",
"out_of_stock_message": null,
"price": "12.13",
"quantity": "4",
"ship_weight": "0.00",
"ship_weight_total": "0.00",
"ship_total": "0.00",
"tax_total": "0.00",
"discount_total": "0.00",
"item_total": "48.52",
"tax_name": "",
"tax_rate": "0.000",
"external_itemid": "1078",
"quickbooks_listid": null,
"is_queued_for_quickbooks_save": "0",
"ship_length_inches": "0.00",
"ship_width_inches": "0.00",
"ship_height_inches": "0.00",
"item_cost": "0.00",
"pre_order_amount_remaining": "0.00",
"pre_order_completed_date": null,
"pre_order_release_date": null,
"amazon_custom_prod": "0",
"amazon_custom_prod_processed": "0",
"is_amazon_fba": 0,
"item_note": null,
"item_upc": "083622553530",
"item_isbn": null,
"item_asin": null,
"item_gtin": "50428658",
"item_ean": null,
"item_additional_id": "042-00-0611",
"option_info": null,
"input_option_info": null,
"warehouse": [
{
"shop_order_item_warehouse": "696",
"soiw_itemid": "1108",
"warehouse_name": "Main Warehouse",
"warehouse_identifier": "main",
"quantity": "4",
"bin_location": null,
"drop_shipper_id": "2"
}
],
"quantity_shipped": "4",
"quantity_to_ship": 0,
"quantity_returned": 0,
"quantity_to_return": "4",
"customization_info": null,
"friendly_url": "",
"images": null
}
]
}
],
"total_orders": "33"
}Grouped: orders by order_status
Request
curl --location --request GET 'https://example.com/api/admin/shop/order/search?group_by=order_status' \
--header 'Authorization: Bearer YOUR_API_KEY'Response 200 OK
[
{
"tcount": "2",
"order_status": "canceled"
},
{
"tcount": "5",
"order_status": "closed"
},
{
"tcount": "2",
"order_status": "pick_up_ready"
},
{
"tcount": "35",
"order_status": "new"
},
{
"tcount": "1",
"order_status": "in_process"
},
{
"tcount": "17",
"order_status": null
}
]Pre-built: top selling SKUs by qty
Request
curl --location --request GET 'https://example.com/api/admin/shop/order/search?pre_built=top_selling_skus_by_qty_since_last_month' \
--header 'Authorization: Bearer YOUR_API_KEY'Response 200 OK
[
{
"sku": "MH-16-TTC",
"qty_sold": "852"
},
{
"sku": "MH-32-TTC",
"qty_sold": "200"
},
{
"sku": "8100327396",
"qty_sold": "156"
},
{
"sku": "REM-60V-GFA-O",
"qty_sold": "148"
},
{
"sku": "8100327394",
"qty_sold": "144"
},
{
"sku": "MH-360A-TTC",
"qty_sold": "141"
},
{
"sku": "MH-80V-LPC-A",
"qty_sold": "140"
},
{
"sku": "8100327397",
"qty_sold": "96"
},
{
"sku": "AFTPPENV",
"qty_sold": "50"
},
{
"sku": "8100327398",
"qty_sold": "48"
}
]Grouped: orders by ship_label
Request
curl --location --request GET 'https://example.com/api/admin/shop/order/search?group_by=ship_label&date_created_greater_equal_than=2026-09-01 12:00:00 AM' \
--header 'Authorization: Bearer YOUR_API_KEY'Response 200 OK
[
{
"tcount": "1",
"ship_label": "CALL1112223333#"
},
{
"tcount": "2",
"ship_label": "Pre-Pay & Add to Invoice"
},
{
"tcount": "2",
"ship_label": "USE VRS/ShipIQ"
},
{
"tcount": "2",
"ship_label": "FedEx priority overnight air"
},
{
"tcount": "1",
"ship_label": "UPS Ground"
},
{
"tcount": "1",
"ship_label": "FOB"
}
]