Import API errors

Error responses in the Import API.

Representations

Base representation of an error response containing common fields to all errors.

An error response may contain additional fields depending on the type of an error, for example, attribute in DuplicateAttributeValueError.

`code` String	An error identifier.
`message` String	A plain language description of the cause of an error.

AccessDeniedError

This is the generic error code for access denied. In case of a wrong scope, an InvalidScopeError will be returned.

`code` String	`"access_denied"` An error identifier.
`message` String	A plain language description of the cause of an error.

ConcurrentModificationError

The request conflicts with the current state of the involved resources. This error typically occurs when the request attempts to modify a resource that is out of date, that is, it has been modified by another client since the last time it was retrieved by the system attempting to update it. The client application should resolve the conflict (with or without involving the end-user) before retrying the request.

`code` String	`"ConcurrentModification"` An error identifier.
`message` String	A plain language description of the cause of an error.
`specifiedVersion` Int	The version specified in the failed request.
`currentVersion` Int	The current version of the resource.
`conflictedResource` Any	The resource in conflict.

ContentionError

`code` String	`"Contention"` An error identifier.
`message` String	A plain language description of the cause of an error.

DuplicateAttributeValueError

The Unique AttributeConstraintEnum was violated.

`code` String	`"DuplicateAttributeValue"` An error identifier.
`message` String	A plain language description of the cause of an error.
`attribute` Attribute	The attribute in conflict.

DuplicateAttributeValuesError

The CombinationUnique AttributeConstraintEnum was violated.

`code` String	`"DuplicateAttributeValues"` An error identifier.
`message` String	A plain language description of the cause of an error.
`attributes` Array of Attribute

DuplicateFieldError

The given value already exists for a field that is checked for unique values.

`code` String	`"DuplicateField"` An error identifier.
`message` String	A plain language description of the cause of an error.
`field` String	The name of the field.
`duplicateValue` Any	The offending duplicate value.

DuplicateVariantValuesError

The given combination of values of a Product Variant conflicts with an existing one. Every Product Variant must have a distinct combination of SKU, prices, and custom attribute values.

`code` String	`"DuplicateVariantValues"` An error identifier.
`message` String	A plain language description of the cause of an error.
`variantValues` VariantValues	The offending variant values.

GenericError

`code` String	`"Generic"` An error identifier.
`message` String	A plain language description of the cause of an error.

NewMasterVariantAdditionNotAllowedError

Returned when attempting to create a ProductVariant and set it as the Master Variant in the same ProductVariantImport.

`code` String	`"NewMasterVariantAdditionNotAllowed"` An error identifier.
`message` String	`"Adding a new variant as master variant is not allowed."`

InsufficientScopeError

`code` String	`"insufficient_scope"` An error identifier.
`message` String	A plain language description of the cause of an error.

InvalidCredentialsError

`code` String	`"InvalidCredentials"` An error identifier.
`message` String	A plain language description of the cause of an error.

InvalidFieldError

A given field is not supported. This error occurs, for example, if the field variants, which is not supported by Product Import, is sent to the Product Import endpoint.

`code` String	`"InvalidField"` An error identifier.
`message` String	A plain language description of the cause of an error.
`field` String	The name of the field.
`invalidValue` Any	The invalid value.
`allowedValues` Array of Any	The set of allowed values for the field, if any.
`resourceIndex` Int	The index of the resource in the import request that contains the invalid field.

InvalidFieldsUpdateError

Returned when a field cannot be updated.

`code` String	`"InvalidFieldUpdate"` An error identifier.
`message` String	`"The following fields are currently not supported for changes/updates"`
`fields` Array of String	Fields that cannot be updated.

InvalidInput

An invalid input has been sent to the service. The client application should validate the input according to the constraints described in the error message before sending the request again.

`code` String	`"InvalidInput"` An error identifier.
`message` String	A plain language description of the cause of an error.

InvalidJsonInput

An invalid JSON input has been sent to the service. Either the JSON is syntactically incorrect or the JSON has an unexpected shape, for example, a required field is missing. The client application should validate the input according to the constraints described in the error message before sending the request again.

`code` String	`"InvalidJsonInput"` An error identifier.
`message` String	A plain language description of the cause of an error.

InvalidOperation

The resources in the request are not in the valid state for the operation. The client application should validate the constraints described in the error message before sending the request again.

`code` String	`"InvalidOperation"` An error identifier.
`message` String	A plain language description of the cause of an error.

InvalidScopeError

The requested scope is invalid, unknown, malformed, or exceeds the scope granted by the resource owner.

`code` String	`"invalid_scope"` An error identifier.
`message` String	A plain language description of the cause of an error.

InvalidStateTransitionError

`code` String	`"InvalidTransition"` An error identifier.
`message` String	A plain language description of the cause of an error.
`currentState` ProcessingState	Every Import Operation is assigned one of the following states.
`newState` ProcessingState	Every Import Operation is assigned one of the following states.

InvalidTokenError

`code` String	`"invalid_token"` An error identifier.
`message` String	A plain language description of the cause of an error.

RequiredFieldError

A required field is missing a value.

`code` String	`"RequiredField"` An error identifier.
`message` String	A plain language description of the cause of an error.
`field` String	The name of the field.

ResourceCreationError

`code` String	`"ResourceCreation"` An error identifier.
`message` String	A plain language description of the cause of an error.
`resource` Any	The resource that was created.

ResourceDeletionError

`code` String	`"ResourceDeletion"` An error identifier.
`message` String	A plain language description of the cause of an error.
`resource` Any	The resource that was deleted.

ResourceNotFoundError

`code` String	`"ResourceNotFound"` An error identifier.
`message` String	A plain language description of the cause of an error.
`resource` Any	The resource that was not found.

ResourceUpdateError

`code` String	`"ResourceUpdate"` An error identifier.
`message` String	A plain language description of the cause of an error.
`resource` Any	The resource that was updated.

Import API errors

Representations

ErrorObject

List of error responses

AccessDeniedError

ConcurrentModificationError

ContentionError

DuplicateAttributeValueError

DuplicateAttributeValuesError

DuplicateFieldError

DuplicateVariantValuesError

GenericError

NewMasterVariantAdditionNotAllowedError

InsufficientScopeError

InvalidCredentialsError

InvalidFieldError

InvalidFieldsUpdateError

InvalidInput

InvalidJsonInput

InvalidOperation

InvalidScopeError

InvalidStateTransitionError

InvalidTokenError

RequiredFieldError

ResourceCreationError

ResourceDeletionError

ResourceNotFoundError

ResourceUpdateError

Import API errors

Representations.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

ErrorObject.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

List of error responses.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

AccessDeniedError.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

ConcurrentModificationError.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

ContentionError.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

DuplicateAttributeValueError.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

DuplicateAttributeValuesError.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

DuplicateFieldError.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

DuplicateVariantValuesError.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

GenericError.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

NewMasterVariantAdditionNotAllowedError.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

InsufficientScopeError.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

InvalidCredentialsError.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

InvalidFieldError.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

InvalidFieldsUpdateError.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

InvalidInput.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

InvalidJsonInput.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

InvalidOperation.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

InvalidScopeError.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

InvalidStateTransitionError.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

InvalidTokenError.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

RequiredFieldError.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

ResourceCreationError.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

ResourceDeletionError.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

ResourceNotFoundError.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

ResourceUpdateError.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}

Representations

ErrorObject

List of error responses

AccessDeniedError

ConcurrentModificationError

ContentionError

DuplicateAttributeValueError

DuplicateAttributeValuesError

DuplicateFieldError

DuplicateVariantValuesError

GenericError

NewMasterVariantAdditionNotAllowedError

InsufficientScopeError

InvalidCredentialsError

InvalidFieldError

InvalidFieldsUpdateError

InvalidInput

InvalidJsonInput

InvalidOperation

InvalidScopeError

InvalidStateTransitionError

InvalidTokenError

RequiredFieldError

ResourceCreationError

ResourceDeletionError

ResourceNotFoundError

ResourceUpdateError