The information necessary to ship a package for Rate Shopper, such as the origin, the destination, and the package dimensions and weight. Note: This schema excludes carrier_id, service_code, and shipping_rule_id as these are automatically selected by the Rate Shopper based on your chosen strategy.
| Name | Type | Description | Notes |
|---|---|---|---|
| AdvancedOptions | AdvancedShipmentOptions | Advanced shipment options. These are entirely optional. | [optional] |
| ComparisonRateType | string | Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS. | [optional] |
| Confirmation | DeliveryConfirmation | The type of delivery confirmation that is required for this shipment. | [optional] |
| CreatedAt | DateTimeOffset | The date and time that the shipment was created in ShipEngine. | [optional] [readonly] |
| Customs | InternationalShipmentOptions | Customs information. This is usually only needed for international shipments. | [optional] |
| ExternalOrderId | string | ID that the Order Source assigned | [optional] |
| ExternalShipmentId | string | A unique user-defined key to identify a shipment. This can be used to retrieve the shipment. > Warning: The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated. | [optional] |
| InsuranceProvider | InsuranceProvider | The insurance provider to use for any insured packages in the shipment. | [optional] |
| IsReturn | bool | An optional indicator if the shipment is intended to be a return. Defaults to false if not provided. | [optional] [default to false] |
| Items | List<ShipmentItem> | Describe the packages included in this shipment as related to potential metadata that was imported from external order sources | [optional] |
| ModifiedAt | DateTimeOffset | The date and time that the shipment was created or last modified. | [optional] [readonly] |
| OrderSourceCode | OrderSourceName | [optional] | |
| Packages | List<Package> | The packages in the shipment. > Note: Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned. | [optional] |
| ReturnTo | ShippingAddress | The return address for this shipment. Defaults to the `ship_from` address. | [optional] |
| ShipDate | DateTimeOffset | The date that the shipment was (or will be) shipped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. | [optional] |
| ShipFrom | ShippingAddress | The shipment's origin address. If you frequently ship from the same location, consider creating a warehouse. Then you can simply specify the `warehouse_id` rather than the complete address each time. | [optional] |
| ShipTo | ShippingAddressTo | The recipient's mailing address | [optional] |
| ShipmentId | string | A string that uniquely identifies the shipment | [optional] [readonly] |
| ShipmentNumber | string | A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment. > Warning: The `shipment_number` is limited to 50 characters. Any additional characters will be truncated. | [optional] |
| ShipmentStatus | ShipmentStatus | The current status of the shipment | [optional] [readonly] |
| Tags | List<Tag> | Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. | [optional] [readonly] |
| TaxIdentifiers | List<TaxIdentifier> | [optional] | |
| TotalWeight | Weight | The combined weight of all packages in the shipment | [optional] [readonly] |
| WarehouseId | string | The warehouse that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified. | [optional] |
| Zone | int | Certain carriers base their rates off of custom zones that vary depending upon the ship_to and ship_from location | [optional] [readonly] |