For the complete documentation index, see llms.txt.
Models
Starshipit API model
Update Order - Order Model
Field names, types, and descriptions for this shared API model.
33 fields
Referenced models
These fields use another model for their nested structure.
| Attribute | Type | Description |
|---|---|---|
| order_id (read-only) | integer | The unique numeric identifier for the order |
| order_date | 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 | string | Customer's reference (max length: 50) |
| carrier | string | The carrier that will be used when creating shipment |
| carrier_service_code | string | Carrier service code for delivery |
| shipping_method | string | Delivery method name (max length: 100) |
| shipping_description | string | Delivery method description (max length: 100) |
| shipping_freight_value | double | The value of the freight being shipped |
| signature_required | boolean | Determine whether signature is needed on delivery |
| currency | string | Currency code for the order value (max length: 3) e.g. AUD |
| sender_details | Sender Details Model | Sender address and contact details |
| destination | Destination Details Model | Shipping address and contact details |
| items | Update Order - Item Model list | Item list containing the order item details |
| packages | Update Order - Package Model list | Package list containing the parcel details |
| metadatas | Meta Data Model list | Additional meta data for the order |
| status | string | The order status |
| is_manifested | boolean | Determine if the order is manifested |
| billing | Billing Model | Additional party or sold-to address details associated with the order. |
| customs | Customs Model | Customs information such as incoterm, export reason, invoice remarks, and documents. |
| total_shipping_price | decimal | The cost of shipping charged from the carrier to the account holder. |
| duties_amount | decimal | Duties amount charged for the shipment. |
| tax_amount | decimal | Tax amount charged for the shipment. |
| return_order | boolean | Indicate if the order is a return order. |
| outgoing_order_id | integer | For return orders, the id of the original outgoing order. |
| carrier_service_name | string | Carrier service name to use when the selected carrier does not provide one. |
| dangerous_goods_type | Dangerous Goods Type Model list | Dangerous goods type entries for the order. |
| is_fully_packed | boolean | Indicates whether the shipment has been marked as fully packed. |
| bbx_parent_id | string | DHL BBX product parent ID. |
| bbx_pallet_id | string | DHL BBX product pallet ID. |
| nfe_key | string | DHL NFe Key. |
| note | string | Internal order note. This field can be updated after print. |
| cod_value | decimal | Adjusted shipment value for cash on delivery orders. |