Shipment Model

Attribute	Type	Description
ConsignmentNo	string	Shipment consignment number.
Consignee	string	Shipment consignee name.
ManualTicket	boolean	False when the shipment originated from an external orders source, such as an integrated system or shopfiy. True when the ticket was create using the GSS UI.
PackingSlipNo	string	Order/packing slip number for integrated orders or Delivery Reference when created using the GSS UI.
Picked	datetime (nullable)	Date/time goods picked by courier. Time local to pickup origi.
Delivered	datetime (nullable)	Date/time goods delivered to receiver. Time local to delivery address.
Status	string	Latest courier tracking status of the shipment.
TotalCost	decimal	Total cost of the shipment excluding taxes where applicable.
Tracking	string	Track and trace url for live tracking of the order.
OriginZone	string	Short code for the origin zone of the consignment.
DestinationZone	string	Short code for the destination zone of the consignment.
CostCentre	string	Name of the associated cost centre.
Carrier	string	Carrier name.
DeliveryInstructions	string	Instructions for delivery driver.
IsSaturdayDelivery	bool	If delivery will be attempted on Saturday, when applicable.
IsRuralDelivery	bool	If the destination has been determined to be rural.
IsResidentialDelivery	bool(Nullable)	If the destination has been determined to be residential.
IsPOBox	bool	If the destination has been determined to be a PO Box, ParcelPod, etc.
CustomerRef	string	Reference number.
TotalCubic	decimal	Sum of cubic volume of all items in this consignment. Denoted in m3.
CreatedUtc	datetime	When the shipment has been created
CreatedBy	string	Who created the shipment
TotalKg	decimal	Sum of weight of all items in this consignment. Denoted in kg.
Parts	int	Number of items in this consignment.
IsSignatureRequired	bool	True if the delivery driver needs to collect a signature.
IsFreightForward	bool	True if this is a freight-forward consignment.
ManifestedAt	datetime (nullable)	Date and time manifestedAt. null when not manifest yet.
ManifestNumber	string	ManifestNumber of shipment.
Parts	int	Number of items in this consignment.
Origin	object	Sender details. (Contact Model)
Destination	object	Destination details. (Contact Model)
Items	object list	Shipment packages. (Shipment Package Model)
CustomField1Name	string	Custom Field 1 Name. If not set up, then null.
CustomField1Value	string	Custom Field 1 Value. If not set up or added in the consignment, then null.
CustomField2Name	string	Custom Field 2 Name. If not set up, then null.
CustomField2Value	string	Custom Field 2 Value. If not set up or added in the consignment, then null.