Reprint Shipment

This operation retrieves an existing shipping label associated with a shipment. The API uses the shipmentId returned by the original Create Shipment request. Use this API only if the original shipping label has been lost or damaged.

Key Considerations:

  • This operation is applicable only if the original shipment was successfully created. It cannot be used if the initial Create Shipment request resulted in no response or encountered an error.
  • USPS allows only 1 reprint.
  • GoFor does not allow reprint.
  • RMG allows 3 reprints.
  • All other carriers allow up to 8 reprints.
  • Reprints are valid for 24 hours from the time the label was first created.
  • Reprinting should only be used when necessary. Excessive reprint attempts are restricted and monitored.
  • Follow the Troubleshooting section in case you are facing any issues creating a shipment.
SecuritybearerAuth
Request
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 isn't required.

X-PB-LocationId
string

This is the Location ID assigned as per the Developer's and Partner's parsed locations, to which all transactions will be billed.
Partner's location will be used for billing if it is configured, however, in case Partner's location is not given, then the Developer's location will be taken. Developer's location will be the default value.
Additionally, Developers and Partners can use carriers belong to this location only.

X-PB-TransactionId
string

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

Request Body schema: application/json
shipmentId
required
string

The shipmentId is a unique identifier for an individual Shipment.

printerAliasName
string

Refers to a printer connected (directly or via network) to a computer. Max length = 60

object

Contains key value map for passing references which is printed on Shipping Label.
For example Department Name, Invoice No., PO No., Package description, Order No./ Purchase Order No., Carrier note, Cost Account No., Transportation No., etc. . Max references allowed here is 2, and max length of each Reference field is 30. [IN/OUT].

Responses
200

The shipment has been reprinted.

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 error.

post/api/v2/shipments/reprint
Request samples
application/json
{
  • "shipmentId": "PUROLATOR2200626353009030",
  • "printerAliasName": "ZPLtoSheltonTest",
  • "references": {
    }
}
Response samples
application/json
{
  • "shipmentId": "PUROLATOR2200626443337314",
  • "parcelTrackingNumber": 329039098457,
  • "labelLayout": [
    ],
  • "parcel": {
    },
  • "rate": {
    },
  • "references": {
    },
  • "printStatus": "submitted"
}