Mercury: Create a product
Mercury products.createProduct: arguments, response, policy and SDK examples.
← Products operations · Get started
Operation mercury.createproduct
Provider route: POST /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"]["createProduct"]>[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.createProduct(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.create_product(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | Model | Optional | Expand Create a product — request body — body |
Referenced models: Create a product — request body — body
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 Create a product — response body |
Referenced models: Create a product — response body
Schemas
Section titled “Schemas”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 — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request data to create a product catalog item using the public API Additional keys: not allowed |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Optional description of the product. |
description (anyOf 2) | null | Alternative | |
name | string | Required within parent | Name of the product. Must be unique per organization in combination with the unit price. Maximum length: 299 Minimum length: 1 |
unitPrice | JSON | Required within parent | |
unitPrice (allOf 1) | number | All variants apply | A dollar amount Format: double |
unitPrice (allOf 2) | JSON | All variants apply | Unit price of the product, in dollars. |
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.createproduct. Catalog operation: mercury:createProduct. 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.