| Name | Type | Description | Notes |
|---|---|---|---|
| shipper | AddressData | ||
| recipient | AddressData | ||
| parcels | [ParcelData] | The shipment's parcels | |
| selected_rate_id | str | The shipment selected rate. | |
| rates | [Rate] | The list for shipment rates fetched previously | |
| options | {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | <details> <summary>The options available for the shipment.</summary> ``` { "currency": "USD", "insurance": 100.00, "cash_on_delivery": 30.00, "shipment_date": "2020-01-01", "dangerous_good": true, "declared_value": 150.00, "email_notification": true, "email_notification_to": "shipper@mail.com", "signature_confirmation": true, } ``` Please check the docs for carrier specific options. </details> | [optional] |
| payment | Payment | [optional] | |
| customs | CustomsData | [optional] | |
| reference | str, none_type | The shipment reference | [optional] |
| label_type | str | The shipment label file type. | [optional] if omitted the server will use the default value of "PDF" |
| any string name | bool, date, datetime, dict, float, int, list, str, none_type | any string name can be used but the value must be the correct type | [optional] |
This repository has been archived by the owner on Jan 15, 2024. It is now read-only.