Mercury: Products schemas
4 Mercury schemas with complete fields and constraints.
← Products operations · All schemas
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
| 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]+)?$ |
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