> 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/close-wave.md).

# Close Wave

Submit a close request for wave records in Xorosoft ERP. Use this operation carefully because it can change transaction status or remove data from active workflows.

```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}}},"PostWaveCloseRequest":{"type":"object","required":["WaveHeaderData"],"properties":{"WaveHeaderData":{"type":"object","description":"Identifies the wave to close and controls whether Xorosoft ERP closes the full wave or only the supplied lines.","properties":{"WaveNumber":{"type":"string","description":"Wave number to close."},"CloseWave":{"type":"boolean","description":"Set to true to close the entire wave after processing the supplied allocations."},"CloseWaveByLinesOnly":{"type":"boolean","description":"Set to true to close only the individual wave lines represented by the supplied allocations."}}},"WaveDetailArr":{"type":"array","description":"Optional wave detail lines associated with the close operation.","items":{"type":"object","additionalProperties":true}},"WaveDetailAllocationArr":{"type":"array","description":"Allocations and picked quantities to apply while closing the wave.","items":{"type":"object","additionalProperties":true}}},"description":"Request body for Close.","additionalProperties":true}}},"paths":{"/api/xerp/wave/close":{"post":{"tags":["Fulfillment and Wave Management"],"summary":"Close Wave","description":"Submit a close request for wave records in Xorosoft ERP. Use this operation carefully because it can change transaction status or remove data from active workflows.","operationId":"post_wave_close","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/PostWaveCloseRequest"}}}}}}}}
```


---

# 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/close-wave.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.