# Shipment split

A React block (a whole screen) in [Beamline](https://beamline.io/)'s [Inventory](https://beamline.io/components/apps/inventory) app. Live demo: https://beamline.io/components/shipment-split

An order's lines split across shipments. A table of lines with what was ordered and a column per shipment (new ones marked); a line already shipped can't be split, said. Split opens a row editor: the line's units per shipment, Add a shipment, the units left to place or too many on their tone, Apply only when they add up. Applying changes the draft (changed cells marked); Save commits the whole draft at once, Discard drops it, and the bar says an unsaved split is lost on leaving; a line that doesn't add up is said. What the sales channel does with a split order is said above. A refused save keeps the draft and says why. The saved shipments listed beside, the one picked showing its contents.

## Use it for

- Splitting an order's quantities across shipments, deliveries or parcels with a draft saved whole.
- Where the total per line must always add up and some lines are already gone.

## Not for

- Dragging items into boxes by weight (the signature list's package allocation).
- Splitting money ([split-anything](https://beamline.io/components/split-anything)).

## Anatomy

- header: the tool's mark, Split order <id>, customer and channel
- table: item and SKU, ordered, a column per shipment, doesn't add up, Split on attention or Shipped (on a phone each line stacks with its counts labelled); the row editor with a field per shipment, Add a shipment, units left, Cancel, Apply
- draft bar: unsaved (what leaving does, a hint) or saved, what the channel does once split, Discard the draft, Save the split
- shipments: the saved ones, the picked one's contents

## States

- not split, a row being edited (left, too many, all placed), draft applied, saving, saved, save refused, a shipped line
- phone: the table scrolls sideways, the shipments below
- right to left: mirrored
- reduced motion: through the tokens

## Keyboard

- Tab through each line's Split, the editor's fields (arrows step units), Apply, the draft bar and the shipments

## Motion

Nothing runs at rest.

## Props

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `order` (required) | `{ id: string; customer: string; channel: string; }` | — |  |
| `lines` (required) | `SplitLine[]` | — |  |
| `shipments` | `SplitShipment[]` | — | The saved shipments (controlled). |
| `defaultShipments` | `SplitShipment[]` | — |  |
| `onShipmentsChange` | `((shipments: SplitShipment[]) => void)` | — |  |
| `onSave` (required) | `(draft: SplitShipment[]) => Promise<SplitShipment[]>` | — | Commits the whole draft; resolve with the shipments as saved (new ones get their ids), reject with why not. |
| `channelNote` | `string \| null` | — | What the channel does once an order is split ("Etsy stops sending order updates…"). |
| `defaultDraft` | `SplitShipment[] \| null` | — | A draft at first (a split reopened mid-way). |
| `product` | `string` | — |  |
| `className` | `string` | — | Classes on the documented visual root; no override by default. |
| `style` | `CSSProperties` | — | Inline styles on the documented visual root; no overrides by default. |
| `ref` | `Ref<HTMLDivElement>` | — | Receives the documented native target or imperative handle; omitted by default. |

## Built from

- [Alert](https://beamline.io/components/alert.md)
- [Avatar](https://beamline.io/components/avatar.md)
- [Button](https://beamline.io/components/button.md)
- [Label](https://beamline.io/components/label.md)
- [Number field](https://beamline.io/components/number-field.md)
- [Spinner](https://beamline.io/components/spinner.md)
- [Tooltip](https://beamline.io/components/tooltip.md)

## Dependencies

`lucide-react`

## Import

```tsx
import { ShipmentSplit } from "@beamline/shipment-split";
```

## Get it

Shipment split is part of Beamline UI. Install the parts you need in your React app as compiled packages or editable source. [Get Beamline](https://beamline.io/checkout?pack=complete) · [Connect your agent](https://beamline.io/connect)

## More in Inventory

- [Stock count](https://beamline.io/components/stock-count): A shelf counted. Count: the products on it with counted units, not counted (an empty field that changes nothing) kept apart from a counted zero, expected…
- [Inventory counts](https://beamline.io/components/inventory-counts): Recurring stock counts from plan to shelf: a phone-first count of one occurrence where an untouched part reads not counted and a zero reads counted, none…
- [Goods receiving](https://beamline.io/components/goods-receiving): Goods received against purchase orders and invoices. Cards grouped by purchase order or invoice, each line once whichever way (a line keeps both sources…
- [Purchase order desk](https://beamline.io/components/purchase-order-desk): Purchase orders for stock from draft to closed. The list of orders with status (ready for review on warning, approved, ordered and partly received on…
- [Restock desk](https://beamline.io/components/restock-desk): Restocking from suppliers' own shops. Items low on stock (below the minimum on danger, at it on warning, unknown said) beside the chosen item with how…
- [Stock alerts](https://beamline.io/components/stock-alerts): Alerts on stock counts and expiry dates. Counts of alerts gone off (danger) and close (warning) in the header. A table: item and type, the rule in words…
- [Inventory finder](https://beamline.io/components/inventory-finder): Find stock and act on what's found. A rail of filters: name or SKU; folders with or without their subfolders (folders the person can't see said as not…
- [Item setup](https://beamline.io/components/item-setup): Setting items up for scanning and records. Barcodes: scanned codes waiting to be linked, each with its symbology, when and who; Look it up brings a…
- [Bulk item edit](https://beamline.io/components/bulk-item-edit): Many items corrected at once. Pick a folder, with its subfolders or not (fixed once anything is edited), up to a limit said. The items in a grid: name…
- [Kit builder](https://beamline.io/components/kit-builder): A kit (bundle) made of standalone products, and how many its parts' stock can make. Sell as a kit; the parts in one kit with units per kit, removable…
- [Serial allocation](https://beamline.io/components/serial-allocation): A receipt line's serial numbers. Serials generated from a first serial and how many (its digits counted up, padding kept; a first serial without digits…
- [Stock moves](https://beamline.io/components/stock-moves): Where stock went, and moving it. The ledger lists movements newest first: moves on info, stock added on success, stock taken out on warning; each with…
- [Scan station](https://beamline.io/components/scan-station): A warehouse scanner, phone-first. Home: one scan field that also takes typing (and says so when the scanner isn't connected), each code named as what it…
- [Pack station](https://beamline.io/components/pack-station): A packing bench. Scanner, scale and printer each said, on the warning tone when away. Find the shipment by scanning or typing its number (none found…
- [Route plan](https://beamline.io/components/route-plan): A day's delivery routes in the service's zone. The day at a glance: routes, routes without a driver (warning), stops running late (danger), stops done…
- [Job materials](https://beamline.io/components/job-materials): Materials sent out to jobs and pick lists. Jobs: the list (draft, active on info, completed on success) beside the chosen job with its site, dates (the…
- [Service tasks](https://beamline.io/components/service-tasks): A fleet shop's maintenance setup. Tasks: active and archived, searchable, main tasks and their subtasks told apart in words, archiving refused while…
- [Owner records](https://beamline.io/components/owner-records): Who a customer is and what they own, at the front desk. New customer: name, phone and email checked as typed against existing customers; each likely…
- [Sample storage](https://beamline.io/components/sample-storage): Where physical items are kept (rooms, freezers, shelves, racks, boxes) and acting on several at once. The storage tree is browsed apart from moving: Move…
- [Sample ledger](https://beamline.io/components/sample-ledger): Materials used in a record and the containers they came from, plus pooling. Subtracting a used amount writes a stock movement with its unit and the…

Part of [Beamline UI: polished, editable React components and complete screens for custom applications](https://beamline.io/). [Build your own style from any look; tokens, fonts, radii, motion; not only colours](https://beamline.io/docs/customize).
