Shipping Preferences Object

Shipping preference objects are used in ShipEngine Connect to convey shipping preferences for a sales order.

Properties

This table lists the properties of a shipping preference object and identifies those properties that are required when it is returned from a method.

Name	Type	Required?	Description
`deliveryConfirmationType`	string		The requested delivery confirmation. Valid values include the following: `delivery` - Package is dropped off at the destination address. `signature` - A person at the destination address signs for the package. `adult_signature` - A person of legal adult age for the destination jurisdiction signs for the package. `direct_signature` - The person named as the recipient signs for the package.
`containsAlcohol`	boolean		Indicates whether the shipment needs to be marked as containing alcohol.
`saturdayDelivery`	boolean		Indicates whether Saturday delivery is requested.
`isGift`	boolean		Indicates whether the item has been marked as a gift.
`requestedShippingService`	string		The requested shipping service to be used.
`deliverByDate`	date/time object, or Date object object, or a string representing the date and time in ISO format.		The requested date for the sales order to be delivered by.
`requestedWarehouse`	string		The warehouse name associated with the request.
`shipByDate`	date/time object, or Date object object, or a string representing the date and time in ISO format.		The requested date for the sales order to be shipped by.
`insuredValue`	object		Requests that the shipment be insured for the specified value. This property is not required. If it is provided, it must contain all of its required properties, listed below.
`insuredValue.value`	number	✔	The value of the insured amount.
`insuredValue.currency`	string	✔	The currency the value represents.
`isPremiumProgam`	boolean		Indicates whether the fulfillment is part of a premium program (Amazon Prime, Walmart+, etc.)
`premiumProgramName`	string		Name of the Premium Program
`documents`	array		The digital manifest document, such as a PDF SCAN form. This property is not required. If it is provided, it must contain all of its required properties, listed below.
`documents[].name`	string		The user-friendly name of the document (e.g. "Label", "Customs Form"). This string must not contain newline characters.
`documents[].type`	string	✔	The type of document (e.g. label, customs form, SCAN form). Valid values include the following: `label` - label `customs_form` - customs form `scan_form` - SCAN form
`documents[].size`	string	✔	The size of document (e.g. label, customs form, SCAN form). Valid values include the following: `A4`- A4 sized paper ( 8.27 inches x 11.69 inches) `letter` - Letter sized paper (8.5 inches by 11 inches) `4x6` - Paper sized 4 inches by 6 inches `4x8` - Paper sized 4 inches by 8 inches
`documents[].format`	string	✔	The file format of the document. Valid values include the following: `pdf` - Portable Document Format (PDF) `zpl` - Zebra Printer Label (ZPL) `png` - Portable Graphics Format (PNG)
`documents[].data`	Buffer object	✔	The document data, in the specified file format.