Advanced Options
Advanced Options
Many carriers support "Advanced Options", such as the ability to ship alcohol, bill to the receiving party, request money on delivery, or many others. You will need to see the supported options by using the List Carrier Advanced Options.
Property | Description |
---|---|
bill_to_account | string The account number to be billed |
bill_to_party | enumerated_string recipient or third_party |
bill_to_postal_code | string |
bill_to_country_code | string Two letter country code as it corresponds to ISO 3166-1 alpha-2. |
canada_delivered_duty | enumerated_string sender_prepay |
contains_alcohol | bool Indicates if the shipment contains alcohol |
delivered_duty_paid | bool |
non_machinable | bool |
saturday_delivery | bool |
dry_ice | bool |
dry_ice_weight | see weight object below |
Weight Object
Property | Description |
---|---|
unit | enumerated string, required |
value | decimal, required |
Example
POST /v1/labels
For this example, we're going to send Amanda Miller some wine. Since we're shipping alcohol, we're also going to have to use a special Delivery Confirmation as well. We'll be using UPS as the carrier, since they support adult_signature and alcohol delivery.
We added the dictionary shipment.advanced_options
and string shipment.confirmation
:
Example Request
Example Response
Step 2: Ship It!
You can now print your label and ship it! Your label can be found by navigating to label_download.href
.