> For the complete documentation index, see [llms.txt](https://docs.xorosoft.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xorosoft.com/developers-api/fulfillment-and-wave-management/list-waves.md).
# List Waves
Retrieves List of waves from the database. The data returned from this API will be paged\
Paging supported.
```json
{"openapi":"3.0.3","info":{"title":"Xorosoft ERP Public API","version":"2026.07"},"tags":[{"name":"Fulfillment and Wave Management","description":"Use Fulfillment and Wave Management APIs to retrieve waves, create waves, fulfill waves, ship waves, confirm shipments, manage carriers and shipping terms, and support warehouse execution workflows. These APIs are designed for WMS, shipping, 3PL, and fulfillment integrations that need to move orders from allocation through picking, packing, shipping, and confirmation."}],"servers":[{"url":"https://res.xorosoft.io","description":"Xorosoft ERP API server"}],"security":[{"basic":[]}],"components":{"securitySchemes":{"basic":{"scheme":"basic","type":"http"}}},"paths":{"/api/xerp/wave/getwave":{"get":{"parameters":[{"description":"A comma-separated list of wave ids.","in":"query","name":"id","required":false,"schema":{"type":"number"}},{"description":"A comma-separated list of wave numbers.","in":"query","name":"wave_number","required":false,"schema":{"type":"string"}},{"description":"Restrict results to after the specified ID.","in":"query","name":"since_id","required":false,"schema":{"type":"string"}},{"description":"A comma-separated list of Sale Store(s).","in":"query","name":"store","required":false,"schema":{"type":"string"}},{"description":"Show waves that can only be processed. By default this is true.","in":"query","name":"show_open_only","required":false,"schema":{"type":"string"}},{"description":"Show waves according to flag value. By default this is false (showing unlocked waves).","in":"query","name":"lock_flag","required":false,"schema":{"type":"string"}},{"description":"Show waves created at or after date (format: 2014-04-25T16:15:47-04:00).","in":"query","name":"created_at_min","required":false,"schema":{"type":"string"}},{"description":"Show orders created at or before date (format: 2014-04-25T16:15:47-04:00).","in":"query","name":"created_at_max","required":false,"schema":{"type":"string"}},{"description":"A comma-separated list of statuses.","in":"query","name":"status","required":false,"schema":{"type":"string"}},{"description":"A comma-separated list of customers.","in":"query","name":"customer","required":false,"schema":{"type":"string"}},{"description":"A comma-separated list of sales order numbers.","in":"query","name":"order_number","required":false,"schema":{"type":"string"}},{"description":"Restrict results to upto the specified ID.","in":"query","name":"max_id","required":false,"schema":{"type":"number"}},{"description":"page number of the query result set to return. Default = 1.","in":"query","name":"page","required":true,"schema":{"type":"number"}},{"name":"updated_at_min","in":"query","required":false,"description":"Filter records updated on or after this date.","schema":{"type":"string"}},{"name":"updated_at_max","in":"query","required":false,"description":"Filter records updated on or before this date.","schema":{"type":"string"}},{"name":"enable_paging","in":"query","required":false,"description":"When true, returns paginated results using page and page size parameters.","schema":{"type":"string","default":"false"}},{"name":"exclude_processed","in":"query","required":false,"description":"When true, excludes records already marked as processed.","schema":{"type":"boolean","default":false}},{"name":"ref_no","in":"query","required":false,"description":"Reference number used to find matching documents or transactions.","schema":{"type":"string"}},{"name":"thirdpartyref_no","in":"query","required":false,"description":"Third-party reference number supplied by the external system.","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"Data":{"properties":{"OrderData":{"items":{"properties":{"BillToAddr":{"type":"string"},"BillToAddr2":{"type":"string"},"BillToCity":{"type":"string"},"BillToCompanyName":{"type":"string"},"BillToCountry":{"type":"string"},"BillToCountryISO2":{"type":"string"},"BillToEmail":{"type":"string"},"BillToFirstName":{"type":"string"},"BillToLastName":{"type":"string"},"BillToName":{"type":"string"},"BillToPhoneNumber":{"type":"string"},"BillToState":{"type":"string"},"BillToStateAbbr":{"type":"string"},"BillToZpCode":{"type":"string"},"CarrierName":{"type":"string"},"CurrencyCode":{"type":"string"},"CustomFieldH1":{"type":"string"},"CustomFieldH10":{"type":"string"},"CustomFieldH11":{"type":"string"},"CustomFieldH12":{"type":"string"},"CustomFieldH13":{"type":"string"},"CustomFieldH14":{"type":"string"},"CustomFieldH15":{"type":"string"},"CustomFieldH16":{"type":"string"},"CustomFieldH17":{"type":"string"},"CustomFieldH18":{"type":"string"},"CustomFieldH19":{"type":"string"},"CustomFieldH2":{"type":"string"},"CustomFieldH20":{"type":"string"},"CustomFieldH21":{"type":"string"},"CustomFieldH22":{"type":"string"},"CustomFieldH23":{"type":"string"},"CustomFieldH24":{"type":"string"},"CustomFieldH25":{"type":"string"},"CustomFieldH26":{"type":"string"},"CustomFieldH27":{"type":"string"},"CustomFieldH28":{"type":"string"},"CustomFieldH29":{"type":"string"},"CustomFieldH3":{"type":"string"},"CustomFieldH30":{"type":"string"},"CustomFieldH4":{"type":"string"},"CustomFieldH5":{"type":"string"},"CustomFieldH6":{"type":"string"},"CustomFieldH7":{"type":"string"},"CustomFieldH8":{"type":"string"},"CustomFieldH9":{"type":"string"},"CustomerEmailMain":{"type":"string"},"CustomerFullName":{"type":"string"},"CustomerMainPhone":{"type":"string"},"CustomerPO":{"type":"string"},"Id":{"type":"number"},"Memo":{"type":"string"},"OrderClassCode":{"type":"string"},"OrderClassName":{"type":"string"},"OrderDate":{"type":"string"},"OrderNumber":{"type":"string"},"OrderTypeCode":{"type":"string","nullable":true},"OrderTypeName":{"type":"string","nullable":true},"PaymentTermsName":{"type":"string"},"RefNo":{"type":"string"},"RiskAnalysis":{"type":"string"},"SaleStoreId":{"type":"number"},"SaleStoreName":{"type":"string"},"ShipMethodName":{"type":"string"},"ShipServiceCode":{"type":"string"},"ShipServiceName":{"type":"string"},"ShipStoreName":{"type":"string"},"ShipToAddr":{"type":"string"},"ShipToAddr2":{"type":"string"},"ShipToCity":{"type":"string"},"ShipToCompanyName":{"type":"string"},"ShipToCountry":{"type":"string"},"ShipToCountryISO2":{"type":"string"},"ShipToEmail":{"type":"string"},"ShipToFirstName":{"type":"string"},"ShipToLastName":{"type":"string"},"ShipToName":{"type":"string"},"ShipToPhoneNumber":{"type":"string"},"ShipToState":{"type":"string"},"ShipToStateAbbr":{"type":"string"},"ShipToZpCode":{"type":"string"},"ShippingAccountNumber":{"type":"string"},"ShippingAmount":{"type":"number"},"ShippingCost":{"type":"number"},"ShippingNotes":{"type":"string"},"ShippingTermsName":{"type":"string"},"StoreId":{"type":"number"},"Tags":{"type":"string"},"TotalAmount":{"type":"number"},"TotalQty":{"type":"number"},"TotalTaxAmount":{"type":"number"},"TotalWaveCount":{"type":"number"},"TransferFromStoreId":{"type":"number","nullable":true},"TransferFromStoreName":{"type":"string","nullable":true},"TransferToStoreId":{"type":"number","nullable":true},"TransferToStoreName":{"type":"string"},"TypeName":{"type":"string"}},"type":"object"},"type":"array"},"WaveData":{"items":{"properties":{"PreviewFlag":{"type":"boolean"},"WaveDetailAllocationArr":{"items":{"properties":{"BatchNumber":{"type":"number","nullable":true},"CreateSource":{"type":"string","nullable":true},"DestinationLocationBrcd":{"type":"string","nullable":true},"DestinationLocationId":{"type":"number"},"DestinationLocationName":{"type":"string","nullable":true},"Id":{"type":"number"},"ItemId":{"type":"number"},"ItemNumber":{"type":"string"},"ItemUpc":{"type":"string"},"LotNumber":{"type":"number","nullable":true},"LpnId":{"type":"number","nullable":true},"LpnNumber":{"type":"number","nullable":true},"MatchedFlag":{"type":"boolean"},"MfgDate":{"type":"string","nullable":true},"MoId":{"type":"number"},"MoLineId":{"type":"number"},"ModifyDttm":{"type":"string","nullable":true},"ModifySource":{"type":"string","nullable":true},"Note":{"type":"string","nullable":true},"OrderNumber":{"type":"string"},"PickLocationBrcd":{"type":"string","nullable":true},"PickLocationClassId":{"type":"number"},"PickLocationId":{"type":"number"},"PickLocationName":{"type":"string"},"PickSeq":{"type":"number","nullable":true},"PriorityNumber":{"type":"number","nullable":true},"QtyAllocated":{"type":"number"},"QtyDecimalFlag":{"type":"boolean"},"QtyPicked":{"type":"number"},"SoId":{"type":"number"},"SoLineId":{"type":"number"},"StatusId":{"type":"number"},"StatusName":{"type":"string","nullable":true},"StoreId":{"type":"number"},"WaveDetailId":{"type":"number"},"WaveId":{"type":"number"}},"type":"object"},"type":"array"},"WaveDetailArr":{"items":{"properties":{"BillToAddrName":{"type":"string","nullable":true},"CarrierId":{"type":"number"},"CloseFlag":{"type":"boolean"},"ConsolidationLocationId":{"type":"number","nullable":true},"CreateDate":{"type":"string"},"CreateDttm":{"type":"string"},"CreateSource":{"type":"string"},"CustomerName":{"type":"string"},"Freight":{"type":"number"},"Id":{"type":"number"},"IsCustomerOnHold":{"type":"boolean"},"ItemDescription":{"type":"string"},"ItemId":{"type":"number"},"ItemNumber":{"type":"string"},"ItemTypeId":{"type":"number"},"ItemTypeName":{"type":"string"},"ItemUpc":{"type":"string"},"KitItemShort":{"type":"boolean"},"MasterKitKey":{"type":"string","nullable":true},"MatchedFlag":{"type":"boolean"},"MoId":{"type":"number","nullable":true},"MoLineId":{"type":"number","nullable":true},"ModifyDttm":{"type":"string"},"ModifySource":{"type":"string"},"Note":{"type":"string"},"OrderNumber":{"type":"string"},"QtyAllocated":{"type":"number"},"QtyDecimalFlag":{"type":"boolean"},"QtyPicked":{"type":"number"},"QtyToPick":{"type":"number"},"RefNo":{"type":"string"},"SellUomId":{"type":"number"},"ShipFlag":{"type":"boolean"},"ShipMethodId":{"type":"number"},"ShipMethodName":{"type":"string"},"ShipServiceId":{"type":"number"},"ShipToAddrName":{"type":"string","nullable":true},"SoId":{"type":"number"},"SoLineId":{"type":"number"},"SoNumber":{"type":"number","nullable":true},"StatusId":{"type":"number"},"StatusName":{"type":"string"},"StoreId":{"type":"number"},"StoreName":{"type":"string"},"ThirdPartySource":{"type":"string"},"UnitPrice":{"type":"number"},"WaveDefaultLocationId":{"type":"number","nullable":true},"WaveDetailAllocationArr":{"type":"array","items":{"type":"object","additionalProperties":true},"nullable":true},"WaveId":{"type":"number"},"WaveNumber":{"type":"string"},"WaveStatusId":{"type":"number"},"WaveStatusName":{"type":"string","nullable":true},"WaveTypeId":{"type":"number"},"WaveTypeName":{"type":"string"}},"type":"object"},"type":"array"},"WaveHeaderData":{"properties":{"CloseWave":{"type":"boolean"},"CloseWaveByLinesOnly":{"type":"boolean"},"CreateDttm":{"type":"string"},"CreateSource":{"type":"string","nullable":true},"Id":{"type":"number"},"LockFlag":{"type":"boolean"},"LockToggleFlag":{"type":"boolean"},"ModifyDttm":{"type":"string","nullable":true},"ModifySource":{"type":"string","nullable":true},"Note":{"type":"string"},"OrderWaveCount":{"type":"number"},"PlannedShipDate":{"type":"string"},"PriorityId":{"type":"number","nullable":true},"PriorityName":{"type":"string"},"StatusId":{"type":"number"},"StatusName":{"type":"string"},"StoreId":{"type":"number"},"StoreName":{"type":"string"},"TypeId":{"type":"number"},"TypeName":{"type":"string"},"UploadFlag":{"type":"boolean"},"WaveNumber":{"type":"string"}},"type":"object"}},"type":"object"},"type":"array"}},"type":"object"},"IsForwardRequest":{"type":"boolean"},"Message":{"type":"string"},"MessageTitle":{"type":"string","nullable":true},"Page":{"type":"number"},"Result":{"type":"boolean"},"TotalPages":{"type":"number"}},"type":"object"}}},"description":"OK","headers":{}}},"tags":["Fulfillment and Wave Management"],"description":"Retrieves List of waves from the database.\nThe data returned from this API will be paged
\nPaging supported.","operationId":"get_wave_getwave","summary":"List Waves"}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.xorosoft.com/developers-api/fulfillment-and-wave-management/list-waves.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.