# Update a shipping method

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

- API version: v1
- Operation ID: `v1_public_shipping_type_update_put`
- 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-update-put/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Changes a shipping method and returns it. Send only the fields to change; for an `integration` method, always send `service_code`. `default: true` makes it the team default. The type and integration can't be changed.

## Permission

Needs the Manage Settings permission.

## Business rules

- For an `integration` method, `service_code` is required on every update and must be a service the integration offers.
- The Shopify fulfillment method cannot be the default.

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.
- `hash_id` (string, required): The shipping method's `id`: a hash id from an earlier answer. Only hash ids work here; anything else answers 404 `page_not_found`. Example `1aNKrP6pU0uytN`.

## Request body

Content type `application/json`, required.

Fields:

- `default` (boolean, optional): `true` makes it the team's default shipping method. `false` does nothing.
- `min_price` (integer, optional): The Minimum Price. Send a whole number of thousandths: `12500` is 12.50. Defaults to 0.
- `name` (string, optional)
- `price_percent` (integer, optional): The Markup Percentage or Margin Percentage. Send a whole number as a percentage ×1000: `8250` is 8.25%, `10000` is 10%. Defaults to 0.
- `price_type` (string, optional): Pricing calculation type: `markup` (markup percentage on carrier cost) or `margin` (profit margin percentage). Defaults to `markup`. Stored with the method; the API does not apply this calculation to shipment prices. One of: `"markup"`, `"margin"`.
- `service_code` (string, optional): Required for `integration` methods, even when it doesn't change. Must be a service the integration offers.

### Example request

```bash
curl -X PUT 'https://secure.yoprint.com/v1/api/store/your-team/setting/shipping_type/1aNKrP6pU0uytN' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1' \
  -H 'Content-Type: application/json' \
  -d '{
    "default": true
  }'
```

Another example: Rename:

```bash
curl -X PUT 'https://secure.yoprint.com/v1/api/store/your-team/setting/shipping_type/1aNKrP6pU0uytN' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Customer pick-up"
  }'
```

## Response

`200` Successful response.

Fields:

- `data` (object, required)
  - `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": "Customer 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`).
  - When: The API key is missing or wrong. Fix: Send your personal API key as `Authorization: Bearer YOUR_API_KEY`.
- `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`.
  - When: Your permission group lacks Manage Settings. This 403 has a short body, `{"message": "Insufficient Permission"}`, without `success` or `error`. Fix: Ask the team owner to give your permission group Manage Settings.
- `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.
  - When: No shipping method with that id on this team (`error.code` is null and `error.message` starts "No query results"), the id is not one of this team's hash ids, or you are not a member of the team (both `page_not_found`). Fix: Use an `id` from the list operation and check the team slug.
- `422` The request was refused and changed nothing. `validation_failed` lists what to fix in `error.fields`; other codes name a business rule, explained in `error.message`. A few checks answer with only `{"message": "..."}`. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer `connect_timeout` ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.
  - When: A field has the wrong type or value. `error.code` is `validation_failed`, and `error.fields` names each field with its messages. Fix: Fix the fields listed in `error.fields` and send the request again.
  - When: `default: true` on the Shopify fulfillment method (`shopify_system_shipping_type_default_locked`). Fix: Pick another method as the default.
- `500` A business rule refused the request (see the operation's errors), or something failed inside YoPrint. Refusals use the error envelope with a code such as `action_not_allowed`; an unexpected failure answers `{"message": "Server Error"}`. Repeating a refusal gets the same answer; after an unexpected failure, read the record back before you retry a change.
  - When: On an `integration` method: `service_code` is missing (a generic `{"message": "Server Error"}`), or the integration doesn't offer it (`error.code` `invalid_service_code`). Nothing is saved. Fix: Send a `service_code` the integration offers.

## Related

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