checkout_shipping_options
InactiveTool of ComOS Federation Gateway
Get available shipping methods and rates for a checkout. **When to use:** After `checkout_start`, before `checkout_create_payment_session`, to let the customer choose shipping speed/carrier. **Prerequisites:** - Checkout must exist (valid sagaId from `checkout_start`) - Shipping address must be set (provided during `checkout_start`) **Returns:** List of shipping options with carrier, service, price, and estimated delivery days. **Important Notes:** - Rates are calculated based on shipping address, cart weight, and dimensions - If no options returned, tenant may lack shipping configuration or address is unserviceable - **This step is OPTIONAL.** If skipped, a default shipping method is automatically applied - Can be called multiple times (e.g., if address changes) **After getting options:** Use `checkout_select_shipping` with the desired carrierId and serviceId. (Federated: requires tenant_id. For cart/orders, pass auth_token from POST /v1/auth/login. Product IDs are MongoDB ObjectIds from catalog_search.)
Parameters schema
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"tenant_id",
"sagaId"
],
"properties": {
"sagaId": {
"type": "string",
"description": "Checkout saga ID"
},
"tenant_id": {
"type": "string",
"description": "Target tenant ID (required). Use federation_list_tenants() to see available tenants."
},
"auth_token": {
"type": "string",
"description": "JWT auth token for authenticated operations (cart, orders). Get from api_call POST /v1/auth/login."
}
},
"additionalProperties": false
}No endpoints wrapped at confidence ≥ 0.70.
Parent server
ComOS Federation Gateway
https://github.com/ronrey/comos-federation
2/7 registries