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.

Important: This operation does not apply to PB Standard Delivery or PB Presort.

Considerations

  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 PB Standard Delivery or PB Presort.

Request URLs

Sandbox: https://shipping-api-sandbox.pitneybowes.com/shippingservices/v1/manifests?originalTransactionId={transaction_id}
Production: https://shipping-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

Recommended. Set this to true to use the standard error object if an error occurs.

Response Elements

Name

Data Type

Description

carrier

String

The carrier to which the manifest applies.

submissionDate

String

The date the shipments are to be tendered to the carrier, entered as YYYY-MM-DD.

fromAddress

Address Object

The shipment origin address.

inductionPostalCode

String

Postal code where the shipments are tendered to the carrier.

parcelTrackingNumbers

Array[String]

Identifies shipments by their tracking numbers.

manifestId

String

The unique manifest ID.

manifestTrackingNumber

String

The manifest tracking number. This is returned only if carrier has a value of USPS.

documents

Array[Documents Object]

The 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": "2021-06-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 error codes returned by the Ecommerce APIs, please see Error Codes.