list_stores
List your stores
Stores this organization owns, with status, visibility, radius and activation. Use the store id to check coverage and book. Filter by status or visibility; page with starting_after.
輸入參數limitstatusvisibilitystarting_afterrobomart_version
register_store
Register a store
Register a store: a real place whose owner promises to load the robot. Send the name, the address, at least one alert channel the store owns (relay, webhook, sms or voice), and optionally where the robot parks (robot_spot), hours inside 10:00 to 22:00, the coverage radius (default 2 miles, maximum 5), private or open visibility, loading notes and your own external_ref. The store starts pending; the activation check makes it live.
輸入參數name必填hoursaddress必填robot_spotvisibilityexternal_refradius_milesloading_notesalert_channels必填robomart_versionperishables_after_hours
update_store
Update a store
Change a store you own: name, address, robot spot, hours, radius, visibility, alert channels, loading notes, perishables setting or external_ref; status pauses (paused) and resumes (live) a store. A pending store becomes live only through the activation check. Changing a live store's address or robot spot returns it to pending.
輸入參數namehoursstatusaddressstore_id必填robot_spotvisibilityexternal_refradius_milesloading_notesalert_channelsrobomart_version另有 1 個
find_stores
Find open stores near an address
Live open stores near a drop-off address, nearest first, with whether each one's coverage radius reaches the address. Any account may book from an open store with an order_ref the store recognizes.
輸入參數limitaddress必填radius_milesrobomart_version
check_coverage
Check coverage and price
Can this store deliver to this address at this ready time? Send store_id (a registered store) and dropoff_address; ready_at defaults to now. Checks the store's status, hours and coverage radius, the 5-mile network maximum and the zone, and returns the $2.99 fee and the arrival window. Capacity is answered at booking.
輸入參數parcelready_atstore_idpickup_addressdropoff_address必填robomart_version
book_delivery
Book a delivery
Book a $2.99 robot delivery from a registered store in one call. Send store_id, dropoff_address and dropoff_phone; order_ref is the store's own order number (required at an open store); ready_at starts the 2-hour promise and defaults to now. The answer is yes or no now: a decline carries retry_after_seconds and a capacity.available webhook follows when capacity frees. A live key holds the posted price from the organization's Wallet; a test key creates a simulated robot delivery.
輸入參數parcelmetadataready_atstore_idorder_refpickup_namepickup_phonedropoff_phone必填pickup_addressdropoff_address必填idempotency_key必填robomart_version另有 2 個
track_delivery
Track a delivery
The current Delivery, including store_id, store_name, order_ref, ready_at, promised_by and the pickup and return timestamps. Test deliveries are simulated.
輸入參數delivery_id必填robomart_version
cancel_delivery
Cancel a delivery
Cancel before pickup; a successful cancellation releases the full fee hold. The owner of an open store may use this on another account's booking inside the decline window: that records store.declined and cancels with cancel_reason store_declined. After pickup the call returns not_cancellable. Safe to retry.
輸入參數delivery_id必填robomart_version
get_proof
Get proof of delivery
Proof of a delivered Delivery, with its store_id and order_ref. Sandbox proof is explicitly marked simulated.
輸入參數delivery_id必填robomart_version
wallet_balance
Read the Wallet balance
The Wallet balance for this organization and environment: available, held, this month's spend and the auto top-up setting. Reading only.
輸入參數robomart_version
request_topup
Request a Wallet top-up
Ask for a Wallet top-up of amount_credited cents (2000 to 1000000). The reply carries a signed confirmation link that a person completes in Console; no money moves until they do, and the link expires after 24 hours. Track it with GET /v1/topups/request/{id}.
輸入參數noteamount_credited必填robomart_version