Overview
Product records from iPaaS.com can be synchronized to OpenAI using manual sync or outbound webhooks. This mapping supports the synchronization of Product data from iPaaS.com into OpenAI via the Product API. OpenAI processes the product data using the configured prompt and returns AI-generated content such as product descriptions to designated fields.
Before You Begin
Ensure the following prerequisites are in place before configuring this integration.
iPaaS Requirements
Product records must have valid SKU.
Required fields (Name, Description, DefaultPrice) should be populated.
Custom fields for OpenAI responses must be configured if capturing AI output.
Categories should be assigned if referenced in the prompt.
OpenAI Requirements
Valid OpenAI API credentials configured in iPaaS.com.
API access enabled with sufficient quota for product processing.
Model endpoint must support the configured prompt format.
ID Format
When manually syncing a Product from iPaaS.com, enter the valid iPaaS.com Product SKU into the input field on the manual sync page. The SKU serves as the unique identifier for product records.
Example: PROD-SKU-12345
Mapping Collection Status
Status: Enabled
Trigger Events: Manual: Create, Update
Conflicting Mappings
This mapping applies only to Product records. Ensure no other mappings target the same OpenAI entity to prevent data from being overwritten.
Supported Child Collections
This integration does not support any child collections.
Authentication and Security
OpenAI API Key: Used to authenticate requests to the OpenAI API. Ensure API keys are stored securely within the iPaaS.com integration settings page. Product data transmitted to OpenAI should comply with your organization's data privacy policies.
Integration Flow
The integration processes iPaaS.com product records as follows:
Product record is created or updated in iPaaS.com, or manual sync is triggered.
iPaaS authenticates with the OpenAI API using the configured API key.
Product data fields (SKU, Name, Description, Categories, Custom Fields) are mapped and sent to OpenAI.
The PromptText instructs OpenAI how to process the product data (e.g., generate seasonal description).
OpenAI processes the request and generates response content.
Response data is returned to the specified fields (e.g., Description, custom fields).
Product record is updated with OpenAI-generated content.
Sync results are logged for troubleshooting and are available for use by other processes
Mappings
OpenAI Add/Update Product FROM iPaaS
Description
This mapping collection sends product data from iPaaS.com to OpenAI for AI processing. The prompt instructs OpenAI to generate customer-facing descriptions and populate custom fields based on product attributes.
PromptText Example
"Write a customer facing description tailored to appeal to Adult Men between ages 35-50. Theme the description for the calendar season and make it cheery. The default description will be found in the field: description, but also include helpful information from custom_fields and categories.category_names. The new description should be less than 100 characters. Create a custom field named 'OpenAI Response Season' and add the Season that was used in the description."
Mapping Type | Source (iPaaS) | Destination (OpenAI) | Description |
Field | Sku | Id | (Required) Maps the iPaaS product SKU to the OpenAI Id field for record identification. |
Field | Type | Type | Maps the product type from iPaaS.com for AI context. |
Field | TrackingMethod | TrackingMethod | Maps the inventory tracking method from iPaaS.com. |
Field | DefaultPrice | DefaultPrice | Maps the default product price for AI context in generating descriptions. |
Field | Status | Status | Maps the product status (e.g., Active, Inactive) from iPaaS. |
Static | PromptText | (Required) Provides instructions to OpenAI for processing the product data. Customize this prompt based on your business requirements. | |
Field | Sku | Sku | Maps the product SKU for reference in OpenAI processing. |
Field | Description | Description | (Required) Maps the product description; serves as input for AI-generated content and may receive updated content based on prompt instructions. |
Field | Name | Name | (Required) Maps the product name for AI context in generating descriptions. |
Error Handling
Missing SKU
SKU is required.
Description: The product record does not have a valid SKU, a required field, before synching.
Resolution: Ensure all product records have a unique SKU before syncing.
OpenAI API Error
API request failed.
Description: The OpenAI API returned an error response.
Resolution: Verify API credentials are valid and have appropriate permissions. Check OpenAI API status and rate limits.
Custom Field Not Found
Response field not found.
Description: The OpenAI response references a custom field that does not exist in iPaaS (e.g., "OpenAI Response Season").
Resolution: Create the custom field in iPaaS before syncing products.
Validation and Testing
Before deploying this integration, verify the following configuration items and run the test scenarios to confirm proper operation.
Validation Checklist
The required SKU field is populated for all products to be synced.
OpenAI API credentials are configured and valid.
PromptText contains appropriate instructions for your use case.
Custom fields referenced in the prompt exist in iPaaS.com.
Product descriptions are populated for AI processing.
Outbound webhooks are configured if automatic sync is required.
Test Scenarios
Scenario 1: Valid Product Sync
Sync a product with complete data (SKU, Name, Description, Categories). Product should be processed by OpenAI, and response fields should be populated.
Scenario 2: Missing SKU (Failure Case)
Attempt to sync a product without SKU. Sync should fail with clear error message.
Scenario 3: Rate Limit Handling
Sync multiple products in rapid succession. Verify rate limiting is handled gracefully with appropriate retry logic.
Additional Notes
The PromptText field is critical for defining how OpenAI processes product data. Test prompts thoroughly before production use.
OpenAI responses are returned to fields specified in the prompt; ensure these fields exist and have appropriate data types.
Character limits in prompts (e.g., "less than 100 characters") are guidelines; OpenAI may not always comply exactly.
Product data sent to OpenAI should comply with your organization's data privacy and security policies.