# Batch


## Fields

| Field                                                                                                                                                                                                                                                                                                      | Type                                                                                                                                                                                                                                                                                                       | Required                                                                                                                                                                                                                                                                                                   | Description                                                                                                                                                                                                                                                                                                | Example                                                                                                                                                                                                                                                                                                    |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `default_carrier_account`                                                                                                                                                                                                                                                                                  | *str*                                                                                                                                                                                                                                                                                                      | :heavy_check_mark:                                                                                                                                                                                                                                                                                         | ID of the Carrier Account object to use as the default for all shipments in this Batch. <br/>The carrier account can be changed on a per-shipment basis by changing the carrier_account in the <br/>corresponding BatchShipment object.                                                                    | 078870331023437cb917f5187429b093                                                                                                                                                                                                                                                                           |
| `default_servicelevel_token`                                                                                                                                                                                                                                                                               | *str*                                                                                                                                                                                                                                                                                                      | :heavy_check_mark:                                                                                                                                                                                                                                                                                         | Token of the service level to use as the default for all shipments in this Batch. <br/>The servicelevel can be changed on a per-shipment basis by changing the servicelevel_token in the <br/>corresponding BatchShipment object. <a href="#tag/Service-Levels">Servicelevel tokens can be found here.</a> | usps_priority                                                                                                                                                                                                                                                                                              |
| `batch_shipments`                                                                                                                                                                                                                                                                                          | [components.BatchShipmentListWrapper](../../models/components/batchshipmentlistwrapper.md)                                                                                                                                                                                                                 | :heavy_check_mark:                                                                                                                                                                                                                                                                                         | N/A                                                                                                                                                                                                                                                                                                        |                                                                                                                                                                                                                                                                                                            |
| `label_url`                                                                                                                                                                                                                                                                                                | List[*str*]                                                                                                                                                                                                                                                                                                | :heavy_check_mark:                                                                                                                                                                                                                                                                                         | An array of URLs each pointing to a merged file of 100 labels each                                                                                                                                                                                                                                         |                                                                                                                                                                                                                                                                                                            |
| `object_created`                                                                                                                                                                                                                                                                                           | *str*                                                                                                                                                                                                                                                                                                      | :heavy_check_mark:                                                                                                                                                                                                                                                                                         | Date and time of Batch creation                                                                                                                                                                                                                                                                            | 2016-01-04T00:15:44.394Z                                                                                                                                                                                                                                                                                   |
| `object_id`                                                                                                                                                                                                                                                                                                | *str*                                                                                                                                                                                                                                                                                                      | :heavy_check_mark:                                                                                                                                                                                                                                                                                         | Unique identifier of the given Batch object                                                                                                                                                                                                                                                                | 5ef63c54f5bf45d3b1f8fb37dcb1c5f4                                                                                                                                                                                                                                                                           |
| `object_owner`                                                                                                                                                                                                                                                                                             | *str*                                                                                                                                                                                                                                                                                                      | :heavy_check_mark:                                                                                                                                                                                                                                                                                         | Username of the user who created the Address object.                                                                                                                                                                                                                                                       | shippo@shippo.com                                                                                                                                                                                                                                                                                          |
| `object_results`                                                                                                                                                                                                                                                                                           | [components.ObjectResults](../../models/components/objectresults.md)                                                                                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                                                                                                                                                         | An object containing the following counts:<br>`creation_succeeded`<br>`creation_failed`<br>`purchase_succeeded`<br>`purchase_failed`                                                                                                                                                                       |                                                                                                                                                                                                                                                                                                            |
| `object_updated`                                                                                                                                                                                                                                                                                           | *str*                                                                                                                                                                                                                                                                                                      | :heavy_check_mark:                                                                                                                                                                                                                                                                                         | Date and time of last update to the Batch                                                                                                                                                                                                                                                                  | 2016-01-04T00:48:13.841Z                                                                                                                                                                                                                                                                                   |
| `status`                                                                                                                                                                                                                                                                                                   | [components.BatchStatus](../../models/components/batchstatus.md)                                                                                                                                                                                                                                           | :heavy_check_mark:                                                                                                                                                                                                                                                                                         | Batches that are `VALIDATING` are being created and validated<br><br/>`VALID` batches can be purchased<br><br/>`INVALID` batches cannot be purchased, `INVALID` BatchShipments must be removed<br><br/>Batches that are in the `PURCHASING` state are being purchased<br><br/>`PURCHASED` batches are finished purchasing. | VALID                                                                                                                                                                                                                                                                                                      |
| `label_filetype`                                                                                                                                                                                                                                                                                           | [Optional[components.LabelFileType]](../../models/components/labelfiletype.md)                                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                                                                         | Print format of the <a href="https://docs.goshippo.com/docs/shipments/shippinglabelsizes/">label</a>. If empty, will use the default format set from <br/><a href="https://apps.goshippo.com/settings/labels">the Shippo dashboard.</a>                                                                    | PDF_4x6                                                                                                                                                                                                                                                                                                    |
| `metadata`                                                                                                                                                                                                                                                                                                 | *Optional[str]*                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                         | A string of up to 100 characters that can be filled with any additional information you want to attach to the object.                                                                                                                                                                                      | BATCH #1                                                                                                                                                                                                                                                                                                   |
| `test`                                                                                                                                                                                                                                                                                                     | *Optional[bool]*                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                         | N/A                                                                                                                                                                                                                                                                                                        | false                                                                                                                                                                                                                                                                                                      |