ShippingMethod

java.lang.Object
- io.sphere.client.shop.model.ShippingMethod

```
public class ShippingMethod
extends java.lang.Object
```
A shipping method defines a specific way of shipping, with different rates for different geographic locations. Example shipping methods are "DHL", "DHL Express" and "UPS". TODO: add a link to the shipping method example in the project-ws wiki.

Constructor Summary

Constructors
Modifier Constructor and Description

protected ShippingMethod()

Constructors
Modifier	Constructor and Description
`protected`	`ShippingMethod()`

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`getDescription()` The description of the shipping method.
`java.lang.String`	`getId()` The unique id.
`VersionedId`	`getIdAndVersion()` The `id` plus version.
`java.lang.String`	`getName()` The name of the shipping method.
`Reference<TaxCategory>`	`getTaxCategory()` The tax category of the shipping method.
`java.util.List<ZoneRate>`	`getZoneRates()` The list of shipping rates per zone.
`boolean`	`isDefault()` true if this is a default shipping method.
`static ReferenceId<ShippingMethod>`	`reference(java.lang.String id)`
`ShippingRate`	`shippingRateForLocation(Location location, java.util.Currency currency)` Determines a shipping rate for a location and currency.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ShippingMethod
```
protected ShippingMethod()
```
- Method Detail
  - reference
```
public static ReferenceId<ShippingMethod> reference(java.lang.String id)
```
  - getId
```
@Nonnull
public java.lang.String getId()
```
    The unique id.
  - getIdAndVersion
```
@Nonnull
public VersionedId getIdAndVersion()
```
    The id plus version.
  - getName
```
@Nonnull
public java.lang.String getName()
```
    The name of the shipping method.
  - getDescription
```
@Nonnull
public java.lang.String getDescription()
```
    The description of the shipping method.
  - getTaxCategory
```
@Nonnull
public Reference<TaxCategory> getTaxCategory()
```
    The tax category of the shipping method.
  - isDefault
```
public boolean isDefault()
```
    true if this is a default shipping method. Only one shipping method can be default.
  - getZoneRates
```
@Nonnull
public java.util.List<ZoneRate> getZoneRates()
```
    The list of shipping rates per zone.
  - shippingRateForLocation
```
public ShippingRate shippingRateForLocation(Location location,
                                   java.util.Currency currency)
```
    Determines a shipping rate for a location and currency. If the given location contains a state and a shipping rate for the country and state is not found then the method tries to find a shipping rate for a country (without state). Returns null if no shipping rate can be determined.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class ShippingMethod

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ShippingMethod

Method Detail

reference

getId

getIdAndVersion

getName

getDescription

getTaxCategory

isDefault

getZoneRates

shippingRateForLocation

toString