curl --request PUT \
--url https://api.upwell.com/api/rest/shipments/{id} \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"input": {
"billOfLadingNumber": "<string>",
"billedDate": "2023-12-25",
"billedMiles": "<unknown>",
"carrierId": "<string>",
"carrierProNumber": "<string>",
"companyId": "<string>",
"coveredDate": "2023-12-25",
"createdFromEmailMessageId": "<string>",
"currency": "AED",
"customerId": "<string>",
"customerPoNumber": "<string>",
"customerReferenceNumber": "<string>",
"deliveredAt": "<unknown>",
"dispatchedDate": "2023-12-25",
"invoiceId": "<string>",
"loadDescription": "<string>",
"loadedDate": "2023-12-25",
"pickupAt": "<unknown>",
"releaseDate": "2023-12-25",
"shipmentId": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"status": "<string>",
"tenantId": "<string>",
"terminal": "<string>",
"trailerNumber": "<string>",
"volume": "<unknown>",
"volumeUnit": "<string>",
"weight": "<unknown>",
"weightUnit": "<string>"
}
}
'{
"updateShipment": {
"billOfLadingNumber": "<string>",
"billedDate": "2023-12-25",
"carrierId": "<string>",
"carrierProNumber": "<string>",
"carrierTotalRate": 123,
"company": {
"dunsNumber": "<string>",
"id": "<string>",
"logoUrl": "<string>",
"mcNumber": "<string>",
"name": "<string>",
"primaryEmailAddress": "<string>",
"primaryPhone": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"termsOfService": "<string>",
"website": "<string>"
},
"companyId": "<string>",
"consigneeAddress": {
"city": "<string>",
"companyName": "<string>",
"country": "AD",
"id": "<string>",
"name": "<string>",
"phoneNumber": "<string>",
"stateOrProvince": "<string>",
"streetLine1": "<string>",
"streetLine2": "<string>",
"type": "ADDRESS_BOOK",
"zipOrPostalCode": "<string>"
},
"coveredDate": "2023-12-25",
"createdAt": "2023-11-07T05:31:56Z",
"currency": "AED",
"customerId": "<string>",
"customerPoNumber": "<string>",
"customerReferenceNumber": "<string>",
"customerTotalRate": 123,
"deliveredAt": "<unknown>",
"dispatchedDate": "2023-12-25",
"id": "<string>",
"invoiceId": "<string>",
"loadDescription": "<string>",
"loadedDate": "2023-12-25",
"pickupAddress": {
"city": "<string>",
"companyName": "<string>",
"country": "AD",
"id": "<string>",
"name": "<string>",
"phoneNumber": "<string>",
"stateOrProvince": "<string>",
"streetLine1": "<string>",
"streetLine2": "<string>",
"type": "ADDRESS_BOOK",
"zipOrPostalCode": "<string>"
},
"pickupAt": "<unknown>",
"releaseDate": "2023-12-25",
"shipmentId": "<string>",
"shipmentInvoices": [
{
"invoiceId": "<string>",
"shipmentId": "<string>"
}
],
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"status": "<string>",
"stops": [
{
"address": {
"city": "<string>",
"companyName": "<string>",
"country": "AD",
"id": "<string>",
"name": "<string>",
"phoneNumber": "<string>",
"stateOrProvince": "<string>",
"streetLine1": "<string>",
"streetLine2": "<string>",
"type": "ADDRESS_BOOK",
"zipOrPostalCode": "<string>"
},
"id": "<string>",
"metadata": "<string>",
"pieceCount": 123,
"sequenceNumber": 123,
"stopType": "<string>",
"weightAmount": "<unknown>",
"weightUnit": "<string>"
}
],
"terminal": "<string>",
"trailerNumber": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"volume": "<unknown>",
"volumeUnit": "<string>",
"weight": "<unknown>",
"weightUnit": "<string>"
}
}Update a shipment by ID
curl --request PUT \
--url https://api.upwell.com/api/rest/shipments/{id} \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"input": {
"billOfLadingNumber": "<string>",
"billedDate": "2023-12-25",
"billedMiles": "<unknown>",
"carrierId": "<string>",
"carrierProNumber": "<string>",
"companyId": "<string>",
"coveredDate": "2023-12-25",
"createdFromEmailMessageId": "<string>",
"currency": "AED",
"customerId": "<string>",
"customerPoNumber": "<string>",
"customerReferenceNumber": "<string>",
"deliveredAt": "<unknown>",
"dispatchedDate": "2023-12-25",
"invoiceId": "<string>",
"loadDescription": "<string>",
"loadedDate": "2023-12-25",
"pickupAt": "<unknown>",
"releaseDate": "2023-12-25",
"shipmentId": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"status": "<string>",
"tenantId": "<string>",
"terminal": "<string>",
"trailerNumber": "<string>",
"volume": "<unknown>",
"volumeUnit": "<string>",
"weight": "<unknown>",
"weightUnit": "<string>"
}
}
'{
"updateShipment": {
"billOfLadingNumber": "<string>",
"billedDate": "2023-12-25",
"carrierId": "<string>",
"carrierProNumber": "<string>",
"carrierTotalRate": 123,
"company": {
"dunsNumber": "<string>",
"id": "<string>",
"logoUrl": "<string>",
"mcNumber": "<string>",
"name": "<string>",
"primaryEmailAddress": "<string>",
"primaryPhone": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"termsOfService": "<string>",
"website": "<string>"
},
"companyId": "<string>",
"consigneeAddress": {
"city": "<string>",
"companyName": "<string>",
"country": "AD",
"id": "<string>",
"name": "<string>",
"phoneNumber": "<string>",
"stateOrProvince": "<string>",
"streetLine1": "<string>",
"streetLine2": "<string>",
"type": "ADDRESS_BOOK",
"zipOrPostalCode": "<string>"
},
"coveredDate": "2023-12-25",
"createdAt": "2023-11-07T05:31:56Z",
"currency": "AED",
"customerId": "<string>",
"customerPoNumber": "<string>",
"customerReferenceNumber": "<string>",
"customerTotalRate": 123,
"deliveredAt": "<unknown>",
"dispatchedDate": "2023-12-25",
"id": "<string>",
"invoiceId": "<string>",
"loadDescription": "<string>",
"loadedDate": "2023-12-25",
"pickupAddress": {
"city": "<string>",
"companyName": "<string>",
"country": "AD",
"id": "<string>",
"name": "<string>",
"phoneNumber": "<string>",
"stateOrProvince": "<string>",
"streetLine1": "<string>",
"streetLine2": "<string>",
"type": "ADDRESS_BOOK",
"zipOrPostalCode": "<string>"
},
"pickupAt": "<unknown>",
"releaseDate": "2023-12-25",
"shipmentId": "<string>",
"shipmentInvoices": [
{
"invoiceId": "<string>",
"shipmentId": "<string>"
}
],
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"status": "<string>",
"stops": [
{
"address": {
"city": "<string>",
"companyName": "<string>",
"country": "AD",
"id": "<string>",
"name": "<string>",
"phoneNumber": "<string>",
"stateOrProvince": "<string>",
"streetLine1": "<string>",
"streetLine2": "<string>",
"type": "ADDRESS_BOOK",
"zipOrPostalCode": "<string>"
},
"id": "<string>",
"metadata": "<string>",
"pieceCount": 123,
"sequenceNumber": 123,
"stopType": "<string>",
"weightAmount": "<unknown>",
"weightUnit": "<string>"
}
],
"terminal": "<string>",
"trailerNumber": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"volume": "<unknown>",
"volumeUnit": "<string>",
"weight": "<unknown>",
"weightUnit": "<string>"
}
}Your API key will be used for authentication of the request. Authorization: YOUR_API_KEY
"id" is required (enter it either in parameters or request body)
Query parameters can also be provided in the request body as a JSON object
Responses for PUT /api/rest/shipments/{id}
columns and relationships of "shipments"
Show child attributes