Job Submission

This is the final stage of a job, where it will be submitted for a final checkout.

URL Config

Method: POST
Endpoint: https://api-stage.dps.io/api
APIVersion: v1
route: jobs/submit
path: 

Request Headers

{
  "Content-Type": "application/json",
  "x-api-key": "<YOUR_API_KEY>",
  "ShipperHash": "<YOUR SHIPPER HASH>"
}

tip

• Use Staging to checkout on staging mode.

• Use Live to checkout on live mode (a charge will be deducted).

info

If API Service is ePostage and container is not equal to VARIABLE, Use Request Body (1).

Request Body (1)

{
            'JobHash': '77oA******dM1I7W',
            'Mode': 'Staging',
            'ShipDate': 'mm/dd/yyyy',
            'Container': 'MD FLAT RATE BOX'
}

info

If API Service is ePostage and container is equal to VARIABLE, Use Request Body (2).

Request Body (2)

{
  'JobHash':'77oA******dM1I7W',
  'Mode': 'Staging',
  'ShipDate': 'mm/dd/yyyy',
  'Container': 'VARIABLE',
  'Width': 5, 
  'Length': 1, 
  'Height': 1
  }
          

ePostage checkout Curl request

curl --location --request POST 'https://api-stage.dps.io/api/v1/jobs/submit' \
--header 'x-api-key: <your-api-key>' \
--header 'ShipperHash: <YOUR SHIPPER HASH>' \
--header 'Content-Type: application/json' \
--data-raw '{
            'JobHash': '77oA******dM1I7W',
            'Mode': 'Staging',
            'ShipDate': 'mm/dd/yyyy',
            'Container': 'MD FLAT RATE BOX'
}'

Response

{
"JobHash": "77oA******dM1I7W", 
"ShipperHash": "<YOUR SHIPPER HASH>", 
"TrackingHash": "9h*********xD", 
"ArticleNumber": "4203*******3419", 
"LabelPreviewUrl": "https://<USPS Label URL>", 
"LabelKey": "<USPS Label Path>", 
"Postage": "PMAIL", 
"Weight": 0.88, 
"Mode": "Staging", 
"ShipDate": "11/28/2023", 
"Container": "MD FLAT RATE BOX", 
"Charged": <Deducted amount>, 
"StorageCost": 0.0, 
"CertificateCost": 0.0, 
"StorageYears": 1
}

info

If API Service is Print2Mail, use Request Body (3).

Request Body (3)

{
  "JobHash": "77oA******dM1I7W",
  "Mode": "Staging"
}

Print2Mail checkout Curl request

curl --location --request POST 'https://api-stage.dps.io/api/v1/jobs/submit' \
--header 'x-api-key: <your-api-key>' \
--header 'ShipperHash: <YOUR SHIPPER HASH>' \
--header 'Content-Type: application/json' \
--data-raw '{
            'JobHash': '77oA******dM1I7W',
            'Mode': 'Staging'
}'

Response

Your job has been added to queue,please check it on tracking.