PEAK Get Product icon

PEAK Get Product

Send parameter to get product via PEAK API

PEAK Get Product

AI-generated

Summary

Retrieves a single product from the PEAK API using ID or code, switching endpoints between UAT and Production based on configuration.

Inputs

  • serverEnvironment (required) — The API environment to use: 'Production' (api.peakaccount.com) or 'UAT' (peakengineapidev.azurewebsites.net).
  • productId — The ID of the product to retrieve.
  • productCode — The code of the product to retrieve.
  • clientTokenOverride — Optional API Client Token to use instead of the credential value.

Output shape

A single record containing the API response and request headers, wrapped in a success envelope.

If the input contains multiple items, the operation processes each item in a loop. If a request fails and 'Continue on Error' is enabled, the error details are included in the returned item.

Examples

Example 1: Fetch a product by its ID in the Production environment.

Server Environment: Production; Product ID: 12345

Example 2: Retrieve a product by its code in the UAT environment using a temporary token.

Server Environment: UAT; Product Code: PROD-001; Client Token (override):

Links

Discussion