Bulk Import Shipments ERR

This operation imports the .CSV file which includes fields required for creating ERR (Electronic Return Receipt) Bulk Shipments. The payload, which is used for shipment transactions, contains the following essential information in .CSV file:

  • Carrier Account
  • Output format: Shipping Label and Coversheet
  • Services, and
  • Special Services

The above-mentioned information are stored in AWS-S3 which in turn provides URL to users. When Batch is submitted, S3 returned URL along with .CSV file are uploaded, which generates BatchID. The same BatchID is used to track the status of BulkImport.

SecuritybearerAuth
Request
header Parameters
X-PB-Developer-Partner-ID
string

The PB-Developer-Partner-ID is assigned by PB to uniquely identify a developer's strategic business partners. If the developer is the sole business partner, this field is not required.

Request Body schema: application/json

This is the request body to import ERR Bulk shipments.

name
string

Name of the of ERR Batch which is imported, e.g. ERR-Import-05.

groupName
string

Indicates the name of the group of batches, which consists of multiple Batch groups.

size
required
string

This indicates the label size of the Bulk Shipment when it gets printed,i.e., DocSize.

Enum: "ERR Label - DOC_8X11 and DOC_4X6." "ERR Coversheet - 10, 6 X 9, 6 X 9.5, and 9.5 X 12"
type
required
string

This indicates the type of the Batch Shipment, e.g., Shipping Label and Coversheet.

Enum: "SHIPPING_LABEL" "COVERSHEET"
format
string

This defines the type of the shipment which is printed, e.g., Shipping label gets printed in PDF form.

Value: "PDF"
carrierAccountId
required
string

A unique identifier associated with the carrier account used by client users during shipment process. Default CarrierAccountID for this batch will be user's registered USPS account.

serviceId
required
string

A unique identifier given to the carrier-specific service. User can override this value by defining it at Shipment level.

parcelType
required
string

Parcel Type is required for creating a shipment while rating a parcel. And it varies as per USPS selected services, e.g. FRPKG, LGENV, TUBE, and PKG.

Array of objects (SpecialServiceBatchERR)
Responses
200

ERR Bulk Shipment has been successfully imported.

400

Invalid request.

401

The request could not be authorized.

500

The request could not be completed due to an internal server error.

post/api/v1/err/shipments/importUrl
Request samples
application/json
{
  • "name": "string",
  • "groupName": "string",
  • "size": "DOC_8X11",
  • "type": "SHIPPING_LABEL",
  • "format": "PDF",
  • "carrierAccountId": "string",
  • "serviceId": "string",
  • "parcelType": "string",
  • "specialServices": [
    ]
}
Response samples
application/json
{
  • "batchId": "string",
  • "name": "string",
  • "groupName": "string",
  • "status": "SUBMITTED",
  • "uploadURL": "string"
}