Options
All
  • Public
  • Public/Protected
  • All
Menu

Module ImportProducts

This service lets you create and update a set of products and their content.

The set is products is hierarchical in nature. For example, if you have a shirt that comes in 3 colors and 5 sizes per color, you would normally define a root product that then contains the 3 color products and each color product would contain the 5 different sizes, which would be the SKU. How you define the hierarchy is up to you, it's also fine to have the 3 color products as root products and only have them contain the SKUs, or to forego a hierarchy entirely and just create the SKUs, but creating the root and color products is useful for search and frontend purposes.

An example request of a hierarchy:

{ "ID": "special_shirt", "Name": "Special Shirt", "TaxCode": "High", "Variations": { "Property": "color_code", "LogicalLevel": "color", "Products": [ { "ID": "special_shirt_blue", "Name": "Special Shirt - Blue", "VariationValues": [ { "LanguageID": null, "Value": "BLUE" } ], "Variations": { "Property": "size_code", "LogicalLevel": "size", "Products": [ { "ID": "sku_special_shirt_blue_xl", "VariationValues": [ { "LanguageID": null, "Value": "XL" } ] } ] } } ] } }

Index

Properties

Optional CustomPropertyTypes

CustomPropertyTypes: ProductPropertyConfiguration[]

Custom properties used in product content can be defined by specifying their definition in this collection.

Optional DownloadImagesInBackground

DownloadImagesInBackground: undefined | false | true

When not specified, or explicitly specified as false, images will be downloaded while you wait and may cause this service to run for a long time. Defaults to true.

Optional ImageBlobCategory

ImageBlobCategory: undefined | string

A string that identifies the category in which the ProductImages will be stored. It's optional, when not provided the SystemID will be used instead.

Products

Products: Product[]

The list of products to create or update. If a product does not exist it's created and if a product with the same ID and SystemID already exists it is updated.

Optional RootLogicalLevel

RootLogicalLevel: undefined | string

The LogicalLevel that will be assigned to the root level of a product hierarcy. If not specified a default value is used.

See ProductVariation.LogicalLevel for more information.

default

root

SystemID

SystemID: string

A string that identifies the system that was used to call this service. In combination with a product's ID, this is what uniquely identifies the product in EVA. The SystemID must be the same for every call, if it's different from a previous call then new products will be created.

Type

Determines the behavior of this service.

Optional WaitForProductComposition

WaitForProductComposition: undefined | false | true

By default this service only blocks for the time that it takes to store the requested modifications. After that time, some processing still needs to happen before the product is fully ready and searchable, but this happens in the background. If this parameter is specified as true then this service blocks for the full duration that it takes to complete the full process.