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

Receive Portal

Get All Items

All Items

Endpoint

GET

/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.

Parameter

locationId

Type

string

Required

Yes

Description

Unique location ID for location selection. If set, the result will only contain recipients of specific location.

Parameter

filterOption

Type

string

Required

Yes

Description

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'.

Parameter

filterType

Type

String

Required

Yes

Description

Default: ALL. One of the filter "SCAN-IN","SCAN_OUT","ALL". returns items based on filter.

Parameter

fromDate

Type

string <date-time>

Required

No

Description

Date in ISO 8601 format. e.g. "2022-04-11T00:00:00Z

Parameter

toDate

Type

string <date-time>

Required

No

Description

Date in ISO 8601 format. e.g. "2022-04-11T11:59:59Z"

Parameter

graphTypeFilter

Type

boolean

Required

No

Description

Default: false. If true, will return items based on filter dates.

Parameter

groupKey

Type

string

Required

No

Description

Should contain comma separated UUID only. UUIDs of groups for which items to show.

Parameter

includeGroupRecipientItems

Type

boolean

Required

No

Description

If true, will include group recipients items.

Parameter

includeImageLinks

Type

boolean

Required

No

Description

If true, will include item image URLs and item thumbnail image URLs.

Parameter

includeLabels

Type

boolean

Required

No

Description

Default: false. If true it will return Labels attached to the item.

Parameter

includeMemberBusinesses

Type

boolean

Required

No

Description

Default: false. If true, response will include recipients groups.

Parameter

includePackageThumbnail

Type

boolean

Required

No

Description

Default: false. If true, will include item thumbnail URLs.

Parameter

includeRecipientGroups

Type

boolean

Required

No

Description

If true, will include group of recipients.

Parameter

memberId

Type

string

Required

No

Description

Filter items based on recipient ID.

Parameter

orderAsc

Type

boolean

Required

No

Description

true to sort items in ascending order.

Parameter

orderBy

Type

string

Required

Yes

Description

Default: created_at. One of the "created_at", "updated_at".

Parameter

paginationLimit

Type

integer

Required

Yes

Description

Default/Max: 50. The pagination limit.

Parameter

paginationOffset

Type

integer

Required

Yes

Description

If set, the result records would be offset-ed by this number.

Get Labels

GET Labels

Endpoint

GET

/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.

Parameter

mailroomId

Type

integer

Required

No

Description

ID of mailroom to get labels for mailroom.

Parameter

locationId

Type

integer

Required

No

Description

ID of location to get location labels

Recipients API

Base URL

https://entities-api.packagex.io/v1

Get Recipient

Endpoint

GET

/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.

Parameter

locationId

Type

integer

Required

Yes

Description

Unique location ID for location selection. If set, the result will only contain recipients of specific location.

Parameter

activityType

Type

string

Required

No

Description

Default: All. Get all pending items based on items activity type. Options: "SCAN-IN","SCAN-OUT","All"

Parameter

fromDate

Type

string <date-time>

Required

No

Description

Date in ISO 8601 format. e.g. "2022-04-11T00:00:00Z"

Parameter

toDate

Type

string <date-time>

Required

No

Description

Date in ISO 8601 format. e.g. "2022-04-11T11:59:59Z"

Parameter

includeDesignatedMembersOnly

Type

boolean

Required

No

Description

Default: false. If true, only designated number of recipients of a group will be returned.

Parameter

includeInactive

Type

boolean

Required

No

Description

Default: false. If true, the response will contain inactive recipients, otherwise only active recipients are returned.

Parameter

includeNotes

Type

boolean

Required

No

Description

Default: false. If true, notes against the recipients will be returned.

Parameter

includeNumPendingitems

Type

boolean

Required

No

Description

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.

Parameter

includeTenantEntity

Type

boolean

Required

No

Description

Default: false. If true, the response will contain an array of json group objects.

Parameter

orderAsc

Type

boolean

Required

No

Description

Order by ascending or descending.

Parameter

orderBy

Type

string

Required

No

Description

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".

Parameter

paginationLimit

Type

integer

Required

Yes

Description

Default/Max:50, if set, the number of records returned will be equal to this number.

Parameter

paginationOffset

Type

integer

Required

Yes

Description

If set, the result records would be offset-ed by this number.

Parameter

searchAttr

Type

string

Required

No

Description

Search based on attribute. Options: "name", "email", "unit", "all". Required with searchQuery.

Parameter

searchQuery

Type

string

Required

No

Description

Search keyword. Min 3 characters required. Required with searchAttr.

Post Recipient

Endpoint

POST

/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

Parameter

locationId

Type

integer

Required

Yes

Description

Unique location ID for location selection. If set, the result will only contain recipients of specific location.

Parameter

name

Type

string

Required

Yes

Description

Name of the recipient.

Parameter

email

Type

string

Required

Yes

Description

Email address of the recipient.

Parameter

phone

Type

string

Required

No

Description

Phone number of the recipient.

Parameter

officeNumber

Type

string

Required

No

Description

Unit/Office number of the recipient in the building.

Parameter

floor

Type

string

Required

No

Description

Floor number of the recipient in the building.

Parameter

permanentAddress

Type

string

Required

No

Description

Permanent address of recipient.

Parameter

alternateName

Type

Array of strings

Required

No

Description

Alternate names / Nick names of the recipient.

Parameter

alternateEmail

Type

Array of strings

Required

No

Description

Alternate phone numbers of the recipient.

Parameter

alternatePhone

Type

Array of strings

Required

No

Description

Alternate phone numbers of the recipient.

Parameter

note

Type

string

Required

No

Description

Recipient Notes.

Parameter

custom1

Type

string

Required

No

Description

First custom attribute of recipient.

Parameter

custom2

Type

string

Required

No

Description

Second custom attribute of recipient.

Update Recipient

Endpoint

PUT

/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

Parameter

locationId

Type

integer

Required

Yes

Description

Unique location ID for location selection. If set, the result will only contain recipients of specific location.

Parameter

uuid

Type

string

Required

Yes

Description

UUID of the recipient.

Parameter

name

Type

string

Required

Yes

Description

Name of the recipient.

Parameter

email

Type

string

Required

Yes

Description

Email address of the recipient.

Parameter

phone

Type

string

Required

No

Description

Phone number of the recipient.

Parameter

officeNumber

Type

string

Required

No

Description

Unit/Office number of the recipient in the building.

Parameter

floor

Type

string

Required

No

Description

Floor number of the recipient in the building.

Parameter

permanentAddress

Type

string

Required

No

Description

Permanent address of recipient.

Parameter

alternateName

Type

Array of strings

Required

No

Description

Alternate names / Nick names of the recipient.

Parameter

alternateEmail

Type

Array of strings

Required

No

Description

Alternate phone numbers of the recipient.

Parameter

alternatePhone

Type

Array of strings

Required

No

Description

Alternate phone numbers of the recipient.

Parameter

note

Type

string

Required

No

Description

Recipient Notes.

Parameter

custom1

Type

string

Required

No

Description

First custom attribute of recipient.

Parameter

custom2

Type

string

Required

No

Description

Second custom attribute of recipient.

Delete Recipient

Endpoint

DELETE

/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

Parameter

uuid

Type

string

Required

Yes

Description

UUID of the recipient.

Parameter

locationId

Type

integer

Required

Yes

Description

Should contain comma separated UUID only. UUIDs of recipients to delete.

Response Example

{
  "pagination": {},
  "data": [
    {
      "message": "Member Deleted Successfully"
    }
  ]
}