# Replace one of the workspace's shipping rates

Needs workspace:selling:manage.

> **Note:**

**Not fully described yet.** The API description has no described successful answer for this operation yet. The method, path, sign-in, rate limits and request fields on this page are read from the server's code and are accurate; what a successful call returns is not written down here yet. Until it is, search engines and the agent index leave this page out.

`PUT /api/v1/public/workspaces/workspaceId/shipping-rates/id`

- Sign-in: A signed-in user's session: send the session id in the x-session-id header.
- Rate limit: Up to 500 requests every 3 seconds per IP address; up to 1,000 requests a minute per API key (some requests are not counted).

Needs `workspace:selling:manage`. Saves the rate whole; orders keep the copy they were sold with. 422 `SHIPPING_RATE_REFUSED` for an invalid rate.

## Request

| Field         | Type   | Required | Constraints              | Description |
| ------------- | ------ | -------- | ------------------------ | ----------- |
| `workspaceId` | string | Yes      | -                        | -           |
| `id`          | string | Yes      | matches `^[a-f0-9]{24}$` | -           |

Send the body as `application/json`.

| Field                       | Type                    | Required | Constraints                                                       | Description |
| --------------------------- | ----------------------- | -------- | ----------------------------------------------------------------- | ----------- |
| `name`                      | string                  | Yes      | 1 to 50 characters                                                | -           |
| `amount`                    | integer                 | Yes      | at least 0, at most 10000000                                      | -           |
| `currency`                  | string                  | Yes      | 3 to 3 characters                                                 | -           |
| `countries`                 | array of string         | Yes      | at least 1 items, at most 60 items                                | -           |
| `minDays`                   | integer or null         | No       | at least 0, at most 365                                           | -           |
| `maxDays`                   | integer or null         | No       | at least 0, at most 365                                           | -           |
| `freeOver`                  | integer or null         | No       | at least 0, at most 10000000                                      | -           |
| `pickup`                    | boolean                 | No       | -                                                                 | -           |
| `basis`                     | string                  | No       | one of `"flat"`, `"weight"`, `"subtotal"`, `"items"`, `"carrier"` | -           |
| `brackets`                  | array of object or null | No       | at most 10 items                                                  | -           |
| `brackets[].upTo`           | integer or null         | No       | at least 0, at most 9007199254740991                              | -           |
| `brackets[].amount`         | integer                 | No       | at least 0, at most 10000000                                      | -           |
| `perItem`                   | integer or null         | No       | at least 0, at most 10000000                                      | -           |
| `carrier`                   | object or null          | No       | -                                                                 | -           |
| `carrier.carriers`          | array of string         | No       | at most 10 items                                                  | -           |
| `carrier.services`          | array of string         | No       | at most 20 items                                                  | -           |
| `carrier.markupBps`         | integer                 | No       | at least 0, at most 10000                                         | -           |
| `carrier.markupFixed`       | integer                 | No       | at least 0, at most 10000000                                      | -           |
| `carrier.fallbackAmount`    | integer or null         | No       | at least 0, at most 10000000                                      | -           |
| `carrier.origin`            | object                  | No       | -                                                                 | -           |
| `carrier.origin.name`       | string                  | No       | 1 to 100 characters                                               | -           |
| `carrier.origin.line1`      | string                  | No       | 1 to 200 characters                                               | -           |
| `carrier.origin.line2`      | string or null          | No       | at most 200 characters                                            | -           |
| `carrier.origin.city`       | string                  | No       | 1 to 100 characters                                               | -           |
| `carrier.origin.state`      | string or null          | No       | at most 50 characters                                             | -           |
| `carrier.origin.postalCode` | string                  | No       | 1 to 20 characters                                                | -           |
| `carrier.origin.country`    | string                  | No       | 2 to 2 characters                                                 | -           |
| `carrier.origin.phone`      | string or null          | No       | at most 30 characters                                             | -           |

## Example request

Replace each `YOUR_...` value with your own, and set the credential in the environment variable the sample reads.

```bash title="cURL"
curl -X PUT "https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/shipping-rates/YOUR_ID" \
  -H "x-session-id: $BUILDBASE_SESSION_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Example",
  "amount": 0,
  "currency": "string",
  "countries": [
    "string"
  ]
}'
```

```ts title="TypeScript"
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/shipping-rates/YOUR_ID',
  {
    method: 'PUT',
    headers: {
      'x-session-id': process.env.BUILDBASE_SESSION_ID ?? '',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      name: 'Example',
      amount: 0,
      currency: 'string',
      countries: ['string'],
    }),
  }
);
if (!response.ok) {
  throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.text();
```

```python title="Python"
import os

import requests

response = requests.put(
    "https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/shipping-rates/YOUR_ID",
    headers={
        "x-session-id": os.environ["BUILDBASE_SESSION_ID"],
    },
    json={
        "name": "Example",
        "amount": 0,
        "currency": "string",
        "countries": [
            "string",
        ],
    },
    timeout=30,
)
response.raise_for_status()
data = response.text
```

## Responses

A successful answer is not described yet. The server answers with the status and body its handler sends.

### Any other status

The handler's own answer. Not described yet: response bodies come from captured responses (server/openapi/captured) and overlays (server/openapi/overlays).

## Errors

Each refusal, what it means, and what to do. The request changed nothing.

### 400 Bad Request

**What it means:** The request failed a `validate()` schema, or an id in the path is not a valid id. `path` names the field.

**What to do:** Fix the field the body names in `path` (or read `message`) and send the request again. Nothing was changed.

```json title="Example"
{
  "error": true,
  "success": false,
  "path": "string",
  "message": "string"
}
```

### 401 Unauthorized

**What it means:** The credential is missing, expired or not accepted here, or the caller's role has no grant for `x-permission` (refused with 401 too). The body is the plain text `Unauthorized`, or a JSON body with a `code` where the gate says why.

**What to do:** Send the credential this operation asks for (see Sign-in above), or sign in again if it expired. A valid credential is also refused when the role has no grant for the permission above.

```text title="Example"
Unauthorized
```

### 429 Too Many Requests

**What it means:** A rate limit in `x-rateLimit` was reached. `retryAfter` and the `Retry-After` header say how many seconds until the window resets.

**What to do:** Wait the number of seconds in the `Retry-After` header (also `retryAfter` in the body), then retry. Slow down repeated calls.

```json title="Example"
{
  "success": false,
  "message": "string",
  "reason": "rate_limited",
  "retryAfter": 1
}
```

## Related

- [Workspaces guide](/workspaces/overview): how this part of BuildBase works
- [All Workspaces operations](/http-api/reference/workspaces)
- [API reference](/http-api/reference): every operation, by tag
- [Sign-in and credentials for the HTTP API](/http-api/authentication)
- [How the HTTP API reports errors](/http-api/errors)
- [Make your first call](/http-api/first-call)
- [Error codes](/reference/error-codes): every `code` the API returns
- OpenAPI: operation `workspaces.shippingRates.update` in [public-v1.json](https://docs.buildbase.app/openapi/public-v1.json)
