Skip to content
Shipping APIs
/
/
Job status

Job status

Request

job status

Security
bearerAuth
Path
jobIdstringrequired

The jobId, a unique identifier assigned for the job.

Headers
X-PB-Developer-Partner-Idstring

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 isn't required.

X-PB-LocationIdstring

The X-PB-LocationId header identifies the enterprise, developer, or partner location under which a shipment is processed and billed. If the header is not provided, the system defaults to the enterprise-level location that was created during developer account onboarding. This default location is automatically used for shipment processing and billing.

Requirement Rules

  • The X-PB-LocationId header is optional when the shipment origin country code matches the enterprise's default address country code.
  • The X-PB-LocationId header is required when the shipment origin country code differs from the enterprise's default address country code.
  • If the header is required but not provided, the API will return a validation error "invalid origin countryCode".
X-PB-TransactionIdstring

A unique transaction Id provided by the partner which is used to enable debugging and linking between the client's transaction and the system.

curl -i -X GET \
  'https://api-sandbox.sendpro360.pitneybowes.com/shipping/api/v1/jobs/{jobId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-PB-Developer-Partner-Id: string' \
  -H 'X-PB-LocationId: string' \
  -H 'X-PB-TransactionId: string'

Responses

The document has been printed successfully.

Bodyapplication/json
jobIdstring

Job ID can be used to check the status of the print request.

Example:"LkolBjvmy3mBzyp"
statusstring

Refers to the status of Print Job.

Example:"SUCCESS"
printStatusTransactionArray of objects
Response
{
  "jobId": "LkolBjvmy3mBzyp",
  "status": "SUCCESS",
  "printStatusTransaction": [
    {
      "name": "LkolBjvmy3mBzyp",
      "status": "COMPLETED"
    }
  ]
}