search_inventory
Search inventory
Keyword search of published, in-stock surplus listings. No sign-in required. `query` matches the name, description, brand, SKU, and category words, in any order. If the whole query is a category (electronics, clothes, home goods), it is treated as that category filter. Pass `category` as a catalogue category, such as electronics or home_goods, when you want to limit results. `max_price` is the maximum unit price in cents. `condition` is salvage, customer_returns, shelf_pulls, overstock, or new_or_refurbished. Name, brand, and SKU matches rank above description matches. For a sentence about what you want, use search_inventory_semantic.
Parameterslimitquerycategoryconditionmax_price
get_product_details
Get product details
Read one listing: description, price, quantity, condition, photo, and whether instant checkout is available. No sign-in required. Use this before requesting a quote or buying. Pass the exact id from search, for example product_2731.
ParametersidproductIdproduct_id
request_quote
Request a bulk quote
Ask a seller to price a bulk order. No sign-in required if you pass buyer_email, which is where the seller replies. buyer_email is always required, including when you are signed in. Anonymous requests are limited to 5 per hour. Sign in with buyer access to attach the quote to your account. Save status_token and pass it to get_quote_status. This does not charge a card. Sensitive: requires user approval each time.
Parametersmessagequantityrequiredbuyer_nameproduct_idrequiredbuyer_emailrequiredtarget_pricebuyer_companyidempotency_keyrequired
get_quote_status
Get quote status
Check a quote you requested: pending, responded, accepted, rejected, or completed, plus the seller price and shipping once they reply. No sign-in required when you pass the status_token from request_quote. Signed-in buyers can also read their own quotes without the token.
Parametersquote_idrequiredstatus_token
create_listing
Create a listing
Publish a surplus lot for sale. Requires sign-in with seller access. Provide a title, category, condition, quantity, and price per unit. Sensitive: requires user approval each time.
Parametersskunamerequiredcategoryrequiredquantityrequiredconditionrequireddescriptionprice_per_unitrequiredidempotency_keyrequiredoriginal_retail_price
get_pricing_recommendation
Get pricing recommendation
Suggest a liquidation unit price in cents from MSRP, condition, category, and lot size. No sign-in required. original_retail is MSRP per unit in cents. Larger lots suggest a lower per-unit price. The result is bounded below retail. This does not change any listing's price.
Parameterscategoryrequiredquantityconditionrequiredoriginal_retailrequired
get_quote_requests
Get incoming quote requests
List quote requests buyers sent you. Requires sign-in with seller access. Filter to pending, responded, or all.
Parametersstatus
respond_to_quote
Respond to a quote request
Answer a quote from a buyer by accepting it, sending a counter-price, or declining. Requires sign-in with seller access. The buyer is notified. Sensitive: requires user approval each time.
Parametersactionrequiredmessagecounter_pricequote_request_idrequired
bulk_update_listings
Bulk update listing prices or MOQ
Change the price or the minimum order quantity on up to 200 of your listings. Requires sign-in with seller access. price_set takes price_cents (integer cents). value_usd is an explicit dollar amount and is deprecated. The percent modes adjust the current price, and moq_set writes a minimum order quantity. Previous values are replaced. Sensitive: requires user approval each time.
Parametersmoderequiredvaluevalue_usdprice_centsproduct_idsrequired
bulk_mark_shipped
Bulk mark orders shipped
Mark up to 200 of your orders as shipped, with an optional tracking number, tracking link, and carrier applied to the whole batch. Requires sign-in with seller access. Tracking you supply replaces tracking already on those orders, and each buyer is notified. Sensitive: requires user approval each time.
Parametersorder_idsrequiredcarrier_nametracking_urltracking_number
bulk_export_orders
Export orders as CSV
Download your orders as CSV, with order id, product, buyer, quantity, total, status, and date. Requires sign-in with seller access. Only orders you own are included.
Parametersorder_idsrequired
seller_inbox_summarise
Summarise seller inbox
Summarise your seller inbox: quotes waiting for a reply, orders that may miss their ship-by date, and orders with reported problems. Requires sign-in with seller access. Use it to decide what to answer or ship next.
Parameterslimitwindow_hours
Start instant checkout for one listing. The listing's seller sells the goods. ForthClear runs the marketplace and Stripe processes the payment. Requires sign-in with buyer purchase access. buyer_email is required. quantity must be a positive integer below the listing's quote threshold (quote_quantity_threshold from get_product_details). A threshold of 1 means no quantity can be bought instantly — use request_quote. The listing must have instant checkout and a shipping price. This creates a checkout session; it does not charge the card. Sensitive: requires user approval each time.
Parametersquantityrequiredbuyer_nameproduct_idrequiredbuyer_emailrequiredbuyer_companyidempotency_keyrequired
search_inventory_semantic
Semantic inventory search
Find listings by describing what you want in everyday language, such as returned kitchen appliances in bulk. No sign-in required. Semantic matches include similarity from 0 to 1 and match_type semantic. When the embedding index is empty or no provider is configured, results use keyword search, similarity is null, and match_type is keyword_fallback. category, when set, is one catalogue category such as electronics. max_price is the maximum unit price in cents.
Parameterslimitqueryrequiredcategoryconditionmax_price
get_order_status
Get order status
Check status, tracking, and the inspection deadline for an order you placed. Requires sign-in with buyer access.
Parametersorder_idrequired
open_dispute
Open a dispute
Report a problem with an order. not_received is allowed while the order is marked shipped. Other reasons require a delivered order waiting for confirmation. This records the issue, pauses the seller payout, and notifies ForthClear. Requires sign-in with buyer access. Sensitive: requires user approval each time.
Parametersreasonrequiredorder_idrequiredphoto_urlsdescriptionrequiredidempotency_keyrequiredrequested_action
subscribe_to_query
Subscribe to a saved search
Save a catalogue search and receive new matching listings by email, webhook, or a pollable feed. Requires sign-in with buyer access.
Parametersqueryrequiredchannelsrequired
search_suppliers
Search suppliers
Search the supplier directory. No sign-in required. Returns published company profiles only, including profiles a company has claimed. These are not lots for sale. A profile is compiled from public sources and is not an endorsement. Use search_inventory to find lots you can buy. Filter with query, country, type (3pl, returns_processor, brand_retailer, liquidator, other), or category.
Parameterstypelimitquerycountrycategory
preview_checkout
Preview checkout
Read the seller of record, unit price, shipping, tax, and total for an instant-checkout listing. Does not charge a card. Requires buyer read access. Pass the returned checkout_id to confirm_purchase.
Parametersquantityrequiredproduct_idrequiredidempotency_keyrequiredshipping_address_id
confirm_purchase
Confirm purchase
Charge the previewed checkout. Uses a Stripe shared payment token when the SDK supports it, otherwise the buyer's saved card, off session. Charges of US$1,000 or more return requires_action and a URL for 3-D Secure. Returns confirmed only after the PaymentIntent succeeds and the order exists. Fails with PRICE_CHANGED if the preview no longer matches. Sensitive: requires user approval each time.
Parameterspaymentrequiredcheckout_idrequiredidempotency_keyrequired
list_my_orders
List my orders
List orders the signed-in buyer placed. Requires buyer read access.
Parameterslimit
list_seller_orders
List seller orders
List orders for the signed-in seller. Requires seller read access. Returns order id, status, quantity, and total. Buyer contact details stay on the order page.
Parameterslimit
cancel_order
Cancel overdue unshipped order
Cancel an unshipped order whose ship-by date has passed, for a full refund. Seller Agreement §5.4. Requires buyer purchase access. Sensitive: requires user approval each time.
Parametersorder_idrequiredidempotency_keyrequired
mark_order_received
Mark order received
Mark a shipped order received. This starts the 3-day inspection window and does not pay the seller. Requires buyer write access.
Parametersorder_idrequiredidempotency_keyrequired
confirm_order
Confirm order
End the inspection window after it has elapsed. A live order then starts the seller payout. A sandbox order is marked delivered and is not paid out. Requires buyer write access.
Parametersorder_idrequiredidempotency_keyrequired
get_dispute_status
Get dispute status
Read the claim on an order you placed. Requires buyer read access.
Parametersorder_idrequired
list_my_quotes
List my quotes
List quote requests for the signed-in buyer. Requires buyer read access.
Parameterslimit
accept_quote_and_pay
Accept counter and pay
Accept a seller's quoted price and charge it with the same payment options as confirm_purchase. Requires buyer purchase access. Sensitive: requires user approval each time.
Parameterspaymentrequiredquote_idrequiredidempotency_keyrequired