Skip to main content
POST
Split Return Line Item

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

Idempotency-Key
string

Optional, client-generated key for deduplicating repeated write requests. A repeated request with the same key returns the originally recorded result instead of executing the effect again.

Required string length: 1 - 255
x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Path Parameters

returnId
string<uuid>
required

The ID of the return that the line item belongs to.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

lineItemId
string<uuid>
required

The ID of the line item to split.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

Body

application/json

Request model for SplitReturnLineItem command endpoint. Route parameters bind from the route, query parameters from the query string, everything else from the body.

quantity
number<decimal>
required

The quantity to split off into a new position. Must be greater than 0 and less than the current position quantity.

Response

The split result containing both position IDs and quantities.

Model Class: SplitReturnLineItem

originalLineItemId
string<uuid>
required

The ID of the original line item (quantity reduced).

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

originalQuantity
number<decimal>
required

The remaining quantity on the original position.

newLineItemId
string<uuid>
required

The ID of the newly created line item (with split-off quantity).

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

newQuantity
number<decimal>
required

The quantity on the new position.