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

ToolWhat it returns
list_delivery_optionsDelivery options for a tenant, with filtering, paging, and free-text search.
get_delivery_optionOne delivery option by id.

Writes

ToolWhat it does
create_delivery_optionCreate a new delivery option.
edit_delivery_optionEdit an existing delivery option by id (fetch–merge–save).
delete_delivery_optionDelete a delivery option by id.

Notes

  • Every delivery option is scoped to a merchant within the tenant.
  • delivery_method is one of DELIVERY, COLLECTION, or DIGITAL — and the backend normalises the payload accordingly: DIGITAL clears carrier_account_id; non-COLLECTION methods clear the customer collection fields.
  • For COLLECTION options, every listed collection location must already be enabled as a customer collection location, and an empty customer_collection_locations list means any eligible collection-enabled location. Use get_locations with the collection_location filter to find eligible locations.
  • A PASS_THROUGH shipping fee without a carrier_account_id is silently downgraded to FREE_OF_COST by the backend.