Bulk Import Shipments

"This operation imports the .CSV file for Bulk Shipment, which includes fields essential to create Bulk Shipments. The payload contains the following essential fields in .CSV file, used for shipment transactions:

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

User stores this information in AWS-S3 which in turn provides URL to users. After submitting Batch, user uploads the S3 returned URL along with the .CSV file, which generates BatchID. The same BatchID can be used to track the status of BulkImport."

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

The 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 isn't required.

Request Body schema: application/json

This is the request body to import Bulk shipments.

name
string

Name of the of Batch which which is imported (imported shipments in bulk).

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, e.g., DocSize can be 8' X 11' or 4' X 6'.

Enum: "DOC_8X11" "DOC_4X6"
type
required
string

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

Value: "SHIPPING_LABEL"
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.

serviceId
required
string

A unique identifier given to the carrier-specific service. This varies as per carrier selection. 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 carrier and its selected services, e.g. FRPKG, LGENV, TUBE, and PKG.

Array of objects (SpecialServiceBatch)
Responses
200

The 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/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"
}