Skip to content
COMMERCE CONNECT
/
/Schemas

Documentation Norce Commerce Connect Supplier Service (4.0)

The Supplier Service has Entities and Operations to create and update supplier 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

JobResponse

General response for async Connect jobs

StatusCodestring

Status of the job

Descriptionstring

Short message describing the job

JobIdstring(int32)

Norce Commerce's interal id created for this job. Refer to this for future requests.

ValidationSummaryobject(ValidationSummary)(ValidationSummary)

Validation data for accepted payload

{
  "StatusCode": "string",
  "Description": "string",
  "JobId": "string",
  "ValidationSummary": {
    "NrOfItemsInTotal": 0,
    "NrOfValidationFailures": 0,
    "Messages": [ … ]
  }
}

ValidationSummary

Validation data for accepted payload

NrOfItemsInTotalinteger(int32)

Total number of items in payload.

NrOfValidationFailuresinteger(int32)

Number of items that failed initial validation.

MessagesArray of strings

Messages concerning the validation.

{
  "NrOfItemsInTotal": 0,
  "NrOfValidationFailures": 0,
  "Messages": [
    "string"
  ]
}

Image

Represents an image that should be uploaded to Norce Commerce from the supplier regarding the specified article. The type and code must be set up in Norce Commerce Administration settings.

ExternalCodestringrequired

Must match code from Administration setting in Norce Commerce.

FileTypeNamestringrequired

File type. Should match file info set up in Norce Commerce, e.g. "MainImage", "Additional", "Embedded".

Urlstring(uri)required

Ulr to image that is accessible for Norce Commerce Connect for upload to the CDN.

Filenamestring

Image file name. If omitted will be parsed from the url.

LastModifiedstring(DateTime)

Deprecated

{
  "ExternalCode": "string",
  "FileTypeName": "string",
  "Url": "http://example.com",
  "Filename": "string",
  "LastModified": "string"
}

Parametric

Represents a content attribute on an article.

ParametricCodestringrequired

Must be set to the specific code the parameter has in Norce Commerce. Max length: 50

MultipleValuesArray of objects(ParametricMultipleCodeValuePair)(ParametricMultipleCodeValuePair)

If parameter is of type multiple list this field is used and all other fields are ignored.

ValueBooleanboolean

If parameter is of type boolean this field is used and all other fields are ignored.

ValueCodestring

If parameter is of type list this field is used and all other fields are ignored. Max length: 255

ValueDateTimestring(DateTime)

If parameter is of type datetime this field is used and all other fields are ignored.

ValueDecimalnumber

If parameter is of type decimal this field is used and all other fields are ignored.

ValueIntinteger(int32)

If parameter is of type integer this field is used and all other fields are ignored.

ValueTextstring

This value field is preferred for supplier integrations. If parameter is of type text value this field is used and all other fields are ignored. Max length: 255

{
  "ParametricCode": "string",
  "MultipleValues": [
    { … }
  ],
  "ValueBoolean": true,
  "ValueCode": "string",
  "ValueDateTime": "string",
  "ValueDecimal": 0,
  "ValueInt": 0,
  "ValueText": "string"
}

ParametricMultipleCodeValuePair

Represent a value item in an multuple value list.

Codestringrequired

Parametric selection value code. Used for matching in Norce Commerce. Max length: 255

Valuestringrequired

Value for selection. Max length: 255

{
  "Code": "string",
  "Value": "string"
}

ProductCulture

Represents article text information in different languages.

CultureCodestringrequired

ISO language codes, e.g. "sv-SE".

Descriptionstring

Article description.

DescriptionHeaderstring

Article description header. Max length: 255

IsUniqueUrlNameManuallyMaintainedboolean

Determines if UniqueUrlName is manually maintained.

MetaDescriptionstring

Aricle meta descriptions.

MetaTagsstring

Article meta tags.

Namestring

Article name. Max length: 255

SubDescriptionstring

Article additional description.

SubHeaderstring

Article additional header. Max length: 255

Synonymsstring

List of words used in search. Max length: 500

Tagsstring

Article tags.

Titlestring

Article title. Max length: 255

UniqueUrlNamestring

Used for bread crumbs, if provided and enabled in Admin GUI, it will override Norce Commerce automation tool.

{
  "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"
}

SupplierOnHand

Represents stock value information on an article.

LocationCodestringrequired

Name of location, must match supplier location name configured in Norce Commerce. Max length: 50

WarehouseCodestringrequired

Name of Warehouse, must match supplier warehouse name configured in Norce Commerce. Max length: 50

ExternalStockValuenumber

Stock value for external display.

IncomingValuenumber

Quantity of items currently inbound to warehouse.

IsActiveboolean

Sets on hand information to active or inactive. Defaults to true.

IsReturnableboolean

Determines if article is returnable.

LeadTimeDayCountinteger(int32)

Indication of time for delivery from warehouse to client.

MinimumOrderValuenumber

Minimum quantity of items on a purchase order, default is 1.

Namestring

Storage site name, for presentation only. Max length: 255

NextDeliveryDatestring(DateTime)

Expected next delivery date for incoming stock.

PackageValuenumber

Quantity of items in a package, default is 1.

StoppedDatestring(DateTime)

Date when on hand information was deactivated.

Valuenumberrequired

Onhand value

{
  "LocationCode": "string",
  "WarehouseCode": "string",
  "ExternalStockValue": 0,
  "IncomingValue": 0,
  "IsActive": true,
  "IsReturnable": true,
  "LeadTimeDayCount": 0,
  "MinimumOrderValue": 0,
  "Name": "string",
  "NextDeliveryDate": "string",
  "PackageValue": 0,
  "StoppedDate": "string",
  "Value": 0
}

SupplierPrice

Represents supplier price information on article.

PriceListCodestringrequired

Must match code from the supplier price list in Norce Commerce. Max length: 50

CostFeenumber

Cost fee

CostPurchasenumber

Supplier sale price

CostPurchaseValidTostring(DateTime)

Valid to date for price information.

CurrencyCodestring

Currency Code, in ISO 4217 format. For example "SEK", "EUR", "USD", default is currency on configured sales area in Norce Commerce. Max length: 3

DiscountPctnumber

Discount

FreightCostnumber

Freight cost.

IsActiveboolean

Sets price to active or inactive. Defaults to true.

IsFocusboolean

Is focus.

IsPromotionboolean

True if price information is based on temporary campaign.

PriceCatalognumber

Catalog price.

PriceDealernumber

Dealer price.

PriceMaxnumber

Max price for end customer.

PriceRankinginteger(int32)

Price ranking.

PriceRecommendednumber

Recommended price for end customer.

QtyBreakinteger(int32)

Quantity of items required for price, default is 1. This is used for discounts for large orders.

{
  "PriceListCode": "string",
  "CostFee": 0,
  "CostPurchase": 0,
  "CostPurchaseValidTo": "string",
  "CurrencyCode": "string",
  "DiscountPct": 0,
  "FreightCost": 0,
  "IsActive": true,
  "IsFocus": true,
  "IsPromotion": true,
  "PriceCatalog": 0,
  "PriceDealer": 0,
  "PriceMax": 0,
  "PriceRanking": 0,
  "PriceRecommended": 0,
  "QtyBreak": 0
}

SupplierProduct

Represents an article from a Supplier. Product content import (e.g. contentlist, images, parametrics) via Supplier will soon be deprecated.

SupplierPartNostringrequired

Supplier article number. Max length: 50

CategoryCodestring

Name or code of the category, ideally this something readable, like "Utensils" or with a hierachy "Kitchen|Utensils". Max length: 255

CommodityCodestring

A classification of goods for import and export between countries. Max length: 50

ContentListArray of objects(ProductCulture)(ProductCulture)

List of culture specific texts on article.

EanCodestring

Bar code. Max length: 50

GrossWeightnumber

Actual weight including package etc.

ImagesArray of objects(Image)(Image)

Additional images, use high definition. Norce Commerce will provide real-time resizing when used in Norce Commerce Services and Norce Administration GUI.

LogisticDepthnumber

Logistic depth.

LogisticHeightnumber

Logistic height

LogisticWidthnumber

Logistic width

MainImageobject(Image)(Image)

Represents an image that should be uploaded to Norce Commerce from the supplier regarding the specified article. The type and code must be set up in Norce Commerce Administration settings.

Manufacturerstring

Manufacturer code or name, required together with ManufacturerPartNo to be unique. Max length: 50

ManufacturerPartNostring

Manufacturer article number, required together with Manufacturer to be unique. Max length: 50

NetWeightnumber

Obsolete. Weight of item, without packaging.

OnHandArray of objects(SupplierOnHand)(SupplierOnHand)

Stock values, at least one is required.

ParametricsArray of objects(Parametric)(Parametric)

List of supplier specific content attributes, like color or size.

PriceListArray of objects(SupplierPrice)(SupplierPrice)

Purchase cost and other price information. At least one is required.

ProductInfoArray of objects(SupplierProductInfo)(SupplierProductInfo)

List of supplier specific setting attributes. This is article specific information needed for supplier integrations, but will not be shown as content. For example "OnlySoldInSweden".

ProductNamestring

Name of the article in default language. Max length: 500

ProductTypestring

Product type.

UnitOfMeasurementCodeinteger(int32)

Unit of measurement code for item: 0 = Unknown, 1 = Pieces, 2 = Hours, 3 = Kilograms, 4 = Litres. Default is pieces.

UnitOfMeasurementCountinteger(int32)

Number of units in the package.

VatCodeinteger(int32)

Vat rate in percent

{
  "SupplierPartNo": "string",
  "CategoryCode": "string",
  "CommodityCode": "string",
  "ContentList": [
    { … }
  ],
  "EanCode": "string",
  "GrossWeight": 0,
  "Images": [
    { … }
  ],
  "LogisticDepth": 0,
  "LogisticHeight": 0,
  "LogisticWidth": 0,
  "MainImage": {
    "ExternalCode": "string",
    "FileTypeName": "string",
    "Url": "http://example.com",
    "Filename": "string",
    "LastModified": "string"
  },
  "Manufacturer": "string",
  "ManufacturerPartNo": "string",
  "NetWeight": 0,
  "OnHand": [
    { … }
  ],
  "Parametrics": [
    { … }
  ],
  "PriceList": [
    { … }
  ],
  "ProductInfo": [
    { … }
  ],
  "ProductName": "string",
  "ProductType": "string",
  "UnitOfMeasurementCode": 0,
  "UnitOfMeasurementCount": 0,
  "VatCode": 0
}

SupplierProductHeader

AccountIdinteger(int32)required

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

FieldsThatAreSetArray of stringsrequired

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

0 = SupplierPartNo
1 = ProductName
2 = CategoryCode
3 = ProductType
4 = Manufacturer
5 = ManufacturerPartNo
6 = EanCode
7 = CommodityCode
8 = GrossWeight
9 = NetWeight
10 = UnitOfMeasurementCode
11 = UnitOfMeasurementCount
12 = VatCode
13 = LogisticWidth
14 = LogisticHeight
15 = LogisticDepth

Items Enum"SupplierPartNo""ProductName""CategoryCode""ProductType""Manufacturer""ManufacturerPartNo""EanCode""CommodityCode""GrossWeight""NetWeight"
FullFilebooleanrequired

Flag that specified how Norce Commerce Connect will handle the import. If true, all articles not in this feed will be handled as deleted and are deactivated in Norce. If false, the import will be handled as an update only on the articles in the feed, other articles will not be changed.

ContentFieldsThatAreSetArray of strings

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

0 = Name
1 = NameCreateOnly (Value is only set if the entity is created by the import)
2 = SubHeader
3 = SubDescription
4 = DescriptionHeader
5 = Description
6 = DescriptionCreateOnly (Value is only set if the 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 entity is created by the import)

Items Enum"Name""NameCreateOnly""SubHeader""SubDescription""DescriptionHeader""Description""DescriptionCreateOnly""Synonyms""Title""Tags"
JobIdstring

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

OnhandFieldsThatAreSetArray of strings

Specifies which on hand fields to be updated.
(Use the integer instead of the name for the xml content type)

0 = Value
1 = IncomingValue
2 = NextDeliveryDate
3 = StoppedDate
4 = IsReturnable
5 = LeadTimeDayCount
6 = ExternalStockValue
7 = PackageValue
8 = MinimumOrderValue
9 = IsActive

Items Enum"Value""IncomingValue""NextDeliveryDate""StoppedDate""IsReturnable""LeadTimeDayCount""ExternalStockValue""PackageValue""MinimumOrderValue""IsActive"
PriceFieldsThatAreSetArray of strings

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

0 = CostPurchase
1 = CostPurchaseValidTo
2 = PriceRecommended
3 = PriceMax
4 = PriceDealer
5 = IsPromotion
6 = IsFocus
7 = PriceRanking
8 = FreightCost
9 = CostFee
10 = DiscountPct
11 = IsActive
12 = PriceCatalog

Items Enum"CostPurchase""CostPurchaseValidTo""PriceRecommended""PriceMax""PriceDealer""IsPromotion""IsFocus""PriceRanking""FreightCost""CostFee"
ProductInfoFieldsThatAreSetArray of strings

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

0 = Value

Items Value"Value"
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"
StorageNamestring(uri)

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

SupplierIdinteger(int32)required

Norce Commerce's internal Supplier identifier.

{
  "AccountId": 0,
  "FieldsThatAreSet": [
    "SupplierPartNo"
  ],
  "FullFile": true,
  "ContentFieldsThatAreSet": [
    "Name"
  ],
  "JobId": "string",
  "OnhandFieldsThatAreSet": [
    "Value"
  ],
  "PriceFieldsThatAreSet": [
    "CostPurchase"
  ],
  "ProductInfoFieldsThatAreSet": [
    "Value"
  ],
  "SerializationType": [
    "JSON"
  ],
  "StorageName": "http://example.com",
  "SupplierId": 0
}

SupplierProductInfo

Additional product information defined by 3rd party

Codestringrequired

Information field code. Max length: 50

Valuestringrequired

Value to set. Max length: 255

{
  "Code": "string",
  "Value": "string"
}

Product

Operations