For the complete documentation index, see llms.txt.
Models
Starshipit API model
Create Order - Order Model
Field names, types, and descriptions for this shared API model.
16 fields
Referenced models
These fields use another model for their nested structure.
| Attribute | Type | Description |
|---|---|---|
| order_date (optional) | datetime | The date when the order was created in UTC |
| order_number | string | The identifier of the order pulled from source e-Commerce platform (max length: 50) |
| reference (optional) | string | Customer's reference (max length: 50) |
| shipping_method (optional) | string | Delivery method name (max length: 100) |
| shipping_description (optional) | string | Delivery method description (max length: 100) |
| shipping_freight_value | double | The value of the freight being shipped |
| signature_required (optional) | boolean | Determine whether signature is needed on delivery |
| return_order (optional) | boolean | If true, only the return label will be generated |
| currency (optional) | string | Currency code for the order value (max length: 3) e.g. AUD |
| sender_details (optional) | Sender Details Model | Sender address and contact details |
| destination | Destination Details Model | Shipping address and contact details |
| items (optional) | Create Order - Item Model list | Item list containing the order item details |
| packages (optional) | Create Order - Package Model list | Package list containing the parcel details |
| dangerous_goods (optional) | boolean | Determine whether the shipment contains dangerous goods. |
| dangerous_goods_type (optional) | Dangerous Goods Type Model list | Dangerous goods type entries for the order. |
| customs (optional) | Customs Model | Customs information such as incoterm, export reason, invoice remarks, and documents. |