Name | Type | Description | Notes |
---|---|---|---|
serviceCode | string | Service Code<br />Must be a valid system service code OR a customer mapped service code.<br />If service code is not supplied a list of all available service options will be returned, otherwise only information about the service requested will be returned. | [optional] |
serviceOptions | \RoyalMail\Shipping\Rest\Api\models\ServiceAvailabilityServiceOptions | [optional] | |
totalPackages | int | Number of Packages<br />The total number of packages. | |
totalWeight | double | Total Weight<br />The total weight of the shipment including packaging. Validated againt package weight.<br />Min weight: 1 gram. | |
weightUnitOfMeasure | string | Weight Unit of Measure | [optional] [default to 'KG'] |
product | string | Shipment/Product type being shipped<br /> <br />DOX - Documents Only<br />NDX - All other shipment product types | [optional] [default to 'NDX'] |
value | double | Total Shipment Value<br />Required for Non-Document International and BFPO Shipments.<br />Ignored for Documents Only shipments. | [optional] |
currency | string | Currency<br />This currency will be used for all values across the shipment request.<br />3 digit ISO Currency Code.<br />Required for Non-Document International and BFPO Shipments, or when value is provided.<br />Ignored for Documents Only shipments. | [optional] |
packages | \RoyalMail\Shipping\Rest\Api\models\ServiceAvailabilityShipmentPackage[] | Shipment Packages<br />The packages in the shipment.<br />Required if TotalPackages is more than 1. | [optional] |