Create Order
starshipit_create_orderCreate a new StarShipIt order with recipient, items, and shipping details, placing it in the unshipped queue for label generation.
Instructions
Create a new order in StarShipIt. The order will appear in the unshipped queue ready for label generation.
When to use: Call this when a new order has been placed and needs to be imported into StarShipIt for fulfilment.
Parameters (all under order object):
order_number(required) — Merchant order number (must be unique)destination(required) — Recipient address (name, street, post_code, country are required)order_date(optional) — ISO timestamp when the order was placedreference(optional) — Secondary reference (e.g. customer PO)carrier/carrier_name(optional) — Pre-assign a carriershipping_method(optional) — Service level (e.g. "Express")signature_required(optional) — Require signature on deliveryreturn_order(optional) — Mark as a return orderitems(optional) — Array of line itemspackages(optional) — Array of package dimensions/weights
Returns: Created Order object with assigned order_id.
Errors: 400 if required fields missing or invalid; 409 if order_number already exists; 401 if API keys invalid.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| order | Yes | Order data to create |
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) |