CSM Administration - API Messages/Log Entries
In some cases, such as a connectivity failure causing incomplete processing, an API Message may need to be edited and reprocessed.
API Messages
- Walmart / Magento
- Search for API Messages and select the related link
- Select the API Message record you want to reprocess
- Select Actions > Copy & Edit API Message
- Choose the message element you want to edit
- Select Actions > Copy & Edit API Message
- In the Parameters window, make the necessary changes to the API message’s response text
- Choose the Actions ribbon, then select Manual Processing
- Choose the desired action you want to take
- Choose the desired action you want to take
- Select the API Message record you want to reprocess
- Search for API Messages and select the related link
- Amazon / Shopify / BigCommerce / WooCommerce
- Search for CSM API Messages and select the related link
- Select the API Message record you want to reprocess. You can only edit CSM API Messages with a message status of Response
- Select Actions > Edit Response Message
- In the Response window, make the necessary changes to the CSM API Message’s response text
- Choose the Actions ribbon, then choose Reprocess
- Select Actions > Edit Response Message
- Select the API Message record you want to reprocess. You can only edit CSM API Messages with a message status of Response
- Search for CSM API Messages and select the related link
Log Entries
The Last API Message Processed field on the CSM Order Channel page links directly to the most recent API message for a channel order, providing a quick starting point when troubleshooting a failed order.
Processing Log Entries: If a log level is defined in CSM Setup, log entries are created for warnings, errors, new information, and data changes that occur during API function execution. Where a single API message represents the overall activity (e.g., retrieving an order), individual log entries capture each discrete action within it — customer, shipping address, payment method, etc. A single API message can relate to hundreds of log entries.
When troubleshooting, rather than browsing all log entries in Business Central, open the relevant API message and choose Related Processing Log Entries from the ribbon. This returns a pre-filtered list scoped to that message, which can be filtered further as needed.