[COMPLETED] Completely Executable Shipment Object

These are the requirements for creating a valid shipment with every optional parameter available.

Requirements

📘

Requirements:

  1. ShipmentContent Object
  2. ShipmentStop Object
  3. ShipmentStopAppointment Object
  4. Orders Object
  5. OrdersCommodity Object

Completed JSON Object

Here is an example of a shipment with all optional and required parameters:

{
   "FreightProviderReferenceNumber":"345345345",
   "CarrierSCAC":"TEST",
   "Stops":[
      {
         "StopReference":"stop1",
         "StopScheduledDatePart":"2018-08-11",
         "StopScheduledStartTimePart": "00:46:06",
         "StopScheduledEndTimePart": "22:46:06",
         "StopSequence":1,
         "StopType":1,
         "Latitude":50.1234,
         "Longitude":-45.1234,
         "StreetAddress1":"4888 Pearl E Cir",
         "StreetAddress2":"300W",
         "City":"Boulder",
         "State":"CO",
         "PostalCode":"80301",
         "Country":"US",
         "StopDescription":"Visibility",
         "StopName":"10-4 Systems",
         "StopContactName":"Good Buddy",
         "StopContactPhoneNumber":"1234567891",
         "StopContactEmailAddress":"[email protected]",
         "StopContactFaxNumber":"0198765432",
         "StopContactPhoneExtension":"887",
         "LocationCode":null,
         "DwellTime":50,
         "Appointment":{
            "AppointmentType":1,
            "AppointmentDatePart":"2018-08-11",
            "AppointmentStartTimePart":"00:15:32",
            "AppointmentEndTimePart":"17:31:42"
         }
      },
      {
         "StopReference":"stop2",
         "StopScheduledDatePart":"2018-08-12",
         "StopScheduledStartTimePart": "00:46:06",
         "StopScheduledEndTimePart": "22:46:06",
         "StopSequence":2,
         "StopType":2,
         "Latitude":51.4110,
         "Longitude":-42.9803,
         "StreetAddress1":"10368 Westmoor Dr",
         "StreetAddress2":null,
         "City":"Westminster",
         "State":"CO",
         "PostalCode":"80021",
         "Country":"US",
         "StopDescription":"Trimble Westminster",
         "StopName":"Trimble",
         "StopContactName":"Bryn Fosburgh",
         "StopContactPhoneNumber":"1821194829",
         "StopContactEmailAddress":"[email protected]",
         "StopContactFaxNumber":"1124492283",
         "StopContactPhoneExtension":"127",
         "LocationCode":null,
         "DwellTime":10
      },
      {
         "StopReference":"stop3",
         "StopScheduledDatePart":"2018-08-13",
         "StopScheduledStartTimePart": "00:46:06",
         "StopScheduledEndTimePart": "22:46:06",
         "StopSequence":3,
         "StopType":3,
         "Latitude":50.4920,
         "Longitude":-44.5543,
         "StreetAddress1":"935 Stewart Drive",
         "StreetAddress2":null,
         "City":"Sunnyvale",
         "State":"CA",
         "PostalCode":"94085",
         "Country":"US",
         "StopDescription":"Destination",
         "StopName":"Trimble HQ",
         "StopContactName":"Wyatt Hello",
         "StopContactPhoneNumber":"5553291185",
         "StopContactEmailAddress":"[email protected]",
         "StopContactFaxNumber":"9402742273",
         "StopContactPhoneExtension":"183",
         "LocationCode":null,
         "DwellTime":30,
         "Appointment":{
            "AppointmentType":1,
            "AppointmentDatePart":"2018-08-13",
            "AppointmentEndDatePart":"2018-08-14",
            "AppointmentStartTimePart":"11:12:30",
            "AppointmentEndTimePart":"12:22:30"
         }
      }
   ],
   "Orders":[
      {
         "Commodities":[
            {
               "PieceDescription":".14ISPIECEOFPI",
               "Height":32,
               "IsHazardous":0,
               "IsStackable":1,
               "CommodityName":"Commodian",
               "Length":12,
               "LinearUnit":"2",
               "PieceCount":8,
               "PieceUnit":"3",
               "ProductBrand":"VISIBILITY ALE",
               "ProductLine":"DOUBLE VISION",
               "PurchaseOrderNumber":"10-4Av2",
               "Volume":313,
               "VolumeUnit":"1",
               "WeightAmount":11644,
               "WeightUnit":"1",
               "Width":29
            }
         ],
         "PickupStopReference":"stop1",
         "DeliveryStopReference":"stop2",
         "OrderNumber":"JUSTANORDERNARYORDER1",
         "CustomerName":"Jonesy",
         "CustomerReference":"APICUSTOMERGUYORGAL",
         "OrderDateTime": "11/17/2021 9:30",
         "OrderTypeName": "Custom2",
         "ServiceLevel": "Urgent2",
         "OrderReference": "2073524REF2"
      }
   ],
   "Equipment":7,
   "EquipmentSize":32,
   "ModeType":2,
   "TractorReferenceNumber":188,
   "TrailerReferenceNumber":9103,
   "IsDropTrailer":1,
   "DriverFirstName":"Emilio",
   "DriverLastName":"Estevez",
   "DriverPhoneNumber":"5558675309",
   "DriverEmailAddress":"[email protected]",
   "TenantExternalId":839281,
   "HasTeamDrivers":1,
   "MinimumTemperature":68.22,
   "MaximumTemperature":76.64,
   "ShipmentStatus": 1,    
   "HaulLinearUnitType": 1,
   "WeightDisplayUnitType": 1, 
   "ShipmentStopNote":[
      {
         "Text":"This is a test Stop Note"
      }
   ],
   "ReferenceNumbers":[
      {
         "ReferenceNumberType":"17",
         "ReferenceNumberValue":"CONT2343"
      },
      {
         "ReferencenumberType":"3",
         "ReferenceNumberValue":"WO123"
      }
   ]
}