Skip to content
COMMERCE CONNECT
/
Product Service
/
/
ProductFamily

Documentation Norce [Storm] Connect Product Service (4.0)

The Product Service has Entities and Operations to create and update products and content in Norce Commerce.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
https://customer-slug.api-se.norce.tech/commerce/connect/4.0/

Schemas

Schemas

ProductCulture

Translated product information.

CultureCodestringrequired

Culture code, e.g. "en-GB". Required to import cultures.

Descriptionstring

Translated product description.

DescriptionHeaderstring

Translated product description header. Max length: 255

IsUniqueUrlNameManuallyMaintainedboolean

Determines if UniqueUrlName is manually maintained.

MetaDescriptionstring

Translated product meta description.

MetaTagsstring

Translated product meta tags.

Namestring

Translated product name. Max length: 255

SubDescriptionstring

Translated additional product description.

SubHeaderstring

Translated additional product header. Max length: 255

Synonymsstring

Translated product synonymous names. Max length: 500

Tagsstring

Translated product tags.

Titlestring

Translated product title. Max length: 255

UniqueUrlNamestring

Language specific unique prodct url name, called 'Unique url' in administration gui.

{
  "CultureCode": "string",
  "Description": "string",
  "DescriptionHeader": "string",
  "IsUniqueUrlNameManuallyMaintained": true,
  "MetaDescription": "string",
  "MetaTags": "string",
  "Name": "string",
  "SubDescription": "string",
  "SubHeader": "string",
  "Synonyms": "string",
  "Tags": "string",
  "Title": "string",
  "UniqueUrlName": "string"
}

ProductFamily

Product family information. Families that can not be matched will not be created but give a warning in the logs.

Codestringrequired

Externally defined product family code. Used for product family matching in Norce Commerce.

Namestring

Product family name.

{
  "Code": "string",
  "Name": "string"
}

ProductHeader

Import product settings. Required to instruct Connect on what to do with provided information.

AccountIdinteger(int32)required

Account which initiated the import. Learn about system accounts here.

FullFilebooleanrequired

If set to true all products previously in a variant cluster that is not in the cluster (i.e. without code) in this import will be removed from the cluster.

ProductFieldsThatAreSetArray of stringsrequired

Specifies which product fields shall be updated.
(Use the integer instead of the name for the xml content type)

0 = ManufacturerCode
1 = ManufacturerName
2 = Alias
3 = Code
4 = Variants (required if you have VariantFieldsThatAreSet values)
5 = Cultures (required if you have ProductCultureFieldsThatAreSet values)
6 = Categories
7 = MainImage
8 = AdditionalImages
9 = Family
10 = ProductParametrics
11 = ProductParametricsCreateOnly (Value is only set if the product parametric entity is created by the import)
12 = VariantDefinitionGroup
13 = VariantDefinitionGroupCreateOnly (Value is only set if the variant definition entity is created by the import)
14 = Assortment
15 = CategoriesCreateOnly (Value is only set if the product category entities is created by the import)
16 = CategoriesLimitedUpdate (If category is manually changed in the Admin UI import is ignored)
17 = AdditionalImagesCleanUp (Remove all additional images not included in the import)
18 = ParametricsCleanUp (Remove all parametrics from the entity, not included in the import)
19 = ImagesAndFilesCleanup (Remove all additional images and files not included in the import)

Items Enum"ManufacturerCode""ManufacturerName""Alias""Code""Variants""Cultures""Categories""MainImage""AdditionalImages""Family"
IgnoreSkuPriceListFieldsWhenEmptyArray of strings

Specifies which SKU price list fields are mandatory. If this field is missing in the import this specific price entity will be ignored.
Required settings: StandardPrice in (SkuFieldsThatAreSet) and all fields added here must be in SkuPriceListFieldsThatAreSet as well
(Use the integer instead of the name for the xml content type)

3 = PriceSale
4 = CostPurchase
5 = CostUnit
6 = PriceRecommended
7 = PricePrevious
8 = PriceCatalog
10 = IsActive

Items Enum"PriceSale""CostPurchase""CostUnit""PriceRecommended""PricePrevious""PriceCatalog""IsActive"
JobIdstring

Norce Commerce Connect job id. Only exists in import logs. Should be omitted in the import request.

ProductCultureFieldsThatAreSetArray of strings

Specifies which product culture fields to be updated.
Required settings: Culture (in ProductFieldsThatAreSet)
(Use the integer instead of the name for the xml content type)

0 = Name
1 = NameCreateOnly (Value is only set if the product culture entity is created by the import)
2 = SubHeader
3 = SubDescription
4 = DescriptionHeader
5 = Description
6 = DescriptionCreateOnly (Value is only set if the product culture entity is created by the import)
7 = Synonyms
8 = Title
9 = Tags
10 = MetaTags
11 = MetaDescription
12 = NameLimitedUpdate (If name is manually changed in the Admin UI, import is ignored)
13 = UniqueUrlName
14 = IsUniqueUrlNameManuallyMaintained
15 = UniqueUrlNameCreateOnly (Value is only set if the product culture entity is created by the import)

Items Enum"Name""NameCreateOnly""SubHeader""SubDescription""DescriptionHeader""Description""DescriptionCreateOnly""Synonyms""Title""Tags"
SerializationTypeArray of strings

Request serialization type.(Use the integer instead of the name for the xml content type)

0 = JSON, 1 = XML

Items Enum"JSON""XML"
SkuCultureFieldsThatAreSetArray of strings

Specifies which SKU culture fields to be updated.
Required settings: Culture (in SkuFieldsThatAreSet)
(Use the integer instead of the name for the xml content type)

0 = Name
0 = ErpName
1 = ErpNameCreateOnly (Value is only set if the SKU culture entity is created by the import)
2 = Comment
3 = CommentCreateOnly (Value is only set if the SKU culture entity is created by the import)

Items Enum"ErpName""ErpNameCreateOnly""Comment""CommentCreateOnly"
SkuFieldsThatAreSetArray of strings

Specifies which SKU fields to be updated.
Required settings: Skus (in VariantFieldsThatAreSet)
(Use the integer instead of the name for the xml content type)

0 = Name
1 = Status
2 = Type
3 = IntegrationPartNo
4 = CommodityCode
5 = EanCode
6 = TrackingCode
7 = UnitOfMeasurementType
8 = UnitOfMeasurementCount
9 = IsDropShipOnly
10 = IsBuyable
11 = DiscountClass
12 = RecommendedSalesQty
13 = IsRecommendedSalesQtyFixed
14 = ActualWeight
15 = VolumeWeight (Deprecated, not supported any longer)
16 = LogisticWidth
18 = LogisticHeight
19 = LogisticDepth
20 = StandardPrice (required if you have SkuPriceListFieldsThatAreSet values)
21 = VatRate
22 = StatusCreateOnly (Value is only set if the SKU entity is created by the import)
23 = StartDate
24 = StopDate
25 = StructureItems (required if you have SkuStructureItemFieldsThatAreSet values)
26 = PartNoCreateWhenMissing (Let's Norce automatically assign a unique PartNo)

Items Enum"Status""Type""IntegrationPartNo""CommodityCode""EanCode""TrackingCode""UnitOfMeasurementType""UnitOfMeasurementCount""IsDropShipOnly""IsBuyable"
SkuPriceListFieldsThatAreSetArray of strings

Specifies which SKU price list fields to be updated.
Required settings: StandardPrice in (SkuFieldsThatAreSet)
(Use the integer instead of the name for the xml content type)

3 = PriceSale
4 = CostPurchase
5 = CostUnit
6 = PriceRecommended
7 = PricePrevious
8 = PriceCatalog
9 = IsPriceDiscountable
10 = IsActive
11 = IsPriceDiscountableCreateOnly (Value is only set if the SKU price list entity is created by the import)
12 = PriceRule

Items Enum"PriceSale""CostPurchase""CostUnit""PriceRecommended""PricePrevious""PriceCatalog""IsPriceDiscountable""IsActive""IsPriceDiscountableCreateOnly""PriceRule"
SkuStructureItemFieldsThatAreSetArray of strings

Specifies which SKU structure item fields to be updated.
Required settings: StructureItems in (SkuFieldsThatAreSet)
(Use the integer instead of the name for the xml content type)

0 = SortOrder
1 = StandardStructureItemPrice
2 = AdditionalInfo

Items Enum"SortOrder""StandardStructureItemPrice""AdditionalInfo"
StorageNamestring(uri)

Location of the import file on Norce's file area. Can be used instead of sending data directly in payload.

SupplierIdinteger(int32)

Derived from base header. Ignored in product import.

VariantCultureFieldsThatAreSetArray of strings

Specifies which variant culture fields to be updated.
Required settings: Cultures (in VariantFieldsThatAreSet) and for anything except Name and UniqueUrl the Client Setting Product texts are variant unique must be active.
(Use the integer instead of the name for the xml content type)

0 = CultureCode
1 = Name
2 = NameCreateOnly (Value is only set if the variant cluster culture entity is created by the import)
3 = NameLimitedUpdate (If name is manually changed in the Admin UI, import is ignored)
4 = UniqueUrlName
5 = IsUniqueUrlNameManuallyMaintained
6 = UniqueUrlNameCreateOnly (Value is only set if the variant cluster culture entity is created by the import)
7 = SubHeader
8 = SubDescription
9 = DescriptionHeader
10 = Description
11 = DescriptionCreateOnly (Value is only set if the variant cluster culture entity is created by the import)
12 = Synonyms
13 = Title
14 = Tags
15 = MetaTags
16 = MetaDescription

Items Enum"CultureCode""Name""NameCreateOnly""NameLimitedUpdate""UniqueUrlName""IsUniqueUrlNameManuallyMaintained""UniqueUrlNameCreateOnly""SubHeader""SubDescription""DescriptionHeader"
VariantFieldsThatAreSetArray of strings

Specifies which variant fields to be updated.
Required settings: Variant (in ProductFieldsThatAreSet)
(Use the integer instead of the name for the xml content type)

0 = ManufacturerPartNo
1 = SortOrderValue
2 = StockDisplayBreakPoint
3 = IsDangerousGoods
4 = Cultures (required if you have VariantCultureFieldsThatAreSet values)
5 = Skus (required if you have SkuFieldsThatAreSet values)
6 = MainImage
7 = AdditionalImages
8 = VariantParametrics
9 = VariantParametricsCreateOnly (Value is only set if the variant cluster entity is created by the import)
10 = NonParametricVariantDefinitions
11 = NonParametricVariantDefinitionsCreateOnly (Value is only set if the variant cluster entity is created by the import)
12 = DeliveryMethods
13 = DeliveryMethodsCreateOnly (Value is only set if the variant cluster entity is created by the import)
14 = AdditionalImagesCleanUp (Remove all AdditionalImages from the entity, not included in the import)
15 = ParametricsCleanUp (Remove all Parametrics from the entity, not included in the import)
16 = TranslationRequested
17 = ImagesAndFilesCleanup (Remove all additional images and files not included in the import)

Items Enum"ManufacturerPartNo""SortOrderValue""StockDisplayBreakPoint""IsDangerousGoods""Cultures""Skus""MainImage""AdditionalImages""VariantParametrics""VariantParametricsCreateOnly"
{
  "AccountId": 0,
  "FullFile": true,
  "ProductFieldsThatAreSet": [
    "ManufacturerCode"
  ],
  "IgnoreSkuPriceListFieldsWhenEmpty": [
    "PriceSale"
  ],
  "JobId": "string",
  "ProductCultureFieldsThatAreSet": [
    "Name"
  ],
  "SerializationType": [
    "JSON"
  ],
  "SkuCultureFieldsThatAreSet": [
    "ErpName"
  ],
  "SkuFieldsThatAreSet": [
    "Status"
  ],
  "SkuPriceListFieldsThatAreSet": [
    "PriceSale"
  ],
  "SkuStructureItemFieldsThatAreSet": [
    "SortOrder"
  ],
  "StorageName": "http://example.com",
  "SupplierId": 0,
  "VariantCultureFieldsThatAreSet": [
    "CultureCode"
  ],
  "VariantFieldsThatAreSet": [
    "ManufacturerPartNo"
  ]
}

Competitor

Operations

Product

Operations

Pricelist

Operations