# Shipping Methods

# Shipping Method Index Endpoint

#### Structure

See [View Shipping Method Endpoint](https://support.aerocommerce.com/books/api/page/view-shipping-method-endpoint) for the structure of the shipping method payload inside the `data` array.

#### Example Request

```
GET /api/shipping-methods?per_page=2
```

#### Example Response

```json
{
    "current_page": 1,
    "data": [
        //...
    ],
    "first_page_url": "http://aero.test/api/shipping-methods?page=1",
    "from": 1,
    "last_page": 2,
    "last_page_url": "http://aero.test/api/shipping-methods?page=2",
    "next_page_url": "http://aero.test/api/shipping-methods?page=2",
    "path": "http://aero.test/api/shipping-methods",
    "per_page": 2,
    "prev_page_url": null,
    "to": 2,
    "total": 4
}
```

<p class="callout info">See [View Shipping Method Endpoint](https://support.aerocommerce.com/books/api/page/view-shipping-method-endpoint) for the structure of the shipping method payload inside the `data` array.</p>

# View Shipping Method Endpoint

#### Structure

##### Shipping Method

<table border="1" id="bkmrk-name-type-descriptio" style="border-collapse: collapse; width: 100%; height: 737.907px;"><colgroup><col style="width: 33.3731%;"></col><col style="width: 33.3731%;"></col><col style="width: 33.3731%;"></col></colgroup><tbody><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**Name**  
</td><td style="height: 29.7969px;">**Type**  
</td><td style="height: 29.7969px;">**Description**  
</td></tr><tr><td>`id`</td><td>int</td><td>The id of the shipping method</td></tr><tr><td>`name`</td><td>string</td><td>The name of the shipping method</td></tr><tr><td>`available`</td><td>boolean</td><td>Whether the shipping method is available for use</td></tr><tr><td>`rates`</td><td>array</td><td>An array of [Rate](https://support.aerocommerce.com/books/api/page/view-shipping-method-endpoint#bkmrk-rate) objects</td></tr></tbody></table>

#### Rate

<table border="1" id="bkmrk-name-type-descriptio-1" style="border-collapse: collapse; width: 100%; height: 737.907px;"><colgroup><col style="width: 33.3731%;"></col><col style="width: 33.3731%;"></col><col style="width: 33.3731%;"></col></colgroup><tbody><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**Name**  
</td><td style="height: 29.7969px;">**Type**  
</td><td style="height: 29.7969px;">**Description**  
</td></tr><tr><td>`id`</td><td>int</td><td>The id of the shipping rate</td></tr><tr><td>`currency`</td><td>string</td><td>ISO currency code of the shipping rate (e.g., GBP)</td></tr><tr><td>`min_price`</td><td>float</td><td>Minimum cart total price for this rate to apply</td></tr><tr><td>`max_price`</td><td>float</td><td>Maximum cart total price for this rate to apply (nullable = no limit)</td></tr><tr><td>`min_weight`</td><td>float</td><td>Minimum total weight for this rate to apply</td></tr><tr><td>`max_weight`</td><td>float</td><td>Maximum total weight for this rate to apply (nullable = no limit)</td></tr><tr><td>`min_volume`</td><td>float</td><td>Minimum total volume for this rate to apply</td></tr><tr><td>`max_volume`</td><td>float</td><td>Maximum total volume for this rate to apply (nullable = no limit)</td></tr><tr><td>`price`</td><td>float</td><td>The cost of shipping, expressed in the specified currency’s smallest units</td></tr></tbody></table>

#### Example Request

```
GET /api/shipping-methods/{id}
```

#### Example Response

```json
{
    "id": 2,
    "name": "Standard",
    "available": true,
    "rates": [
        {
            "id": 2,
            "currency": "GBP",
            "min_price": 1000,
            "max_price": null,
            "min_weight": 0,
            "max_weight": null,
            "min_volume": 0,
            "max_volume": null,
            "price": 12300
        }
    ]
}
```