Product API message usage

The product API message shows the most recent message recorded for the product from the integration and the time it was recorded. This allows you to check what product information AI Commerce received and in what format the information came.

The API message is not the entire integration history of a product. It only shows the most recent saved message, so use it to narrow down a single product or integration issue.

Open the product API message

The product API message is opened from the product edit view in the Dashboard.

1. Open Products and select the product you want to review.
2. Open the API Message product tab.
3. Check the recording time above the message.

If there is no message stored for the product, the view will read No API message stored for the product . An empty view does not prove that the product was never processed; it only indicates that the product does not have a message stored in this field.

Identify the message format

The presentation of an API message is determined by the stored content. A JSON message is displayed as structured keys, values, arrays, and nested structures. An XML message is displayed as formatted elements, attributes, and values. Other content is displayed as inlined text.

The parsing only changes the presentation, not the meaning of the stored message. Always check the field name, value, and structure level together, as a field with the same name can appear in multiple places in the data content.

Make sure the message belongs to the right product

It is a good idea to first look for the product number, SKU, external integration identifier, or other unique value for the product in the product API message. Compare the identifier to the open product information before interpreting other fields.

If the tag in the message belongs to a different product, do not draw conclusions about price, name, or inventory. Record the open product ID, message tag, and message storage time for integration troubleshooting. Also, check that the same external tag has not been accidentally assigned to multiple products.

Find the product information you want to check

For example, you can check the price, name, EAN, product number, or other product information passed by the integration from the product API message. Search for a field in the message and compare its raw value to the product information in the Dashboard or the visible result in the online store.

The value displayed in the message indicates that the value was included in the most recent message stored for the product. It does not, by itself, prove that the value was accepted, converted, or stored in all final fields of the product. For example, taxation, currency, language, unit, or integration conversion rules may explain the difference between the raw message and the displayed value.

If a field is missing, you can only assume that it is not in the most recent saved message. A previous message may have contained the field, as the view does not maintain message history.

Narrow down the integration issue with an API message

The product API message helps distinguish between three situations:

• If the expected field and value appear in the message but the final result is different, check AI Commerce 's field mapping, transformations, and validation.
• If the message is displayed but the expected field is missing, check the data content of the sending system and the field selection in the integration.
• If there is no message or the storage time does not match the latest transfer, check the integration run, the product external identifier, and any transfer error.

When troubleshooting, include the product ID, the time the message was recorded, the external identifier found in the message, and the exact field you are checking. Do not include secrets, personal information, or the entire data content in the support request if a delimited field and value are sufficient to indicate the problem.

Remember API message limits

The product API message reports the latest integration message stored for the product. It does not report the content of all previous messages, the full result of the integration run, or why an individual value may have been rejected in subsequent processing.

Use the API message as the first evidence of what arrived for the product. Confirm the final save from the product's current fields and integration logs if necessary. The field names and structure of the message depend on the ERP, PIM or other integration used.