# Set a location as a warehouse

```http
PATCH https://secure.yoprint.com/v1/api/store/{team_slug}/setting/location/{id}/hold_stock
```

- API version: v1
- Operation ID: `v1_public_location_hold_stock`
- Section: Team settings › [Company locations](https://developer.yoprint.com/reference/company-locations.md)
- Web page: https://developer.yoprint.com/reference/company-locations/v1-location-hold-stock/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Turns a company location into a warehouse that can hold stock (`hold_stock: true`) and returns it. This is permanent: no operation turns it back. The number of warehouses is limited by the team's plan.

## Permission

Needs the Manage Settings permission.

## Business rules

- Permanent.
- The team's plan must allow another warehouse.

## Side effects

- Stock can now be received, adjusted and allocated at this location.

## Path parameters

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

## Request body

This operation takes no request body.

### Example request

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

## Response

`200` Successful response.

Fields:

- `data` (object, required)
  - `address1` (string | null, required)
  - `city` (string | null, required)
  - `country_code` (string | null, required)
  - `hold_stock` (boolean, required): Whether it is a warehouse that holds stock. Permanent once set.
  - `id` (string, required)
  - `is_current_source` (boolean, required): False for deleted or replaced rows.
  - `is_default_warehouse` (boolean, required): The default warehouse for new sales orders.
  - `is_primary` (boolean, required): The team's primary location: its primary billing address. Exactly one.
  - `label` (string | null, required)
  - `nexus` (boolean, required): Whether the team collects sales tax here (tax nexus).
  - `revision_number` (integer, required): Goes up by one on every saved change. Send it back as `base_revision_number` to avoid overwriting someone else's edit.
  - `role` (string, required): Always `store_location` for company locations.
  - `trashed` (boolean, required): True for a deleted location.
  - `address2` (string | null, optional)
  - `address_family_id` (string | null, optional): Groups an address with the versions that replaced it.
  - `copied_from_address_id` (string | null, optional): The address this one replaced, if any.
  - `country` (string | null, optional)
  - `external_type` (string | null, optional)
  - `is_external` (boolean, optional)
  - `note` (string | null, optional)
  - `owner_id` (string | null, optional): For company locations, the team, encoded with the team's own hash ids. It is not the same string as the team `id` that Get your company details returns.
  - `owner_type` (string, optional)
  - `postal_can_validate` (boolean, optional)
  - `postal_is_valid` (boolean, optional)
  - `postal_validated` (boolean, optional)
  - `postcode` (string | null, optional)
  - `source` (string, optional)
  - `state` (string | null, optional)
  - `state_code` (string | null, optional)
  - `superseded_at` (string (date-time) | null, optional): When it was replaced, if it was.
  - `superseded_by_address_id` (string | null, optional): The address that replaced this one, if any. Company locations are edited in place, so this is normally null.
- `status` (integer, required)
- `success` (boolean, required)

Example response:

```json
{
  "data": {
    "address1": "100 Example Street",
    "address2": null,
    "address_family_id": null,
    "city": "Springfield",
    "copied_from_address_id": null,
    "country": "United States",
    "country_code": "US",
    "external_type": null,
    "hold_stock": true,
    "id": "5ySODwONuta7hu",
    "is_current_source": true,
    "is_default_warehouse": true,
    "is_external": false,
    "is_primary": true,
    "label": "Main shop",
    "nexus": true,
    "note": null,
    "owner_id": "U9KHQle41wSkHO",
    "owner_type": "team",
    "postal_can_validate": false,
    "postal_is_valid": false,
    "postal_validated": false,
    "postcode": "62701",
    "revision_number": 1,
    "role": "store_location",
    "source": "company_location",
    "state": "Illinois",
    "state_code": "IL",
    "superseded_at": null,
    "superseded_by_address_id": null,
    "trashed": false
  },
  "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.
  - When: The plan's warehouse limit is reached. The body is short: `{"message": "Plan only allow maximum of N warehouses to hold stock"}` (`warehouse` when N is 1). Fix: Upgrade the plan, or use an existing warehouse.
- `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 current company location 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.
- `409` Not done: the id is a replaced version, or an external or redacted address. `current_address` holds the current version, when there is one.
  - When: The location is a replaced version, or an external or redacted address. The body is the one Update a company location gives on a 409, `{success: false, address_save_result, message}`, with `save_mode` `blocked_superseded_historical_address` or `blocked_external_or_compliance`. Fix: Use the current location's id, from `current_address` in the answer.

## Related

- [Set the default warehouse](https://developer.yoprint.com/reference/company-locations/v1-location-default-warehouse.md): `PATCH /v1/api/store/{team_slug}/setting/location/{id}/default_warehouse`