---
title: "Update a shipping rate's active flag or metadata (the amount is fixed; there is no delete)"
method: PATCH
path: "/api/v1/shipping-rates/{id}"
tags: ["Catalog"]
---

# Update a shipping rate's active flag or metadata (the amount is fixed; there is no delete)

`PATCH /api/v1/shipping-rates/{id}`

## Request

- Base URL: `https://merchant.zahlo.eu`
- URL: `https://merchant.zahlo.eu/api/v1/shipping-rates/{id}`
- Auth: API key in header `x-api-key`

Update a shipping rate's active flag or metadata (the amount is fixed; there is no delete). Use the response status and request ID to decide whether to retry, reconcile, or ask the customer for action.

## Path parameters

- `id` string, required

## Headers

- `Idempotency-Key` string

## Request body

- ShippingRateUpdateRequest
  - `active` boolean
  - `metadata` object: Up to 50 key-value pairs; keys up to 40 characters, values strings up to 500 characters.

## Response `200`

The updated shipping rate

- ShippingRate
  - `id` string, required
  - `object` 'shipping_rate', required
  - `livemode` boolean, required
  - `createdAt` string, date-time, required
  - `active` boolean, required
  - `displayName` string, required
  - `type` 'fixed_amount', required
  - `fixedAmount` object, required
    - `amount` integer, required: Minor units, VAT included.
    - `currency` string, required
  - `deliveryEstimate` object, nullable, required: Either bound may be omitted; the minimum may not exceed the maximum.
    - `minimum` object, nullable
      - `unit` 'business_day' | 'day' | 'hour' | 'week' | 'month', required
      - `value` integer, required
    - `maximum` object, nullable
      - `unit` 'business_day' | 'day' | 'hour' | 'week' | 'month', required
      - `value` integer, required
  - `metadata` object, required: Up to 50 key-value pairs; keys up to 40 characters, values strings up to 500 characters.

## Other responses

- `400`: Invalid request
- `401`: Authentication failed
- `404`: Resource not found
- `409`: Request conflicts with existing state

---

[API](https://skmtc.dev/zahlo/apis/zahlo-merchant-api.md) - [All operations](https://skmtc.dev/zahlo/apis/zahlo-merchant-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zahlo/apis/zahlo-merchant-api/revisions/8fcbef981e0d?raw)
