Use this endpoint to update a shipment. To achieve this, this endpoint deletes the current shipment and creates a new shipment on which it will begin tracking. This updates how we track the shipment but will not affect the dispatch with the carrier. Note that you must pass the entire details for the shipment, just as you would on a POST. Note that you only need to update a shipment when the carrier, time, or date has changed.
shipment
OK
Invalid request
Invalid or missing credentials
User not authorized to perform this operation
{- "apiConfiguration": {
- "fallBackToDefaultAccountGroup": true
}, - "capacityProviderAccountGroup": {
- "code": "string",
- "accounts": [
- {
- "code": "string"
}
]
}, - "id": 0,
- "ltlLegId": "005b127f-bb88-444f-8788-e084b7eeceb3",
- "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa",
- "shipmentAttributes": [
- {
- "name": "string",
- "values": [
- "string"
]
}
], - "shipmentIdentifiers": [
- {
- "type": "PRO",
- "value": "string",
- "primaryForType": true,
- "source": "CUSTOMER"
}
], - "shipmentStops": [
- {
- "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"
}
]
}
], - "appointmentWindow": {
- "startDateTime": "2019-08-24T14:15:22Z",
- "endDateTime": "2019-08-24T14:15:22Z",
- "localTimeZoneIdentifier": "string"
}, - "geoCoordinates": {
- "latitude": -90,
- "longitude": -180
}, - "id": 0,
- "involvedParties": [
- {
- "partyIdentifiers": [
- {
- "type": "ACCOUNT",
- "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"
}
], - "stopDescription": "string",
- "stopName": "string",
- "stopNumber": 0,
- "stopType": "ORIGIN",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
]
}
{- "infoMessages": [
- {
- "severity": "ERROR",
- "message": "string",
- "diagnostic": "string",
- "source": "SYSTEM"
}
], - "shipment": {
- "apiConfiguration": {
- "fallBackToDefaultAccountGroup": true
}, - "capacityProviderAccountGroup": {
- "code": "string",
- "accounts": [
- {
- "code": "string"
}
]
}, - "id": 0,
- "ltlLegId": "005b127f-bb88-444f-8788-e084b7eeceb3",
- "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa",
- "shipmentAttributes": [
- {
- "name": "string",
- "values": [
- "string"
]
}
], - "shipmentIdentifiers": [
- {
- "type": "PRO",
- "value": "string",
- "primaryForType": true,
- "source": "CUSTOMER"
}
], - "shipmentStops": [
- {
- "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
}
]
}
], - "appointmentWindow": {
- "startDateTime": "2019-08-24T14:15:22Z",
- "endDateTime": "2019-08-24T14:15:22Z",
- "localTimeZoneIdentifier": "string"
}, - "geoCoordinates": {
- "latitude": -90,
- "longitude": -180
}, - "id": 0,
- "involvedParties": [
- {
- "partyIdentifiers": [
- {
- "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"
}
], - "stopDescription": "string",
- "stopName": "string",
- "stopNumber": 0,
- "stopType": "ORIGIN",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
]
}
}