importAssets

post

/ccadmin/v1/asset/import

Import Assets. Import catalog or inventory items that have been uploaded and validated.

Request

Supported Media Types
Body ()
Root Schema : importAssets_request
Type: object
Show Source
  • The token associated with a previous upload/validation operation, for which the import operation will take place.
  • Boolean value to indicate whether to create new products and categories under the catalog specified in the previously uploaded file or under Product Catalog. If it is not provided then default value is false. When the value is true, it places new categories, for which no parent category is specified, under the storefront category of the catalog provided in the file header. When the value is false, such categories are placed under the storefront category of Product Catalog. When the value is true, it places new products under the category referred by the 'defaultCategoryForProducts' property of the catalog provided in the file header. When the value is false, new products are placed under the category referred by the 'defaultCategoryForProducts' property of Product Catalog. In either case, if 'defaultCategoryForProducts' property is blank then new products will be orphaned.
Example:
{
    "useCatalogHeaderForCreatingNewItems":true,
    "token":"QEnltim5M5VNaygUgjomyR0hzV4_10037"
}
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : importAssets_response
Type: object
Show Source
Nested Schema : importErrors
Type: object
Additional Properties Allowed
Show Source
Map of errors with asset uri as key and list of errors as value
Nested Schema : additionalProperties
Type: array
List of errors prefixed with property name.
Show Source
Example Response (application/json)
{
    "modifiedErrorCount":500,
    "total":5001,
    "newErrorCount":500,
    "modifiedSuccessCount":1500,
    "unchangedCount":1000,
    "newSuccessCount":1500,
    "importErrors":{
        "atgasset:/ProductCatalog/sku/sku_id":[
            "parentProduct:Parent product's type does not match with the product type of the variant."
        ]
    }
}

Default Response

The error response
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top