Mercury: List all products
Mercury products.listProducts: arguments, response, policy and SDK examples.
← Products operations · Get started
Operation mercury.listproducts
Provider route: GET /ar/products. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/mercury with npm, or alter-sdk-mercury with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { MercuryIntegration } from "@alter-ai/mercury";
async function execute(input: Parameters<MercuryIntegration["products"]["listProducts"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new MercuryIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.products.listProducts(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_mercury import MercuryIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = MercuryIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.products.list_products(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.limit | integer | Optional | Maximum number of results to return. Allowed range: 1 to 1000. Defaults to 1000 Default: 1000 Format: int64 Maximum: 1000 Minimum: 1 |
query.start_after | string | Optional | The ID of the product to start the page after (exclusive). When provided, results will begin with the product immediately following this ID. Use this for standard forward pagination to get the next page of results. Cannot be combined with end_before. Format: uuid |
query.end_before | string | Optional | The ID of the product to end the page before (exclusive). When provided, results will end just before this ID and work backwards. Use this for reverse pagination or to retrieve previous pages. Cannot be combined with start_after. Format: uuid |
query.order | string | Optional | Sort order. Can be ‘asc’ or ‘desc’. Defaults to ‘asc’ Default: asc One of: asc, desc |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand List all products — response body |
Referenced models: List all products — response body
Schemas
Section titled “Schemas”List all products — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Paginated response data for Accounts Receivable products API endpoint |
page | object | Required within parent | Pagination cursors for navigating to next/previous pages |
page.nextPage | string | Optional | The ID of an invoicing product. Use the /api/v1/ar/products endpoint to list your products. Format: uuid |
page.previousPage | string | Optional | The ID of an invoicing product. Use the /api/v1/ar/products endpoint to list your products. Format: uuid |
products | array | Required within parent | The list of products for this page |
products[] | Model | Each item | Expand Create a product — response body |
Referenced models: Create a product — response body
Create a product — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A product catalog item for Accounts Receivable API endpoints |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description of the product, if any. |
description (anyOf 2) | null | Alternative | |
id | JSON | Required within parent | |
id (allOf 1) | string | All variants apply | The ID of an invoicing product. Use the /api/v1/ar/products endpoint to list your products. Format: uuid |
id (allOf 2) | JSON | All variants apply | ID of the product. |
name | string | Required within parent | Name of the product. Maximum length: 299 Minimum length: 1 |
unitPrice | JSON | Required within parent | |
unitPrice (allOf 1) | Model | All variants apply | Expand Create a product — response body — unit Price value |
unitPrice (allOf 2) | JSON | All variants apply | Unit price of the product, in dollars. |
updatedAt | JSON | Required within parent | |
updatedAt (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
updatedAt (allOf 2) | JSON | All variants apply | The time the product's current details were last set. |
Referenced models: Create a product — response body — unit Price value
Create a product — response body — unit Price value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | number | Alternative | A dollar amount Format: double |
$ (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: mercury.listproducts. Catalog operation: mercury:listProducts. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.