Get Known Shipper

Request

This operation retrieves detailed information about a registered known shipper using their unique ID.

Security

bearerAuth

Path

shipperIDstringrequired

The unique ID of the known shipper.

curl -i -X GET \
  'https://api-sandbox.sendpro360.pitneybowes.com/shipping/api/v1/shippers/{shipperID}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Known shipper details successfully retrieved.

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