Skip to content
Partner APIs
/
/Known Shipper

Known Shipper

APIs for managing known shipper entities. These APIs support operations such as registering a merchant as a known shipper, retrieving shipper details, updating shipper information, modifying shipper status, and deleting shipper records. They enable control over which merchants are authorized and active for shipping operations within the platform.

Operations

Register Known Shipper

Request

This operation registers a merchant as a known shipper.

Security
bearerAuth
Bodyapplication/jsonrequired

Request body to register a merchant as a known shipper.

addressLine1stringrequired

The addressLine1 contains the Flat number, Building or Apartment Name/number (if any) or company name (if not residential) of the Sender.
Max length = 50

Example:"1234 Elm Street"
addressLine2string

The addressLine2 contains the Area or Street Name. This is an optional field.
Max length = 50

Example:"Suite 567"
addressLine3string

The addressLine3 contains other details for easy reach, e.g. Landmark. This is an optional field.
Max length = 50

Example:"Building A"
cityTownstringrequired

The name of the city or town the merchant's address belongs to.

Example:"San Francisco"
stateProvincestringrequired

The name of the State or Province the merchant belongs to. It is the 2-letter State or Province Code for US address(es).

Example:"CA"
postalCodestringrequired

The Postal Code or ZIP Code of the address.
For US addresses, use only 9-digit ZIP Code. If it is 5 digit code then pass four zeros (0000)

Example:"941056743"
countryCodestringrequired

The country in which the merchant's address is located.

Example:"US"
namestring

Name of the merchant you want to register as a known shipper.

Example:"John Doe"
companystringrequired

The name of the company, in case if the merchant address is not residential.

Example:"PB"
phonestringrequired

This is merchant's phone number.
Max length = 10.

Example:"1234512343"
carrierAccountIdstringrequired

A unique identifier assigned to the specific carrier account. Its value can be referred from the response of Get Carrier Accounts API.

Example:"34jdsS81Kmp"
emailstringrequired

This must be merchant's valid email address.
Max length = 50

Example:"johndoe@yopmail.com"
curl -i -X POST \
  https://api-sandbox.sendpro360.pitneybowes.com/shipping/api/v1/shippers/registration \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "addressLine1": "1234 Elm Street",
    "addressLine2": "Suite 567",
    "addressLine3": "Building A",
    "cityTown": "San Francisco",
    "stateProvince": "CA",
    "postalCode": "941056743",
    "countryCode": "US",
    "name": "John Doe",
    "company": "PB",
    "phone": "1234512343",
    "carrierAccountId": "34jdsS81Kmp",
    "email": "johndoe@yopmail.com"
  }'

Responses

The merchant has been successfully registered.

Bodyapplication/json
shipperIDstring

A unique ID is generated for a merchant when they register as a known shipper. This ID is used for all future operations related to this known shipper

Example:"2000083071"
addressLine1string

The addressLine1 contains the Flat number, Building or Apartment Name/number (if any) or company name (if not residential) of the Sender.

Example:"1234 Elm Street"
addressLine2string

The addressLine2 contains the Area or Street Name. This is an optional field.

Example:"Suite 567"
addressLine3string

The addressLine3 contains other details for easy reach, e.g. Landmark.

Example:"Building A"
cityTownstring

The name of the city or town the merchant's address belongs to.

Example:"San Francisco"
stateProvincestring

The name of the State or Province the merchant belongs to.

Example:"CA"
postalCodestring

The Postal Code or ZIP Code of the address.

Example:"941056743"
countryCodestring

The country in which the merchant's address is located.

Example:"US"
namestring

Name of the merchant registered as a known shipper.

Example:"John Doe"
companystring

The name of the company, in case if the merchant address is not residential.

Example:"PB"
phonestring

This is known shipper's phone number.

Example:"1234512343"
carrierAccountIdstring

A unique identifier assigned to the specific carrier account.

Example:"34jdsS81Kmp"
emailstring

This is known-shippers's valid email address.

statusstring

This indicates the status for the operation.

Enum:"new""updated""withdrawn"
Example:"new"
Response
{
  "shipperID": "2000083071",
  "addressLine1": "1234 Elm Street",
  "addressLine2": "Suite 567",
  "addressLine3": "Building A",
  "cityTown": "San Francisco",
  "stateProvince": "CA",
  "postalCode": "941056743",
  "countryCode": "US",
  "name": "John Doe",
  "company": "PB",
  "phone": "1234512343",
  "carrierAccountId": "34jdsS81Kmp",
  "email": "string",
  "status": "new"
}