CreateShipmentRequest.md

CreateShipmentRequest

Properties

Name	Type	Description	Notes
size	SizeEnum	This defines the label size of the Shipment, e.g., Shipping Label having Doc Size (8' X 11').
type	TypeEnum	This defines the type of the Shipment, e.g., Shipping Label.
format	FormatEnum	This defines the type of the shipment which is printed. For example Shipping label prints in PDF form.	[optional]
dateOfShipment	String	This defines the date of the Shipment in the format YYYY:MM:DD.	[optional]
fromAddress	ShipmentInternationalFromAddress
parcel	ShipmentDomesticParcel
carrierAccountId	String	The unique identifier associated with the Carrier account used by client users during shipment process.
parcelType	String	>-Parcel Type is required for creating a shipment while rating a parcel, which varies as per Carrier selection. It has categories like Package, Envelopes, Paks, Boxes, Tube, defined per specific carrier and used in abbreviated form, e.g., FRPKG, LGENV, TUBE,PKG.
parcelId	String	>-Parcel Id is optional and required to be given in case of branded parcels which have brandedDimension and/or brandedWeight. If parcel has brandedDimension, in that case user need not to pass dimensionUnit and dimension details(length, width and height) in the parcel object. And if brandedWeight is also available for the parcel then in that case weightUnit and weight need not to be passed in parcel object	[optional]
serviceId	String	>-A unique identifier given to the carrier-specific service. This is required for creating a shipment, while it is optional for rating a parcel.
specialServices	List<SpecialService>	This provides a carrier-service based special or extra sevice.	[optional]
shipmentOptions	ShipmentOptions		[optional]
metadata	List<ShipmentInternationalMetadataInner>	Additional metadata that needs to be stored for this shipment can be added here. For now, `costAccountName` is supported.	[optional]
toAddress	ShipmentInternationalToAddress
customs	ShipmentInternationalCustoms

Enum: SizeEnum

Name	Value
DOC_8_X11	"DOC_8X11"

Enum: TypeEnum

Name	Value
SHIPPING_LABEL	"SHIPPING_LABEL"

Enum: FormatEnum

Name	Value
PDF	"PDF"
ZPL2	"ZPL2"