broker_idstringrequired
Merchant numeric ID from get_merchant_info or get_search_autocomplete results.
Shop Merchant Products
https://api.sandbase.ai/v1/api/shop-app/merchant-productsRetrieves one page of a merchant's in-stock product listing, sorted by the site's most-sales order, in a single upstream request.
- Price
- $0.03USD / call
- Method
- POST
- Response
- JSON
- Parameters
- 1 required · 2 optional
Playground
Input
Merchant numeric ID from get_merchant_info or get_search_autocomplete results.
Pagination cursor taken unchanged from a previous response's endCursor field. Omit or leave empty for the first page.
Number of products to retrieve per page; must be an integer from 1 to 100, other values are rejected before any request.
OutputReady
Your output will appear here
Complete the inputs, then click Run.
API README
Shop Merchant Products API
Retrieves one page of a merchant's in-stock product listing, sorted by the site's most-sales order, in a single upstream request.
Request
curl -X POST "https://api.sandbase.ai/v1/run" \
-H "Authorization: Bearer $SANDBASE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"model": "shop-app/merchant-products", "broker_id": "9658745"}'
The result is returned in outputs[0].data.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
broker_id | string | Yes | Merchant numeric ID from get_merchant_info or get_search_autocomplete results. |
after | string | No | Pagination cursor taken unchanged from a previous response's endCursor field. Omit or leave empty for the first page. |
first | integer | No | Number of products to retrieve per page; must be an integer from 1 to 100, other values are rejected before any request. |
Pricing
Flat $0.03 per call. Failed calls are not charged.
Start building
Send your first request
Platform API endpoint with unified authentication and usage tracking.
# The quoted heredoc keeps Unicode and shell metacharacters unchanged.
result=$(curl --fail-with-body --silent \
-X POST "https://api.sandbase.ai/v1/api/shop-app/merchant-products" \
-H "Authorization: Bearer $SANDBASE_API_KEY" \
-H "Content-Type: application/json" \
--data-binary @- <<'SANDBASE_JSON'
{
"after": "",
"first": 10,
"broker_id": "9658745"
}
SANDBASE_JSON
)
printf '%s\n' "$result"2. Authentication
Set your SandBase API key in your server environment. Requests use Bearer authentication.
export SANDBASE_API_KEY="YOUR_API_KEY"Keep your key on the server. Do not expose it in browser code.
3. Parameters
afterstring
Pagination cursor taken unchanged from a previous response's endCursor field. Omit or leave empty for the first page.
firstinteger
Number of products to retrieve per page; must be an integer from 1 to 100, other values are rejected before any request.
Default: 30
4. Response
Saved example response for this API; no live request is made when viewing it.
No saved response has been published. Run the API in Playground to inspect its response.
Explore more
Related APIs
| API | Price | Response |
|---|---|---|
Shop Merchant ProductsThis API Shop | $0.03 per call | JSON |
Shop | $0.03 per call | JSON |
Shop | $0.03 per call | JSON |
Shop | $0.03 per call | JSON |
Shop | $0.03 per call | JSON |
Shop | $0.03 per call | JSON |
Questions
FAQ
How do I use the Shop Merchant Products API?
Send a POST request to https://api.sandbase.ai/v1/api/shop-app/merchant-products with your SandBase API key in the Authorization header (Bearer) and the parameters as a JSON body. You can also try it in the Playground on this page without writing code.
How much does the Shop Merchant Products API cost?
$0.03 per call, billed from your SandBase balance. You are only charged for calls you make; there is no subscription.
What parameters does the Shop Merchant Products API accept?
Required: broker_id (string). Optional: after (string) and first (integer). The Parameters table and the Playground on this page list every field.
What does the Shop Merchant Products API return?
A JSON response returned in the same HTTP request (synchronous).
Do I need a Shop developer account or API key?
No. Shop Merchant Products runs through SandBase, so one SandBase API key covers this endpoint and every other API and model in the catalog. You do not need to apply for Shop API access separately.