PEAK icon

PEAK

Interact with the PEAK Accounting API

Actions11

Product → Get Product

AI-generated

Summary

Retrieve a product's details from the PEAK Accounting API by specifying either its product ID or product code.

Inputs

  • Server Environment (required) — Select the PEAK server environment to use, either UAT or Production.
  • Product ID — The ID of the product to retrieve.
  • Product Code — The code of the product to retrieve.
  • Client Token — Optional client token to authenticate the request; if not provided, a client token must be mapped from a previous Create Client Token operation.

Output shape

a single product record in JSON format

Either Product ID or Product Code must be provided to identify the product. The response includes the product details retrieved from the PEAK API. If neither is provided, the operation throws an error.

Examples

Example 1: Get product by ID

Set Server Environment to 'Production', provide the Product ID, and optionally a Client Token.

Example 2: Get product by code

Set Server Environment to 'Production', provide the Product Code, and optionally a Client Token.

Links

Discussion