Create an unshipped order
starshipit_create_orderDestructive
WRITE: create ONE new UNSHIPPED order in Starshipit (order number, destination, optional items, parcels, sender). No label is printed, no shipment is booked and no postage is bought; staff still print the label in Starshipit. Not idempotent: creating the same order_number twice may create a duplicate, so check with starshipit_search_orders first. Starshipit rules configured in the account (carrier selection, validation) may run on the new order. POST /api/orders.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| items | No | ||
| carrier | No | Starshipit carrier code, e.g. AusPost (optional; rules may choose one). | |
| currency | No | Currency code of the item values, e.g. AUD. | |
| packages | No | ||
| reference | No | Customer reference (max 50 chars). | |
| destination | Yes | ||
| order_number | Yes | Order number from the source system (max 50 chars). | |
| return_order | No | true = a return order (only the return label will be generated later). | |
| sender_details | No | Sender; omitted = the account's pickup address. | |
| shipping_method | No | Delivery method name, e.g. Express Shipping. | |
| signature_required | No | ||
| carrier_service_code | No | Carrier service code from a rates quote, e.g. 7B05. | |
| shipping_description | No |