Skip to content
Receiving APIs
/
/
Get Package

Get Package

Request

This operation retrive detailed information or activities of a specific package using its unique packageId.
The packageId is generated when a package is added to the system

Security
bearerAuth
Path
packageIdstringrequired

The unique identifier of the package to retrieve.

Example:d86w9YdE3e1JPm01NxaeP
Query
typestringrequired

The type of the package details to retrive.

Enum:"IMAGES""ACTIVITIES""DETAILED"
curl -i -X GET \
  'https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack/api/v1/packages/d86w9YdE3e1JPm01NxaeP?type=IMAGES' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Requested package has been retrived successfully.

Bodyapplication/json
One of:
packageobject(PackageResponse)

Details of the package.

activitiesArray of objects

List of activities with details of each activity.

imagesArray of objects

List of images related to the package.

Response
{
  "package": {
    "packageId": "LMQmVaVXXxyQyZv1l2EkO",
    "sender": {
      "personalId": "jy32",
      "contactId": "5f508e6baa797f3c3d092307",
      "name": "contact_name",
      "company": "company_name",
      "phone": "1234567890",
      "email": "user@email.com",
      "additionalEmailIds": [ … ],
      "location": { … },
      "mailStopLocation": { … }
    },
    "receiver": {
      "personalId": "jy32",
      "contactId": "5f508e6baa797f3c3d092307",
      "name": "contact_name",
      "company": "company_name",
      "phone": "1234567890",
      "email": "user@email.com",
      "additionalEmailIds": [ … ],
      "location": { … },
      "mailStopLocation": { … }
    },
    "givenTo": {
      "personalId": "jy32",
      "contactId": "5f508e6baa797f3c3d092307",
      "name": "contact_name",
      "company": "company_name",
      "phone": "1234567890",
      "email": "user@email.com",
      "additionalEmailIds": [ … ],
      "location": { … },
      "mailStopLocation": { … }
    },
    "trackingNumber": "PBYV4PVRBYLAAW",
    "carrier": {
      "carrierId": "FedEx",
      "name": "FedEx"
    },
    "damaged": false,
    "comment": "user_comment",
    "currentLocation": {
      "inboundSiteId": "zy0a23Bo4Gn0",
      "name": "Site 1CD1001RMF",
      "parent": "Site",
      "type": "site",
      "locationHierarchy": "Noida, Office of CG| Noida,Bldg| Noida,Floor| Noida,MS",
      "ancestorlist": [ … ],
      "topTier": { … }
    },
    "currentStatus": "RECEIVED",
    "confirmationType": "PHONE",
    "additionalConfirmationType": "SIGNATURE",
    "timezone": -330,
    "customFields": [
      { … }
    ]
  },
  "activities": [
    {
      "activityId": "NWZ7lnJgOMLl",
      "status": "CREATED",
      "location": { … },
      "route": {},
      "username": "API-SP360-8BZWymklRPj5-DEV",
      "currentState": {}
    }
  ],
  "images": [
    {
      "imageId": "7NNO1R3e1455",
      "url": "https://225934331380-receiving-service-artifacts-qa.s3.amazonaws.com/images/sac11be/Vlyx3zyQNr8omx6VzoR8Q/7NNO1R3e1455?X-Amz-Algorithm=AWS4-HMAC-SHA256&..........",
      "contentType": "image/gif"
    }
  ]
}