Skip to main content

OpenAI to iPaaS.com Product Mapping Documentation

How a completed OpenAI enrichment is applied back to an iPaaS.com Product, including the fields cleared on every write unless preserved.

Summary

A completed OpenAI enrichment is applied back to the iPaaS.com Product it came from through this collection. It is the return leg of OpenAI from iPaaS.com Product Mapping Documentation: the notification OpenAI sends is received as a Message, the completed response is retrieved, and the mapped fields are written onto the Product along with an audit trail of which request produced them.

iPaaS.com data type: Product

ID Format

Manual Sync ID Format

Enter the identifier OpenAI assigned to the enrichment response. This is the same value stored on the Product in the OpenAI Last Response ID custom field after a successful transfer, so the simplest way to re-run one is to copy it from the record.

Manual Sync on this collection can only retrieve a response that already exists, which means the Product must previously have been sent through OpenAI from iPaaS.com Product Mapping Documentation.

External ID Format

iPaaS.com records the link between the two systems on a dedicated external-ID record, and that record is the primary match routing subsequent transfers for a Product that has already been synchronised.

The default mappings additionally write the source identifier into Sku. That gives visibility on the Product record and serves as a fallback match when no external-ID record exists yet — iPaaS.com then links to the existing Product rather than creating a duplicate. Remapping Sku to a different source is supported, but it disables that fallback for Products that already exist.

Deleted Record Support

Delete is not supported. The Product model's delete operation is not implemented and nothing in OpenAI removes an iPaaS.com Product.

Custom Field Support

Five of this collection's sixteen mappings write to custom fields.

OpenAI Last Response ID, OpenAI Last Prompt Text and OpenAI Last Response Date are supplied by the integration itself on every inbound transfer and together give a complete audit trail of the most recent enrichment. OpenAI Response Season and OpenAI Dimension Explanation are different — they hold values the model was asked to produce by the instruction configured on the outbound collection, and are matched from the response by name.

Two rules govern custom fields an instruction asks for:

  • A custom field that is already the destination of a mapping arrives with the integration template and needs no manual setup. All five above fall into this group.

  • A custom field named only inside the instruction, with no mapping of its own, is not created for you and its value is discarded. Add it in iPaaS.com and map it here first.

Mapping Collection Status

  • Status: Enabled. No mapping filter is applied, so every enrichment result routed here is written to the Product.

  • Trigger Events: the OpenAI completed-response webhook, dispatched via the Message collection. Manual Sync is also available.

Duplicate or Conflicting Mappings

OpenAI from iPaaS.com Product Mapping Documentation operates on the same iPaaS.com Product entity. It is the outbound leg of this collection rather than a competitor, and the two are designed to run as a pair.

Collision handling is not supported for this collection, and the Product model does not implement it.

Unmapped Field Overwrite Risk

The iPaaS.com API replaces the whole Product record on update. The following Product fields are not mapped in the default template mappings, so any existing values they hold are overwritten with empty values each time an enrichment result is applied, unless mappings are added to preserve them:

  • AllowBackorders

  • AllowDiscounts

  • Barcode

  • InStockThreshold

  • MSRP

  • SalePrice

  • TaxClass

  • Unit

This is the most consequential configuration decision on this collection. Several of these carry commercial data — MSRP, SalePrice and TaxClass in particular — and losing them silently on every enrichment is a real risk on a live catalogue.

Where any of these fields is populated from another source, add a Dynamic Formula mapping that carries the existing iPaaS.com value forward. The DestinationValue function does this: mapping DestinationValue.SalePrice to the SalePrice destination preserves whatever the Product already holds instead of clearing it, and the same pattern applies to each field above.

Category assignments, variants, inventory, options, units, alternate identifiers and related products are not affected — they are managed by their own collections and are not cleared by this transfer.

Cross-integration risk

Because this collection applies whatever the model returned, it should not be enabled on fields where another merchandising or PIM system is the agreed source of truth.

Supported Child Collections

None. This is a standalone collection with no child collections.

System Caveats

OpenAI Caveats

  • Only a completed response can be read. A response that has not finished, or that OpenAI no longer holds, cannot be applied.

  • Rate limiting. When OpenAI reports its request rate has been exceeded, the transfer is rescheduled automatically and resumes once the limit window has passed. No action is required.

  • The response shape depends on the instruction. This collection can only write fields the model actually returned. A field the instruction never mentioned comes back unchanged from what was sent out.

  • Researched values are inferences. Where the instruction asks the model to supply attributes it was not given, the returned values are its best inference from public sources, not verified product data.

iPaaS.com Caveats

  • The outbound leg must have run first. There is no enrichment result to apply for a Product that was never submitted.

  • Required Product values must be present and valid. iPaaS.com rejects the write if Sku, Name, Type, TrackingMethod, DefaultPrice or Status is missing, or if Type, TrackingMethod or Status carries a value outside its allowed set. An instruction that rewrites any of those risks producing a value the write will not accept.

  • Categories are never modified. The integration instructs OpenAI to leave category assignments alone.

Setup Requirements

OpenAI Configuration

A webhook created in the OpenAI console pointed at the subscription's webhook address and subscribed to the completed-response event. iPaaS.com does not register it — the subscriber creates it. The full procedure is in the OpenAI Installation Instructions.

iPaaS.com Configuration

OpenAI to iPaaS.com Message Mapping Documentation enabled, since every enrichment result is routed through it, and OpenAI from iPaaS.com Product Mapping Documentation configured, since this collection has nothing to apply without it. No additional iPaaS.com-side webhook configuration is required.

Integration Flow

  1. OpenAI finishes an enrichment and notifies iPaaS.com.

  2. The notification is received as a Message and authenticated using the token in the webhook address.

  3. The Message collection retrieves the completed response and reads the routing details attached to the original request.

  4. Those details identify the Product and this collection, and a transfer is dispatched here.

  5. The enriched Product is read out of the response.

  6. The mapped fields are written to the iPaaS.com Product, replacing the whole record.

  7. The audit custom fields are stamped with the response identifier, the instruction used, and the time.

Mappings

Add/Update OpenAI Product TO iPaaS.com

iPaaS.com data type: Product

Mapping Type

Source Field (OpenAI)

Destination Field (iPaaS.com)

Description

Field

Sku

Sku

Required. iPaaS.com rejects a Product write without it. Also serves as the fallback match when no external-ID record exists yet.

Field

Name

Name

Required. Returned unchanged unless the instruction asks for it to be rewritten.

Field

Description

Description

Optional to iPaaS.com, but usually the field the enrichment exists to populate. Replaced on every transfer under the shipped instruction.

Field

Type

Type

Required. Allowed values are Physical and Virtual.

Field

TrackingMethod

TrackingMethod

Required. Allowed values are Product and Variant.

Field

DefaultPrice

DefaultPrice

Required. Be cautious about instructions that adjust pricing — the value is written without a review step.

Field

Status

Status

Required. Allowed values are Preorder, Active, Disabled and Discontinued.

Field

Width

Width

Optional. May carry a researched rather than measured value.

Field

Height

Height

Optional. Same provisional-value caution as Width.

Field

Depth

Depth

Optional. Same provisional-value caution as Width.

Field

Weight

Weight

Optional. Most often consumed downstream by shipping and rating calculations, so confirm any model-supplied figure.

Field

OpenAI Last Response ID (custom field)

OpenAI Last Response ID (custom field)

Recommended. The identifier of the enrichment response that produced this update. Supplied by the integration on every inbound transfer.

Field

OpenAI Response Season (custom field)

OpenAI Response Season (custom field)

Optional. Receives a value the shipped example instruction asks the model to produce. Remove or repoint it when that instruction is replaced.

Field

OpenAI Dimension Explanation (custom field)

OpenAI Dimension Explanation (custom field)

Optional. The model's account of where the dimension values came from, or why it could not supply them. The audit trail for the dimension-research step.

Field

PromptText

OpenAI Last Prompt Text (custom field)

Recommended. Records the exact instruction used, so results can be attributed to a version of the prompt.

Dynamic Formula

return CurrentDateTimeOffset();

OpenAI Last Response Date (custom field)

Recommended. Stamps when iPaaS.com applied the result, including time-zone offset. Generated at write time, not taken from the response.

Error Handling

Errors on this flow are cataloged in the OpenAI Error Messages article. The shapes seen here are:

  • Errors returned by OpenAI when the completed response is fetched, reported with the operation attempted, the HTTP status and OpenAI's own message.

  • Rejections from iPaaS.com when a required Product value is missing or outside its allowed set.

  • A prerequisite failure reported by the Message collection when the dispatch to this collection does not complete.

Testing & Validation

Test Scenarios

  1. Submit a Product for enrichment, wait for OpenAI to complete, and confirm the enriched Description arrives on the Product.

  2. Confirm the three audit custom fields are stamped on the same transfer.

  3. Populate SalePrice on a Product, run an enrichment, and confirm the value is cleared — demonstrating the overwrite risk before it is mitigated.

  4. Add a DestinationValue mapping for SalePrice, repeat, and confirm the value now survives.

  5. Manual Sync using a response identifier copied from OpenAI Last Response ID and confirm the same result is re-applied.

  6. Attempt a Manual Sync for a Product never submitted for enrichment and confirm there is nothing to retrieve.

  7. Write an instruction that returns an invalid Status value and confirm iPaaS.com rejects the write.

Validation Checklist

  • Every unmapped field listed in the overwrite warning has a recorded decision — preserved with DestinationValue, or confirmed as not populated from another source.

  • The Message collection is enabled.

  • The OpenAI webhook exists and points at this subscription.

  • Every custom field the outbound instruction names is mapped here.

  • Required Product values stay mapped on both legs of the round trip.

Additional Notes

  • Enriched values are applied without a review step. Validate an instruction thoroughly in a staging environment before enabling automatic transfers in production.

  • Bulk initialization is not supported, and polling is not supported. Transfers occur by inbound webhook or Manual Sync.

Related Documents

Did this answer your question?