Skip to content

Reprint Shipment

Request

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.
Security
bearerAuth
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.

Bodyapplication/jsonrequired
shipmentIdstringrequired

The shipmentId is a unique identifier for an individual Shipment.

Example:"PUROLATOR2200626353009030"
printerAliasNamestring

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

Example:"ZPLtoSheltonTest"
referencesobject

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.

curl -i -X POST \
  https://api-dev.sendpro360.pitneycloud.com/shipping/api/v2/shipments/reprint \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-PB-Developer-Partner-Id: string' \
  -H 'X-PB-LocationId: string' \
  -H 'X-PB-TransactionId: string' \
  -d '{
    "shipmentId": "PUROLATOR2200626353009030",
    "printerAliasName": "ZPLtoSheltonTest",
    "references": {
      "additionalReference1": "612987641",
      "additionalReference2": "989"
    }
  }'

Responses

The shipment has been reprinted.

Bodyapplication/json
shipmentIdstring

The shipmentId, a unique identifier for an individual Shipment, which is used for Reprint or Cancel.

Example:"PUROLATOR2200626443337314"
parcelTrackingNumberstring

The Tracking number given to the Parcel for tracking purpose.

Example:329039098457
labelLayoutArray of objects

It defines the layout of the shipping label.

parcelobject(parcelV2)

The details of the Parcel.

rateobject(rateResponseV2)
referencesobject

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.

printStatusstring

Status of the Printed Label.

Example:"submitted"
Response
{ "shipmentId": "PUROLATOR2200626443337314", "parcelTrackingNumber": 329039098457, "labelLayout": [ { "contentType": "BASE64", "contents": "Xhsafiuis", "fileFormat": "ZPL2", "size": "DOC_4X6", "type": "SHIPPING_LABEL" } ], "parcel": { "length": 2, "width": 1, "height": 1, "dimUnit": "IN", "weightUnit": "OZ", "weight": 2, "packageValue": 2 }, "rate": { "baseCharge": 16.15, "carrier": "PUROLATOR", "currencyCode": "CAD", "parcelType": "PKG", "serviceId": "GRD", "surcharges": [ { … } ], "totalCarrierCharge": 22.46, "deliveryCommitment": { "estimatedDeliveryDateTime": "2024-03-25", "maxEstimatedNumberOfDays": 5, "guarantee": "None" }, "inductionPostalCode": "06905", "destinationZone": 1 }, "references": { "additionalReference1": "612987641", "additionalReference2": "989" }, "printStatus": "submitted" }