ShippingPreferences
This represents the shipping preferences specified for an order
Name | Type | Nullable? | Description |
---|---|---|---|
additional_handling | boolean | ✔ | Indicates whether or not this shipment will require additional handling |
bill_duties_to_sender | boolean | ✔ | Indicates whether duties should be billed to the sender of the package |
deliver_by_date | string | ✔ | The (ISO 8601) datetime (UTC) associated with when the order needs to be delivered by @example "2021-03-31T18:21:14.858Z" |
digital_fulfillment | boolean | ✔ | Indicates whether or not the item being delivered is a digital good or not |
do_not_prepay_postage | boolean | ✔ | Indicates whether you must pay for postage at drop off, for carriers that usually require prepaid postage. |
documents | Document[] | ✔ | Any documents relevant to shipping that the order source provides |
gift | boolean | ✔ | Indicates whether or not this order is a gift |
has_alcohol | boolean | ✔ | Indicates whether or not this order contains alcohol |
hold_until_date | string | ✔ | The (ISO 8601) datetime (UTC) associated with how long to hold the order @example "2021-03-31T18:21:14.858Z" |
insurance_requested | boolean | ✔ | Indicates whether or not insurance has been requested for shipping this order |
insured_value | number | ✔ | The amount of money being request for insurance on this shipment |
is_premium_program | boolean | ✔ | true if the order was placed under the terms of the order source's premium program (Amazon Prime, Walmart+, etc) |
non_machinable | boolean | ✔ | Indicates whether or not this order is nonmachinable (must be sorted outside of the standard, automated mail process) |
package_type | string | ✔ | The requested package type for this fulfillment |
premium_program_name | string | ✔ | The name of the premium program, if any. This is for informational purposes. Consumers should base all logic on is_premium_program flag. |
preplanned_fulfillment_id | string | ✔ | The identifer assigned by a fulfillment planning system at checkout (Delivery Options). |
ready_to_ship_date | string | ✔ | The (ISO 8601) datetime (UTC) associated with when the order is ready to ship @example "2021-03-31T18:21:14.858Z" |
requested_warehouse | string | ✔ | The warehouse name associated with the requested warehouse |
saturday_delivery | boolean | ✔ | Indicates whether or not this order should be delivered on a saturday |
ship_by_date | string | ✔ | The (ISO 8601) datetime (UTC) associated with when the order needs to be shipped by @example "2021-03-31T18:21:14.858Z" |
shipping_service | string | ✔ | The requested shipping service for this fulfillment |
show_postage | boolean | ✔ | Indicates whether or not to allow display of postage paid on the shipping label |
suppress_email_notify | boolean | ✔ | Indicates whether or not to supress email notifications to the buyer |
suppress_marketplace_notify | boolean | ✔ | Indicates whether or not to supress email notifications to the seller |