(batches())
A batch is a technique for creating multiple labels at once. Use the batch object to create and purchase many shipments in two API calls. After creating the batch, retrieve the batch to verify that all shipments are valid. You can add and remove shipments after you have created the batch. When all shipments are valid you can purchase the batch and retrieve all the shipping labels.
The batch shipment object is a wrapper around a shipment object, which include shipment-specific information for batch processing.
Note: batch shipments can only be created on the batch endpoint, either when creating a batch object or by through
the /batches/{BATCH_OBJECT_ID}/add_shipments endpoint
- create - Create a batch
- get - Retrieve a batch
- addShipments - Add shipments to a batch
- purchase - Purchase a batch
- removeShipments - Remove shipments from a batch
Creates a new batch object for purchasing shipping labels for many shipments at once. Batches are created asynchronously. This means that the API response won't include your batch shipments yet. You need to retrieve the batch later to verify that all batch shipments are valid.
package hello.world;
import com.goshippo.shippo_sdk.Shippo;
import com.goshippo.shippo_sdk.models.components.AddressCreateRequest;
import com.goshippo.shippo_sdk.models.components.AddressFrom;
import com.goshippo.shippo_sdk.models.components.AddressReturn;
import com.goshippo.shippo_sdk.models.components.AddressTo;
import com.goshippo.shippo_sdk.models.components.BatchCreateRequest;
import com.goshippo.shippo_sdk.models.components.BatchShipmentCreateRequest;
import com.goshippo.shippo_sdk.models.components.Cod;
import com.goshippo.shippo_sdk.models.components.CustomerReference;
import com.goshippo.shippo_sdk.models.components.DepartmentNumber;
import com.goshippo.shippo_sdk.models.components.Insurance;
import com.goshippo.shippo_sdk.models.components.InvoiceNumber;
import com.goshippo.shippo_sdk.models.components.LabelFileTypeEnum;
import com.goshippo.shippo_sdk.models.components.ParcelCreateFromTemplateRequest;
import com.goshippo.shippo_sdk.models.components.ParcelExtra;
import com.goshippo.shippo_sdk.models.components.ParcelInsurance;
import com.goshippo.shippo_sdk.models.components.ParcelInsuranceProvider;
import com.goshippo.shippo_sdk.models.components.ParcelTemplateEnumSet;
import com.goshippo.shippo_sdk.models.components.ParcelTemplateFedExEnum;
import com.goshippo.shippo_sdk.models.components.Parcels;
import com.goshippo.shippo_sdk.models.components.PaymentMethod;
import com.goshippo.shippo_sdk.models.components.PoNumber;
import com.goshippo.shippo_sdk.models.components.RmaNumber;
import com.goshippo.shippo_sdk.models.components.ShipmentCreateRequest;
import com.goshippo.shippo_sdk.models.components.ShipmentCreateRequestCustomsDeclaration;
import com.goshippo.shippo_sdk.models.components.ShipmentExtra;
import com.goshippo.shippo_sdk.models.components.UPSReferenceFields;
import com.goshippo.shippo_sdk.models.components.WeightUnitEnum;
import com.goshippo.shippo_sdk.models.operations.CreateBatchResponse;
import java.lang.Exception;
import java.util.List;
public class Application {
public static void main(String[] args) throws Exception {
Shippo sdk = Shippo.builder()
.apiKeyHeader("<YOUR_API_KEY_HERE>")
.shippoApiVersion("2018-02-08")
.build();
CreateBatchResponse res = sdk.batches().create()
.shippoApiVersion("2018-02-08")
.batchCreateRequest(BatchCreateRequest.builder()
.defaultCarrierAccount("078870331023437cb917f5187429b093")
.defaultServicelevelToken("usps_priority")
.batchShipments(List.of(
BatchShipmentCreateRequest.builder()
.shipment(ShipmentCreateRequest.builder()
.addressFrom(AddressFrom.of(AddressCreateRequest.builder()
.country("US")
.name("Shwan Ippotle")
.company("Shippo")
.street1("215 Clayton St.")
.street3("")
.streetNo("")
.city("San Francisco")
.state("CA")
.zip("94117")
.phone("+1 555 341 9393")
.email("[email protected]")
.isResidential(true)
.metadata("Customer ID 123456")
.validate(true)
.build()))
.addressTo(AddressTo.of("d799c2679e644279b59fe661ac8fa489"))
.parcels(List.of(
Parcels.of(ParcelCreateFromTemplateRequest.builder()
.massUnit(WeightUnitEnum.LB)
.weight("1")
.template(ParcelTemplateEnumSet.of(ParcelTemplateFedExEnum.FED_EX_BOX25KG))
.extra(ParcelExtra.builder()
.cod(Cod.builder()
.amount("5.5")
.currency("USD")
.paymentMethod(PaymentMethod.CASH)
.build())
.insurance(ParcelInsurance.builder()
.amount("5.5")
.content("Laptop")
.currency("USD")
.provider(ParcelInsuranceProvider.UPS)
.build())
.build())
.metadata("Customer ID 123456")
.build())))
.extra(ShipmentExtra.builder()
.accountsReceivableCustomerAccount(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.appropriationNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.billOfLadingNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.cod(Cod.builder()
.amount("5.5")
.currency("USD")
.paymentMethod(PaymentMethod.CASH)
.build())
.codNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.customerReference(CustomerReference.builder()
.refSort(1L)
.build())
.dealerOrderNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.deptNumber(DepartmentNumber.builder()
.refSort(3L)
.build())
.fdaProductCode(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.insurance(Insurance.builder()
.amount("5.5")
.currency("USD")
.build())
.invoiceNumber(InvoiceNumber.builder()
.refSort(2L)
.build())
.manifestNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.modelNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.partNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.poNumber(PoNumber.builder()
.refSort(2L)
.build())
.productionCode(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.purchaseRequestNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.rmaNumber(RmaNumber.builder()
.refSort(1L)
.build())
.salespersonNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.serialNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.storeNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.transactionReferenceNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.build())
.metadata("Customer ID 123456")
.shipmentDate("2021-03-22T12:00:00Z")
.addressReturn(AddressReturn.of("d799c2679e644279b59fe661ac8fa488"))
.customsDeclaration(ShipmentCreateRequestCustomsDeclaration.of("adcfdddf8ec64b84ad22772bce3ea37a"))
.carrierAccounts(List.of(
"065a4a8c10d24a34ab932163a1b87f52",
"73f706f4bdb94b54a337563840ce52b0"))
.build())
.carrierAccount("a4391cd4ab974f478f55dc08b5c8e3b3")
.metadata("SHIPMENT #1")
.servicelevelToken("fedex_ground")
.build()))
.labelFiletype(LabelFileTypeEnum.PDF4X6)
.metadata("BATCH #1")
.build())
.call();
if (res.batch().isPresent()) {
// handle response
}
}
}| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
shippoApiVersion |
Optional<String> | ➖ | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 |
batchCreateRequest |
BatchCreateRequest | ✔️ | Batch details. |
| Error Type | Status Code | Content Type |
|---|---|---|
| models/errors/SDKError | 4XX, 5XX | */* |
Returns a batch using an object ID.
Batch shipments are displayed 100 at a time. You can iterate
through each page using the ?page= query parameter. You can also filter based on batch shipment
status, for example, by passing a query param like ?object_results=creation_failed.
For more details on filtering results, see our guide on filtering.
package hello.world;
import com.goshippo.shippo_sdk.Shippo;
import com.goshippo.shippo_sdk.models.operations.GetBatchResponse;
import java.lang.Exception;
public class Application {
public static void main(String[] args) throws Exception {
Shippo sdk = Shippo.builder()
.apiKeyHeader("<YOUR_API_KEY_HERE>")
.shippoApiVersion("2018-02-08")
.build();
GetBatchResponse res = sdk.batches().get()
.batchId("<id>")
.page(1L)
.results(5L)
.shippoApiVersion("2018-02-08")
.call();
if (res.batch().isPresent()) {
// handle response
}
}
}| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
batchId |
String | ✔️ | Object ID of the batch | |
page |
Optional<Long> | ➖ | The page number you want to select | |
results |
Optional<Long> | ➖ | The number of results to return per page (max 100, default 5) | |
shippoApiVersion |
Optional<String> | ➖ | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 |
| Error Type | Status Code | Content Type |
|---|---|---|
| models/errors/SDKError | 4XX, 5XX | */* |
Adds batch shipments to an existing batch.
package hello.world;
import com.goshippo.shippo_sdk.Shippo;
import com.goshippo.shippo_sdk.models.components.AddressCreateRequest;
import com.goshippo.shippo_sdk.models.components.AddressFrom;
import com.goshippo.shippo_sdk.models.components.AddressReturn;
import com.goshippo.shippo_sdk.models.components.AddressTo;
import com.goshippo.shippo_sdk.models.components.BatchShipmentCreateRequest;
import com.goshippo.shippo_sdk.models.components.Cod;
import com.goshippo.shippo_sdk.models.components.CustomerReference;
import com.goshippo.shippo_sdk.models.components.DepartmentNumber;
import com.goshippo.shippo_sdk.models.components.DistanceUnitEnum;
import com.goshippo.shippo_sdk.models.components.Insurance;
import com.goshippo.shippo_sdk.models.components.InvoiceNumber;
import com.goshippo.shippo_sdk.models.components.ParcelCreateRequest;
import com.goshippo.shippo_sdk.models.components.ParcelExtra;
import com.goshippo.shippo_sdk.models.components.ParcelInsurance;
import com.goshippo.shippo_sdk.models.components.ParcelInsuranceProvider;
import com.goshippo.shippo_sdk.models.components.Parcels;
import com.goshippo.shippo_sdk.models.components.PaymentMethod;
import com.goshippo.shippo_sdk.models.components.PoNumber;
import com.goshippo.shippo_sdk.models.components.RmaNumber;
import com.goshippo.shippo_sdk.models.components.ShipmentCreateRequest;
import com.goshippo.shippo_sdk.models.components.ShipmentCreateRequestCustomsDeclaration;
import com.goshippo.shippo_sdk.models.components.ShipmentExtra;
import com.goshippo.shippo_sdk.models.components.UPSReferenceFields;
import com.goshippo.shippo_sdk.models.components.WeightUnitEnum;
import com.goshippo.shippo_sdk.models.operations.AddShipmentsToBatchResponse;
import java.lang.Exception;
import java.util.List;
public class Application {
public static void main(String[] args) throws Exception {
Shippo sdk = Shippo.builder()
.apiKeyHeader("<YOUR_API_KEY_HERE>")
.shippoApiVersion("2018-02-08")
.build();
AddShipmentsToBatchResponse res = sdk.batches().addShipments()
.batchId("<id>")
.shippoApiVersion("2018-02-08")
.requestBody(List.of(
BatchShipmentCreateRequest.builder()
.shipment(ShipmentCreateRequest.builder()
.addressFrom(AddressFrom.of("d799c2679e644279b59fe661ac8fa488"))
.addressTo(AddressTo.of(AddressCreateRequest.builder()
.country("US")
.name("Shwan Ippotle")
.company("Shippo")
.street1("215 Clayton St.")
.street3("")
.streetNo("")
.city("San Francisco")
.state("CA")
.zip("94117")
.phone("+1 555 341 9393")
.email("[email protected]")
.isResidential(true)
.metadata("Customer ID 123456")
.validate(true)
.build()))
.parcels(List.of(
Parcels.of(ParcelCreateRequest.builder()
.massUnit(WeightUnitEnum.LB)
.weight("1")
.distanceUnit(DistanceUnitEnum.IN)
.height("1")
.length("1")
.width("1")
.extra(ParcelExtra.builder()
.cod(Cod.builder()
.amount("5.5")
.currency("USD")
.paymentMethod(PaymentMethod.CASH)
.build())
.insurance(ParcelInsurance.builder()
.amount("5.5")
.content("Laptop")
.currency("USD")
.provider(ParcelInsuranceProvider.UPS)
.build())
.build())
.metadata("Customer ID 123456")
.build())))
.extra(ShipmentExtra.builder()
.accountsReceivableCustomerAccount(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.appropriationNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.billOfLadingNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.cod(Cod.builder()
.amount("5.5")
.currency("USD")
.paymentMethod(PaymentMethod.CASH)
.build())
.codNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.customerReference(CustomerReference.builder()
.refSort(1L)
.build())
.dealerOrderNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.deptNumber(DepartmentNumber.builder()
.refSort(3L)
.build())
.fdaProductCode(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.insurance(Insurance.builder()
.amount("5.5")
.currency("USD")
.build())
.invoiceNumber(InvoiceNumber.builder()
.refSort(2L)
.build())
.manifestNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.modelNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.partNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.poNumber(PoNumber.builder()
.refSort(2L)
.build())
.productionCode(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.purchaseRequestNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.rmaNumber(RmaNumber.builder()
.refSort(1L)
.build())
.salespersonNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.serialNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.storeNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.transactionReferenceNumber(UPSReferenceFields.builder()
.prefix("ABC")
.value("value")
.refSort(1L)
.build())
.build())
.metadata("Customer ID 123456")
.shipmentDate("2021-03-22T12:00:00Z")
.addressReturn(AddressReturn.of("d799c2679e644279b59fe661ac8fa488"))
.customsDeclaration(ShipmentCreateRequestCustomsDeclaration.of("adcfdddf8ec64b84ad22772bce3ea37a"))
.carrierAccounts(List.of(
"065a4a8c10d24a34ab932163a1b87f52",
"73f706f4bdb94b54a337563840ce52b0"))
.build())
.carrierAccount("a4391cd4ab974f478f55dc08b5c8e3b3")
.metadata("SHIPMENT #1")
.servicelevelToken("fedex_ground")
.build()))
.call();
if (res.batch().isPresent()) {
// handle response
}
}
}| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
batchId |
String | ✔️ | Object ID of the batch | |
shippoApiVersion |
Optional<String> | ➖ | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 |
requestBody |
List<BatchShipmentCreateRequest> | ✔️ | Array of shipments to add to the batch |
| Error Type | Status Code | Content Type |
|---|---|---|
| models/errors/SDKError | 4XX, 5XX | */* |
Purchases an existing batch with a status of VALID.
Once you send a POST request to the purchase endpoint the batch status will change to PURCHASING.
When all the shipments are purchased, the status will change to PURCHASED and you will receive a
batch_purchased webhook indicating that the batch has been purchased
package hello.world;
import com.goshippo.shippo_sdk.Shippo;
import com.goshippo.shippo_sdk.models.operations.PurchaseBatchResponse;
import java.lang.Exception;
public class Application {
public static void main(String[] args) throws Exception {
Shippo sdk = Shippo.builder()
.apiKeyHeader("<YOUR_API_KEY_HERE>")
.shippoApiVersion("2018-02-08")
.build();
PurchaseBatchResponse res = sdk.batches().purchase()
.batchId("<id>")
.shippoApiVersion("2018-02-08")
.call();
if (res.batch().isPresent()) {
// handle response
}
}
}| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
batchId |
String | ✔️ | Object ID of the batch | |
shippoApiVersion |
Optional<String> | ➖ | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 |
| Error Type | Status Code | Content Type |
|---|---|---|
| models/errors/SDKError | 4XX, 5XX | */* |
Removes shipments from an existing batch shipment.
package hello.world;
import com.goshippo.shippo_sdk.Shippo;
import com.goshippo.shippo_sdk.models.operations.RemoveShipmentsFromBatchResponse;
import java.lang.Exception;
import java.util.List;
public class Application {
public static void main(String[] args) throws Exception {
Shippo sdk = Shippo.builder()
.apiKeyHeader("<YOUR_API_KEY_HERE>")
.shippoApiVersion("2018-02-08")
.build();
RemoveShipmentsFromBatchResponse res = sdk.batches().removeShipments()
.batchId("<id>")
.shippoApiVersion("2018-02-08")
.requestBody(List.of(
"<value>"))
.call();
if (res.batch().isPresent()) {
// handle response
}
}
}| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
batchId |
String | ✔️ | Object ID of the batch | |
shippoApiVersion |
Optional<String> | ➖ | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 |
requestBody |
List<String> | ✔️ | Array of shipments object ids to remove from the batch |
RemoveShipmentsFromBatchResponse
| Error Type | Status Code | Content Type |
|---|---|---|
| models/errors/SDKError | 4XX, 5XX | */* |