batch.md

Batch

Fields

Field	Type	Required	Description	Example
default_carrier_account	str	✔️	ID of the Carrier Account object to use as the default for all shipments in this Batch. The carrier account can be changed on a per-shipment basis by changing the carrier_account in the corresponding BatchShipment object.	078870331023437cb917f5187429b093
default_servicelevel_token	str	✔️	Token of the service level to use as the default for all shipments in this Batch. The servicelevel can be changed on a per-shipment basis by changing the servicelevel_token in the corresponding BatchShipment object. Servicelevel tokens can be found here.	usps_priority
batch_shipments	components.BatchShipmentPaginatedList	✔️	N/A
label_url	List[str]	✔️	An array of URLs each pointing to a merged file of 100 labels each
object_created	str	✔️	Date and time of Batch creation	2016-01-04T00:15:44.394Z
object_id	str	✔️	Unique identifier of the given Batch object	5ef63c54f5bf45d3b1f8fb37dcb1c5f4
object_owner	str	✔️	Username of the user who created the Address object.	[email protected]
object_results	components.ObjectResults	✔️	An object containing the following counts: creation_succeeded creation_failed purchase_succeeded purchase_failed
object_updated	str	✔️	Date and time of last update to the Batch	2016-01-04T00:48:13.841Z
status	components.BatchStatus	✔️	Batches that are VALIDATING are being created and validated VALID batches can be purchased INVALID batches cannot be purchased, INVALID BatchShipments must be removed Batches that are in the PURCHASING state are being purchased PURCHASED batches are finished purchasing.	VALID
label_filetype	Optional[components.LabelFileTypeEnum]	➖	Print format of the label. If empty, will use the default format set from the Shippo dashboard.	PDF_4x6
metadata	Optional[str]	➖	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]	➖	N/A	false