CoolCMS API

Dto

Table of Contents

Classes

ImportAccessoryDto
One `<accessories>` item; the target is `ProductSet.code`. It may point to a code created in the same file, so references are evaluated only at the end of the validation run.
ImportBundleBag
Shared collector for `<bundles>`, same trick as {@see ImportIssueBag}.
ImportBundleDto
`<bundle code="" id="" action="">`: a `ProductSet` of type `type=2` without card, variant or stock.
ImportBundleItemDto
One `<items><item code="" count=""/></items>` entry of a bundle. The target is `ProductSet.code` of any type (a bundle may contain another bundle) and may point to a code created in the same file (second pass, like `<accessories>`).
ImportCategoryDto
One `<categories>` item, keyed by `href` (`ProductCategoryText`) or by `path` of names.
ImportCollectionDto
Wrapper of a collection: categories, tags, parameters, images, accessories.
ImportDto
Normalized, format-independent shape of the whole file. The XML parser fills it today and the CSV/JSON parsers fill it the same way, so the validator and executor do not depend on the format.
ImportImageDto
One `<images>` item: either `src` (URL to download) or `assetId` (an existing asset from an export).
ImportIssueBag
Collector of structural defects above the `<product>` level (`<bundles>`).
ImportParameterDto
One `<parameters>` item. A different field is read by parameter type: option types read `option` or the content text, range types `value` and `value2`, others the element content.
ImportPriceDto
One point of the `<price>` series. Axes: `currency` (required) x `fromAmount` x `userGroupId` (supported by the grammar and the DTO, not by the UI).
ImportProductDto
`<product>`: a product card. It is matched indirectly through the codes of its variants; `Product` has no business key of its own. `$id` is an optional explicit target from an export.
ImportSettingsDto
Import settings. They exist in two instances and only one of them decides:
ImportStockDto
`<stock>` of a variant. `warehouse` is `Warehouse.code` (null means the only active warehouse), `quantityMode` is `set` (correction to the target state) or `add` (movement by a +/- value).
ImportStructureIssueDto
Records a defect in the file shape that the parser caught.
ImportTagDto
One `<tags>` item; a tag is matched by name (`ProductTagText.name`), match-only (never created).
ImportValue
One scalar value from the source file, carrying the **line number** of its tag (the line log needs it).
ImportVariantDto
A `<variant>` = `ProductVariant` + `ProductSet` (type=1).
On this page

Search results