edit_delivery_option
Updated August 7, 20261 min read
Edit a delivery option. The tool fetches the current delivery option,
merges your changes on top, and saves via PUT /delivery-options/{id}
(the backend PUT is a full replace — the fetch–merge–save keeps the
fields you didn't touch).
Merge contract:
- Top-level fields you pass replace the stored values.
- Pass an explicit
nullto clear a field. - Arrays replace wholesale — no element merging.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
tenantId | string | Yes | The tenant. |
delivery_option_id | string | Yes | Delivery option ID. |
| any delivery option field | — | No | Same payload fields as create_delivery_option — at least one is required. |
Returns
The updated delivery option record.
Example agent prompt
"Rename the express option to 'Express (next day)' and remove its weight condition."
edit_delivery_option(
tenantId="…",
delivery_option_id="a1b2c3",
name="Express (next day)",
weight=null
)
Related tools
Notes
The same server-side normalisations as
create_delivery_option
apply — switching delivery_method away from COLLECTION clears the
customer collection fields, and switching to DIGITAL clears
carrier_account_id.