Get Package

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

SecuritybearerAuth

Request

path Parameters

packageId

required

string

The unique identifier of the package to retrieve.

Example: d86w9YdE3e1JPm01NxaeP

query Parameters

type

required

string

The type of the package details to retrive.

Enum: "IMAGES" "ACTIVITIES" "DETAILED"

Responses

200

Requested package has been retrived successfully.

400

Invalid request.

401

The request could not be authorized.

500

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

get/api/v1/packages/{packageId}

Request samples

Response samples

application/json

{"package": {"packageId": "LMQmVaVXXxyQyZv1l2EkO",
"sender": {"personalId": "jy32",
"contactId": "5f508e6baa797f3c3d092307",
"name": "contact_name",
"company": "company_name",
"phone": "1234567890",
"location": {"inboundSiteId": "zy0a23Bo4Gn0",
"name": "Site 1CD1001RMF",
"parent": "Site",
"type": "site",
"locationHierarchy": "Noida, Office of CG| Noida,Bldg| Noida,Floor| Noida,MS",
"ancestorlist": ["k5OrZWe0ly6dg1v",
"gKP4RNbMzrPO",
"XbyR9zpPDneY"
],
"topTier": {"inboundSiteId": "EMPTY_SITE",
"name": "EMPTY_SITE"
}
},
"mailStopLocation": {"inboundSiteId": "zy0a23Bo4Gn0",
"name": "Site 1CD1001RMF",
"parent": "Site",
"type": "site",
"locationHierarchy": "Noida, Office of CG| Noida,Bldg| Noida,Floor| Noida,MS",
"ancestorlist": ["k5OrZWe0ly6dg1v",
"gKP4RNbMzrPO",
"XbyR9zpPDneY"
],
"topTier": {"inboundSiteId": "EMPTY_SITE",
"name": "EMPTY_SITE"
}
}
},
"receiver": {"personalId": "jy32",
"contactId": "5f508e6baa797f3c3d092307",
"name": "contact_name",
"company": "company_name",
"phone": "1234567890",
"location": {"inboundSiteId": "zy0a23Bo4Gn0",
"name": "Site 1CD1001RMF",
"parent": "Site",
"type": "site",
"locationHierarchy": "Noida, Office of CG| Noida,Bldg| Noida,Floor| Noida,MS",
"ancestorlist": ["k5OrZWe0ly6dg1v",
"gKP4RNbMzrPO",
"XbyR9zpPDneY"
],
"topTier": {"inboundSiteId": "EMPTY_SITE",
"name": "EMPTY_SITE"
}
},
"mailStopLocation": {"inboundSiteId": "zy0a23Bo4Gn0",
"name": "Site 1CD1001RMF",
"parent": "Site",
"type": "site",
"locationHierarchy": "Noida, Office of CG| Noida,Bldg| Noida,Floor| Noida,MS",
"ancestorlist": ["k5OrZWe0ly6dg1v",
"gKP4RNbMzrPO",
"XbyR9zpPDneY"
],
"topTier": {"inboundSiteId": "EMPTY_SITE",
"name": "EMPTY_SITE"
}
}
},
"givenTo": {"personalId": "jy32",
"contactId": "5f508e6baa797f3c3d092307",
"name": "contact_name",
"company": "company_name",
"phone": "1234567890",
"location": {"inboundSiteId": "zy0a23Bo4Gn0",
"name": "Site 1CD1001RMF",
"parent": "Site",
"type": "site",
"locationHierarchy": "Noida, Office of CG| Noida,Bldg| Noida,Floor| Noida,MS",
"ancestorlist": ["k5OrZWe0ly6dg1v",
"gKP4RNbMzrPO",
"XbyR9zpPDneY"
],
"topTier": {"inboundSiteId": "EMPTY_SITE",
"name": "EMPTY_SITE"
}
},
"mailStopLocation": {"inboundSiteId": "zy0a23Bo4Gn0",
"name": "Site 1CD1001RMF",
"parent": "Site",
"type": "site",
"locationHierarchy": "Noida, Office of CG| Noida,Bldg| Noida,Floor| Noida,MS",
"ancestorlist": ["k5OrZWe0ly6dg1v",
"gKP4RNbMzrPO",
"XbyR9zpPDneY"
],
"topTier": {"inboundSiteId": "EMPTY_SITE",
"name": "EMPTY_SITE"
}
}
},
"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": ["k5OrZWe0ly6dg1v",
"gKP4RNbMzrPO",
"XbyR9zpPDneY"
],
"topTier": {"inboundSiteId": "EMPTY_SITE",
"name": "EMPTY_SITE"
}
},
"currentStatus": "RECEIVED",
"confirmationType": "PHONE",
"additionalConfirmationType": "SIGNATURE",
"timezone": -330,
"customFields": [{"name": "End User",
"status": "ACTIVE",
"customFieldId": "o1axRY2NKxq",
"value": "end user"
}
]
},
"activities": [{"activityId": "NWZ7lnJgOMLl",
"status": "CREATED",
"location": {"inboundSiteId": "zy0a23Bo4Gn0",
"name": "Site 1CD1001RMF",
"type": "site",
"locationHierarchy": "Site 1CD1001RMF"
},
"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"
}
]
}