Shipment events
shipment.accessorials.updated
Example
{
"id": "01GPCVGSSTCESCA145JPY7B7QP",
"occurred_at": "2023-01-10T03:27:55.363609+00:00",
"source": {
"user_id": "41741659-b4fb-4fbf-9887-91ceed79eebd",
"company_id": "a54ef012-77d4-44a0-8ba5-115b09b655be",
"request_id": "6b335860-361b-490b-97bd-b942ece7990a",
"publishing_system": "backend",
"environment": "dev"
},
"event_name": "shipment.accessorials.updated",
"details": {
"id": "ec9ed888-751f-4592-853a-f7dc0481b867",
"new_data": {
"accessorials": [
"GUR"
]
},
"old_data": {
"accessorials": []
},
"self_link": "/v2/shipments/ec9ed888-751f-4592-853a-f7dc0481b867/",
"resource_type": "shipment"
}
}shipment.bol.created
Example
{
"1": {
"id": "73897d6d-a8d7-4df3-b5d7-9d4dbfc82d76",
"driver": null,
"company": {
"id": "a54ef012-77d4-44a0-8ba5-115b09b655be",
"self_link": "/v2/companies/a54ef012-77d4-44a0-8ba5-115b09b655be/",
"resource_type": "company"
},
"shipment": {
"id": "f25d63e6-97ac-45f9-b8c0-c5cf036b8c86",
"self_link": "/v2/shipments/f25d63e6-97ac-45f9-b8c0-c5cf036b8c86/",
"resource_type": "shipment"
},
"self_link": "/v2/shipments/f25d63e6-97ac-45f9-b8c0-c5cf036b8c86/documents/73897d6d-a8d7-4df3-b5d7-9d4dbfc82d76/",
"document_id": "7a3d87aa-3fad-4b88-89cd-bc9d4430a020",
"resource_type": "shipment_bol"
}
}shipment.document.created
Example
Note
The list of supported document types is available as reference data here.
{
"id": "01JFG2H67WRZYJ4F4J60F69MBK",
"occurred_at": "2025-01-02T03:26:55.363609+00:00",
"source": {
"user_id": "41741659-b4fb-4fbf-9887-91ceed79eebd",
"company_id": "a54ef012-77d4-44a0-8ba5-115b09b655be",
"request_id": "a3501107-962c-4f57-b21c-4325377108ee",
"publishing_system": "backend",
"environment": "dev"
},
"event_name": "shipment.document.created",
"details": {
"id": "79cc835f-692d-4c22-ac86-48be46605598",
"resource_type": "shipment_document",
"type": "SIGNATURE",
"filename": "filename-of-file.pdf",
"description": "Original Description",
"url": "https://filedownload.example.com/x/abc124-long-lived-f90a2e39-73d8-4e10-8762-11583578fed7",
"shipment": {
"id": "ec9ed888-751f-4592-853a-f7dc0481b867",
"resource_type": "shipment",
"self_link": "/v2/shipments/ec9ed888-751f-4592-853a-f7dc0481b867/"
},
"self_link": "/v2/shipments/ec9ed888-751f-4592-853a-f7dc0481b867/documents/79cc835f-692d-4c22-ac86-48be46605598/"
}
}shipment.document.updated
Example
Note
The list of supported document types is available as reference data here.
{
"id": "01JFG2GDCR9GE1FZPH18APDZ2N",
"occurred_at": "2025-01-02T03:27:55.363609+00:00",
"source": {
"user_id": "41741659-b4fb-4fbf-9887-91ceed79eebd",
"company_id": "a54ef012-77d4-44a0-8ba5-115b09b655be",
"request_id": "6b335860-361b-490b-97bd-b942ece7990a",
"publishing_system": "backend",
"environment": "dev"
},
"event_name": "shipment.document.updated",
"details": {
"id": "79cc835f-692d-4c22-ac86-48be46605598",
"resource_type": "shipment_document",
"type": "SIGNATURE",
"old_data": {
"type": "OTHER",
"description": "Original Description"
},
"new_data": {"type": "BOL", "description": "Updated Description"},
"filename": "filename-of-file.pdf",
"description": "Updated Description",
"url": "https://filedownload.example.com/x/abc124-long-lived-f90a2e39-73d8-4e10-8762-11583578fed7",
"shipment": {
"id": "ec9ed888-751f-4592-853a-f7dc0481b867",
"resource_type": "shipment",
"self_link": "/v2/shipments/ec9ed888-751f-4592-853a-f7dc0481b867/"
},
"self_link": "/v2/shipments/ec9ed888-751f-4592-853a-f7dc0481b867/documents/79cc835f-692d-4c22-ac86-48be46605598/"
}
}shipment.charge_line_item.created
Example
{
"1": {
"id": "a0675df7-e06c-4af2-a9ea-3870d595b12e",
"resource_type": "shipment_charge_line_item",
"category": "LH",
"shipment": {
"id": "de9d2e59-e7b2-4525-bccf-333ee58ff0e3",
"self_link": "/v2/shipments/de9d2e59-e7b2-4525-bccf-333ee58ff0e3/",
"resource_type": "shipment"
},
"unit_name": "LINE_HAUL",
"charge_code": null,
"unit_amount": "1926.63",
"unit_quantity": 1
}
}shipment.charge_line_item.updated
Example
{
"metadata": {
"1": {
"publishing_system": "backend",
"request_id": "9a722652-b044-41f5-981b-8286fcbcbba2",
"event_name": "shipment.charge_line_item.updated",
"caused_by": {
"user_id": "4f44caa4-638c-45ae-8595-254d7ef80678",
"company_id": "a54ef012-77d4-44a0-8ba5-115b09b655be"
},
"occurred_at": "2022-08-01T03:28:48.214591+00:00"
}
},
"details": {
"1": {
"id": "c694e723-d121-4fc1-b6e0-662505b37abf",
"resource_type": "shipment_charge_line_item",
"shipment": {
"id": "f8780971-1d06-4b5c-a975-21f3a81b93b6",
"resource_type": "shipment",
"self_link": "/v2/shipments/f8780971-1d06-4b5c-a975-21f3a81b93b6/"
},
"old_data": {
"category": "LAYOVER",
"unit_name": "Layover"
},
"new_data": {
"category": "SF",
"unit_name": "Service Fee"
}
}
}
}shipment.charge_line_item.carrier_added
Example
Note
This event occurs when a shipment has a financial charge line item added by a carrier or service provider.
{
"id":"01J85R4PBFF81ET7A9M8KTCHCR",
"occurred_at":"2024-09-26T20:20:54.709432Z",
"event_name":"shipment.charge_line_item.carrier_added",
"details":{
"1":{
"id":"c694e723-d121-4fc1-b6e0-662505b37abf",
"resource_type":"shipment_charge_line_item",
"shipment":{
"id":"f8780971-1d06-4b5c-a975-21f3a81b93b6",
"resource_type":"shipment",
"self_link":"/v2/shipments/f8780971-1d06-4b5c-a975-21f3a81b93b6/"
},
"category":"LH",
"unit_name":"Freight",
"charge_code":"400",
"unit_amount":2750,
"unit_quantity":1,
"booking_party_id":"45898b8b-b100-44a8-8e7a-8ac27ea71d74",
"service_provider_id":"dc9a7f5b-6f0a-43b2-b27b-ba6878c6c8a5"
}
}
}shipment.charge_line_item.carrier_updated
Example
Note
This event occurs when a shipment has a financial charge line item updated by a carrier or service provider.
{
"id":"01J85R4PBFF81ET7A9M8KTCHCR",
"occurred_at":"2024-09-26T20:20:54.709432Z",
"event_name":"shipment.charge_line_item.carrier_updated",
"details":{
"1":{
"id":"c694e723-d121-4fc1-b6e0-662505b37abf",
"resource_type":"shipment_charge_line_item",
"shipment":{
"id":"f8780971-1d06-4b5c-a975-21f3a81b93b6",
"resource_type":"shipment",
"self_link":"/v2/shipments/f8780971-1d06-4b5c-a975-21f3a81b93b6/"
},
"new_data":{
"category":"LH",
"unit_name":"Freight",
"charge_code":"400",
"unit_amount":2850,
"unit_quantity":1
},
"old_data":{
"category":"LH",
"unit_name":"Freight",
"charge_code":"400",
"unit_amount":2750,
"unit_quantity":1
},
"booking_party_id":"45898b8b-b100-44a8-8e7a-8ac27ea71d74",
"service_provider_id":"dc9a7f5b-6f0a-43b2-b27b-ba6878c6c8a5"
}
}
}shipment.carrier_assigned
Example
{
"id":"01HJ70KMWY1ZVV7D7XJA2RT5QP",
"occurred_at":"2023-12-21T20:20:54.709432Z",
"event_name":"shipment.carrier_assigned",
"details":{
"1":{
"id":"6fde2b17-ec4f-4a11-9e53-e876cc4cbbc9",
"resource_type":"shipment",
"customer_id":"7733898e-4ab8-4e10-bda6-873972088edc",
"vendor_id":"971ecf14-1c46-416d-a3c0-cc94b6c6d1d7",
"assigned_as_carrier_at":"2024-03-19T10:56:21.396466-05:00",
"self_link":"/v2/shipments/6fde2b17-ec4f-4a11-9e53-e876cc4cbbc9/",
"carrier_relationship":{
"id":"d12897f3-21b7-47bc-9b06-2274071a9956",
"resource_type":"carrier_relationship",
"self_link":"/v2/carrier-relationships/d12897f3-21b7-47bc-9b06-2274071a9956/",
"name":"Carrier Co. Name"
}
}
}
}shipment.carrier_removed
Example
{
"id":"01HJ75E6J6FCSRBJ7VQT4SH47B",
"occurred_at":"2023-12-21T21:45:19.574333Z",
"event_name":"shipment.carrier_removed",
"details":{
"1":{
"id":"6fde2b17-ec4f-4a11-9e53-e876cc4cbbc9",
"resource_type":"shipment",
"customer_id":"7733898e-4ab8-4e10-bda6-873972088edc",
"vendor_id":"971ecf14-1c46-416d-a3c0-cc94b6c6d1d7",
"assigned_as_carrier_at":"2024-03-19T10:56:21.396466-05:00",
"self_link":"/v2/shipments/6fde2b17-ec4f-4a11-9e53-e876cc4cbbc9/"
}
}
}shipment.created
Example
{
"1": {
"id": "6ab16aad-64cb-44e8-bb1e-62c2989bb4cb",
"mode": "PARCEL",
"name": null,
"status": "draft",
"delayed": false,
"group_id": null,
"self_link": "/v2/shipments/6ab16aad-64cb-44e8-bb1e-62c2989bb4cb/",
"bol_number": null,
"pro_number": null,
"weight_lbs": 1.0,
"description": null,
"total_miles": 0.4101042,
"accessorials": [],
"reference_id": "68Q93Q",
"pickup_number": null,
"resource_type": "shipment",
"service_level": null,
"equipment_type": null,
"est_trip_miles": null,
"created_by_user": {
"id": "5e661f94-c226-49a8-acff-b7ce64ecf12c",
"self_link": "/v2/companies/a54ef012-77d4-44a0-8ba5-115b09b655be/users/5e661f94-c226-49a8-acff-b7ce64ecf12c/",
"resource_type": "user"
},
"tracking_number": null,
"final_trip_miles": null,
"notes_for_carrier": null,
"outsider_view_key": "5IQceK0yIj0a6NETZr3cKWNlHENrJCVu",
"status_updated_at": "2020-04-13T19:15:01.287853+00:00",
"total_linear_feet": null,
"preferred_currency": "USD",
"cancellation_reason": null,
"drayage_seal_number": null,
"drayage_release_date": null,
"total_declared_value": null,
"label_last_printed_at": null,
"purchase_order_number": null,
"drayage_booking_number": null,
"drayage_chassis_number": null,
"drayage_last_free_date": null,
"external_tracking_json": null,
"temperature_lower_limit": null,
"temperature_upper_limit": null,
"drayage_container_number": null,
"additional_bol_recipients": [],
"customer_reference_number": "JOFFGK",
"drayage_vessel_imo_number": null,
"significantly_modified_at": null,
"created_by_freight_authority": {
"id": "0f128e3d-ebb2-49d8-bfed-84001fc14afd",
"self_link": "/v2/companies/0f128e3d-ebb2-49d8-bfed-84001fc14afd/",
"resource_type": "freight_authority"
},
"drayage_container_return_date": null,
"drayage_estimated_arrival_date": null,
"capacity_provider_customer_reference_number": null
}
}shipment.updated
Example
{
"id": "01GQMW3549T7D75V1VQ7GM20RA",
"occurred_at": "2023-01-25T16:27:24.867066+00:00",
"source": {
"user_id": "user_id",
"company_id": "company_id",
"request_id": "ecee5902-ecc1-4370-8601-cdd71e72f23f",
"publishing_system": "backend",
"environment": "prod"
},
"event_name": "shipment.updated",
"details": {
"id": "d101c51d-df6b-4c26-b39d-cc68183d7cfe",
"new_data": {
"state": "carrier_confirmed",
"tracking_number": "9470136109361359957433",
"usps_specific_options_id": "1275466f-7d78-49a0-9b9e-9440a30bb17b",
"capacity_provider_customer_reference_number": "order_12789ec022aa46c084e23b3d044ff959"
},
"old_data": {
"state": "tendered",
"tracking_number": null,
"usps_specific_options_id": null,
"capacity_provider_customer_reference_number": null
},
"self_link": "/v2/shipments/d101c51d-df6b-4c26-b39d-cc68183d7cfe/",
"resource_type": "shipment"
}
}shipment.dispatched
Example
{
"1": {
"line_items": [{
"nmfc_code": null,
"po_number": null,
"dimensions": {
"width": {
"unit": "IN",
"value": "20"
},
"height": {
"unit": "IN",
"value": "20"
},
"length": {
"unit": "IN",
"value": "20"
}
},
"description": null,
"line_item_id": null,
"package_type": "OTHER",
"total_pieces": 1,
"total_weight": {
"unit": "LB",
"value": "600"
},
"freight_class": null,
"insured_value": {
"amount": "11000",
"currency": "USD"
},
"tracking_number": "794616878442",
"provider_properties": null,
"total_handling_units": null,
"capacity_provider_reference_number": "7q168aj05de6510609923"
}, {
"nmfc_code": null,
"po_number": null,
"dimensions": {
"width": {
"unit": "IN",
"value": "20"
},
"height": {
"unit": "IN",
"value": "20"
},
"length": {
"unit": "IN",
"value": "20"
}
},
"description": null,
"line_item_id": null,
"package_type": "OTHER",
"total_pieces": 1,
"total_weight": {
"unit": "LB",
"value": "600"
},
"freight_class": null,
"insured_value": {
"amount": "11000",
"currency": "USD"
},
"tracking_number": "794616878453",
"provider_properties": null,
"total_handling_units": null,
"capacity_provider_reference_number": "7q168aj05de6510609923"
}],
"provider_code": "FEDEX",
"tracking_number": "794616878442",
"external_reference_id": null,
"capacity_provider_reference_number": null
}
}shipment.line_item.created
Example
{
"id": "01GPCSC09DVB2QBX3MWFDM3M13",
"occurred_at": "2023-01-10T02:50:20.233326+00:00",
"source": {
"user_id": "41741659-b4fb-4fbf-9887-91ceed79eebd",
"company_id": "a54ef012-77d4-44a0-8ba5-115b09b655be",
"request_id": "3aedd9d9-4504-407b-9575-912f73a24ca4",
"publishing_system": "backend",
"environment": "dev"
},
"event_name": "shipment.line_item.created",
"details": {
"id": "b60fc4c0-52ed-4ab0-a737-7ceead19472c",
"width": 12,
"height": 12,
"length": 12,
"shipment": {
"id": "ec9ed888-751f-4592-853a-f7dc0481b867",
"self_link": "/v2/shipments/ec9ed888-751f-4592-853a-f7dc0481b867/",
"resource_type": "shipment"
},
"stackable": true,
"temp_unit": "F",
"piece_type": "BAG",
"description": "Large quantity of unmarked bills in a bag.",
"length_unit": "IN",
"product_ref": "Big Bags of Money",
"weight_unit": "LB",
"package_type": "BAG",
"total_pieces": null,
"freight_class": "50",
"insured_value": null,
"nmfc_sub_code": null,
"resource_type": "shipment_line_item",
"dry_ice_weight": null,
"nmfc_item_code": null,
"package_weight": 63,
"purchase_order": null,
"total_packages": 100,
"value_per_piece": 100,
"dry_ice_weight_unit": "LB",
"hazmat_hazard_class": null,
"hazmat_packing_group": null,
"country_of_manufacture": null,
"insured_value_currency": null,
"refrigeration_max_temp": null,
"refrigeration_min_temp": null,
"refrigeration_required": false,
"value_per_piece_currency": "USD",
"hazmat_proper_shipping_name": null,
"provider_specific_packaging": null,
"hazmat_identification_number": null
}
}shipment.line_item.updated
Example
{
"id": "01GPCSJ61EGR6G2QNTZZX0655V",
"occurred_at": "2023-01-10T02:53:43.354681+00:00",
"source": {
"user_id": "41741659-b4fb-4fbf-9887-91ceed79eebd",
"company_id": "a54ef012-77d4-44a0-8ba5-115b09b655be",
"request_id": "4ce4a0ee-7a6b-4ade-8015-e6d499a238b4",
"publishing_system": "backend",
"environment": "dev"
},
"event_name": "shipment.line_item.updated",
"details": {
"id": "b60fc4c0-52ed-4ab0-a737-7ceead19472c",
"new_data": {
"package_type": "PLT",
"package_weight": 53
},
"old_data": {
"package_type": "BAG",
"package_weight": 63
},
"resource_type": "shipment_line_item"
}
}shipment.rep.created
Example
{
"1": {
"id": "f760b565-eb39-4d1d-ba9c-5491c28b4d24",
"role": "Sales Rep",
"user": {
"id": "257c1a1d-9cac-4319-8537-16963fd82cc3",
"self_link": "/v2/companies/a54ef012-77d4-44a0-8ba5-115b09b655be/users/257c1a1d-9cac-4319-8537-16963fd82cc3/",
"resource_type": "user"
},
"shipment": {
"id": "b4249ac6-27c1-4411-8d17-370c9088f0d0",
"self_link": "/v2/shipments/b4249ac6-27c1-4411-8d17-370c9088f0d0/",
"resource_type": "shipment"
},
"self_link": "/v2/shipments/b4249ac6-27c1-4411-8d17-370c9088f0d0/reps/f760b565-eb39-4d1d-ba9c-5491c28b4d24/",
"resource_type": "shipment_rep"
}
}shipment.status.updated
Example
{
"1": {
"id": "48e928d1-6565-48c0-a7fb-5b8562657629",
"new_data": {
"status": "carrier_confirmed"
},
"old_data": {
"status": "quoting"
},
"self_link": "/v2/shipments/48e928d1-6565-48c0-a7fb-5b8562657629/",
"resource_type": "shipment"
}
}shipment.stop.created
Example
{
"1": {
"id": "0992ba78-7f22-45c8-8d19-4b00a760a5cc",
"location": {
"city": "Austin",
"type": "Business (with dock or forklift)",
"line_1": "9842 Westminster Glen Ave",
"line_2": null,
"country": "US",
"latitude": 30.3636388,
"longitude": -97.8494388,
"postal_code": "78730",
"phone_number": null,
"state_or_province": "TX"
},
"shipment": {
"id": "0dbf9dba-19a5-4f22-aec0-22a1be63cc3c",
"self_link": "/v2/shipments/0dbf9dba-19a5-4f22-aec0-22a1be63cc3c/",
"resource_type": "shipment"
},
"self_link": "/v2/shipments/0dbf9dba-19a5-4f22-aec0-22a1be63cc3c/stops/0992ba78-7f22-45c8-8d19-4b00a760a5cc/",
"appointment": {
"type": null,
"time_end": "18:00:00",
"date_start": "2020-07-08",
"time_start": "08:00:00",
"utc_offset": -5.0
},
"accessorials": [],
"instructions": null,
"ordinal_index": 1,
"resource_type": "stop",
"internal_notes": null,
"confirmed_arrival": null,
"eta_overridden_by": null,
"confirmed_departure": null,
"unconfirmed_arrival": null,
"predictive_model_eta": {
"end": null,
"start": null
},
"carrier_specified_eta": {
"end": null,
"start": null
},
"unconfirmed_departure": null
}
}shipment.stop.updated
Example
{
"id": "01GPCXKRR9A18MF4XAT4FWNT7M",
"occurred_at": "2023-01-10T04:04:27.775765+00:00",
"source": {
"user_id": null,
"company_id": null,
"request_id": "0b68985e-af15-4e0c-b20e-189de5b57353",
"publishing_system": "backend",
"environment": "dev"
},
"event_name": "shipment.stop.updated",
"details": {
"id": "7ba85cc8-4e5c-4329-9ddc-69d400861913",
"new_data": {
"status": "DEPARTED",
"confirmed_departure": "2023-01-10T04:04:23.595000Z"
},
"old_data": {
"status": "AT_STOP",
"confirmed_departure": null
},
"self_link": "/v2/shipments/a149f6e7-3b0b-44bc-abcc-18b7ab2bf849/stops/7ba85cc8-4e5c-4329-9ddc-69d400861913/",
"resource_type": "stop"
}
}shipment.stop.location.updated
Example
{
"id": "01J1R3RHHJK7DY1T5GSZ0ZAX99",
"occurred_at": "2024-07-01T21:45:19.574333Z",
"event_name": "shipment.stop.location.updated",
"source": {
"user_id": "41741659-b4fb-4fbf-9887-91ceed79eebd",
"company_id": "a54ef012-77d4-44a0-8ba5-115b09b655be",
"request_id": "14d1911b-4872-4a01-9800-42cd897557e2",
"publishing_system": "backend",
"environment": "staging"
},
"details": {
"id": "1c8211fa-56dc-4729-969e-fd937d235d22",
"resource_type": "stop_location",
"stop": {
"id": "7ba85cc8-4e5c-4329-9ddc-69d400861913",
"resource_type": "stop",
"self_link": "/v2/shipments/a149f6e7-3b0b-44bc-abcc-18b7ab2bf849/stops/7ba85cc8-4e5c-4329-9ddc-69d400861913/"
},
"shipment": {
"id": "a149f6e7-3b0b-44bc-abcc-18b7ab2bf849",
"resource_type": "shipment",
"self_link": "/v2/shipments/a149f6e7-3b0b-44bc-abcc-18b7ab2bf849/"
},
"old_data": {
"facility_id": null,
"created_using_address_book_entry_id": null,
"identification_code": null,
"address": {
"address_1": "615 Red River St.",
"address_2": null,
"city": "Austin",
"state_or_province": "TX",
"country": "US",
"phone_number": "+16155042603",
"postal_code": "78701",
"latitude": 30.2671738,
"longitude": -97.7388727
}
},
"new_data": {
"facility_id": "01H8D3QA2Q0PAXWC9J0KHZKRGM",
"created_using_address_book_entry_id": "350d682a-de47-4f45-9759-1591f8645044",
"identification_code": "some_code",
"address": {
"address_1": "100 E. Weatherford St.",
"address_2": null,
"city": "Fort Worth",
"state_or_province": "TX",
"country": "US",
"phone_number": "+16155042603",
"postal_code": "76196",
"latitude": 32.757144,
"longitude": -97.332880
}
}
}
}shipment.timeline_event.created
Example
{
"1": {
"id": "c1164ff6-056a-48b6-bac6-9a1d88cae4d6",
"user": null,
"source": null,
"shipment": {
"id": "7db14034-c3e4-4981-979f-5f61e34b6164",
"self_link": "/v2/shipments/7db14034-c3e4-4981-979f-5f61e34b6164/",
"resource_type": "shipment"
},
"self_link": "/v2/shipments/7db14034-c3e4-4981-979f-5f61e34b6164/timeline-events/c1164ff6-056a-48b6-bac6-9a1d88cae4d6/",
"event_type": "LOCATION_UPDATED",
"description": "ARRIVAL SCAN",
"occurred_at": "2020-03-31T04:28:02+00:00",
"resource_type": "shipment.timeline_event",
"event_sub_type": "INFO"
}
}shipment.timeline_event.updated
Example
{
"2": {
"id": "9f8adc89-b1f8-4b10-b8f8-6dd3134cdc36",
"new_data": {},
"old_data": {},
"self_link": "/v2/shipments/6195ed6f-1e0a-42ba-a236-b0af6b2d8764/timeline-events/9f8adc89-b1f8-4b10-b8f8-6dd3134cdc36/",
"resource_type": "shipment.timeline_event"
}
}