Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.limitintegerOptionalMaximum number of results to return. Allowed range: 1 to 1000. Defaults to 1000
Default: 1000
Format: int64
Maximum: 1000
Minimum: 1
query.start_afterstringOptionalThe 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_beforestringOptionalThe 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.orderstringOptionalSort order. Can be ‘asc’ or ‘desc’. Defaults to ‘asc’
Default: asc
One of: asc, desc

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand List all products — response body

Referenced models: List all products — response body

List all products — response body
FieldTypePresenceDescription and constraints
$objectRootPaginated response data for Accounts Receivable products API endpoint
pageobjectRequired within parentPagination cursors for navigating to next/previous pages
page.nextPagestringOptionalThe ID of an invoicing product. Use the /api/v1/ar/products endpoint to list your products.
Format: uuid
page.previousPagestringOptionalThe ID of an invoicing product. Use the /api/v1/ar/products endpoint to list your products.
Format: uuid
productsarrayRequired within parentThe list of products for this page
products[]ModelEach itemExpand Create a product — response body

Referenced models: Create a product — response body

Create a product — response body
FieldTypePresenceDescription and constraints
$objectRootA product catalog item for Accounts Receivable API endpoints
descriptionJSONOptional
description (anyOf 1)stringAlternativeDescription of the product, if any.
description (anyOf 2)nullAlternative
idJSONRequired within parent
id (allOf 1)stringAll variants applyThe ID of an invoicing product. Use the /api/v1/ar/products endpoint to list your products.
Format: uuid
id (allOf 2)JSONAll variants applyID of the product.
namestringRequired within parentName of the product.
Maximum length: 299
Minimum length: 1
unitPriceJSONRequired within parent
unitPrice (allOf 1)ModelAll variants applyExpand Create a product — response body — unit Price value
unitPrice (allOf 2)JSONAll variants applyUnit price of the product, in dollars.
updatedAtJSONRequired within parent
updatedAt (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
updatedAt (allOf 2)JSONAll variants applyThe 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
FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)numberAlternativeA dollar amount
Format: double
$ (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

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.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.