> 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/merge-waves-by-address.md).

# Merge Waves by Address

Run the mergewavebasedonaddr workflow for wave records in Xorosoft ERP. This operation is typically used after the related transaction already exists and the external system needs to advance its processing status.

```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"}},"schemas":{"XoroApiResponse":{"type":"object","description":"Standard Xorosoft ERP API response envelope used by most endpoints.","properties":{"Result":{"type":"boolean","description":"True when the operation completed successfully."},"Message":{"type":"string","description":"Human-readable success or error message."},"Data":{"description":"Endpoint-specific payload.","type":"object","additionalProperties":true,"nullable":true},"Page":{"type":"integer","description":"Current page number when paging is enabled.","nullable":true},"TotalPages":{"type":"integer","description":"Total page count when paging is enabled.","nullable":true}}},"PostWaveMergewavebasedonaddrRequest":{"type":"object","required":["secondaryWaveId","MergeWaveByOrderNumber"],"properties":{"secondaryWaveId":{"type":"integer","format":"int64","description":"Identifier of the wave to merge into the primary wave."},"MergeWaveByOrderNumber":{"type":"boolean","description":"Set to true to merge by sales-order number rather than only by delivery address."},"orderMergeShipServicesToFilterOut":{"type":"array","description":"Optional shipping-service names to exclude from the merge.","items":{"type":"string"}}},"description":"Merges the selected wave into the current wave based on the requested merge rules."}}},"paths":{"/api/xerp/wave/mergewavebasedonaddr":{"post":{"tags":["Fulfillment and Wave Management"],"summary":"Merge Waves by Address","description":"Run the mergewavebasedonaddr workflow for wave records in Xorosoft ERP. This operation is typically used after the related transaction already exists and the external system needs to advance its processing status.","operationId":"post_wave_mergewavebasedonaddr","responses":{"200":{"description":"Request processed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XoroApiResponse"}}}},"400":{"description":"Invalid request, failed validation, or business rule error.","content":{"text/plain":{"schema":{"type":"string"}}}},"401":{"description":"Missing or invalid private app credentials."},"403":{"description":"Private app does not have permission for this request."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostWaveMergewavebasedonaddrRequest"}}}}}}}}
```


---

# 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/merge-waves-by-address.md?ask=<question>&goal=<endgoal>
```

`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.
