snake_case.
In keyless test mode, only
search_catalog and get_product at Walmart (mrc_walmart) work.
Every other tool is listed with the same inputs, and returns needs_test_key. See what test mode
covers.Catalog
Find products at a merchant.search_catalog
Search a merchant’s catalog by keyword. Works in keyless test mode.
lookup_catalog
Look up specific items by ID.
get_product
Get a single product by ID. Works in keyless test mode.
Locations
Find the merchant’s stores.search_locations
Search for merchant locations in an area.
lookup_locations
Look up specific locations by ID.
Shoppers
The person the agent buys for.create_shopper
Create a new shopper profile.
get_shopper
Get a shopper by ID.
Payment methods
Add and manage payment methods without the agent seeing card details. See Vault and credentials.create_payment_session
Create a hosted payment method enrollment session.
get_payment_session
Read enrollment status and the issued payment reference.
list_payment_references
List a shopper’s active opaque payment references.
get_payment_reference
Get a stored payment reference.
revoke_payment_reference
Revoke a stored payment reference.
Sessions
Record one agent’s shopping run. See Sessions.create_session
Start a new shopping session.
get_session
Get a session with outcome, duration, and tool call count.
list_sessions
List sessions with optional filters.
get_session_events
Get every tool call made during a session.
Carts
Build a basket at one merchant.create_cart
Create a new shopping cart.
get_cart
Get a cart by ID.
update_cart
Update line items in a cart.
cancel_cart
Cancel a cart.
Checkout
Get a quote and place the order. See Order flow.create_checkout
Create a checkout session from a cart.
get_checkout
Get a checkout session by ID.
update_checkout
Update a checkout session.
complete_checkout
Complete a checkout and create an order.
cancel_checkout
Cancel a checkout session.
Approval
Get the shopper’s approval and the mandate. See Mandates and approval.request_approval
Create a shopper approval session for a checkout.
get_approval
Get the shopper decision and issued mandate.
get_mandate
Get a spending mandate by ID.
Orders
Track an order and change it.get_order
Get an order by ID.
get_order_events
Get the append-only event timeline for an order.
get_order_receipt
Get the reconciled money breakdown for an order.
cancel_order
Cancel an order.
modify_order
Modify an existing order.
Returns and refunds
Handle what happens after delivery.create_return
Request a return for order items.
get_return
Get a return by ID.
create_refund
Create a refund for an order.
get_refund
Get a refund by ID.
Merchants
See which merchants and operations are supported.list_merchants
List all merchants on the platform.
No inputs.
get_merchant
Get a merchant by ID.
get_operations
List all platform commerce operations and their certification status.
Flows
Step-by-step guides an agent can follow. Flow names arecheckout and return.