Split an Order into Multiple Orders

Divides one order into several child orders. The source order and its line items are superseded
once the split succeeds, and the associated cart is superseded along with them.

The source order must be in Draft, Pending, Confirmed or In Fulfillment status, and must not have
a custom plan associated with it.

The SplitType field selects how the order is divided, and determines which other field of the
request body is used:

  • 'Split By Line Number' uses LineNumbers, where each inner list is one resulting order. Every
    line number supplied must exist on the source order, and may appear only once across the
    whole payload - listing one in two groups, or twice in the same group, is rejected with
    400 Bad Request.
  • 'Split By Adhoc Criteria' uses Criteria, a list of line item property paths. Line items are
    grouped by the combined values of those properties, and each group becomes one order.
  • 'Split By Predefined Criteria' uses CriteriaIds, referencing existing split criteria setups.
    Grouping must produce at least two groups, otherwise the request is rejected.

Any other SplitType value is rejected with 400 Bad Request.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique identifier of the order to be split

Body Params

The request model containing the details for splitting the order. The split type decides whether LineNumbers, Criteria or CriteriaIds is required

Model describing how an order should be split into multiple new orders.
The value of Conga.Revenue.Order.Utils.Models.SplitOrderRequestModel.SplitType determines which of the remaining
properties is required.

string | null

Defines the type of split to be performed on the order.
Valid values are 'Split By Line Number', 'Split By Adhoc Criteria' and
'Split By Predefined Criteria'. Any other value is rejected.
The value chosen determines which of the remaining fields is used.

LineNumbers
array of arrays of int32s | null

Contains the line numbers to be split for each new order.
Each inner list represents a new order, and the integers within the inner
list represent the line numbers from the original order that should be included in that new order.
Required when SplitType is 'Split By Line Number'; every line number supplied must exist on the
source order, and may appear only once across the whole payload. Line numbers not listed are
collected into one additional order.

LineNumbers
CriteriaIds
array of strings | null

Contains the criteria IDs to be used for splitting the order.
Required when SplitType is 'Split By Predefined Criteria'. Each identifier must reference an
existing split criteria setup, and the resulting grouping must produce at least two groups.

CriteriaIds
Criteria
array of strings | null

Adhoc criteria values to be used for splitting the order in case of adhoc split type.
Required when SplitType is 'Split By Adhoc Criteria'. Each entry is a property path on the order
line item, and line items are grouped by the combined values of those properties.

Criteria
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses
200

OK

500

Internal Server Error

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json