Update Package

This operation updates the details of an existing package using its unique packageId. Updates include the latest activity performen on the package or current status of the package such as RECEIVED or DELIVERED as well as recording additional information like damage reports, location changes, or other relevant package events.

SecuritybearerAuth

Request

path Parameters

packageId

required

string

Request Body schema: application/json

required	object
	object
	Array of objects List of images related to the packages.

Responses

200

Package has been updated successfully.

400

Invalid request.

401

The request could not be authorized.

500

The request could not be completed due to an internal error.

put/api/v1/packages/{packageId}

Request samples

application/json

{"package": {"trackingNumber": "TB123456789ABCE",
"assetType": "PACKAGE",
"damaged": false,
"timezone": -330,
"sender": {"contactId": "5f508e6baa797f3c3d092307"
},
"receiver": {"contactId": "5f508e6baa797f3c3d092307"
},
"givenTo": {"contactId": "5f508e6baa797f3c3d092307"
},
"comment": "User comments",
"confirmationType": "PHONE",
"additionalConfirmationType": "SIGNATURE",
"customFields": [{"name": "End User",
"status": "ACTIVE",
"customFieldId": "o1axRY2NKxq",
"value": "end user"
}
]
},
"lastActivity": {"status": "RECEIVED",
"location": {"inboundSiteId": "zy0a23Bo4Gn0"
}
},
"images": [{"imageLevel": "ASSET",
"imageType": "PHOTO",
"tempURL": "temp/images/vvrbWY3rRBz",
"contentType": "image/png"
}
]
}

Response samples

application/json

{"packageId": "NeLnz9LZ1j4KK5WlEOlyW",
"trackingNumber": "PB4OZAWWNPBGB",
"images": [{"imageId": "img12345",
"tempURL": "temp/images/a5qk9gR1X85v",
"imageType": "PHOTO"
}
]
}