Create a PB Standard Delivery Manifest (Closeout)

HTTP Request

POST /v1/manifests

Summary

This operation closes out the day for PB Standard Delivery parcels by electronically notifying Pitney Bowes how many parcels await. The operation does not generate a pickup slip. By default, the operation closes out all parcels generated since the previous closeout. You can optionally specify specific parcels to close out.

Note: To print a slip or container label for PB Standard Delivery parcels, see the Create Container Label API.

Prerequisite

The merchant must be onboarded with PB Standard. Please see the onboarding steps on the Pitney Bowes page.

Considerations

  1. When issuing the API call, you must set the following:

    Field Value
    carrier NEWGISTICS (PB Standard)
    submissionDate The date the shipments are to be tendered to the carrier.
    parameters

    You must include the following Manifest Parameters:

    • SHIPPER_ID: The merchant’s Pitney Bowes Shipper ID.

    • CLIENT_ID: The merchant’s unique PB Standard client ID, which was assigned when the merchant onboarded with PB Standard.

      If testing in Sandbox, set this to NGST.

  2. You can optionally close out specific parcels by specifying the parcel tracking numbers in the parcelTrackingNumbers array.

  3. You can optionally close out only those parcels corresponding to specific facilities by including the CARRIER_FACILITY_ID_<#> parameter in the parameters array. You can specify up to five facilities. Each requires a separate object in the parameters array.

    If testing in Sandbox, set this to 1585.

  4. Manifest requests for PB Standard Delivery do not support filtering by induction postal code.

  5. The manifest response does not contain a pickup slip.

  6. You cannot reprint or retry a PB Standard Delivery manifest.

Request URLs

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

See also APAC Services URLs.

APAC Services URLs

To manifest PB Standard Delivery shipments created with APAC Services, you must use the following URLs. You can use these URLs only if the shipments were created using APAC Services. These URLs apply only to PB Standard Delivery shipments created with APAC Services:

Sandbox URL APAC: https://apac-sandbox.shippingapi.pitneybowes.com/shippingservices/v1/manifests?carrier=Newgistics
Production URL APAC: https://apac.shippingapi.pitneybowes.com/shippingservices/v1/manifests?carrier=Newgistics

Query Parameter

Name Description
carrier APAC Services Only. If your manifest request originates in the Asia-Pacific Region and if you use the APAC Services URLs, you must set the carrier query parameter to Newgistics.

Request Headers

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

Required. A unique identifier for the transaction, up to 25 characters.

Important: You must ensure this is a unique id.

X-PB-UnifiedErrorStructure Recommended. Set this to true to use the standard error object if an error occurs.

Request / Response Elements

The API call sends and receives a Manifest Object. The following table describes all possible fields in a Manifest Object.

Important

Some fields in the Manifest Object are not applicable to this request and are marked as such.

Important

See the Considerations on this page for the required values when making this request.

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: PB Expedited or PMOD
  • NEWGISTICS: PB Standard
  • PBPresort: PB Presort
submissionDate String Required. The date the shipments are to be tendered to the carrier, entered as YYYY-MM-DD.
fromAddress Address Object

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 carrier field is set to NEWGISTICS, use the long version of the tracking number.

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).

        name String The name of the manifest parameter.
        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 carrier has a value of USPS.
documents Array[Documents Object]

RESPONSE ONLY. The manifest.

This field is not returned for a PB Standard manifest.

Sample Requests

See the following examples:

Close Out All Parcels Associated with the Shipper ID

Request
curl -X POST .../v1/manifests \
-H "Authorization: Bearer <oauth_token>" \
-H "Content-Type: application/json" \
-H "X-PB-TransactionId: <transaction-id>" \
-H "X-PB-UnifiedErrorStructure: true" \
-d '
{
    "carrier": "NEWGISTICS",
    "submissionDate": "2020-03-12",
    "parameters": [ {
        "name": "SHIPPER_ID",
        "value": "9024324564"
    },{
        "name": "CLIENT_ID",
        "value": "NGST"
    },{
        "name": "CARRIER_FACILITY_ID_1",
        "value": "1585"
    } ]
}'
Response
{
    "carrier": "newgistics",
    "submissionDate": "2020-03-12",
    "manifestId": "NGST03111552332799302",
    "parameters": [ {
        "name": "SHIPPER_ID",
        "value": "9024324564"
    },{
        "name": "CLIENT_ID",
        "value": "NGST"
    },{
        "name": "CARRIER_FACILITY_ID_1",
        "value": "1585"
    } ]
}

Close Out Parcels by Tracking Number

Request to Close Out by Tracking Number
curl -X POST .../v1/manifests \
-H "Authorization: Bearer <oauth_token>" \
-H "Content-Type: application/json" \
-H "X-PB-TransactionId: <transaction-id>" \
-H "X-PB-UnifiedErrorStructure: true" \
-d '
{
    "carrier": "NEWGISTICS",
    "submissionDate": "2020-05-15",
    "parameters": [ {
        "name": "SHIPPER_ID",
        "value": "9024324564"
    },{
        "name": "CLIENT_ID",
        "value": "NGST"
    } ],
    "parcelTrackingNumbers": [
        "4206740192612123456789000008534003",
        "4206740192612123456789000008524226",
        "4206740192612123456789000008526541"
    ]
}'
Response for Close Out by Tracking Number
{
    "carrier": "newgistics",
    "manifestId": "NGST05151589571962949",
    "parameters": [ {
        "name": "SHIPPER_ID",
        "value": "9024324564"
    },{
        "name": "CLIENT_ID",
        "value": "NGST"
    } ],
    "parcelTrackingNumbers": [
        "4206740192612123456789000008534003",
        "4206740192612123456789000008524226",
        "4206740192612123456789000008526541"
    ],
    "submissionDate": "2020-05-15"
}

Error Codes

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