| Name | Type | Description | Notes |
|---|---|---|---|
| shipper | \Karrio\Model\AddressData | ||
| recipient | \Karrio\Model\AddressData | ||
| parcels | \Karrio\Model\ParcelData[] | The shipment's parcels | |
| options | object | <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 | \Karrio\Model\Payment | [optional] | |
| customs | \Karrio\Model\CustomsData | [optional] | |
| reference | string | The shipment reference | [optional] |
| label_type | string | The shipment label file type. | [optional] [default to 'PDF'] |
| service | string | Specify a service to Buy a label in one call without rating. | [optional] |
| services | string[] | 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 | string[] | 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 | object | User metadata for the shipment | [optional] |
This repository has been archived by the owner on Jan 15, 2024. It is now read-only.