50 lines (30 loc) · 2.12 KB

CreateBulkShipmentsERRCoversheet

This ShipmentBatch contains the schema information for ERR Coversheet.

Properties

Name	Type	Description	Notes
name	String	Name of the of ERR Batch which consists of multiple shipments (shipments in bulk) for Coversheet printing., e.g. ERR-Coversheet07.
groupName	String	Indicates the name of the group of batches, which consists of multiple Batch groups.	[optional]
size	SizeEnum	This indicates the envelope size of the ERR Bulk Shipment, i.e., DocSize. We have indicated the example values in enum.
type	TypeEnum	This indicates the type of the ERR Batch Shipment, e.g., Coversheet.
format	FormatEnum	This defines the format type of the shipment which is printed. For example Coversheet prints in PDF form.	[optional]
carrierAccountId	String	The unique identifier associated with the user's registered USPS Account which will be required for this batch. User can override this value by defining it at Shipment level.
parcelType	String	Parcel Type is required for creating a shipment while rating a parcel. And it varies as per USPS selected services, e.g. LTR, LGENV. User can override this value by defining it at shipment level.
serviceId	String	A unique identifier given to the carrier-specific service which is used for this BulkShipment. User can override this value by defining it at shipment level.
specialServices	List<SpecialServiceERRInner>		[optional]
shipments	List<ShipmentERRCoversheet>

Enum: SizeEnum

Name	Value
_10	"10"
_6_X_9	"6 X 9"
_6_X_9_5	"6 X 9.5"
_9_5_X_12	"9.5 X 12"

Enum: TypeEnum

Name	Value
COVERSHEET	"COVERSHEET"

Enum: FormatEnum

Name	Value
PDF	"PDF"