Register Known Shipper

This operation registers a merchant as a known shipper.

SecuritybearerAuth
Request
Request Body schema: application/json

Request body to register a merchant as a known shipper.

addressLine1
required
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
required
string

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

stateProvince
required
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
required
string

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)

countryCode
required
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
required
string

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

phone
required
string

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

carrierAccountId
required
string

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

email
required
string

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

Responses
200

The merchant has been successfully registered.

400

Invalid or Bad Request

401

Unauthorized Error

500

Internal Server Error

post/api/v1/shippers/registration
Request samples
application/json
{
  • "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"
}
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",
  • "carrierAccountId": "34jdsS81Kmp",
  • "email": "string",
  • "status": "new"
}