Skip to content
/Inbound sites

Inbound sites

APIs for managing inbound site records and their association with locations. Inbound sites represent physical or logical intake points where packages are received and processed. These APIs support operations such as Creating and managing inbound site hierarchy, retrieving inbound sites by filters (location, hierarchy, status), deleting inbound sites, and retrieving inbound sites mapped to specific locations.

Operations

Add Inbound Site

Request

This operation used for generating Inbound Site Id.

Security
bearerAuth
Bodyapplication/json
One of:
namestringrequired

The name of the inbound site to be added.

Example:"Site A"
typestringrequired

The type of the inbound site

Example:"site"
locationIdstringrequired

The location ID associated with the inbound site.

Example:"M0K9QbNMgob"
defaultSiteboolean

Indicates if this is the default site.

Example:true
curl -i -X POST \
  https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack/api/v1/inboundsites \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Site A",
    "type": "site",
    "locationId": "M0K9QbNMgob",
    "defaultSite": true
  }'

Responses

Requested Inbound Site Id has been generated successfully.

Bodyapplication/json
inboundSiteIdstring
Example:"zADZNQ1VWvvA"
Response
{
  "inboundSiteId": "zADZNQ1VWvvA"
}