Skip to content
Receiving APIs
/
/
Update Package

Update Package

Request

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.

Security
bearerAuth
Path
packageIdstringrequired
Bodyapplication/jsonrequired
packageobjectrequired
lastActivityobject
imagesArray of objects

List of images related to the packages.

curl -i -X PUT \
  'https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack/api/v1/packages/{packageId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "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"
      }
    ]
  }'

Responses

Package has been updated successfully.

Bodyapplication/json
packageIdstring

Unique identifier generated for the package

Example:"NeLnz9LZ1j4KK5WlEOlyW"
trackingNumberstring

Tracking number associated with the package

Example:"PB4OZAWWNPBGB"
imagesArray of objects(Image)
Response
{
  "packageId": "NeLnz9LZ1j4KK5WlEOlyW",
  "trackingNumber": "PB4OZAWWNPBGB",
  "images": [
    {
      "imageId": "img12345",
      "tempURL": "temp/images/a5qk9gR1X85v",
      "imageType": "PHOTO"
    }
  ]
}