Add Items to Batch

This method is used to add additional shipments to an existing batch. The batch must not be in validating, processing, or completed status.

Endpoint

Method URI Headers
PUT /batches/{batch_id}/add-items default

Request

Field | Required | Type | Description
- | : | :- | batch_id | Yes | String | The batch hash ID. (URL parameter) batch_shipments [] | Yes | Array | Array of shipment objects to add. Same structure as Create Batch.

Request Example

{
    "batch_shipments": [
        {
            "from_address_id": 1387235969,
            "to_address": {
                "name": "Alice Brown",
                "street_1": "321 Elm St",
                "city": "Miami",
                "state": "FL",
                "zip": "33101",
                "country": "US",
                "telephone": "5553334444"
            },
            "package_list": [
                {
                    "count": 1,
                    "length": 8,
                    "width": 6,
                    "height": 4,
                    "weight": 1,
                    "reference_1": "ORDER-003"
                }
            ]
        }
    ]
}

Response

Returns the same response structure as Create Batch. The batch status will be set to validating while new items are processed.

Response Examples

Successful

{
    "success": true,
    "data": {
        "id": "12345678",
        "status": "validating",
        "default_service": "USPS-3",
        "default_shipper_id": "99999999"
    }
}

Failed

{
    "success": false,
    "message": "Shipment batch is being processed."
}