list_delivery_options
Updated September 9, 20261 min read
List delivery options for a tenant via GET /delivery-options. Pagination starts at page 1. Use optional select with json-mask syntax to return only required fields.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
tenantId | string | Yes | — |
carrier_account_id | array or string | No | — |
customer_country | array or string | No | — |
location_id | array or string | No | — |
merchant | array or string | No | — |
page | string | No | Page number, starting at 1. |
page_size | string | No | — |
pagination | boolean or string | No | — |
search_string | string | No | — |
select | string | No | json-mask expression to filter response fields. |
status | array or string | No | — |
Returns
items — an array of delivery option records (id, code, name,
delivery method, status, merchant, shipping fee, conditions) — plus
pagination with total and page.
Example agent prompt
"Which delivery options does the ACME merchant offer?"
list_delivery_options(
tenantId="…",
merchant="ACME",
status="ACTIVE",
select="items(id,code,name,delivery_method,status)"
)