# Order composer

A React block (a whole screen) in [Beamline](https://beamline.io/)'s [Shop](https://beamline.io/components/apps/shop) app. Live demo: https://beamline.io/components/order-composer

An order made inside a support ticket: products found by name, each variant with its stock drawn and said (in stock, none, oversold, not known) and the shop's oversell rule kept, added by its stable id; a copy of an order starting as a free replacement that is said and can be switched to charging; shipping and a note with the total; and a draft created awaiting payment, nothing charged and no invoice sent until Send the invoice, prices that changed since they were added said first.

## Use it for

- Agents creating or duplicating an order for a customer from a ticket.

## Not for

- Acting on an existing order ([ticket-orders](https://beamline.io/components/ticket-orders)).

## Anatomy

- header: the mark, New order for or Copy of … for the customer
- picker: Product (searchable), stock as of, the variants (title, price, SKU, stock bar and word), Quantity, Add, the oversell rule
- draft: Items (the quantity leading as a figure that edits in place, product, each or free / was, amount, remove on attention), Pricing (Free replacement · Charge for it, a switch) for a copy, the sum with Shipping as a menu and the total as the figure, Add a note on demand, Create draft order; created: the draft's number, changed prices, Send the invoice

## States

- empty draft
- a copy as a free replacement
- no stock; oversold; stock not known; past stock refused or on backorder
- creating; created; prices changed; create failed
- invoice sending; sent; failed

## Keyboard

- the variants are a radio group
- Tab through quantity, Add, the draft's lines and pricing

## Motion

The chosen variant's ring fades in; nothing moves at rest.

## Props

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `products` | `Product[]` | — | Products with variants: stable id, title, SKU, price, stock (null not known, negative oversold). |
| `customer` | `{ name; email }` | — | Who it's for. |
| `duplicateOf` | `{ number; lines }` | — | A copy of an order: its lines start here as a free replacement. |
| `oversell` | `boolean` | — | Whether the shop sells past stock. |
| `onCreate` | `(d: OrderDraft) => Promise<{ number; priceChanged? }>` | — | Create a draft awaiting payment; resolve with its number and any prices that changed since. |
| `onSendInvoice` | `(number) => Promise<unknown>` | — | Send the draft's invoice, a separate step. |
| `currency` (required) | `string` | — |  |
| `stockAsOf` | `string` | — |  |
| `shippingPrices` | `{ standard: number; express: number; }` | — |  |
| `defaultProductId` | `string` | — | The product picked at first, to show its variants. |
| `timeZone` | `string` | — |  |
| `product` | `string` | — |  |
| `className` | `string` | — | Classes on the documented visual root; no override by default. |
| `ref` | `Ref<HTMLDivElement>` | — | Receives the documented native target or imperative handle; omitted by default. |

## Built from

- [Avatar](https://beamline.io/components/avatar.md)
- [Bottom sheet](https://beamline.io/components/bottom-sheet.md)
- [Button](https://beamline.io/components/button.md)
- [Combobox](https://beamline.io/components/combobox.md)
- [Dropdown menu](https://beamline.io/components/dropdown-menu.md)
- [Inline edit](https://beamline.io/components/inline-edit.md)
- [Label](https://beamline.io/components/label.md)
- [Number field](https://beamline.io/components/number-field.md)
- [Segmented control](https://beamline.io/components/segmented-control.md)
- [Select](https://beamline.io/components/select.md)
- [Spinner](https://beamline.io/components/spinner.md)
- [Text morph](https://beamline.io/components/text-morph.md)
- [Textarea](https://beamline.io/components/textarea.md)
- [Tooltip](https://beamline.io/components/tooltip.md)

## Dependencies

`lucide-react`

## Import

```tsx
import { OrderComposer } from "@beamline/order-composer";
```

## Get it

Order composer 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 Shop

- [Product editor](https://beamline.io/components/product-editor): A product being made in a shop's back office, every value read as text at rest. The variant grid, grouped by the first option, lists each combination…
- [Category manager](https://beamline.io/components/category-manager): A shop's product categories, nested and ranked. Each category moves up, down or into another from its menu, and every move gets its own receipt (saving…
- [Inventory item](https://beamline.io/components/inventory-item): One stock item in a shop's back office, apart from the variants that sell it (how many each uses per unit). Stock per location as stocked, reserved and…
- [Plan comparison](https://beamline.io/components/plan-comparison): Plans side by side against every feature: prices that roll between monthly and yearly, the current and recommended plan marked, a header that stays in…
- [Step form](https://beamline.io/components/step-form): The finished frame for any multi-step form you compose — onboarding, intake brief, questionnaire, booking, application: a wide card with progress, the…
- [Orders admin](https://beamline.io/components/orders-admin): A shop's order desk: today's orders and revenue, quick filters for what needs doing (to fulfil, unpaid, returns), a virtualised orders grid, and the…
- [Order detail](https://beamline.io/components/order-detail): One shop order with payment and fulfilment as two separate lanes. The header says where each stands (paid, partly paid, awaiting, refunded; not…
- [Order board](https://beamline.io/components/order-board): A shop's orders as cards in its columns, on the shared kanban with drag and keyboard moves. Each card: number, estimate or work order, customer, vehicle…
- [Draft orders](https://beamline.io/components/draft-orders): A draft order made for a customer in a shop's back office that reads like the order it will become. The lines lead: each with its variant and SKU or…
- [Order changes](https://beamline.io/components/order-changes): What happens to a shop order after it's placed. Edit: the order as it stands beside the requested version, each line marked new, changed (old → new…
- [Special orders](https://beamline.io/components/special-orders): Customers' special orders as demand to buy for, per outlet: To order apart from Ordered; each product's demand, what is reserved, incoming and on order…
- [Order history and fills](https://beamline.io/components/order-history): Every order the account placed and every fill it got, for a period: totals for volume, fees, fill rate and maker share; orders with their status and how…
- [Order ledger](https://beamline.io/components/order-ledger): Purchase orders as money. Each order's spend is drawn against its approved total (paid, billed, pending, what is left, and any overrun past the end…
- [Ticket orders](https://beamline.io/components/ticket-orders): A customer's orders inside a support ticket, each action's effect said before it's done: orders and drafts kept apart, a paid draft shown once as its…
- [Record search](https://beamline.io/components/record-search): One search across connected records (customers, vehicles, orders) by name, phone, plate, VIN or order number. What the words look like is said (info)…
- [Return queue](https://beamline.io/components/return-queue): A queue of return cases. Search by return, order or customer, exactly (the default) or loosely; status tabs with counts, Requires attention first; a date…
- [Return case](https://beamline.io/components/return-case): One return as one place where every act is its own. The return, its order (linked out) and the customer on three cards; the stage said on its tone. Items…
- [Return request](https://beamline.io/components/return-request): Staff start a return from an order, and edit the reasons customers pick. New return: the order's lines as a checklist, each with its variant, price and…
- [Purchase orders](https://beamline.io/components/purchase-orders): A salon's purchase orders, received: the orders down the side, the chosen one beside them. Each line still due reads as a strip of received, this…
- [Print quote](https://beamline.io/components/print-quote): A print shop's quoting in three places. Quote: a group of garments that share one imprint and one quantity break, the group's pieces counted together and…
- [Service estimate](https://beamline.io/components/service-estimate): An estimate for one vehicle. Services added from the catalogue (one not listed for this vehicle said on warning, fit unknown said); each with its lines…
- [Job card](https://beamline.io/components/job-card): A technician's repair order, phone-first. The vehicle, the customer and when it's due in words (due at, due in, overdue by how long); an offline copy…
- [Parts tracker](https://beamline.io/components/parts-tracker): Parts across a shop's work orders: each with its number, the order and vehicle, supplier, quantity and cost (not known said), and where it is: ordered…
- [Visit board](https://beamline.io/components/visit-board): The staff board for a walk-in queue: visits move from waiting through called and serving to done today. Arrival (here or on the way), the place in 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).
