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.

AttributeTypeDescription
order_date (optional)datetimeThe date when the order was created in UTC
order_numberstringThe identifier of the order pulled from source e-Commerce platform (max length: 50)
reference (optional)stringCustomer's reference (max length: 50)
shipping_method (optional)stringDelivery method name (max length: 100)
shipping_description (optional)stringDelivery method description (max length: 100)
shipping_freight_valuedoubleThe value of the freight being shipped
signature_required (optional)booleanDetermine whether signature is needed on delivery
return_order (optional)booleanIf true, only the return label will be generated
currency (optional)stringCurrency code for the order value (max length: 3) e.g. AUD
sender_details (optional)Sender Details ModelSender address and contact details
destinationDestination Details ModelShipping address and contact details
items (optional)Create Order - Item Model listItem list containing the order item details
packages (optional)Create Order - Package Model listPackage list containing the parcel details
dangerous_goods (optional)booleanDetermine whether the shipment contains dangerous goods.
dangerous_goods_type (optional)Dangerous Goods Type Model listDangerous goods type entries for the order.
customs (optional)Customs ModelCustoms information such as incoterm, export reason, invoice remarks, and documents.