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.

post

Authorizations

AuthorizationstringRequired

Body

Confirms shipment by wave using the current ShipConfirmation model.

ShipmentIdstringOptional

IgnoreVoidedWaveLinesFlagbooleanOptional

ReShipWavebooleanOptional

MarkAsShippedbooleanOptional

Marks the selected wave lines as shipped without requiring individual shipment lines.

IsMarkupExemptbooleanOptional

CompareWaveLinesWhileShippingbooleanOptional

OverrideWMSRestrictionsOnWavebooleanOptional

SplitAllocationsByLotNumberbooleanOptional

OverrideRestrictionsOnOrderbooleanOptional

AllowShippingOfLockedWavebooleanOptional

IgnoreOrderSuffixbooleanOptional

DisableBatchInvoiceGenerationbooleanOptional

Responses

200

Request processed successfully.

application/json

Standard Xorosoft ERP API response envelope used by most endpoints.

ResultbooleanOptional

True when the operation completed successfully.

MessagestringOptional

Human-readable success or error message.

Pageinteger · nullableOptional

Current page number when paging is enabled.

TotalPagesinteger · nullableOptional

Total page count when paging is enabled.

400

Invalid request, failed validation, or business rule error.

text/plain

401

Missing or invalid private app credentials.

403

Private app does not have permission for this request.

post/api/xerp/shipconfirmation/shipbywave

POST /api/xerp/shipconfirmation/shipbywave HTTP/1.1
Host: res.xorosoft.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "WaveHeader": {
    "WaveNumber": "WAVE-1001"
  },
  "WaveDetailArr": []
}

{
  "Result": true,
  "Message": "Request processed successfully",
  "Data": {}
}