Process Batch

This operation processes (executes) the existing Batch. The payload for this endpoint needs only an empty JSON object and no additional data is required in the request body. The BatchID parameter located in the endpoint specifies which batch of shipments to process.

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

The Batch has been processed successfully.

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.

post/api/v1/shipments/batch/{batchId}/process
Request samples 
Response samples 
application/json
{
  • "batchId": "string",
  • "name": "string",
  • "groupName": "string",
  • "status": "string"
}