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.

AttributeTypeDescription
order_id (read-only)integerThe 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 (max length: 50)
referencestringCustomer's reference (max length: 50)
carrierstringThe carrier that will be used when creating shipment
carrier_service_codestringCarrier service code for delivery
shipping_methodstringDelivery method name (max length: 100)
shipping_descriptionstringDelivery method description (max length: 100)
shipping_freight_valuedoubleThe value of the freight being shipped
signature_requiredbooleanDetermine whether signature is needed on delivery
currencystringCurrency code for the order value (max length: 3) e.g. AUD
sender_detailsSender Details ModelSender address and contact details
destinationDestination Details ModelShipping address and contact details
itemsUpdate Order - Item Model listItem list containing the order item details
packagesUpdate Order - Package Model listPackage list containing the parcel details
metadatasMeta Data Model listAdditional meta data for the order
statusstringThe order status
is_manifestedbooleanDetermine if the order is manifested
billingBilling ModelAdditional party or sold-to address details associated with the order.
customsCustoms ModelCustoms information such as incoterm, export reason, invoice remarks, and documents.
total_shipping_pricedecimalThe cost of shipping charged from the carrier to the account holder.
duties_amountdecimalDuties amount charged for the shipment.
tax_amountdecimalTax amount charged for the shipment.
return_orderbooleanIndicate if the order is a return order.
outgoing_order_idintegerFor return orders, the id of the original outgoing order.
carrier_service_namestringCarrier service name to use when the selected carrier does not provide one.
dangerous_goods_typeDangerous Goods Type Model listDangerous goods type entries for the order.
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.
notestringInternal order note. This field can be updated after print.
cod_valuedecimalAdjusted shipment value for cash on delivery orders.