Skip to main content

About Shipper

The shipper ID is used to identify the account submitting jobs. The shipper is considered an object of the sender and provides the origin information for the shipment.

  • Creating a shipper
  • Get shipper details by ShipperHash
  • Get shipper details by email
Important

After creating a Shipper you need to verify the address of the shipper

A shipper could have multiple attributes. The following are all related attributes of the shipper.

KeyTypeRequiredLengthDescription
EmailStringYes150Shipper email address
ShipperHashStringYes150Shipper hashed key
VendorHashStringYes150Vendor hashed key
UniqueShipperIdIntegerYes150Shipper Id for unique identification
CompanyNameStringYes150Shipper's company
PersonNameStringYes150Name of person
AddressLine1StringYes150Address of person
AddressLine2StringYes150
CityStringYes150
StateStringYes2State code
CountryStringYes2Country code
ZipStringYes10Zip code
EmailStringYes150Shipper's email id
PhoneStringYes10Contact number
CreatedDateTimestampYes150Date & Time of shipper creation
LastModifiedTimestampYes150Date & Time of Shipper modification
IdentityVerifiedbooleanYesTrue or FalseTo verify Shipper
AvailableBalancefloatyes150Left amount of Shipper
ReferralCodeStringnull150Referral code Received either from Vendor or DPS Partner
CustomerIdStringnull150Customer unique id
TotalQueuedJobsintegerYes150Number of job done