Skip to content
Partner APIs
/
Knownshippers APIs
/
/
Update Known Shipper

Update Known Shipper

Request

This operation updates details of an existing known shipper.
Body must not be empty.

Security
bearerAuth
Path
shipperIDstringrequired

The unique ID of the known shipper.

Bodyapplication/jsonrequired
addressLine1string

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:"1236 Elm Street"
addressLine2string

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

Example:"Suite 367"
addressLine3string

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

Example:"Building B"
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. It is the 2-letter State or Province Code for US address(es).

Example:"UT"
postalCodestring

The Postal Code or ZIP Code of the address.
For US addresses, use only 9-digit ZIP Code.

Example:"941056743"
countryCodestring

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

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

Example:"PB"
phonestring

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

Example:"1234512343"
emailstring

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

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

Responses

Known shipper details successfully updated.

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

This is known-shippers's valid email address.

statusstring

This indicates the status for the operation.

Enum:"new""updated""withdrawn"
Example:"updated"
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",
  "email": "string",
  "status": "updated"
}