# List shipping methods

```http
GET https://secure.yoprint.com/v1/api/store/{team_slug}/setting/shipping_type
```

- API version: v1
- Operation ID: `v1_public_shipping_type_index`
- Section: Team settings › [Shipping methods](https://developer.yoprint.com/reference/shipping-methods.md)
- Web page: https://developer.yoprint.com/reference/shipping-methods/v1-shipping-type-index/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Returns all the team's shipping methods in one list, including deleted ones (`trashed: true`).

Shipping methods say how a shipment goes out: by courier, your own delivery, customer pick-up, or a service of a connected carrier integration such as UPS or FedEx. Each shipment names its method with `shipping_type_id`. YoPrint makes the GoShippo and Shopify fulfillment methods itself.

## Permission

Any team member can call it. Reading needs no extra permission.

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.

## Request body

This operation takes no request body.

### Example request

```bash
curl 'https://secure.yoprint.com/v1/api/store/your-team/setting/shipping_type' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1'
```

## Response

`200` Successful response.

Fields:

- `data` (array of objects, required)
  - Each item:
    - `default` (boolean, required): Whether it is the team's default shipping method.
    - `external_integration_id` (string | null, required): The carrier integration, for `integration` methods.
    - `id` (string, required)
    - `min_price` (integer, required): The Minimum Price. Thousandths, an older encoding: `12500` is 12.50. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (`1234.5` is 1.2345), or as a string (`"1234.5"`) when you send `X-Yoprint-Decimal-Format: exact-v1`. See [Money and quantities](/concepts/money-and-quantities/). Stored only, like `price_type`.
    - `name` (string, required)
    - `price_percent` (integer, required): The Markup Percentage or Margin Percentage as a percentage ×1000: `8250` is 8.25%, `10000` is 10%. Stored only, like `price_type`.
    - `price_type` (string, required): Pricing calculation type: `markup` (markup percentage on carrier cost) or `margin` (profit margin percentage). Stored and displayed in the web app; the API does not apply this calculation to shipment prices. One of: `"markup"`, `"margin"`.
    - `service_code` (string | null, required): The carrier's service code, for `integration` methods.
    - `trashed` (boolean, required): True for a deleted shipping method.
    - `type` (string, required): `courier`, `self_delivery`, `pick_up`: your own methods. `integration`: a service of a connected carrier integration. `integration_shippo` and `shopify_fulfillment` are made by YoPrint. One of: `"courier"`, `"self_delivery"`, `"pick_up"`, `"integration"`, `"integration_shippo"`, `"shopify_fulfillment"`.
- `status` (integer, required)
- `success` (boolean, required)

Example response:

```json
{
  "data": [
    {
      "default": true,
      "external_integration_id": null,
      "id": "1aNKrP6pU0uytN",
      "min_price": 0,
      "name": "Pick Up",
      "price_percent": 0,
      "price_type": "markup",
      "service_code": null,
      "trashed": false,
      "type": "pick_up"
    }
  ],
  "status": 200,
  "success": true
}
```

## Errors

- `401` The API key is missing or wrong (`unauthenticated`).
- `403` You are not allowed to do this. `api_access_not_in_plan`: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only `{"message": "Insufficient Permission"}`. Other refusals use the error envelope, with `unauthorized` or `user_is_not_authorized`.
- `404` Not found. `page_not_found`: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. `code: null`, with a message that starts "No query results for": there is no record with that id.

## Related

- [Create a shipping method](https://developer.yoprint.com/reference/shipping-methods/v1-shipping-type-store.md): `POST /v1/api/store/{team_slug}/setting/shipping_type`
