Create a Manifest for PMOD Shipments

HTTP Request

POST /v1/manifests

Summary

This operation creates a PS Form 3152 to list PMOD shipments. The shipments must be requested by the same shipper on the same day and inducted at the same ZIP code or origin entry facility.

Things to Consider

  1. All shipments with rates.serviceId field set to PMOD are eligible for inclusion in the manifest. Such shipments are considered to have the ADD_TO_MANIFEST option enabled, no matter how the option is explicitly set. Setting the option to false has no effect. The API still considers the option to be enabled.

  2. A shipment is eligible for inclusion both on and before its shipment date.

  3. If an eligible shipment is not included in a manifest request within 24 hours of the specified shipment date, it is automatically manifested.

  4. Up to 5000 shipments can be included in a single manifest request.

  5. Shipments, once manifested, cannot be re-manifested.

  6. When creating the manifest, set the MANIFEST_TYPE to PMOD, as shown in the sample request, below.

  7. You can add shipments to the manifest by specifying Shipper ID, tracking numbers, or both:

    • If you specify Shipper ID, the form will include all eligible shipments created with that Shipper ID. To specify Shipper ID, add the SHIPPER_ID parameter to the parameters array.
    • If you specify tracking numbers, the form will include all eligible shipments with those tracking numbers. Specify tracking numbers in the parcelTrackingNumbers array.

    Note: If you specify both Shipper ID and tracking numbers, ensure the tracking numbers belong to the Shipper ID or the API will return an error.

  8. You can filter further by specifying an inductionPostalCode. When specified, the inductionPostalCode value in the manifest request must match the rates.inductionPostalCode value of the shipment. If a shipment has no rates.inductionPostalCode, the value in the manifest request must match the shipment’s fromAddress.postalCode.

  9. If a manifest request contains shipments with different inductionPostalCode values, then a multi-page manifest is created, with one inductionPostalCode value per page. The pages are accessed via a single PDF.

    For example, the operation will create multiple forms if the list of matching PMOD labels spans multiple induction ZIP codes or multiple origin entry facilities.

  10. Manifest documents retrieved through URLs are available for 24 hours after creation.

Request URIs

Sandbox: https://api-sandbox.pitneybowes.com/shippingservices/v1/manifests
Production: https://api.pitneybowes.com/shippingservices/v1/manifests

Request Headers

Name Data Type Description
Authorization String Required. OAuth token generated using the Generate an OAuth Token API.
Content-Type String Required. The media type of the request entity. Set this to application/json.
X-PB-TransactionId String

A unique identifier for the manifest, up to 25 characters.

Important: You must ensure this is a unique id.

Request / Response Elements

The API call sends and receives a manifest object. The table below describes all the elements in a manifest object. Some elements might not apply to your operation.

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 POST .../v1/manifests \
–H "Authorization: Bearer <oauth_token>" \
-H "Content-Type: application/json" \
–H "X-PB-TransactionId: <unique_transaction_id>" \
-d '
{
    "carrier": "usps",
    "submissionDate": "2017-08-14",
    "fromAddress": {
        "company": "Pitney Bowes Inc.",
        "name": "Ron Wilson",
        "phone": "203-000-0000",
        "email": "RonWilson@example.com",
        "residential": "false",
        "addressLines": ["8 Progress Drive"],
        "cityTown": "Shelton",
        "stateProvince": "CT",
        "postalCode": "06825",
        "countryCode": "US"
    },
    "parameters": [ {
        "name": "SHIPPER_ID",
        "value": "88888888"
    }, {
        "name": "MANIFEST_TYPE",
        "value": "PMOD"
    } ]
}'

Error Codes

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