Merge Orders
starshipit_merge_ordersMerge selected child orders into a parent order so multiple purchases ship together as one package in StarShipIt.
Instructions
Merge one or more child orders into a parent order in StarShipIt. After merging, the child orders are absorbed into the parent and the combined shipment will be dispatched as a single package.
When to use: Use when a customer has placed multiple orders that should ship together in one box. Use starshipit_get_suggested_merges first to find recommended candidates.
Parameters:
parent_order_id(required) — The order ID that will be kept as the merged resultchild_order_ids(required) — Array of order IDs to merge into the parent (at least one)
Returns: Confirmation of the merged order.
Warning: This is a destructive operation — child orders will no longer exist as independent orders after the merge.
Errors: 400 if child_order_ids is empty; 404 if any order ID not found; 409 if orders are not merge-compatible (e.g. different destination addresses); 401 if API keys invalid.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| child_order_ids | Yes | Array of order IDs to merge into the parent order | |
| parent_order_id | Yes | Order ID of the parent order that will contain the merged result |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| errors | No | Validation or processing errors returned by StarShipIt | |
| object | No | The response payload when StarShipIt returns a non-object value | |
| success | No | StarShipIt success flag (a boolean on most endpoints) |