Update Known Shipper

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

SecuritybearerAuth
Request
path Parameters
shipperID
required
string

The unique ID of the known shipper.

Request Body schema: application/json
addressLine1
string

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

addressLine2
string

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

addressLine3
string

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

cityTown
string

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

stateProvince
string

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

postalCode
string

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

countryCode
string

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

name
string

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

company
string

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

phone
string

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

email
string

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

Responses
200

Known shipper details successfully updated.

400

Invalid or Bad Request

401

Unauthorized Error

404

Known Shipper not found.

500

Internal Server Error

put/api/v1/shippers/registration/{shipperID}
Request samples
application/json
{
  • "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"
}
Response samples
application/json
{
  • "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"
}