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.

AttributeTypeDescription
order_idintegerThe unique numeric identifier for the order
order_datedatetimeThe date when the order was created in UTC
order_numberstringThe identifier of the order pulled from source e-Commerce platform
referencestringCustomer's reference
carrierstringThe carrier that will be used when creating shipment
carrier_namestringName of the carrier used for shipment delivery
carrier_service_codestringCarrier service code for delivery
shipping_methodstringDelivery method name
shipping_descriptionstringDelivery method description
signature_requiredbooleanDetermine whether signature is needed on delivery
dangerous_goodsbooleanDetermine whether shipment contains dangerous goods
currencystringCurrency code for the order value (e.g. AUD)
sender_detailsSender Details ModelSender address and contact details
destinationDestination Details ModelShipping address and contact details
itemsFull Item Model listItem list containing the order item details
packagesFull Package Model listPackage list containing the parcel details
metadatasMeta Data Model listAdditional meta data for the order
eventsEvent Model listHistorical events associated with this order
declared_valuedoubleDeclared value of an international order
archivedbooleanDetermine whether a shipment is archived
manifest_numberintegerCarrier manifest identifier
address_validationstringDetermine whether an address is validated for a shipment. NotChecked, Valid or Invalid
child_consignment_idsstringDisplays child consignment ids if the shipment has been merged
create_returnbooleanDetermine whether a return label was generated when outgoing label was generated
dtpbooleanDetermine whether duty and tax has been paid for a shipment
export_typestringExport type of a shipment
add_insurancebooleanDetermine whether shipment has insurance
insurance_valuedoubleShipment insurance value
pltbooleanDetermine whether shipment is paperless trade
typeenumType of shipment. Outgoing, Return or Transfer
platformstringThe order platform
statusstringThe order status. Unshipped, Saved, Printed or Delivered)
manifestedbooleanDetemine whether shipment is manifested
dangerous_goods_typeDangerous Goods Type Model listDangerous goods type entries for the order.
billingBilling ModelSold-to or billing address details associated with the order.
customsCustoms ModelCustoms information such as incoterm, export reason, invoice remarks, and documents.
writeback_statusstringThe status of the order writeback to the e-Commerce platform.
writeback_detailsstringThe full result message returned by the e-Commerce platform after order writeback.
duties_amountdecimalDuties amount charged for the shipment.
tax_amountdecimalTax amount charged for the shipment.
price_breakdownobjectUnstructured shipping price data.
total_shipping_pricedecimalPrice of shipping.
total_shipping_currencystringCurrency for total_shipping_price.
custom_margin_valuedecimalCustom margin value set by the user.
shipping_freight_valuedecimalShipping or freight value for the buyer to pay, not the shipping cost to the sender.
outgoing_order_idintegerFor return orders, the id of the original outgoing order.
return_optionstringReturn option selected when creating the return, for example pickup or dropoff.
return_methodstringReturn method selected when creating the return, for example credit, refund, or exchange.
tagsstring listAny tags applied to the order.
has_commercial_invoicebooleanDetermine whether the shipment has a commercial invoice.
is_fully_packedbooleanIndicates whether the shipment has been marked as fully packed.
bbx_parent_idstringDHL BBX product parent ID.
bbx_pallet_idstringDHL BBX product pallet ID.
nfe_keystringDHL NFe Key.
service_point_idstringDHL service point identifier imported from Shopify.
notestringInternal order note.
landed_costsobjectDHL Express landed costs.
cod_valuedecimalCash on delivery adjusted shipment value.