OrdersWork orders
Get Many Work Orders
Get multiple work orders with filtering, searching, and pagination
Authorization
api_key x-access-token<token>
In: header
Query Parameters
page?number
Page number for pagination
Format
doubleDefault
0limit?number
Number of items per page
Format
doubleDefault
20search?string
Search term to filter work orders by name
Default
""order_by?string
Field to order results by
Default
"created_at"Value in
- "created_at"
- "scheduled_by"
- "requested_by"
- "completed_at"
- "updated_at"
- "priority"
order?string
Sort order - "asc" or "desc"
Value in
- "asc"
- "desc"
type?string
Filter by work order type (ASSEMBLY, CUSTOM)
Default
""status?string
Filter by work order status
Default
""priority?string
Filter by priority
Default
""merchant_team_id?string
Filter by merchant team ID
Default
""warehouse_id?string
Filter by warehouse ID
Default
""scheduled_by_start?string
Filter by scheduled date (start)
Default
""scheduled_by_end?string
Filter by scheduled date (end)
Default
""completed_at_start?string
Filter by completion date (start)
Default
""Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/shipos/work-orders"{ "data": [ { "description": "string", "pick_list_urls": [ "string" ], "work_order_number": "string", "receiving_location_name": "string", "receiving_location_id": "string", "staging_location_name": "string", "staging_location_id": "string", "warehouse_name": "string", "fulfiller_team_name": "string", "merchant_team_name": "string", "fulfiller_team_id": "string", "vendor_name": "string", "vendor_id": "string", "merchant_team_id": "string", "warehouse_id": "string", "requested_by_user_name": "string", "requested_by_user_id": "string", "assembly_product_image_url": "string", "assembly_product_name": "string", "assembly_product_sku": "string", "assembly_product_id": "string", "assembled_quantity": 0.1, "quantity_to_assemble": 0.1, "assembly_details": "string", "packing_details": "string", "config": { "require_pack_shot": true, "show_unfulfilled_items_on_packing_list": true, "show_prices_on_packing_slip": true, "tote_qa_enabled": true, "incoterm": "FAS", "incoterm_location": "string", "eel_pfc": "string", "delivery_confirmation": "NO_SIGNATURE", "saturday_delivery": true, "insurance_policy": { "mode": "none" }, "customs_signer": "string", "customs_signer_title": "string", "customs_certify": true, "non_delivery_option": "ABANDON", "restriction_type": "NONE", "restriction_comments": "string", "contents_type": "OTHER", "contents_explanation": "string", "commercial_invoice_transaction_reason": "SALE", "declaration": "string", "commercial_invoice_payment_terms": "string", "commercial_invoice_transport_mode": "string", "commercial_invoice_port_of_entry": "string", "commercial_invoice_country_of_transshipment": "string", "commercial_invoice_package_marks": "string", "commercial_invoice_freight_amount": 0, "commercial_invoice_discount_amount": 0, "commercial_invoice_other_charge_amount": 0, "commercial_invoice_other_charge_description": "string", "commercial_invoice_importer_tax_id": "string", "commercial_invoice_importer_vat": "string", "commercial_invoice_importer_eori": "string", "commercial_invoice_importer_ioss": "string", "commercial_invoice_vat_statement": "string", "commercial_invoice_export_license_number": "string", "destination_control_statement_required": true }, "currency": "string", "priority": 0.1, "status": "AWAITING_APPROVAL", "type": "ASSEMBLY", "name": "string", "packed_by_user_name": "string", "packed_by_user_id": "string", "packing_completed_at": "2019-08-24T14:15:22Z", "packing_started_at": "2019-08-24T14:15:22Z", "packing_revision": 0.1, "completed_at": "2019-08-24T14:15:22Z", "assembled_at": "2019-08-24T14:15:22Z", "picked_at": "2019-08-24T14:15:22Z", "requested_by": "2019-08-24T14:15:22Z", "scheduled_by": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "id": "string" } ], "meta": { "page": 0.1, "page_size": 0.1, "has_next_page": true, "has_previous_page": true, "start_index": 0.1, "end_index": 0.1 }}