This API splits the order into multiple orders. All the "siReferenceCode" of the package has to be provided in the request. Can split only one package at a time.
siReferenceCode : This is associated with item(suborder) level. This value can be fetched from "/orders/new/{packageReferenceCode}" api under packages -> items -> siReferenceCode
After getting response as "split successfully", "orders/new" api has to be called to get the new splitted packages.
Example: If an package contains 4 items (4 suborders) and we want to split it into 3 packages containing (1,2,1) items, then request will be like in below mentioned example.
Note
Sub orders belonging to Dropship, Oneship.
Allowed status: PFF, PRNT
If order is in PRNT state and seller is on Bulk invoice mode or Manual invoice mode, then invoiceCodes field in the request is needed for successful splitting.Request allowed values:
fulfillmentType - DROPSHIP, ONESHIP, OCPLUS
Request
| ParameterName | DataType | ParameterType | Requirement | Description |
|---|---|---|---|---|
| subOrderIds | List<List > | Body | Mandatory | List of list of siReferenceCode |
| fulfillmentType | String | Body | Mandatory | Fulfillment model |
| invoiceCodes | LinkedHashSet | Body | Optional | Invoice codes |
Response
metadata :
| FieldName | DataType | Description |
|---|---|---|
| requestId | String | Unique ID for the request |
| clientId | String | Partner Id |
| responseTime | Long | Response Time |
| requestedURI | String | Requested URI |
| message | String | Error message |
payload :
| FieldName | DataType | Description |
|---|---|---|
| operationSuccessful | boolean | Describes whether operation Successful or not |
| errorMessage | String | Error message will be given if operationSuccessful is false otherwise it will be null. |