Retry a Manifest

HTTP Request

GET /v1/manifests?originalTransactionId={transaction_id}

Summary

This operation retries a Create Manifest request that was submitted but received no response. You can use this operation only if the request received no response at all. If the request returned an error, you must instead create a new manifest.

Things to Consider

  1. Do not use this operation if the request returned an error. Instead use create a new manifest.
  2. This operation does not apply to Newgistics or PB Presort.

Request URIs

Sandbox: https://api-sandbox.pitneybowes.com/shippingservices/v1/manifests?originalTransactionId={transaction_id}
Production: https://api.pitneybowes.com/shippingservices/v1/manifests?originalTransactionId={transaction_id}

Query Parameter

Name Description
originalTransactionId Required. The X-PB-TransactionId that was used when the original manifest was submitted.

Request Header

Name Description
Authorization Required. OAuth token generated using the Generate an OAuth Token API.
X-PB-UnifiedErrorStructure (new) Available in Sandbox: Set this to true to use the standard error object if an error occurs.

Response Elements

IMPORTANT: Some fields might not apply to your operation.

The response returns a manifest object. The following table describes all possible fields in a manifest object, including those used in manifest requests. Request-only fields are marked as such.

Name Data Type Description
carrier String

Required. The carrier to which the manifest applies. For some operations, this field is not present in the response. Valid values:

  • USPS
  • NEWGISTICS (applicable only if creating a manifest)
  • PBPresort (applicable only if creating a manifest)
submissionDate String

Required. The date the shipments are tendered to the carrier. The time must be in GMT/UTC and in one of the following formats:

  • YYYY-MM-DD
  • YYYY-MM-DD HH:mm:ss
  • YYYY-MM-DD HH:mm:ss.SSS
fromAddress address object Required. The shipment origin address.
inductionPostalCode String

Postal code where the shipments are tendered to the carrier.

Note: Not applicable to Newgistics manifests.

parcelTrackingNumbers Array[String]

Identifies shipments by their tracking numbers. List one or more shipment tracking numbers, separated by commas.

Note: Not applicable to Newgistics manifests.

parameters Array[Object] Each object in the array defines a different manifest parameter. This field is used only in the request and is not returned in the response.
        name String The name of the manifest parameter.
        value String The value of the manifest parameter.
manifestId String Response Only. The unique manifest ID.
manifestTrackingNumber String Response Only. The manifest tracking number.
documents Array[documents object]

Response Only. The manifest.

Note: Not returned for a Newgistics manifest.

Sample Request

curl -X GET .../v1/manifests?originalTransactionId=manifest-abc-111 \
-H "Authorization: Bearer <oauth_token>" \
-H "X-PB-UnifiedErrorStructure: true"

Sample Response

{
    "carrier": "USPS",
    "submissionDate": "2017-07-12 00:00:00.0",
    "fromAddress": { ... },
    "parcelTrackingNumbers": [
        "9405509898641490869341"
    ],
    "manifestId": "9475709899581000147106",
    "manifestTrackingNumber": "9475709899581000147106",
    "documents": [ {
        "type": "MANIFEST",
        "contentType": "URL",
        "contents": "https://.../usps/872060188/scanform/5c080c0ccd6b4d5aa5dfbf1957f12ce8.pdf"
    } ]
}

Error Codes

For a list of all PB Complete Shipping APIs error codes, see Error Codes.