Delivery options tools
Updated August 7, 20261 min read
5 tools for managing delivery options — the delivery choices a merchant offers at checkout (home delivery, click & collect, digital delivery), each carrying its schedule, shipping fee, delivery estimation, and eligibility conditions.
Reads
| Tool | What it returns |
|---|---|
list_delivery_options | Delivery options for a tenant, with filtering, paging, and free-text search. |
get_delivery_option | One delivery option by id. |
Writes
| Tool | What it does |
|---|---|
create_delivery_option | Create a new delivery option. |
edit_delivery_option | Edit an existing delivery option by id (fetch–merge–save). |
delete_delivery_option | Delete a delivery option by id. |
Notes
- Every delivery option is scoped to a
merchantwithin the tenant. delivery_methodis one ofDELIVERY,COLLECTION, orDIGITAL— and the backend normalises the payload accordingly:DIGITALclearscarrier_account_id; non-COLLECTIONmethods clear the customer collection fields.- For
COLLECTIONoptions, every listed collection location must already be enabled as a customer collection location, and an emptycustomer_collection_locationslist means any eligible collection-enabled location. Useget_locationswith thecollection_locationfilter to find eligible locations. - A
PASS_THROUGHshipping fee without acarrier_account_idis silently downgraded toFREE_OF_COSTby the backend.