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

# Ship by Wave

Run the ship bywave workflow for shipconfirmation 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}}},"PostShipconfirmationShipbywaveRequest":{"type":"object","description":"Confirms shipment by wave using the current ShipConfirmation model.","properties":{"SoEstimateHeader":{"type":"object","description":"Sales order header used to identify the order or third-party shipment.","additionalProperties":true,"properties":{"Id":{"type":"integer","format":"int64"},"OrderNumber":{"type":"string"},"ThirdPartyRefNo":{"type":"string"},"ThirdPartyShipConfirmationFlag":{"type":"boolean"}}},"SoEstimateItemLineArr":{"type":"array","description":"Sales order lines to ship.","items":{"type":"object","additionalProperties":true}},"ShipmentCartonList":{"type":"array","description":"Optional shipment carton records.","items":{"type":"object","additionalProperties":true}},"ShipmentId":{"type":"string"},"IgnoreVoidedWaveLinesFlag":{"type":"boolean"},"ReShipWave":{"type":"boolean"},"MarkAsShipped":{"type":"boolean","description":"Marks the selected wave lines as shipped without requiring individual shipment lines."},"IsMarkupExempt":{"type":"boolean"},"CompareWaveLinesWhileShipping":{"type":"boolean"},"OverrideWMSRestrictionsOnWave":{"type":"boolean"},"SplitAllocationsByLotNumber":{"type":"boolean"},"OverrideRestrictionsOnOrder":{"type":"boolean"},"AllowShippingOfLockedWave":{"type":"boolean"},"IgnoreOrderSuffix":{"type":"boolean"},"DisableBatchInvoiceGeneration":{"type":"boolean"}}}}},"paths":{"/api/xerp/shipconfirmation/shipbywave":{"post":{"tags":["Fulfillment and Wave Management"],"summary":"Ship by Wave","description":"Run the ship bywave workflow for shipconfirmation 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_shipconfirmation_shipbywave","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/PostShipconfirmationShipbywaveRequest"}}}}}}}}
```


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.xorosoft.com/developers-api/fulfillment-and-wave-management/ship-by-wave.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.