Troubleshoot Catalog Import Errors

Use this topic to understand how to troubleshoot some of the errors that occur during Import job. These errors may occur when the input data file used for import is incorrect.

You must use the error information provided by the errorLog and errorLogUrl attributes in the importJob GET by ID response to identify and address the issue in the input data file. The errorLog attribute provides a summary of errors that has occurred in the import job, while the errorLogUrl gives an error log file URL which shows the exact resource ID, resource name, and the error message. A new import job may be submitted with the fixed data file.

Here's the list of potential errors along with some troubleshooting tips.

Error	Error Description	Troubleshooting Tips
Wrong JSON format of the input data file	The records in the input data file are based on specific JSON formatting. Incorrect and invalid formatting results in errors.	Refer to the instructions provided in the How to prepare data files for import section to resolve this error.
Wrong attributes used in the input payload resource	Use of unknown attributes which aren't part of Launch Experience entities results in errors.	You must correct the individual records to use only the supported attributes.
Records rolled back	Import runs in multiple batches. Any error in a batch results in all records in that batch to be rolled back. Sample error message with resulting rollback records in the log file: "jobId: 102465|id: 500TextMessage|name: 500 Text Message |resource: productOffering|errorMessage: <Actual Error for this record> |status: FAILED| The following record(s) were rolled back due to 1 error(s) in the Import Batch sub job:- jobId: 102465|id: SpotifyMusic|name: Spotify Music|resource: productOffering|status: ROLLBACK| jobId: 102465|id: ModCaseClearM15M25M35|name: Moderna Case Clear - M15/M25/M35|resource: productOffering|status: ROLLBACK|"	As a corrective action, you have to check the log file, correct the errors and rerun the import. When the error is fixed, the rollback record gets resolved by itself.
Schema validation failures	The records are validated based on the schema for base resource types for each resource mentioned in the schema template. Error messages appear when the validation fails.	You must provide the required attributes for all the resources and subresources in the correct format for attribute values.
Reference ID validation	Any reference to an existing or new top-level catalogManagement resource that isn't provided in the same input file is validated based on the ID value passed in the reference attributes. The error message appears in the following format: The <reference resource name> with id <reference resource id> referenced within <parent resource> with id <parent resource id> and name <parent resource name> doesn't exist in the system. Any reference to a new top-level catalogManagement resource that's provided in the same input file will be provided with an empty ID value. This gets validated based on the name value passed in the reference attributes. The error message appears in the following format: The <reference resource name> with name <reference resource name> referenced within <parent resource> with id <parent resource id> and name <parent resource name> isn't present in the input file. If the mandatory project reference in any of the resource is different from the top-level project in the same input file, the error message appears in the following format: The Project with id <project id> and version <project version> referenced within <parent resource> with name <parent resource name> and id <parent resource id> and isn't present in the input file.	For an existing or new top-level catalogManagement resource that isn't provided in the same input file, you have to either fix the reference ID or include the top-level record in the same input file. For a new top-level catalogManagement resource that's provided in the same input file, you have to ensure that a unique name value is provided in the top-level and reference resources. If the referred top-level project doesn't exist in the input file as a separate top-level resource, it must be added. Otherwise the incorrect reference must be corrected to refer to the existing top-level project.
ID null or empty validation	When ID isn't present in the payload, it's generated using the name in the base item details, devoid of all special characters and spaces, and including only characters and numbers. Example: For a base item titled, summer offer 123, the ID generated is summeroffer123. ID must not be an empty string for a top-level resource.	ID must not be an empty string for a top-level resource.
Name validation	Name is a mandatory and unique attribute for top-level resources and when null or empty, an error message appears.	Name must be provided for all the top-level resources.
Version validation	The version number must be provided for the entities that are imported.	When the version is either null or empty, a default version 1.0 is created.