Create a Newgistics Manifest (Closeout)

HTTP Request

POST /v1/manifests

Summary

This operation closes out the day for Newgistics parcels by electronically notifying Newgistics how many parcels await. Newgistics creates manifest files for all valid labels generated since previous closeout. The operation does not generate a pickup slip.

You can close out parcels for up to five facilities with one API call. To close out parcels for additional facilities, you must issue the API call again.

Things to Consider

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

    Field Value
    carrier NEWGISTICS
    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 PB Shipper ID.
    • CLIENT_ID: The merchant’s Newgistics Merchant ID.

     

  2. You can optionally include up to five instances of the CARRIER_FACILITY_ID_<#> manifest parameter to close out pieces corresponding to specific facilities. If this parameter is not specified, all un-manifested parcels are closed out.

  3. Manifest requests for Newgistics do not support filtering by tracking numbers or induction postal code. If you provide these values in the request, they will be ignored.

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

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

Required. A unique identifier for the pickup slip, 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 are not applicable to Newgistics and are marked as such.

IMPORTANT: See Things to Consider on this page for the required values when making a 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
  • 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: 8e-485d-9313-4b6d1343a054" \
-d '
{
    "carrier": "NEWGISTICS",
    "submissionDate": "2018-03-12",
    "parameters": [ {
        "name": "SHIPPER_ID",
        "value": "11111"
    },{
        "name": "CARRIER_FACILITY_ID_1",
        "value": "1585"
    },{
        "name": "CLIENT_ID",
        "value": "NGST"
    } ]
}

Sample Response

{
    "carrier": "NEWGISTICS",
    "submissionDate": "2018-03-12",
    ...
}

Error Codes

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