Create Shipper

Creating a shipper ID must be completed before submitting jobs. Once created you can make the following requests.

Get shipper details by ShipperHash
Get shipper details by email

Important

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

URL Config
Endpoint: https://api.dps.io/api
APIVersion: v1
route: shippers
path: 

Method

POST

URL

https://api.dps.io/api/v1/shippers

Request Headers
{
    "Content-Type": "application/json",
    "x-api-key": "<YOUR_API_KEY>",
}

Request Body
{
    "Email": "testapi2@dps.io", 
    "CompanyName": "TestCompany",
    "PersonName": "John Doe",
    "AddressLine1": "3195 Stanley Avenue",
    "AddressLine2": "Garden City",
    "City": "Garden City",
    "State": "NY",
    "Country": "US",
    "Zip": "11530",
    "Phone": "9876543210",
    "VendorHash": "8fcb******************wY6"
}

Curl request
curl --location --request POST 'https://api.dps.io/api/v1/shippers' \
--header 'x-api-key: xxxxxxdfjbdjdfjdhfxxxxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Email": "testapi2@dps.io", 
    "CompanyName": "TestCompany",
    "PersonName": "John Doe",
    "AddressLine1": "3195 Stanley Avenue",
    "AddressLine2": "Garden City",
    "City": "Garden City",
    "State": "NY",
    "Country": "US",
    "Zip": "11530",
    "Phone": "9876543210",
    "VendorHash": "8fc**********************5wY6"
}'

Response
{
    "ShipperHash": "F1WQ***************UI8Gd",
}

Error codes and status

Code	Description
200	This key contains your shipper hash, you will get the value if a valid shipper exists
400	Bad request response will be received in case of any error

Info

"VendorHash" issued by the DPS team. DPS team will issue a vendorHash with an authentication code, VendorHash also known as Partner Code.

Important

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