| Name | Type | Description | Notes |
|---|---|---|---|
| shipper | AddressData | ||
| recipient | AddressData | ||
| parcels | [ParcelData] | The shipment's parcels | |
| 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": "[email protected]", "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" |
| service | str | Specify a service to Buy a label in one call without rating. | [optional] |
| services | [str], none_type | The requested carrier service for the shipment. Please consult the reference for specific carriers services.<br/> Note that this is a list because on a Multi-carrier rate request you could specify a service per carrier. | [optional] |
| carrier_ids | [str], none_type | The list of configured carriers you wish to get rates from. Note that the request will be sent to all carriers in nothing is specified | [optional] |
| metadata | {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | User metadata for the shipment | [optional] |
| 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.