List All Orders
GET /orders
Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ”Restrict results to after specified ID
Example
12345Show entities created after date (format: YYYY-MM-DD HH:MM:SS)
Example
2016-03-01 11:10:01Show entities updated after date (format: YYYY-MM-DD HH:MM:SS)
Example
2016-03-01 11:10:01Only show orders from the given channel ID(s). Accepts a single ID or an array. For multiple IDs, use bracket array form, for example channel_ids[]=12345&channel_ids[]=67890.
Example
12345Only show orders created on or after this date.
Example
2026-01-01Only show orders created on or before this date (the whole day is included). Combine with created[after] to bound a date range server-side instead of scanning from created_at_min onwards.
Example
2026-01-31Only show orders due on or after this date.
Example
2026-01-01Only show orders due on or before this date (the whole day is included).
Example
2026-01-31Orders per page. Default 10, maximum 100; larger values are capped to 100.
Example
25Page to show
Example
1Free text search
Order Status
Example
awaiting_fulfillmentRestrict results to orders with a tag of the name provided
Example
Give+your+tag+a+nameRestrict results to orders allocated at a specific warehouse
Example
3Header Parameters
Section titled “Header Parameters ”E.g. 123
Example
123Responses
Section titled “ Responses ”OK
object
object
object
object
object
object
object
object
object
object
object
Whether Veeqo pushes fulfilment and tracking back to this sales channel after a label is purchased. A shipment-level update_remote_order overrides it when set.
object
object
object
object
object
object
Total weight of the allocation’s items, in its weight_unit.
object
object
object
object
object
object
object
The sellable’s dimensions, in dimensions_unit. 0 means not set.
object
object
Package dimensions and weight for this allocation, in its weight_unit and dimensions_unit. null until a package exists; a null or 0 dimension means not set.
object
Package width
Package height
Package depth
Package weight
Unit of weight (e.g. “oz”, “g”)
Unit of dimensions (e.g. “inches”, “cm”)
Package selection source (“ONE_OFF” applied to this allocation only or estimated from its products, “SUGGESTION” from a package saved for similar shipments, “RULES” set by a shipping rule)
Applied package id (e.g. “4821”, “fedex/envelope”); null when the package has dimensions only
Applied package name; null when the package has dimensions only
Applied package provider (“CUSTOM” for a saved package, “CARRIER” for a carrier package); null when the package has dimensions only
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
Example
[ { "id": 13359622, "cancel_reason": null, "refund_amount": null, "send_refund_email": null, "cancelled_at": null, "created_at": "2018-01-19T18:11:06.820Z", "customer_viewable_notes": null, "delivery_cost": 2, "due_date": "2018-01-31T00:00:00.000Z", "dispatch_date": null, "international": false, "notes": null, "number": "rdr1234", "receipt_printed": false, "send_notification_email": true, "shipped_at": null, "status": "awaiting_stock", "subtotal_price": 175.5, "total_discounts": 49.5, "total_price": 213.04, "total_tax": 35.54, "total_fees": 0, "buyer_user_id": null, "updated_at": "2018-01-19T18:11:07.098Z", "payment": { "id": 13177340, "order_id": 13359622, "payment_type": "paypal", "reference_number": "PPP1234", "created_at": "2018-01-19T18:11:06.831Z", "updated_at": "2018-01-19T18:11:06.869Z", "card_number": null, "created_by_id": 23005 }, "till_id": null, "fulfilled_by_amazon": false, "is_amazon_prime": false, "is_amazon_premium_order": false, "additional_order_level_taxless_discount": 19.5, "restock_shipped_items": false, "adjustment_amount": 0, "tags": [], "cancelled_by": null, "created_by": { "id": 12345, "login": "Phil Reynolds", "email": "phil+api@veeqo.com", "location": null, "guide_completed_message_viewed": null, "orders_walkthrough_viewed": false, "default_warehouse_id": null, "created_at": "2017-07-04T09:40:37.515Z", "updated_at": "2017-12-20T11:56:02.938Z", "company": { "id": 12345, "name": "Phil", "created_at": "2017-07-04T09:40:37.495Z", "updated_at": "2017-12-22T12:59:57.854Z", "referring_website": null, "card_valid": false, "stripe_customer_id": null, "has_right_to_use_veeqo": true, "subscription_status": "trialing", "billing_period_started": null, "subscription_plan_id": 62, "chargify_product_handle": "trial", "chargify_current_plan": { "name": "Unlimited", "planId": "unlimited-monthly-veeqo", "chargeType": "monthly", "pricing": "£9999", "setup_fee": null, "product_handle": "monthly-unlimited-9999", "product_url": null, "features": { "users": "Unlimited", "products": "Unlimited", "orders": "Unlimited", "stores": "Unlimited", "support": "Unlimited", "product_pusher": true, "stock_take": true }, "available": false }, "setting": { "currency_code": "GBP", "phone_number": 7812345678 }, "subscription_plan": { "id": 62, "name": "Business[Monthly]", "stripe_plan_id": "BUSINESS_MONTHLY_99999", "billing_interval": "month" } } }, "updated_by": null, "delivery_method": { "id": 171784, "name": "Delivery Method #2", "cost": 2 }, "deliver_to": { "id": 26463776, "first_name": "Samwise", "last_name": "Gamgee", "email": "Gamgee@fellowship.net", "company": "The Fellowship", "address1": "Bag End", "address2": "Hobbiton", "city": "Shire", "country": "GB", "state": "Middle Earth", "zip": "SH1 1BG", "phone": 7891234567 }, "channel": { "id": 12345, "type_code": "direct", "created_by_id": 12345, "name": "Phone", "currency_code": "GBP", "state": "active", "url": null, "shopify_url": null, "ebay_url": null, "ebay_site_code_id": 3, "country": null, "region": "", "city": "", "address_line_1": "", "address_line_2": "", "post_code": "", "pulled_products_at": null, "pulled_orders_at": null, "pending_setup": true, "seller_id": null, "marketplace_id": null, "mws_auth_token": null, "deleted_at": null, "deleted_by_id": null, "api2cart_store_key": null, "bridge_url": null, "bridge_verified": null, "pull_pending_orders": false, "default_send_shipment_email": true, "automatic_product_linking_disabled": false, "update_remote_order": true, "successfully_fetched_stock_levels_at": null, "create_product_if_unmatched": true, "skip_title_matching": true, "email": "phil+api@veeqo.com", "skip_fba_orders_and_products": true, "pull_stock_level_required": true, "pull_product_properties": true, "pull_historical_orders": false, "adjust_orders_tax_rate": null, "send_notification_emails_to_customers": false, "end_ebay_listing_on_out_of_stock": false, "update_product_attributes": true, "max_qty_to_advert": 0, "min_threshold_qty": 0, "percent_of_qty": 100, "always_set_qty": 0, "veeqo_dictates_stock_level": true, "with_fba": false, "first_sync_finish_notice_marked_as_read": false, "pull_unpaid_shopify_orders": false, "create_product_on_ended_listings": true, "link_to_products_linked_to_current_channel": true, "weight_unit": null, "import_cost_price": true, "veeqo_dictates_price": false, "keep_inventory_tracking_value": false, "marketplace_country": null, "time_zone": null, "time_zone_offset": null, "amazon_fulfillment_enabled": false, "import_product_tags": true, "import_product_brands": true, "channel_warehouses": [], "warehouses": [], "stock_level_update_requests": [], "amazon_fulfillment_setting": null, "amazon_channel_specific": null, "api2cart_channel_specific": null, "additional_api2cart_site": null, "time_since_product_sync": null, "time_since_order_sync": null, "time_since_tried_fetch_stock_level": null, "time_since_successfully_fetch_stock_level": null, "default_warehouse": { "id": 12345, "name": "My Warehouse", "user_id": null, "address_line_1": "", "address_line_2": "", "city": "", "region": "", "country": null, "post_code": "", "inventory_type_code": "wavg", "default_min_reorder": 0, "click_and_collect_enabled": false, "click_and_collect_days": null, "created_by_id": 12345, "updated_by_id": null, "deleted_at": null, "deleted_by_id": null, "created_at": "2017-07-04T09:40:37.539Z", "updated_at": "2017-07-04T09:40:37.539Z", "phone": null, "requested_carrier_account": null, "display_position": 9999 }, "remote": false }, "customer": { "id": 12137221, "email": "baggins@ringbearers.org", "phone": 7891234567, "mobile": 7891234567, "created_by_id": 12345, "billing_address": { "id": 26463775, "first_name": "Frodo", "last_name": "Baggins", "address1": "The New Bag End", "address2": "1st Avenue", "city": "Valinor", "company": "The Ring Bearers", "country": "GB", "state": "The Undying Lands", "zip": "VA1 1NB", "phone": 7891234567, "email": "baggins@ringbearers.org" }, "shipping_addresses": [ { "id": 26463776, "first_name": "Samwise", "last_name": "Gamgee", "email": "Gamgee@fellowship.net", "company": "The Fellowship", "address1": "Bag End", "address2": "Hobbiton", "city": "Shire", "country": "GB", "state": "Middle Earth", "zip": "SH1 1BG", "phone": 7891234567 } ] }, "customer_note": { "id": 1013050, "text": "Please tell Sam to look after this puppy. --This is a customer note--", "order_id": 13359622 }, "allocations": [ { "id": 10214654, "updated_at": "2018-01-19T18:11:07.095Z", "created_at": "2018-01-19T18:11:06.886Z", "total_weight": 0, "weight_unit": "g", "allocated_by_id": 12345, "order_id": 13359622, "packed_completely": null, "line_items": [ { "id": 13715700, "quantity": 1, "picked_quantity": 0, "created_at": "2018-01-19T18:11:06.891Z", "updated_at": "2018-01-19T18:11:06.891Z", "sellable": { "total_quantity_sold": 8, "allocated_stock_level_at_all_warehouses": 8, "id": 13847534, "type": "ProductVariant", "title": "Black", "sku_code": "M2IEG-B", "upc_code": "4044155094916", "model_number": "", "price": 75, "cost_price": 40, "min_reorder_level": 0, "quantity_to_reorder": 0, "created_by_id": 12345, "created_at": "2017-09-29T09:45:01.265Z", "updated_at": "2018-01-19T18:11:07.111Z", "weight_grams": 0, "weight_unit": "g", "product_title": "Sennheiser Momentum In-Ear", "full_title": "Sennheiser Momentum In-Ear Black", "sellable_title": "Black", "profit": 35, "margin": 46.67, "tax_rate": 20, "product": { "id": 5793641, "title": "Sennheiser Momentum In-Ear", "weight": 0, "origin_country": "", "hs_tariff_number": null, "tax_rate": 0, "main_image": { "id": 10319279, "binary_data": null, "content_type": null, "display_position": null, "created_by_id": null, "updated_by_id": null, "deleted_at": null, "deleted_by_id": null, "created_at": "2017-08-21T11:50:24.545Z", "updated_at": "2017-08-21T11:50:27.358Z", "src": null, "product_id": 5793641, "picture_file_name": "senn.jpg", "picture_content_type": "image/jpeg", "picture_file_size": 165161, "picture_updated_at": "2017-08-21T11:50:24.450Z", "picture_order": 0 }, "estimated_delivery": null, "deleted_at": null, "deleted_by_id": null, "description": "Quintessential. Forward Thinking. Custom machined stainless steel sound tunnels for acoustic precision.", "main_image_src": "https://thumbnails.veeqo.com/example-image" }, "stock_entries": [ { "sellable_id": 13847534, "warehouse_id": 12345, "infinite": false, "allocated_stock_level": 8, "warehouse": { "id": 12345, "name": "My Warehouse", "user_id": null, "address_line_1": "", "address_line_2": "", "city": "", "region": "", "country": null, "post_code": "", "inventory_type_code": "wavg", "default_min_reorder": 0, "click_and_collect_enabled": false, "click_and_collect_days": null, "created_by_id": 12345, "updated_by_id": null, "deleted_at": null, "deleted_by_id": null, "created_at": "2017-07-04T09:40:37.539Z", "updated_at": "2017-07-04T09:40:37.539Z", "phone": null, "requested_carrier_account": null, "display_position": 9999 }, "location": "flow", "stock_running_low": false, "updated_at": "2018-01-19T18:11:06.897Z", "incoming_stock_level": 0, "physical_stock_level": 21, "available_stock_level": 13, "sellable_on_hand_value": 840 } ], "variant_option_specifics": [ { "id": 6083049, "product_specific_id": 2622355, "product_property_id": 58230, "product_property_name": "Colour", "value": "Black" } ], "variant_property_specifics": [], "measurement_attributes": { "id": 12268074, "width": 0, "height": 0, "depth": 0, "dimensions_unit": "cm" }, "images": [], "active_channels": [], "channel_sellables": [], "available_stock_level_at_all_warehouses": 13, "stock_level_at_all_warehouses": 21, "on_hand_value": 840, "inventory": { "infinite": false, "physical_stock_level_at_all_warehouses": 21, "allocated_stock_level_at_all_warehouses": 8, "available_stock_level_at_all_warehouses": 13, "incoming_stock_level_at_all_warehouses": 0 }, "weight": 0 } } ], "recommended_shipping_options": null, "matched_parcel_properties_criteria": null, "shipment": null, "warehouse": { "address_line_1": "", "address_line_2": "", "city": "", "click_and_collect_days": null, "click_and_collect_enabled": false, "country": null, "created_at": "2017-07-04T09:40:37.539Z", "created_by_id": 12345, "default_min_reorder": 0, "deleted_at": null, "deleted_by_id": null, "id": 12345, "inventory_type_code": "wavg", "name": "My Warehouse", "phone": null, "post_code": "", "region": "", "display_position": 9999, "updated_at": "2017-07-04T09:40:37.539Z", "updated_by_id": null, "requested_carrier_account": null } } ], "employee_notes": [ { "id": 887051, "text": "Package contains a dog. Use suitable box. --This is an internal note--", "order_id": 13359622, "created_at": "2018-01-19T18:11:06.850Z", "created_by": { "id": 12345, "login": "Phil Reynolds", "email": "phil+apitest@veeqo.com", "location": null, "guide_completed_message_viewed": null, "orders_walkthrough_viewed": false, "default_warehouse_id": null, "created_at": "2017-07-04T09:40:37.515Z", "updated_at": "2017-12-20T11:56:02.938Z", "company": { "id": 12345, "name": "Phil", "created_at": "2017-07-04T09:40:37.495Z", "updated_at": "2017-12-22T12:59:57.854Z", "referring_website": null, "card_valid": false, "stripe_customer_id": null, "has_right_to_use_veeqo": true, "subscription_status": "trialing", "billing_period_started": null, "subscription_plan_id": 62, "chargify_product_handle": "trial", "chargify_current_plan": { "name": "Unlimited", "planId": "unlimited-monthly-veeqo", "chargeType": "monthly", "pricing": "£9999", "setup_fee": null, "product_handle": "monthly-unlimited-9999", "product_url": null, "features": { "users": "Unlimited", "products": "Unlimited", "orders": "Unlimited", "stores": "Unlimited", "support": "Unlimited", "product_pusher": true, "stock_take": true }, "available": false }, "setting": { "currency_code": "GBP", "phone_number": 7812345678 }, "subscription_plan": { "id": 62, "name": "Business[Monthly]", "stripe_plan_id": "BUSINESS_MONTHLY_12345", "billing_interval": "month" } } } } ], "line_items": [ { "id": 17976358, "price_per_unit": 150, "quantity": 1, "tax_rate": 0.2, "taxless_discount_per_unit": 30, "additional_options": null, "created_at": "2018-01-19T18:11:06.829Z", "updated_at": "2018-01-19T18:11:06.829Z", "remote_id": "184390284", "sellable": { "total_quantity_sold": 14, "allocated_stock_level_at_all_warehouses": 13, "id": 14358568, "type": "ProductVariant", "title": "Puppy - ProdVariantTitle", "sku_code": "g-dog-2", "upc_code": "", "model_number": "", "price": 150, "cost_price": 100, "min_reorder_level": 0, "quantity_to_reorder": 0, "created_by_id": 12345, "created_at": "2017-10-16T15:26:15.810Z", "updated_at": "2018-01-19T18:08:36.295Z", "weight_grams": 0, "weight_unit": "g", "product_title": "Golden Retriever Dog - Title", "full_title": "Golden Retriever Dog - Title Puppy - ProdVariantTitle", "sellable_title": "Puppy - ProdVariantTitle", "profit": 50, "margin": 33.33, "tax_rate": 0, "product": { "id": 8851441, "title": "Golden Retriever Dog - Title", "weight": 0, "origin_country": null, "hs_tariff_number": null, "tax_rate": 0, "main_image": null, "estimated_delivery": null, "deleted_at": null, "deleted_by_id": null, "description": "Golden Retriever Dog - Description", "main_image_src": null }, "stock_entries": [ { "sellable_id": 14358568, "warehouse_id": 12345, "infinite": false, "allocated_stock_level": 13, "warehouse": { "id": 12345, "name": "My Warehouse", "user_id": null, "address_line_1": "", "address_line_2": "", "city": "", "region": "", "country": null, "post_code": "", "inventory_type_code": "wavg", "default_min_reorder": 0, "click_and_collect_enabled": false, "click_and_collect_days": null, "created_by_id": 12345, "updated_by_id": null, "deleted_at": null, "deleted_by_id": null, "created_at": "2017-07-04T09:40:37.539Z", "updated_at": "2017-07-04T09:40:37.539Z", "phone": null, "requested_carrier_account": null, "display_position": 9999 }, "location": "Kennels", "stock_running_low": false, "updated_at": "2018-01-19T18:08:36.077Z", "incoming_stock_level": 0, "physical_stock_level": 9, "available_stock_level": -4, "sellable_on_hand_value": 900 }, { "id": 18867592, "sellable_id": 14358568, "warehouse_id": 12345, "infinite": false, "allocated_stock_level": 0, "warehouse": { "id": 12345, "name": "Warehouse #2", "user_id": null, "address_line_1": "", "address_line_2": "", "city": "", "region": "", "country": "GB", "post_code": "", "inventory_type_code": "wavg", "default_min_reorder": 0, "click_and_collect_enabled": false, "click_and_collect_days": "", "created_by_id": 12345, "updated_by_id": null, "deleted_at": null, "deleted_by_id": null, "created_at": "2018-01-18T12:22:50.522Z", "updated_at": "2018-01-18T12:22:50.522Z", "phone": "1234567890", "requested_carrier_account": null, "display_position": 9999 }, "location": null, "stock_running_low": false, "updated_at": "2018-01-19T18:08:06.694Z", "incoming_stock_level": 0, "physical_stock_level": 100, "available_stock_level": 100, "sellable_on_hand_value": 10000 } ], "variant_option_specifics": [], "variant_property_specifics": [], "measurement_attributes": { "id": 12810244, "width": 0, "height": 0, "depth": 0, "dimensions_unit": "cm" }, "images": [], "active_channels": [], "channel_sellables": [], "available_stock_level_at_all_warehouses": 96, "stock_level_at_all_warehouses": 109, "on_hand_value": 10900, "inventory": { "infinite": false, "physical_stock_level_at_all_warehouses": 109, "allocated_stock_level_at_all_warehouses": 13, "available_stock_level_at_all_warehouses": 96, "incoming_stock_level_at_all_warehouses": 0 }, "weight": 0 } }, { "id": 17976357, "price_per_unit": 75, "quantity": 1, "tax_rate": 0.2, "taxless_discount_per_unit": 0, "additional_options": null, "created_at": "2018-01-19T18:11:06.826Z", "updated_at": "2018-01-19T18:11:06.826Z", "sellable": { "total_quantity_sold": 8, "allocated_stock_level_at_all_warehouses": 8, "id": 13847534, "type": "ProductVariant", "title": "Black", "sku_code": "M2IEG-B", "upc_code": "4044155094916", "model_number": "", "price": 75, "cost_price": 40, "min_reorder_level": 0, "quantity_to_reorder": 0, "created_by_id": 12345, "created_at": "2017-09-29T09:45:01.265Z", "updated_at": "2018-01-19T18:11:07.111Z", "weight_grams": 0, "weight_unit": "g", "product_title": "Sennheiser Momentum In-Ear", "full_title": "Sennheiser Momentum In-Ear Black", "sellable_title": "Black", "profit": 35, "margin": 46.67, "tax_rate": 20, "product": { "id": 5793641, "title": "Sennheiser Momentum In-Ear", "weight": 0, "origin_country": "", "hs_tariff_number": null, "tax_rate": 0, "main_image": { "id": 10319279, "binary_data": null, "content_type": null, "display_position": null, "created_by_id": null, "updated_by_id": null, "deleted_at": null, "deleted_by_id": null, "created_at": "2017-08-21T11:50:24.545Z", "updated_at": "2017-08-21T11:50:27.358Z", "src": null, "product_id": 5793641, "picture_file_name": "senn.jpg", "picture_content_type": "image/jpeg", "picture_file_size": 165161, "picture_updated_at": "2017-08-21T11:50:24.450Z", "picture_order": 0 }, "estimated_delivery": null, "deleted_at": null, "deleted_by_id": null, "description": "Quintessential. Forward Thinking. Custom machined stainless steel sound tunnels for acoustic precision.", "main_image_src": "https://thumbnails.veeqo.com/example-image" }, "stock_entries": [ { "sellable_id": 13847534, "warehouse_id": 12345, "infinite": false, "allocated_stock_level": 8, "warehouse": { "id": 12345, "name": "My Warehouse", "user_id": null, "address_line_1": "", "address_line_2": "", "city": "", "region": "", "country": null, "post_code": "", "inventory_type_code": "wavg", "default_min_reorder": 0, "click_and_collect_enabled": false, "click_and_collect_days": null, "created_by_id": 12345, "updated_by_id": null, "deleted_at": null, "deleted_by_id": null, "created_at": "2017-07-04T09:40:37.539Z", "updated_at": "2017-07-04T09:40:37.539Z", "phone": null, "requested_carrier_account": null, "display_position": 9999 }, "location": "flow", "stock_running_low": false, "updated_at": "2018-01-19T18:11:06.897Z", "incoming_stock_level": 0, "physical_stock_level": 21, "available_stock_level": 13, "sellable_on_hand_value": 840 } ], "variant_option_specifics": [ { "id": 6083049, "product_specific_id": 2622355, "product_property_id": 58230, "product_property_name": "Colour", "value": "Black" } ], "variant_property_specifics": [], "measurement_attributes": { "id": 12268074, "width": 0, "height": 0, "depth": 0, "dimensions_unit": "cm" }, "images": [], "active_channels": [], "channel_sellables": [], "available_stock_level_at_all_warehouses": 13, "stock_level_at_all_warehouses": 21, "on_hand_value": 840, "inventory": { "infinite": false, "physical_stock_level_at_all_warehouses": 21, "allocated_stock_level_at_all_warehouses": 8, "available_stock_level_at_all_warehouses": 13, "incoming_stock_level_at_all_warehouses": 0 }, "weight": 0 } } ], "returns": [], "allocated_completely": false, "picked_completely": false, "fulfillment_channel_order": null }]