Use this endpoint to update a truckload shipment with a given shipment identifier.
Example: You can update location fields or appointment windows to reflect changes with this endpoint.
Note that tracking information updates are currently not supported. This includes shipmentIdentifiers, capacityProviderAccountGroup, and apiConfiguration changes.* It is suggested to first get the current shipment object from the GET shipment endpoint, make the desired modifications, and then PUT the modified shipment to this endpoint. After the modified shipment is successfully submitted, the updated stops, attributes, shipping details etc. will be applied and used in tracking from then on. If a shipment PUT request comes in with only GeoCoordinates, it is possible that a street address will not be returned in the response.shipment
OK
Invalid request
Invalid or missing credentials
User not authorized to perform this operation
{- "apiConfiguration": {
- "fallBackToDefaultAccountGroup": true,
- "webhookEndpointConfigName": "string",
- "enableIntelligentMatching": true
}, - "attributes": [
- {
- "name": "string",
- "predefined": true,
- "value": "string",
- "values": [
- "string"
]
}
], - "capacityProviderAccountGroup": {
- "code": "string",
- "accounts": [
- {
- "code": "string"
}
]
}, - "carrierIdentifier": {
- "type": "SCAC",
- "value": "string"
}, - "equipmentIdentifierChanges": [
- {
- "timestamp": "string",
- "type": "MOBILE_PHONE_NUMBER",
- "value": "string"
}
], - "equipmentIdentifiers": [
- {
- "shouldDelete": true,
- "type": "MOBILE_PHONE_NUMBER",
- "value": "string"
}
], - "id": 0,
- "idleDuration": 0,
- "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa",
- "pointsOfInterest": [
- {
- "geoCoordinates": {
- "latitude": -90,
- "longitude": -180
}, - "location": {
- "address": {
- "postalCode": "string",
- "addressLines": [
- "str"
], - "city": "string",
- "state": "string",
- "country": "US"
}, - "contact": {
- "companyName": "string",
- "contactName": "string",
- "phoneNumber": "string",
- "phoneNumberCountryCode": "string",
- "phoneNumber2": "string",
- "phoneNumber2CountryCode": "string",
- "email": "string",
- "faxNumber": "string",
- "faxNumberCountryCode": "string"
}
}, - "locationIdentifiers": [
- {
- "type": "EXTERNAL",
- "value": "string"
}
], - "pointOfInterestDescription": "string",
- "pointOfInterestId": "string",
- "pointOfInterestName": "string",
- "pointOfInterestType": "GENERAL",
- "shouldDelete": true
}
], - "sensors": [
- {
- "identifier": {
- "type": "TEMPERATURE",
- "value": "string"
}, - "max": 0,
- "min": 0,
- "target": 0
}
], - "shipmentDetails": {
- "lineItems": [
- {
- "commodityCode": "string",
- "contact": {
- "companyName": "string",
- "contactName": "string",
- "phoneNumber": "string",
- "phoneNumberCountryCode": "string",
- "phoneNumber2": "string",
- "phoneNumber2CountryCode": "string",
- "email": "string",
- "faxNumber": "string",
- "faxNumberCountryCode": "string"
}, - "deliveryStopNumber": 0,
- "description": "string",
- "freightClass": "50",
- "handlingUnitPackageType": "PLT",
- "handlingUnitQuantity": 0,
- "involvedParties": [
- {
- "partyIdentifiers": [
- {
- "type": null,
- "value": null
}
]
}
], - "itemIdentifiers": [
- {
- "type": "PURCHASE_ORDER",
- "value": "string"
}
], - "itemPackageType": "BAG",
- "itemQuantity": 0,
- "monetaryValue": {
- "currency": "USD",
- "amount": 0
}, - "pickupStopNumber": 0,
- "subLineItems": [
- {
- "commodityCode": "string",
- "contact": {
- "companyName": "string",
- "contactName": "string",
- "phoneNumber": "string",
- "phoneNumberCountryCode": "string",
- "phoneNumber2": "string",
- "phoneNumber2CountryCode": "string",
- "email": "string",
- "faxNumber": "string",
- "faxNumberCountryCode": "string"
}, - "description": "string",
- "freightClass": "50",
- "involvedParties": [
- {
- "partyIdentifiers": [ ]
}
], - "itemIdentifiers": [
- {
- "type": null,
- "value": null
}
], - "itemPackageType": "BAG",
- "itemQuantity": 0,
- "monetaryValue": {
- "currency": "USD",
- "amount": 0
}, - "totalWeight": {
- "weight": 0,
- "weightUnit": "LB"
}
}
], - "totalWeight": {
- "weight": 0,
- "weightUnit": "LB"
}
}
]
}, - "shipmentIdentifiers": [
- {
- "type": "BILL_OF_LADING",
- "value": "string"
}
], - "shipmentLegId": "6798b072-0783-4009-baaf-2b9780277fbd",
- "shipmentStops": [
- {
- "stopNumber": 1,
- "appointmentWindow": {
- "startDateTime": "2019-08-24T14:15:22Z",
- "endDateTime": "2019-08-24T14:15:22Z",
- "localTimeZoneIdentifier": "string"
}, - "additionalAppointmentWindows": [
- {
- "type": "STRATEGIC",
- "appointmentWindow": {
- "startDateTime": "2019-08-24T14:15:22Z",
- "endDateTime": "2019-08-24T14:15:22Z",
- "localTimeZoneIdentifier": "string"
}, - "appointmentStatus": "PENDING",
- "identifiers": [
- {
- "type": "DOCK",
- "value": "string"
}
]
}
], - "location": {
- "address": {
- "postalCode": "string",
- "addressLines": [
- "str"
], - "city": "string",
- "state": "string",
- "country": "US"
}, - "contact": {
- "companyName": "string",
- "contactName": "string",
- "phoneNumber": "string",
- "phoneNumberCountryCode": "string",
- "phoneNumber2": "string",
- "phoneNumber2CountryCode": "string",
- "email": "string",
- "faxNumber": "string",
- "faxNumberCountryCode": "string"
}
}, - "locationIdentifiers": [
- {
- "type": "EXTERNAL",
- "value": "string"
}
], - "stopName": "string",
- "geoCoordinates": {
- "latitude": -90,
- "longitude": -180
}, - "stopType": "PICKUP",
- "stopDescription": "string",
- "involvedParties": [
- {
- "partyIdentifiers": [
- {
- "type": "ACCOUNT",
- "value": "string"
}
]
}
], - "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "externalArrivalEstimate": {
- "source": "SHIPPER",
- "dateTime": "2019-08-24T14:15:22Z"
}
}
], - "shippingDetails": {
- "multipleDrivers": true,
- "truckDetails": {
- "truckDimensions": {
- "length": 0,
- "width": 0,
- "height": 0,
- "unitOfMeasure": "IN"
}, - "weight": 0,
- "weightUnitOfMeasure": "LB",
- "truckType": "AUTO_CARRIER"
}, - "hazmatDetails": {
- "hazardClasses": [
- "string"
]
}
}, - "trackingDetails": [
- {
- "equipmentIdentifier": {
- "shouldDelete": true,
- "type": "MOBILE_PHONE_NUMBER",
- "value": "string"
}, - "equipmentIdentifierSource": "CUSTOMER",
- "trackingType": "MOBILE_PHONE"
}
]
}
{- "infoMessages": [
- {
- "severity": "ERROR",
- "message": "string",
- "diagnostic": "string",
- "source": "SYSTEM"
}
], - "shipment": {
- "apiConfiguration": {
- "fallBackToDefaultAccountGroup": true,
- "webhookEndpointConfigName": "string",
- "enableIntelligentMatching": true
}, - "attributes": [
- {
- "name": "string",
- "predefined": true,
- "value": "string",
- "values": [
- "string"
]
}
], - "capacityProviderAccountGroup": {
- "code": "string",
- "accounts": [
- {
- "code": "string"
}
]
}, - "carrierIdentifier": {
- "type": "SCAC",
- "value": "string"
}, - "equipmentIdentifierChanges": [
- {
- "timestamp": "string",
- "type": "MOBILE_PHONE_NUMBER",
- "value": "string"
}
], - "equipmentIdentifiers": [
- {
- "shouldDelete": true,
- "type": "MOBILE_PHONE_NUMBER",
- "value": "string"
}
], - "id": 0,
- "idleDuration": 0,
- "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa",
- "pointsOfInterest": [
- {
- "geoCoordinates": {
- "latitude": -90,
- "longitude": -180
}, - "location": {
- "address": {
- "postalCode": "string",
- "addressLines": [
- "str"
], - "city": "string",
- "state": "string",
- "country": "US"
}, - "contact": {
- "companyName": "string",
- "contactName": "string",
- "phoneNumber": "string",
- "phoneNumberCountryCode": "string",
- "phoneNumber2": "string",
- "phoneNumber2CountryCode": "string",
- "email": "string",
- "faxNumber": "string",
- "faxNumberCountryCode": "string"
}
}, - "locationIdentifiers": [
- {
- "type": "EXTERNAL",
- "value": "string"
}
], - "pointOfInterestDescription": "string",
- "pointOfInterestId": "string",
- "pointOfInterestName": "string",
- "pointOfInterestType": "GENERAL",
- "shouldDelete": true
}
], - "sensors": [
- {
- "identifier": {
- "type": "TEMPERATURE",
- "value": "string"
}, - "max": 0,
- "min": 0,
- "target": 0
}
], - "shipmentDetails": {
- "lineItems": [
- {
- "commodityCode": "string",
- "contact": {
- "companyName": "string",
- "contactName": "string",
- "phoneNumber": "string",
- "phoneNumberCountryCode": "string",
- "phoneNumber2": "string",
- "phoneNumber2CountryCode": "string",
- "email": "string",
- "faxNumber": "string",
- "faxNumberCountryCode": "string"
}, - "deliveryStopNumber": 0,
- "description": "string",
- "freightClass": "50",
- "handlingUnitPackageType": "PLT",
- "handlingUnitQuantity": 0,
- "involvedParties": [
- {
- "partyIdentifiers": [
- null
]
}
], - "itemIdentifiers": [
- {
- "type": "PURCHASE_ORDER",
- "value": "string"
}
], - "itemPackageType": "BAG",
- "itemQuantity": 0,
- "monetaryValue": {
- "currency": "USD",
- "amount": 0
}, - "pickupStopNumber": 0,
- "subLineItems": [
- {
- "commodityCode": "string",
- "contact": {
- "companyName": null,
- "contactName": null,
- "phoneNumber": null,
- "phoneNumberCountryCode": null,
- "phoneNumber2": null,
- "phoneNumber2CountryCode": null,
- "email": null,
- "faxNumber": null,
- "faxNumberCountryCode": null
}, - "description": "string",
- "freightClass": "50",
- "involvedParties": [
- null
], - "itemIdentifiers": [
- null
], - "itemPackageType": "BAG",
- "itemQuantity": 0,
- "monetaryValue": {
- "currency": null,
- "amount": null
}, - "totalWeight": {
- "weight": null,
- "weightUnit": null
}
}
], - "totalWeight": {
- "weight": 0,
- "weightUnit": "LB"
}
}
]
}, - "shipmentIdentifiers": [
- {
- "type": "BILL_OF_LADING",
- "value": "string"
}
], - "shipmentLegId": "6798b072-0783-4009-baaf-2b9780277fbd",
- "shipmentStops": [
- {
- "stopNumber": 1,
- "appointmentWindow": {
- "startDateTime": "2019-08-24T14:15:22Z",
- "endDateTime": "2019-08-24T14:15:22Z",
- "localTimeZoneIdentifier": "string"
}, - "additionalAppointmentWindows": [
- {
- "type": "STRATEGIC",
- "appointmentWindow": {
- "startDateTime": "2019-08-24T14:15:22Z",
- "endDateTime": "2019-08-24T14:15:22Z",
- "localTimeZoneIdentifier": "string"
}, - "appointmentStatus": "PENDING",
- "identifiers": [
- {
- "type": null,
- "value": null
}
]
}
], - "location": {
- "address": {
- "postalCode": "string",
- "addressLines": [
- "str"
], - "city": "string",
- "state": "string",
- "country": "US"
}, - "contact": {
- "companyName": "string",
- "contactName": "string",
- "phoneNumber": "string",
- "phoneNumberCountryCode": "string",
- "phoneNumber2": "string",
- "phoneNumber2CountryCode": "string",
- "email": "string",
- "faxNumber": "string",
- "faxNumberCountryCode": "string"
}
}, - "locationIdentifiers": [
- {
- "type": "EXTERNAL",
- "value": "string"
}
], - "stopName": "string",
- "geoCoordinates": {
- "latitude": -90,
- "longitude": -180
}, - "stopType": "PICKUP",
- "stopDescription": "string",
- "involvedParties": [
- {
- "partyIdentifiers": [
- {
- "type": null,
- "value": null
}
]
}
], - "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "externalArrivalEstimate": {
- "source": "SHIPPER",
- "dateTime": "2019-08-24T14:15:22Z"
}
}
], - "shippingDetails": {
- "multipleDrivers": true,
- "truckDetails": {
- "truckDimensions": {
- "length": 0,
- "width": 0,
- "height": 0,
- "unitOfMeasure": "IN"
}, - "weight": 0,
- "weightUnitOfMeasure": "LB",
- "truckType": "AUTO_CARRIER"
}, - "hazmatDetails": {
- "hazardClasses": [
- "string"
]
}
}, - "trackingDetails": [
- {
- "equipmentIdentifier": {
- "shouldDelete": true,
- "type": "MOBILE_PHONE_NUMBER",
- "value": "string"
}, - "equipmentIdentifierSource": "CUSTOMER",
- "trackingType": "MOBILE_PHONE"
}
]
}
}