ShipmentCreateUrl

Fires when a new shipment is created in the TMS.

Triggers

Shipment created in BackOffice UI (New Shipment form)
Shipment created via Public API POST
Shipment created via EDI 204 inbound
System-generated shipment (e.g. incomplete shipment resolution)

Delivery

Batched with a ~1-minute delay after the triggering event. Multiple edits to the same shipment within the window coalesce into a single delivery.

Notes

If ShipmentCreateUrl is not configured but ShipmentDetailUpdateUrl is, the creation event delivers to ShipmentDetailUpdateUrl instead — with isCreate=true semantics.
One shipment can fire this once at most (subsequent edits fire ShipmentDetailUpdateUrl or ShipmentStatusUpdateUrl).

Payload — `ShipmentDetails`

Field	Type	Nullable	Description
`shipmentId`	integer	No	Unique shipment identifier.
`status`	string (enum)	No	Current shipment status (see Versioning for V2 vs V3 label differences).
`shipmentType`	string (enum)	No	Mode of transport (e.g., `LTL`, `TL`, `Parcel`).
`serviceLevel`	string (enum)	No	Service level (e.g., `Standard`, `Expedited`).
`stackable`	boolean	No	Whether freight can be stacked.
`trailerType`	string (enum)	Yes	Required trailer type.
`trailerSize`	string (enum)	Yes	Trailer size (e.g., `FT53`, `FT48`).
`weightUnits`	string (enum)	Yes	`LBS` or `KGS`.
`dimensionUnits`	string (enum)	Yes	`IN` or `CM`.
`importExport`	string (enum)	Yes	Import/export flag if applicable.
`mileage`	decimal	No	Total estimated mileage.
`transitTime`	integer	Yes	Estimated transit time in days.
`totalBuy`	decimal	No	Total carrier cost.
`totalSell`	decimal	No	Total customer charge.
`latitude`	number	Yes	Last known GPS latitude.
`longitude`	number	Yes	Last known GPS longitude.
`locationString`	string	Yes	Human-readable last known location.
`lastLocationUpdate`	string (datetime)	Yes	UTC timestamp of the most recent location ping.
`driverCellPhoneNumber`	string	Yes	Driver's cell phone number.
`hazmatEmergencyContactNumber`	string	Yes	Emergency contact for hazmat.
`customer`	`CustomerDetailsV2`	No	Customer record.
`carrierRep`	`StaffDTO`	Yes	TMS staff assigned as carrier rep.
`payerOrganization`	`PayerOrganization`	No	Billing organization.
`stops`	`ShippingAddress[]`	No	Ordered list of shipment stops.
`commodities`	`Commodity[]`	No	Freight commodity records.
`accessorialCodes`	`Accessorial[]`	No	Accessorial services applied.
`shipmentReferenceNumbers`	`ReferenceNumber[]`	No	Shipment-level reference numbers.
`shipmentAlerts`	`ShipmentAlert[]`	No	Active alerts.
`carrierList`	`CarrierDetails[]`	No	Carriers assigned (supports multi-leg).
`attachments`	`Attachment[]`	No	Files attached to the shipment.

Example

{
    "latitude": 42.61458,
    "longitude": -89.62367,
    "locationString": "06/30 08:04 ET : North 29th Avenue, Monroe, WI, 53566",
    "lastLocationUpdate": "2026-06-30T12:04:00Z",
    "mileage": 4093.64,
    "customer": {
      "name": "Acme Manufacturing",
      "referenceNumber": null,
      "staffID": 896203,
      "staffName": "Shipping",
      "staffReferenceNumber": null,
      "salesRepNames": "Sales Rep",
      "billToOrganizationId": 217393,
      "officeOrganizationId": 798833,
      "officeName": "Field Sales"
    },
    "carrierRep": {
      "staffId": 1040914,
      "contactName": "Acme Automation",
      "email": null,
      "phone": null
    },
    "payerOrganization": {
      "organizationId": 217393,
      "name": "Acme Manufacturing",
      "address": {
        "streetAddress": "8950 Seward Road",
        "streetAddressTwo": null,
        "city": "Fairfield",
        "state": "OH",
        "zipCode": "45014",
        "country": "USA",
        "contactName": null
      }
    },
    "totalBuy": 1500.00,
    "totalSell": 1600.00,
    "status": "Delivered",
    "carrierList": [
      {
        "carrierMasterId": 516202,
        "transitLegId": 29837094,
        "shipmentStopIds": [54235677, 54659984, 54235678],
        "name": "Sample Carrier Corp",
        "scac": "",
        "dotNumber": "3305176",
        "mcNumber": "1048914",
        "trackingURL": "",
        "city": "Murfreesboro",
        "state": "TN",
        "zipCode": "37129",
        "phoneNumber": "+15551234567",
        "tariffName": null,
        "transitType": "Linehaul",
        "status": "Delivered",
        "buy": 1500.00,
        "sell": 1600.00,
        "parentShipmentId": null,
        "childShipmentIds": []
      }
    ],
    "attachments": [
      {
        "attachmentName": "CarrierConfirmationTruckload_130037578_signed.pdf",
        "attachmentUrl": "https://<tenant>.taicloud.net/Files/SecureDownload?token=<token>",
        "attachmentType": "Carrier Confirmation",
        "documentId": 63309845
      },
      {
        "attachmentName": "RateQuoteSheet_130037578.pdf",
        "attachmentUrl": "https://<tenant>.taicloud.net/Files/SecureDownload?token=<token>",
        "attachmentType": "Document",
        "documentId": 63309861
      }
    ],
    "shipmentType": "Truckload",
    "stackable": false,
    "trailerType": "53 ft Van | Dry",
    "trailerSize": "Full",
    "weightUnits": "lbs",
    "dimensionUnits": "in",
    "serviceLevel": "Normal",
    "importExport": null,
    "shipmentReferenceNumbers": [
      { "referenceType": "Shipper Reference Number",         "value": "63746" },
      { "referenceType": "Customer PO Number",               "value": "QSTP000019138" },
      { "referenceType": "Trailer Number",                   "value": "012" },
      { "referenceType": "Tracking Reference Number",        "value": "Stop 1 Arrived 06/29 12:38 - Chain (Geofence)" },
      { "referenceType": "Driver Cell Phone Number",         "value": "+15551234567" },
      { "referenceType": "Linehaul Carrier Pro Number",      "value": "63746" },
      { "referenceType": "Driver Name",                      "value": "Sample Driver" },
      { "referenceType": "Truck Number",                     "value": "104" },
      { "referenceType": "Carrier Dispatcher Name",          "value": "Alex" },
      { "referenceType": "Carrier Dispatcher Phone Number",  "value": "+15551234567" },
      { "referenceType": "Carrier Rep",                      "value": "Sample Rep" },
      { "referenceType": "Customer Confirmation",            "value": "False" },
      { "referenceType": "Carrier Confirmation",             "value": "False" },
      { "referenceType": "Carrier Dispatcher Email",         "value": "[email protected]" },
      { "referenceType": "Offer Rate",                       "value": "1450" },
      { "referenceType": "Min Buy Rate",                     "value": "1350" },
      { "referenceType": "Max Buy Rate",                     "value": "1550" },
      { "referenceType": "External Carrier Confirmation Id", "value": "10107785|20242312" },
      { "referenceType": "Shipment Id",                      "value": "130037578" },
      { "referenceType": "Linehaul Carrier Pro Number Clean","value": "63746" },
      { "referenceType": "Built by",                         "value": "Sample User" },
      { "referenceType": "Tracking Check Call Notes",        "value": "Empty in Walton, KY" },
      { "referenceType": "Tracking Miles to Next Stop",      "value": "0.1 miles to Stop 2 : 06/30 08:04 ET" },
      { "referenceType": "Est ETA",                          "value": "06/30 08:00 CT" },
      { "referenceType": "VIN",                              "value": "1XKYD00X0XX000000" },
      { "referenceType": "Customer Tracking Link",           "value": "https://example.com/tracking/307e91da" }
    ],
    "stops": [
      {
        "shipmentStopId": 54235677,
        "companyName": "Acme Manufacturing",
        "streetAddress": "8950 Seward Rd.",
        "streetAddressTwo": null,
        "city": "Fairfield",
        "state": "OH",
        "zipCode": "45011",
        "country": "USA",
        "contactName": "Shipping/Receiving",
        "phone": "+15551234567",
        "fax": null,
        "email": null,
        "instructions": "MUST HAVE LOCKS OR STRAPS TO SECURE",
        "notes": "SET RATE -- 4PM",
        "referenceNumber": null,
        "estimatedReadyDateTime": "2026-06-29T12:00:00+00:00",
        "estimatedCloseDateTime": "2026-06-29T18:00:00+00:00",
        "appointmentReadyDateTime": null,
        "appointmentCloseDateTime": null,
        "actualArrivalDateTime": "2026-06-29T16:38:00+00:00",
        "actualDepartureDateTime": null,
        "stopType": "First Pickup",
        "shipmentStopReferenceNumbers": [],
        "shipmentStopPickupCommodities": [
          {
            "shipmentCommodityId": 36866679,
            "pickupStopId": null,
            "deliveryStopId": null
          }
        ],
        "shipmentStopDeliveryCommodities": []
      },
      {
        "shipmentStopId": 54659984,
        "companyName": "Intermediate Stop",
        "streetAddress": "555 Main Street",
        "streetAddressTwo": "Suite 1",
        "city": "Anaheim",
        "state": "CA",
        "zipCode": "92807",
        "country": "USA",
        "contactName": null,
        "phone": null,
        "fax": null,
        "email": null,
        "instructions": null,
        "notes": null,
        "referenceNumber": null,
        "estimatedReadyDateTime": "2026-06-29T21:00:00+00:00",
        "estimatedCloseDateTime": "2026-06-29T22:00:00+00:00",
        "appointmentReadyDateTime": null,
        "appointmentCloseDateTime": null,
        "actualArrivalDateTime": "2026-06-29T20:00:00+00:00",
        "actualDepartureDateTime": null,
        "stopType": "Both",
        "shipmentStopReferenceNumbers": [],
        "shipmentStopPickupCommodities": [],
        "shipmentStopDeliveryCommodities": []
      },
      {
        "shipmentStopId": 54235678,
        "companyName": "Sample Consignee",
        "streetAddress": "303 North 29th Ave",
        "streetAddressTwo": null,
        "city": "Monroe",
        "state": "WI",
        "zipCode": "53566",
        "country": "USA",
        "contactName": null,
        "phone": null,
        "fax": null,
        "email": null,
        "instructions": null,
        "notes": null,
        "referenceNumber": null,
        "estimatedReadyDateTime": "2026-06-30T13:00:00+00:00",
        "estimatedCloseDateTime": "2026-06-30T16:00:00+00:00",
        "appointmentReadyDateTime": null,
        "appointmentCloseDateTime": null,
        "actualArrivalDateTime": null,
        "actualDepartureDateTime": null,
        "stopType": "Last Drop",
        "shipmentStopReferenceNumbers": [],
        "shipmentStopPickupCommodities": [],
        "shipmentStopDeliveryCommodities": [
          {
            "shipmentCommodityId": 36866679,
            "pickupStopId": null,
            "deliveryStopId": null
          }
        ]
      }
    ],
    "commodities": [
      {
        "shipmentCommodityId": 36866679,
        "handlingQuantity": 1,
        "packagingType": "Skid",
        "length": null,
        "width": null,
        "height": null,
        "weightTotal": 15000.0,
        "hazardousMaterial": false,
        "piecesTotal": 1,
        "freightClass": "70",
        "nmfc": "120700-19",
        "description": "Conveyors, Elevators or Lifts",
        "additionalMarkings": null,
        "unNumber": null,
        "packingGroup": null,
        "referenceNumber": null,
        "hazmatCustomClassDescription": null,
        "hazmatPieceDescription": null,
        "harmonizedCode": null,
        "hazardClasses": [],
        "shipmentCommodityReferenceNumbers": []
      }
    ],
    "accessorialCodes": [],
    "shipmentAlerts": [
      {
        "type": "On Hand Origin",
        "alertId": 2,
        "createdDate": "2026-06-29T16:38:59+00:00",
        "resolved": true,
        "shipmentStopId": null
      },
      {
        "type": "AI Agent Call",
        "alertId": 271,
        "createdDate": "2026-07-22T15:36:28+00:00",
        "resolved": false,
        "shipmentStopId": null
      },
      {
        "type": "Team: Purple Team",
        "alertId": 477,
        "createdDate": "2026-06-29T14:15:27+00:00",
        "resolved": false,
        "shipmentStopId": null
      },
      {
        "type": "Customer Approved Quote",
        "alertId": 1005,
        "createdDate": "2026-06-29T14:16:25+00:00",
        "resolved": false,
        "shipmentStopId": null
      }
    ],
    "driverCellPhoneNumber": "+15551234567",
    "hazmatEmergencyContactNumber": null,
    "transitTime": null,
    "shipmentId": 130037578
}

Updated 4 days ago

Did this page help you?