Create a Priority Mail Open and Distribute (PMOD) Label

HTTP Request

POST /v1/shipments

Summary

This operation prints labels for USPS-approved Priority Mail Open and Distribute (PMOD) containers.

PMOD uses Priority Mail to send containers containing lower classes of mail to USPS-authorized destination centers for processing, expediting the transport of the lower-class mailings. To use PMOD, shippers prepare their mailings and place them in approved USPS Priority Mail containers (sacks, trays, or tubs). They then affix PMOD labels to the containers and ship them to USPS-authorized centers, which open the containers and process the individual mailings according to their mail classes. The postage price is based on the weight of the contents (excluding the tare weight of the external container) and on regular Priority Mail distance-based prices.

PMOD works with both the individual and bulk payment models, which are described in Merchant Enrollment Models.

For more information on PMOD, contact the PB support team at ShippingAPISupport@pb.com.

Things to Consider

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

    Field Value
    rates.serviceId PMOD
    rates.parcelType

    Set to one of the following PMOD parcel types:

    • SACK — Sack
    • FTTB — Flat Tub Tray
    • HTB — Half Tray Box
    • FTB — Full Tray Box
    • EMMTB — Extended Managed Mail Tray Box
    rates.specialServices.specialServiceId PMOD_OPTIONS
    rates.specialServices.inputParameters Add a separate object for each PMOD option listed in the PMOD Options table below.
    toAddress

    Set this to the destination facility. The shipper is responsible for providing the destination facility address information. The addressing data should be derived from the Drop Entry files located at the USPS FAST web site: http://fast.usps.com.

    If the DESTINATION_ENTRY_FACILITY PMOD option is set to DDU, include the entire destination address: name, addressLines, cityTown, stateProvince, and postalCode.

    If the option is set to NDC, ADC, ASF or SCF, the address need only include the cityTown, stateProvince, and postalCode.

    Note: In some cases the ZIP code on a PMOD label does not correspond to the city and state referenced. For example, the Washington DC Network Distribution Center (NDC) is addressed as NDC WASHINGTON DC 20799. The 20799 ZIP code, however, is the Maryland ZIP code where the NDC is located.

  2. The maximum weight allowed for each container is 70 pounds.

  3. Stealth postage is not allowed with PMOD. You cannot hide postage. If you set the HIDE_TOTAL_CARRIER_CHARGE option to true, it will be ignored.

  4. PMOD labels are supported for domestic shipments only.

    Note: You cannot print PMOD labels for international destinations.

  5. The ADD_TO_MANIFEST option is always considered true for PMOD labels. If you set the option to false, the PB Shipping APIs ignore the setting and still consider the option to be true.

  6. After you create the PMOD label, you must add the label to PS Form 3152. See Create a Manifest for PMOD Shipments.

Request URIs

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

Query Parameter

Name Description
includeDeliveryCommitment

If set to true, returns estimated transit times in days.

Valid values:

  • true
  • false

See also:

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.
Accept-Language Language and country code. Default: en-US
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-Shipper-Rate-Plan USPS Only. Shipper rate plan, if applicable. For more information, see this FAQ.
X-PB-Integrator-CarrierId USPS Only. Negotiated services rate, if applicable.
X-PB-UnifiedErrorStructure Recommended. Set this to true to use the standard error object if an error occurs.

Request / Response Elements

Important

The API call sends and receives a Shipment Object. The table below describes all the elements in a Shipment Object. Some fields do no apply to PMOD and are marked as such.

Name Data Type Description
fromAddress Address Object

Required. Origin address.

If you want a different address to appear on the label from the one listed here, see How do I print a return address that is different from the origin address?

toAddress Address Object

Required. Destination address.

Note for UPS: If you are shipping with United Parcel Service (UPS) to Puerto Rico or an international destination, and if the importer is different from the final recipient, this is the address of the importer. Enter the recipient’s address in the soldToAddress object. If importer’s address is the same as the final recipient, the toAddress and soldToAddress must match.

altReturnAddress Address Object

Applies only to the following:

  • USPS: If you are sending an international shipment through USPS and if you have set the NON_DELIVERY_OPTION shipment option to redirect, then enter the address that a returned parcel should go to.
  • PB Cross-Border: For a Create Shipment request, this is the address used to return a parcel from the Pitney Bowes consolidation center. If omitted, the fromAddress is used.
parcel Parcel Object Required. Contains physical characteristics of the parcel.
rates Array[Rates Object]

Required. Specifies the carrier, service, parcel, and other information. In a response, this field also contains the service charges.

Important: In a request, the rates array can contain only one rates object.

documents Array[Documents Object]

Conditional. Defines the label, manifest, or other shipment document. Applies as follows:

  • Required for Create Shipment requests except as noted in the next bullet.
  • Does not apply to a Cross-Border Create Shipment request.
  • Does not apply to Rate Parcel requests.
shipmentOptions Array[Object] Conditional. Each object in this array defines a shipment option. Required for Create Shipment requests. Does not apply to Rate Parcel requests. All Create Shipment requests require the SHIPPER_ID option. Please see the Things to Consider section on the carrier’s Create Shipment page for any additional requirements.
        name String The name of the shipment option. The shipmentOptions array requires this field.
        value String The value of the shipment option. The shipmentOptions array requires this field.
customs Object

Conditional. For shipments that use customs forms, this object contains the customs information. This field is required for:

  • USPS shipments to international destinations and to APO/FPO/DPO, Territories/Possessions, and FAS
  • PB Cross-Border
  • UPS shipments to international destinations and Puerto Rico
        customsInfo Customs Info Object Customs clearance information used to fill out a commercial invoice.
        customsItems Array[Customs Items Object]

Information about each commodity in the shipment, used for customs clearance.

The maximum number of objects in this array is 30.

domesticShipmentDetails Domestic Shipment Details Object PB Cross-Border Only. Required in Create Shipment requests; does not apply to Rate Parcel requests. Contains information about the domestic leg of the PB Cross-Border shipment.
soldToAddress Address Object

UPS Only. The final recipient of a United Parcel Service shipment. Required for a shipment from the U.S. to Puerto Rico or to an international destination. Otherwise optional.

This address must match the toAddress.countryCode, with the exception of shipments to Canada and to U.S. satellite countries.

If the final recipient’s address is the same as the importer’s address, the entries in the soldToAddress object must match the entries in the toAddress object.

shipmentType String USPS Return Labels Only. Required for USPS Return Labels. If you are creating a Pure Post Return label or Scan-Based Return label, include this field and set the value to RETURN.
references Array[Object]

Applies only to the following:

  • PB Cross-Border: Required in a Create Shipment request; does not apply to a Rate Parcel request. Contains the buyer order ID. The array takes an object with two String elements. Set name to ORDER_NUMBER, and set value to the order ID:

    {
        "name": "ORDER_NUMBER",
        "value": "<order_ID>"
    }
    
  • Newgistics: Optional. This array maps client-generated identifiers to fields in the Newgistics package record. The information in this array does not appear on the shipping label. The array takes up to three objects, and each object maps an identifier to a specific Newgistics field. An object’s sequence in the array determines which Newgistics field the object maps to. The first object in the array maps to the Newgistics “ReferenceNumber” field; the second to the “AddlRef1” field; and the third to the “AddlRef2” field.

    Use the syntax shown below. Enter the names in the order shown. If you enter different names, the system will change them to the names below. In the value fields, enter the client-generated identifiers. The values must be strings of no more than 50 characters each. For additional information on using references, merchants can contact their Newgistics representatives.

    {
        "name": "ReferenceNumber",
        "value": "<client identifier 1>"
    }, {
        "name": "AddlRef1",
        "value": "<client identifier 2>"
    }, {
        "name": "AddlRef2",
        "value": "<client identifier 3>"
    }
    
shipmentId String Response Only. Unique identifier for the shipment, generated by the system in response to shipment purchase.
parcelTrackingNumber String Response Only. Tracking number assigned to the shipment by the system.

PMOD Options

The rates.specialServices.inputParameters array must contain a separate object for each of the following options. For an example, see the Sample Request after this table.

Name Description
ORIGIN_ENTRY_FACILITY

Required. The type of facility where the shipment begins, i.e., the type of facility that will pick up the packages or receive your drop off of the packages. To determine which type of facility to use, visit the USPS FAST web site at http://fast.usps.com.

Possible values:

  • DDU: Destination Delivery Unit
  • NDC: Network Distribution Center
  • ASF: Auxiliary Service Center
  • SCF: Sectional Center Facility
  • ADC: Area Distribution Center

Note: Do not use the facility for the fromAddress. Use the merchant’s address.

DESTINATION_ENTRY_FACILITY

Required. The type of facility the shipment is delivered to, i.e., where USPS opens the container and processes the individual mailings according to their mail classes. To determine which type of facility to use, visit the USPS FAST web site at http://fast.usps.com.

Possible values:

  • DDU: Destination Delivery Unit
  • NDC: Network Distribution Center
  • ASF: Auxiliary Service Center
  • SCF: Sectional Center Facility
  • ADC: Area Distribution Center

Note: The destination facility’s address is entered in the toAddress field. For more information, see Things to Consider above.

ENCLOSED_MAIL_CLASS

Required. Possible values:

  • FCM: First-Class Mail
  • FCPS: First-Class Package Service
  • PM: Priority Mail
  • STDPOST: Standard Post
  • PRCLSEL: Parcel Select
  • PSLW: Parcel Select Lightweight
  • MEDIA: Media Mail
  • LIB: Library Mail
  • MKTMAIL: Marketing Mail
  • PER: Periodicals
  • MIX: Only very specific combinations are allowed. The shipper is responsible for following USPS rules. PB does not provide validation.*
ENCLOSED_PARCEL_TYPE

Required. Possible values:

  • LTR
  • LGENV: Large Envelope
  • PKG: Package
  • MIX
ENCLOSED_PAYMENT_METHOD Required. If the enclosed parcels are evidenced and paid via USPS e-VS (Electronic Verification System), set this to ELECTRONIC. Otherwise set this to NONELECTRONIC.
DESTINATION_ENTRY_FACILITY_NAME Conditional. Required for all facilities except DDU facilities. Enter the facility name. Facility names can be found on fast.usps.com.
NASS_CODE Conditional. Required for all facilities except DDU facilities. Enter the NASS (National Air Surface System) code for the NDC, ADC, ASF, or SCF destination facility. The code consists of three to five alpha-numeric characters and can be found on fast.usps.com.

Sample Request

curl -X POST .../v1/shipments \
-H "Authorization: Bearer <oauth_token>" \
-H "Content-Type: application/json" \
-H "X-PB-TransactionId: <unique_transaction_id>" \
-H "X-PB-UnifiedErrorStructure: true" \
-d '
{
    "fromAddress": {
        ...
    },
    "toAddress": {
        ...
    },
    "parcel": {
        "weight": {
            "unitOfMeasurement": "OZ",
            "weight": "80"
        }
    },
    "rates": [ {
        "carrier": "USPS",
        "serviceId": "PMOD",
        "parcelType": "SACK",
        "specialServices": [ {
            "specialServiceId": "PMOD_OPTIONS",
            "inputParameters": [ {
                "name": "ORIGIN_ENTRY_FACILITY",
                "value": "DDU"
            }, {
                "name": "DESTINATION_ENTRY_FACILITY",
                "value": "DDU"
            }, {
                "name": "ENCLOSED_PARCEL_TYPE",
                "value": "PKG"
            }, {
                "name": "ENCLOSED_MAIL_CLASS",
                "value": "STDPOST"
            }, {
                "name": "ENCLOSED_PAYMENT_METHOD",
                "value": "NONELECTRONIC"
            } ]
        } ],
        "inductionPostalCode": "06484"
    } ],
    "documents": [ {
        "type": "SHIPPING_LABEL",
        "contentType": "URL",
        "size": "DOC_8X11",
        "fileFormat": "PDF",
        "printDialogOption": "NO_PRINT_DIALOG"
    } ],
    "shipmentOptions": [ {
        "name": "SHIPPER_ID",
        "value": "9024324564"
    }, {
        "name": "ADD_TO_MANIFEST",
        "value": "true"
    }, {
        "name": "MINIMAL_ADDRESS_VALIDATION",
        "value": "false"
    } ]
}'

Sample Response

{
    "fromAddress": {
        ...
    },
    "toAddress": {
        ...
    },
    "parcel": {
        "weight": {
            "unitOfMeasurement": "OZ",
            "weight": "80"
        }
    },
    "rates": [ {
        "carrier": "USPS",
        "parcelType": "SACK",
        "inductionPostalCode": "06484",
        "specialServices": [ {
            "specialServiceId": "PMOD_OPTIONS",
            "inputParameters": [ {
                "name": "ORIGIN_ENTRY_FACILITY",
                "value": "DDU"
            }, {
                "name": "DESTINATION_ENTRY_FACILITY",
                "value": "DDU"
            }, {
                "name": "ENCLOSED_PARCEL_TYPE",
                "value": "PKG"
            }, {
                "name": "ENCLOSED_MAIL_CLASS",
                "value": "STDPOST"
            }, {
                "name": "ENCLOSED_PAYMENT_METHOD",
                "value": "NONELECTRONIC"
            } ]
        } ],
        "dimensionalWeight": {
            "unitOfMeasurement": "OZ",
            "weight": 0
        },
        "deliveryCommitment": {
            "minEstimatedNumberOfDays": "1",
            "maxEstimatedNumberOfDays": "1",
            "estimatedDeliveryDateTime": "2019-04-24",
            "guarantee": "NONE",
            "additionalDetails": "By end of Day"
        },
        "serviceId": "PMOD",
        "totalCarrierCharge": 7.81,
        "baseCharge": 7.81,
        "currencyCode": "USD",
        "destinationZone": "1"
    } ],
    "documents": [ {
        "type": "SHIPPING_LABEL",
        "size": "DOC_8X11",
        "fileFormat": "PDF",
        "contentType": "URL",
        "contents": "https://.../usps/253536747/outbound/label/8cb101763888485296df9e08f58d25e3.pdf"
    } ],
    "shipmentOptions": [ {
        "name": "HIDE_TOTAL_CARRIER_CHARGE",
        "value": "false"
    }, {
        "name": "SHIPPER_ID",
        "value": "9024324564"
    }, {
        "name": "ADD_TO_MANIFEST",
        "value": "true"
    }, {
        "name": "MINIMAL_ADDRESS_VALIDATION",
        "value": "false"
    }, {
        "name": "SHIPPING_LABEL_RECEIPT",
        "value": "noOptions"
    } ],
    "shipmentId": "USPS2200253403883570",
    "parcelTrackingNumber": "9412309838644503839917"
}

Sample PMOD Label

Sample PMOD Label

Error Codes

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