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¶
Do not use this operation if the request returned an error. Instead use create a new manifest.
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 |
Request Header¶
Name |
Description |
---|---|
Authorization |
Required. OAuth token generated using the Generate an OAuth Token API. |
X-PB-UnifiedErrorStructure |
Recommended. Set this to |
Response Elements¶
The API call returns a Manifest Object. The following table describes all possible fields in a Manifest Object.
Important
Some fields in the Manifest Object do not apply to this operation and are marked accordingly.
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:
|
submissionDate |
String |
Required. The date the shipments are to be tendered to the carrier, entered as |
fromAddress |
Conditional. The shipment origin address. Required for:
|
|
inductionPostalCode |
String |
Conditional. Postal code where the shipments are tendered to the carrier. This field does not apply to PB Standard manifests. |
parcelTrackingNumbers |
Array[String] |
Identifies shipments by their tracking numbers. List one or more tracking numbers, separated by commas. Enter each tracking number as a separate String. If the |
parameters |
Array[Object] |
Conditional. 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. Required for PB Standard Manifests (Closeouts). |
parameters.name |
String |
The name of the manifest parameter. |
parameters.value |
String |
The value of the manifest parameter. |
manifestId |
String |
RESPONSE ONLY. The unique manifest ID. This field is not returned for APAC Services. This field is not returned for APAC Services. |
manifestTrackingNumber |
String |
RESPONSE ONLY. The manifest tracking number. This is returned only if |
documents |
Array[Documents Object] |
RESPONSE ONLY. The manifest. This field is not returned for a PB Standard 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.