Batch Overview

Batch shipping provides the capability to customers so that they can print labels in batches. This feature makes the customer process efficient by enabling them to print multiple labels from a single document. There are two approaches to do the Batch Shipment.

To perform Batch Shipment using the 1st Approach, perform the operations below:

1. Create Bulk Shipments: This operation allows the user to create a bulk shipment. The user provides the necessary information, such as recipient details, package dimensions, weight, and other shipment-specific data. The system processes this information and returns a unique batch Id which can be used in next step to check status.
2. Get Status of an Existing Batch: After creating the bulk shipment, the user can check the status of the batch. This operation retrieves the current status of the batch, which indicates whether the labels have been generated and are ready for printing or if there are any errors or issues that need attention.
3. Get Batch Shipment Details: This operation retrieves the shipment details which are SUCCESS or FAILED during batch processing of addressValidation, rating and labelGeneration. This also returns the detailed error for Failed shipments.

To perform Batch Shipment using the 2nd Approach, perform the operations below:

1. Bulk Import Shipments: In this approach, the user imports a batch of shipments using a specific format or file. The system stores the imported data and returns a unique batch Id and upload URL. Use this upload URL for actual file upload. This method is useful when the user has shipment data in a specific format or wants to import large number of shipments at once which may not be possible in bulk shipment.
   A sample file in this format is available for download here

   ERR (Electronic Return Receipt):

   A sample file in this format is available for download here

2. Upload csv file to the uploadUrl generated from previous step response: Below curl to be used for uploading the shipment csv file. Upon successful 200 response code will be returned.
   Copy

   Copied

   curl --location --request PUT '<uploadUrl>' \
   --header 'Content-Type: text/csv' \
   --data '@/C:/Users/import_shipment.csv'

3. Process an Existing Batch: After importing the shipments, the user initiates the processing of the batch. This operation triggers the system to generate labels for the imported shipments, perform any required validations or checks, and prepare the batch for printing.
4. Get Status of an Existing Batch: Similar to Approach 1, the user can check the status of the batch after processing. This operation retrieves the current status of the batch, indicating whether the labels have been generated successfully, any errors encountered during processing, or if the batch is ready for further actions.
5. Get Batch Shipment Details: Similar to Approach 1, this operation retrieves the shipment details which are SUCCESS or FAILED during batch processing of addressValidation, rating and labelGeneration. This also returns the detailed error for Failed shipments.

Void Batch Label Overview

Void batch label API provides the capability to customers so that they can void/cancel shipments created by batch.

To perform Void batch labels perform the operations below:

1. Void Batch Shipping Labels: This operation allows the user to void all or selective shipments created though batch. The system processes this information and returns a unique batch Id which can be used in next step to check status.
2. Get Status of an Existing Batch: After voiding shipment, the user can check the status of the batch. This operation retrieves the current status of the batch, which indicates whether the labels have been voided or if there are any errors or issues that need attention.
3. Get Batch Shipment Details: This operation retrieves the shipment details which are SUCCESS or FAILED during batch processing of voidLabel. This also returns the detailed error for Failed void shipments.