Batch.md

Batch

Fields

Field	Type	Required	Description	Example
DefaultCarrierAccount	string	✔️	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
DefaultServicelevelToken	string	✔️	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
LabelFiletype	LabelFileTypeEnum	➖	Print format of the label. If empty, will use the default format set from the Shippo dashboard.	PDF_4x6
Metadata	string	➖	A string of up to 100 characters that can be filled with any additional information you want to attach to the object.	BATCH #1
BatchShipments	BatchShipmentPaginatedList	✔️	N/A
LabelUrl	List<string>	✔️	An array of URLs each pointing to a merged file of 100 labels each
ObjectCreated	string	✔️	Date and time of Batch creation	2016-01-04T00:15:44.394Z
ObjectId	string	✔️	Unique identifier of the given Batch object	5ef63c54f5bf45d3b1f8fb37dcb1c5f4
ObjectOwner	string	✔️	Username of the user who created the Address object.	[email protected]
ObjectResults	ObjectResults	✔️	An object containing the following counts: creation_succeeded creation_failed purchase_succeeded purchase_failed
ObjectUpdated	string	✔️	Date and time of last update to the Batch	2016-01-04T00:48:13.841Z
Status	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
Test	bool	➖	N/A	false