Getting Started
Base URL
https://packages-api.packagex.io/v1/
Header
Key: x-api-key
Value: Available in the API section of the Web Dashboard (portal.packagex.io)
Receive Portal
Get All Items
All Items
Endpoint
/packages/package-api
Description
This endpoint retrieves all item records within access limits of user role.
Content-Type
application/json
Query Parameters
The following parameters are accepted in the query string of the request.
locationId
string
Yes
Unique location ID for location selection. If set, the result will only contain recipients of specific location.
filterOption
string
Yes
Should contain comma separated strings only. One or Multiple the value 'outstanding', 'scanned', 'overdue', 'collected', 'deleted', 'hold', 'discarded', 'snapsend', 'destroy', 'request_forward', 'request_hold', 'forward'.
filterType
String
Yes
Default: ALL. One of the filter "SCAN-IN","SCAN_OUT","ALL". returns items based on filter.
fromDate
string <date-time>
No
Date in ISO 8601 format. e.g. "2022-04-11T00:00:00Z
toDate
string <date-time>
No
Date in ISO 8601 format. e.g. "2022-04-11T11:59:59Z"
graphTypeFilter
boolean
No
Default: false. If true, will return items based on filter dates.
groupKey
string
No
Should contain comma separated UUID only. UUIDs of groups for which items to show.
includeGroupRecipientItems
boolean
No
If true, will include group recipients items.
includeImageLinks
boolean
No
If true, will include item image URLs and item thumbnail image URLs.
includeLabels
boolean
No
Default: false. If true it will return Labels attached to the item.
includeMemberBusinesses
boolean
No
Default: false. If true, response will include recipients groups.
includePackageThumbnail
boolean
No
Default: false. If true, will include item thumbnail URLs.
includeRecipientGroups
boolean
No
If true, will include group of recipients.
memberId
string
No
Filter items based on recipient ID.
orderAsc
boolean
No
true to sort items in ascending order.
orderBy
string
Yes
Default: created_at. One of the "created_at", "updated_at".
paginationLimit
integer
Yes
Default/Max: 50. The pagination limit.
paginationOffset
integer
Yes
If set, the result records would be offset-ed by this number.
Get Labels
GET Labels
Endpoint
/labels-api
Description
This endpoint retrieves all item labels for the tenant/location
Content-Type
application/json
Query Parameters
The following parameters are accepted in the query string of the request.
mailroomId
integer
No
ID of mailroom to get labels for mailroom.
locationId
integer
No
ID of location to get location labels
Recipients API
Base URL
https://entities-api.packagex.io/v1
Get Recipient
Endpoint
/members-api
Description
This endpoint retrieves all recipients within access limits of user role.
Content-Type
application/json
Query Parameters
The following parameters are accepted in the query string of the request.
locationId
integer
Yes
Unique location ID for location selection. If set, the result will only contain recipients of specific location.
activityType
string
No
Default: All. Get all pending items based on items activity type. Options: "SCAN-IN","SCAN-OUT","All"
fromDate
string <date-time>
No
Date in ISO 8601 format. e.g. "2022-04-11T00:00:00Z"
toDate
string <date-time>
No
Date in ISO 8601 format. e.g. "2022-04-11T11:59:59Z"
includeDesignatedMembersOnly
boolean
No
Default: false. If true, only designated number of recipients of a group will be returned.
includeInactive
boolean
No
Default: false. If true, the response will contain inactive recipients, otherwise only active recipients are returned.
includeNotes
boolean
No
Default: false. If true, notes against the recipients will be returned.
includeNumPendingitems
boolean
No
Default: false. If true, number of pending items associated with all the recipients will be returned. Recipients with no items in the given time window will not be returned as a result.
includeTenantEntity
boolean
No
Default: false. If true, the response will contain an array of json group objects.
orderAsc
boolean
No
Order by ascending or descending.
orderBy
string
No
Default: recentNotifiedFirst. If "recentNotifiedFirst" is specified, then members who have items will appear at top and will be sorted according to the items which have been recently notified. Options: "name", "createdAt", "updatedAt".
paginationLimit
integer
Yes
Default/Max:50, if set, the number of records returned will be equal to this number.
paginationOffset
integer
Yes
If set, the result records would be offset-ed by this number.
searchAttr
string
No
Search based on attribute. Options: "name", "email", "unit", "all". Required with searchQuery.
searchQuery
string
No
Search keyword. Min 3 characters required. Required with searchAttr.
Post Recipient
Endpoint
/members-api
Description
This endpoint adds a new recipients in the specified building.
Content-Type
application/json
Query Parameters
The following parameters are accepted in the body of the request in a json format
locationId
integer
Yes
Unique location ID for location selection. If set, the result will only contain recipients of specific location.
name
string
Yes
Name of the recipient.
string
Yes
Email address of the recipient.
phone
string
No
Phone number of the recipient.
officeNumber
string
No
Unit/Office number of the recipient in the building.
floor
string
No
Floor number of the recipient in the building.
permanentAddress
string
No
Permanent address of recipient.
alternateName
Array of strings
No
Alternate names / Nick names of the recipient.
alternateEmail
Array of strings
No
Alternate phone numbers of the recipient.
alternatePhone
Array of strings
No
Alternate phone numbers of the recipient.
note
string
No
Recipient Notes.
custom1
string
No
First custom attribute of recipient.
custom2
string
No
Second custom attribute of recipient.
Update Recipient
Endpoint
/members/uuid/{uuid}/api
Description
This endpoint updates a recipient
Content-Type
application/json
Query Parameters
The following parameters are accepted in the body of the request in a json format
locationId
integer
Yes
Unique location ID for location selection. If set, the result will only contain recipients of specific location.
uuid
string
Yes
UUID of the recipient.
name
string
Yes
Name of the recipient.
string
Yes
Email address of the recipient.
phone
string
No
Phone number of the recipient.
officeNumber
string
No
Unit/Office number of the recipient in the building.
floor
string
No
Floor number of the recipient in the building.
permanentAddress
string
No
Permanent address of recipient.
alternateName
Array of strings
No
Alternate names / Nick names of the recipient.
alternateEmail
Array of strings
No
Alternate phone numbers of the recipient.
alternatePhone
Array of strings
No
Alternate phone numbers of the recipient.
note
string
No
Recipient Notes.
custom1
string
No
First custom attribute of recipient.
custom2
string
No
Second custom attribute of recipient.
Delete Recipient
Endpoint
/members/uuid/{uuid}/api
Description
This endpoint deletes a recipient
Content-Type
application/json
Query Parameters
The following parameters are accepted in the body of the request in a json format
uuid
string
Yes
UUID of the recipient.
locationId
integer
Yes
Should contain comma separated UUID only. UUIDs of recipients to delete.
Response Example
{
"pagination": {},
"data": [
{
"message": "Member Deleted Successfully"
}
]
}