If the shipment does not exist, this will create a new shipment.
If the shipment is already being tracked (and the corresponding id field is provided), this operation is add only for the provided fields.
Note: This operation only modifies data that the user has provided.
shipment
OK
Invalid request
Invalid or missing credentials
User not authorized to perform this operation
{- "accessGroups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
], - "attributes": [
- {
- "name": "string",
- "value": "string",
- "values": [
- "string"
]
}
], - "createdDateTime": "string",
- "events": [
- {
- "dateTime": "string",
- "dateTimes": [
- {
- "type": "UNKNOWN",
- "dateTime": "2019-08-24T14:15:22Z",
- "endDateTime": "2019-08-24T14:15:22Z",
- "lastModifiedDateTime": "2019-08-24T14:15:22Z",
- "source": "UNKNOWN",
- "sourceIdentifiers": [
- {
- "type": "AIR_WAYBILL",
- "value": "string"
}
], - "selected": true,
- "sequence": 0
}
], - "description": "string",
- "estimateDateTime": "string",
- "estimateLastCalculatedDateTime": "string",
- "plannedDateTime": "string",
- "plannedEndDateTime": "string",
- "receivedDateTime": "string",
- "routeSegmentId": "a5aad6c5-e2d6-4a7a-8912-ea0254639352",
- "stopId": "dd775241-8a00-4193-b07c-f3e4740fdc43",
- "type": "UNKNOWN"
}
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "identifiers": [
- {
- "type": "AIR_WAYBILL",
- "value": "string"
}
], - "lastModifiedDateTime": "string",
- "relatedShipments": [
- {
- "accessGroups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
], - "attributes": [
- {
- "name": "string",
- "value": "string",
- "values": [
- "string"
]
}
], - "createdDateTime": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "identifiers": [
- {
- "type": "AIR_WAYBILL",
- "value": "string"
}
], - "lastModifiedDateTime": "string",
- "shipmentShareLink": "string"
}
], - "routeInfo": {
- "routeSegments": [
- {
- "emissions": {
- "co2EmissionIntensity": {
- "value": 0,
- "unit": "KG_PER_KM"
}, - "distance": {
- "value": 0,
- "unit": "FT"
}, - "totalCO2Emissions": {
- "value": 0,
- "unit": "LB"
}
}, - "fromStopId": "257296aa-4e11-4168-b6a7-981b8b94815b",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "identifiers": [
- {
- "type": "AIR_WAYBILL",
- "value": "string"
}
], - "toStopId": "5f1765b9-dde0-424e-963b-bb3b4e1d1d56",
- "transportationMode": "AIR"
}
], - "stops": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "UNKNOWN",
- "location": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "identifiers": [
- {
- "type": "AIRPORT_IATA",
- "value": "string"
}
], - "address": {
- "postalCode": "string",
- "addressLines": [
- "str"
], - "city": "string",
- "state": "string",
- "country": "US"
}, - "coordinates": {
- "latitude": -90,
- "longitude": -180
}, - "timeZone": "string"
}
}
]
}, - "shipmentShareLink": "string"
}
{- "accessGroups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
], - "attributes": [
- {
- "name": "string",
- "value": "string",
- "values": [
- "string"
]
}
], - "createdDateTime": "string",
- "events": [
- {
- "dateTime": "string",
- "dateTimes": [
- {
- "type": "UNKNOWN",
- "dateTime": "2019-08-24T14:15:22Z",
- "endDateTime": "2019-08-24T14:15:22Z",
- "lastModifiedDateTime": "2019-08-24T14:15:22Z",
- "source": "UNKNOWN",
- "sourceIdentifiers": [
- {
- "type": "AIR_WAYBILL",
- "value": "string"
}
], - "selected": true,
- "sequence": 0
}
], - "description": "string",
- "estimateDateTime": "string",
- "estimateLastCalculatedDateTime": "string",
- "plannedDateTime": "string",
- "plannedEndDateTime": "string",
- "receivedDateTime": "string",
- "routeSegmentId": "a5aad6c5-e2d6-4a7a-8912-ea0254639352",
- "stopId": "dd775241-8a00-4193-b07c-f3e4740fdc43",
- "type": "UNKNOWN"
}
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "identifiers": [
- {
- "type": "AIR_WAYBILL",
- "value": "string"
}
], - "lastModifiedDateTime": "string",
- "relatedShipments": [
- {
- "accessGroups": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
], - "attributes": [
- {
- "name": "string",
- "value": "string",
- "values": [
- "string"
]
}
], - "createdDateTime": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "identifiers": [
- {
- "type": "AIR_WAYBILL",
- "value": "string"
}
], - "lastModifiedDateTime": "string",
- "shipmentShareLink": "string"
}
], - "routeInfo": {
- "routeSegments": [
- {
- "emissions": {
- "co2EmissionIntensity": {
- "value": 0,
- "unit": "KG_PER_KM"
}, - "distance": {
- "value": 0,
- "unit": "FT"
}, - "totalCO2Emissions": {
- "value": 0,
- "unit": "LB"
}
}, - "fromStopId": "257296aa-4e11-4168-b6a7-981b8b94815b",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "identifiers": [
- {
- "type": "AIR_WAYBILL",
- "value": "string"
}
], - "toStopId": "5f1765b9-dde0-424e-963b-bb3b4e1d1d56",
- "transportationMode": "AIR"
}
], - "stops": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "UNKNOWN",
- "location": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "identifiers": [
- {
- "type": "AIRPORT_IATA",
- "value": "string"
}
], - "address": {
- "postalCode": "string",
- "addressLines": [
- "str"
], - "city": "string",
- "state": "string",
- "country": "US"
}, - "coordinates": {
- "latitude": -90,
- "longitude": -180
}, - "timeZone": "string"
}
}
]
}, - "shipmentShareLink": "string"
}