Skip to content
Receiving APIs
/
/
Get Inbound Site

Get Inbound Site

Request

This operation is used to retrived the Inbound Sites.

Security
bearerAuth
Query
skipinteger

Number of records to skip from the beginning.

Example:skip=0
limitinteger

Maximum number of records to return in one response.

Example:limit=20
sortstring

Sorts the results by a specific field in ascending (ASC) or descending (DESC) order.

Example:sort=name,ASC
querystring

Searches for inbound sites using a keyword.

Example:query=site
searchBystring

Finds inbound sites based on a relationship with another site.

Examples:
For getting inbound sites which belongs to particaular site
searchBy=parent:X7okeWJyx5zz
For searching inside the inbound sites hierarchy
searchBy=ancestorlist:X7okeWJyx5zz
fetchPrimarySiteboolean

Only get default site in response, if set true.

Example:fetchPrimarySite=true
timestampstring

Get inbound site which are created before or after the provided timestamp.

Example:timestamp=2024-11-19T07:54:46.807
statusstring

Only get default site in response, if set true.

Enum:"active""inactive"
Example:status=active
curl -i -X GET \
  'https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack/api/v1/inboundsites?skip=0&limit=20&sort=name%2CASC&query=site&searchBy=parent%3AX7okeWJyx5zz&fetchPrimarySite=true&timestamp=2024-11-19T07%3A54%3A46.807&status=active' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Requested Inbound Sites list has been retrived successfully.

Bodyapplication/json
inboundsitesArray of objects(InboundSiteResponse)

List of inbound sites

pageInfoobject(PageInfo)
Response
{
  "inboundsites": [
    {
      "inboundSiteId": "xy277mD9Plbl",
      "name": "Gandhi Nagar",
      "type": "site",
      "locationId": "M0K9QbNMgob",
      "locationHierarchy": "Gandhi Nagar",
      "status": "ACTIVE",
      "defaultSite": false
    }
  ],
  "pageInfo": {
    "totalCount": 9,
    "startCount": 1,
    "limit": 10
  }
}