Use this article to find, filter, read and export the developer logs in the Kustom Portal, so you can troubleshoot the API calls between your systems and Kustom.
Developer logs in the Kustom Portal are kept for 14 days. Use them to:
Investigate technical issues with orders or your integration.
Review the request and response of a specific API call.
Export logs to share with your developer, platform partner or Kustom support.
Kustom's technical documentation is available at docs.kustom.co.
Where to find the developer logs
Open the Kustom Portal and sign in.
Select Developers in the menu to the left, then select Developer logs.
The developer logs page opens with the last 14 days selected. The date range is shown as exact dates, so you always know which period you are looking at. Selecting a single day includes the full 24 hours of that day.
Filtering and searching the developer logs
Use the filters above the developer logs table to narrow down the logs:
Date range. The period to show logs for, up to 14 days back.
Type. Incoming or Outgoing. See Reading the developer logs.
Service. The Kustom service that produced the log, for example Checkout or Order Manager. Useful when you only want to see order management calls or only checkout calls.
Status. The HTTP status code of the response.
Event. The underlying Kustom event, for example ORDER.
Filter options are listed alphabetically, with All at the top. Click the X to the right of the filters to reset them.
To search, click the search icon in the table toolbar. The search only matches a complete Reference ID or Correlation ID. Partial IDs do not return results, so paste the full ID.
The developer logs table shows 100 rows per page. Timestamps are shown to the millisecond, so you can tell apart events that happened within the same second.
Reading the developer logs
Each row in the developer logs table is one API call and shows:
Request timestamp. When Kustom received or sent the request, in your local time.
Action. The Kustom API action triggered by the request, for example CREATE_ORDER or UPDATE_ORDER.
Service. The Kustom service that handled the call.
Status. The HTTP status code returned. See HTTP status codes below.
Method. The HTTP request method, such as GET, POST or PATCH.
Reference ID. The Kustom order ID. Click it to see all logs for that order.
Event. The underlying Kustom event.
Type. The direction of the call. Incoming means from your system to Kustom. Outgoing means from Kustom to your system, for example callbacks and push notifications.
If your store is connected to a platform partner, a Partner column shows which partner each event belongs to. Use the columns icon in the toolbar to show or hide columns.
Log details
Click a row to open the log details. At the top you see the method, status code and endpoint path, followed by the metadata for the call:
reference-id. The order ID.
correlation-id. Links all calls that belong to the same request flow. Include it when you contact Kustom support.
producing-system. The Kustom service that produced the log.
log-id. The unique ID of this log entry.
Switch between the Request and Response tabs to see the headers, parameters and body of each. Hover over the body and click the copy icon to copy it. The copied content pastes as indented JSON, exactly as shown on screen.
Exporting developer logs
You can export developer logs to a CSV file to share them or analyse them outside the Kustom Portal:
Tick the checkbox on each row you want to export, or tick the checkbox in the table header to select all rows on the current page.
Click the download icon in the table toolbar. The tooltip shows how many logs will be exported.
The CSV file contains the complete request and response bodies for each log, not only the columns shown in the table.
You can also share a direct link to a log. The link opens the right view for whoever clicks it, whether they are a user on your store or a member of Kustom support.
HTTP status codes
HTTP status codes in the developer logs are grouped by their first digit:
2xx (Success). The request was received, understood and processed.
3xx (Redirection). The request needs further action to complete, usually a redirect, for example when a customer selects an unsupported shipping country.
4xx (Client errors). The request failed because of an error on the calling side, such as invalid data or missing permissions. A 401 means the API credentials were not accepted. See Checkout Troubleshooting.
5xx (Server errors). Kustom could not process the request because of an error on Kustom's side.
For more detail, see the Kustom docs.