Get Batch Shipment Details

"This API operation provides the shipment details for those shipments which are SUCCESS or FAILED during batch processing at the following levels:

  • addressValidation
  • rating
  • labelGeneration, and
  • voidLabel

Based on fields/data mentioned in Query Parameter, user can check shipment details for particular status at any levels.
If no values are provided in the fields mentioned in Query Parameter, the default for each will be:

  • Page: 1
  • Size: 20
  • Status: SUCCESS/FAILED.
SecuritybearerAuth
Request
path Parameters
batchId
required
string

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

query Parameters
page
integer

It returns detailed information for shipments status and it can cover in one or more pages. The default value for page number is 1.

size
integer

Indicates the number of records per page. The default value for records is 20.

status
string

The status of the shipment. Values can be Failed or Success.

Enum: "SUCCESS" "FAILED"
step
string

Indicates various stages of the batch processing.

Enum: "rating" "addressValidation" "labelGeneration" "voidLabel"
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

Detailed status of processed shipments for the batch.

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}/shipments
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pageInfo": {
    }
}