Get Batch Status

This operation retrieves the status of an existing Batch using Batch ID. Once the Job status is completed, the URL received from Response can be used to download the shipping label in PDF format.

SecuritybearerAuth
Request
path Parameters
batchId
required
string

This is a system-generated unique identifier assigned to the Batch while it is processed.

header Parameters
X-PB-Developer-Partner-ID
string

The Developer-Partner- ID is assigned by PB to uniquely identify a Developer's strategic business partners. If the developer is the sole business partner, this field is not required.

Responses
200

Here, is the status of the Batch ID.

400

Invalid request.

401

The request could not be authorized.

404

The requested resource was not found.

500

The request could not be completed due to an internal server error.

get/api/v1/shipments/batch/{batchId}/status
Request samples 
Response samples 
application/json
{
  • "batchId": "string",
  • "name": "string",
  • "groupName": "string",
  • "status": "SUBMITTED",
  • "import": {
    },
  • "addressValidation": {
    },
  • "rating": {
    },
  • "labelGeneration": {
    },
  • "voidLabel": {
    },
  • "labelDetails": {},
  • "totalShipmentCharge": 8.97
}