For the complete documentation index, see llms.txt.
Models
Starshipit API model
Full Order Model
Field names, types, and descriptions for this shared API model.
58 fields
Referenced models
These fields use another model for their nested structure.
| Attribute | Type | Description |
|---|---|---|
| order_id | 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 |
| reference | string | Customer's reference |
| carrier | string | The carrier that will be used when creating shipment |
| carrier_name | string | Name of the carrier used for shipment delivery |
| carrier_service_code | string | Carrier service code for delivery |
| shipping_method | string | Delivery method name |
| shipping_description | string | Delivery method description |
| signature_required | boolean | Determine whether signature is needed on delivery |
| dangerous_goods | boolean | Determine whether shipment contains dangerous goods |
| currency | string | Currency code for the order value (e.g. AUD) |
| sender_details | Sender Details Model | Sender address and contact details |
| destination | Destination Details Model | Shipping address and contact details |
| items | Full Item Model list | Item list containing the order item details |
| packages | Full Package Model list | Package list containing the parcel details |
| metadatas | Meta Data Model list | Additional meta data for the order |
| events | Event Model list | Historical events associated with this order |
| declared_value | double | Declared value of an international order |
| archived | boolean | Determine whether a shipment is archived |
| manifest_number | integer | Carrier manifest identifier |
| address_validation | string | Determine whether an address is validated for a shipment. NotChecked, Valid or Invalid |
| child_consignment_ids | string | Displays child consignment ids if the shipment has been merged |
| create_return | boolean | Determine whether a return label was generated when outgoing label was generated |
| dtp | boolean | Determine whether duty and tax has been paid for a shipment |
| export_type | string | Export type of a shipment |
| add_insurance | boolean | Determine whether shipment has insurance |
| insurance_value | double | Shipment insurance value |
| plt | boolean | Determine whether shipment is paperless trade |
| type | enum | Type of shipment. Outgoing, Return or Transfer |
| platform | string | The order platform |
| status | string | The order status. Unshipped, Saved, Printed or Delivered) |
| manifested | boolean | Detemine whether shipment is manifested |
| dangerous_goods_type | Dangerous Goods Type Model list | Dangerous goods type entries for the order. |
| billing | Billing Model | Sold-to or billing address details associated with the order. |
| customs | Customs Model | Customs information such as incoterm, export reason, invoice remarks, and documents. |
| writeback_status | string | The status of the order writeback to the e-Commerce platform. |
| writeback_details | string | The full result message returned by the e-Commerce platform after order writeback. |
| duties_amount | decimal | Duties amount charged for the shipment. |
| tax_amount | decimal | Tax amount charged for the shipment. |
| price_breakdown | object | Unstructured shipping price data. |
| total_shipping_price | decimal | Price of shipping. |
| total_shipping_currency | string | Currency for total_shipping_price. |
| custom_margin_value | decimal | Custom margin value set by the user. |
| shipping_freight_value | decimal | Shipping or freight value for the buyer to pay, not the shipping cost to the sender. |
| outgoing_order_id | integer | For return orders, the id of the original outgoing order. |
| return_option | string | Return option selected when creating the return, for example pickup or dropoff. |
| return_method | string | Return method selected when creating the return, for example credit, refund, or exchange. |
| tags | string list | Any tags applied to the order. |
| has_commercial_invoice | boolean | Determine whether the shipment has a commercial invoice. |
| 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. |
| service_point_id | string | DHL service point identifier imported from Shopify. |
| note | string | Internal order note. |
| landed_costs | object | DHL Express landed costs. |
| cod_value | decimal | Cash on delivery adjusted shipment value. |