list_delivery_options
Updated August 7, 20261 min read
List delivery options for a tenant via GET /delivery-options.
Pagination starts at page 1. Use select (json-mask) for response
trimming.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
tenantId | string | Yes | The tenant to list. |
select | string | No | json-mask — useful for trimming the response. |
merchant | string | string[] | No | Filter by one or more merchants. |
status | string | string[] | No | Values: ACTIVE, INACTIVE. |
carrier_account_id | string | string[] | No | Filter by assigned carrier account. |
location_id | string | string[] | No | Filter by fulfillment / collection location. |
customer_country | string | string[] | No | Filter by the customer condition's country. |
search_string | string | No | Free-text search. |
page, page_size | string | No | Pagination — page starts at 1. |
pagination | boolean | No | Set false to skip pagination. |
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)"
)