{"info":{"version":"4.0","title":"Documentation Norce Commerce Connect Supplier Service","description":"The Supplier Service has Entities and Operations to create and update supplier products and content in Norce Commerce."},"paths":{"/Supplier/ImportProducts":{"post":{"tags":["Product"],"summary":"Import supplier products.","description":"Use this to import whole supplier product catalogs with their prices (costs) and availability (onhand).
Read more about the method here.","operationId":"ImportProducts","parameters":[{"schema":{"$ref":"#/components/schemas/SupplierProductHeader"},"name":"X-StormConnect-Header","in":"header","required":true,"description":"JSON or XML serialized string of the SupplierProductHeader object.
Note that the enums must be of integer values when using application/xml encoding and can be both string or integer for application/json."}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/JobResponse"}}}},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}},"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SupplierProduct"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SupplierProduct"}}}},"required":true,"description":"List of supplier products to import."}}}},"openapi":"3.0.4","servers":[{"url":"https://customer-slug.api-se.norce.tech/commerce/connect/4.0"}],"components":{"schemas":{"JobResponse":{"description":"General response for async Connect jobs","properties":{"StatusCode":{"description":"Status of the job","type":"string"},"Description":{"description":"Short message describing the job","type":"string"},"JobId":{"description":"Norce Commerce's interal id created for this job. Refer to this for future requests.","type":"string","format":"int32"},"ValidationSummary":{"description":"Short validation of request data","$ref":"#/components/schemas/ValidationSummary"}},"type":"object","format":"JobResponse"},"ValidationSummary":{"description":"Validation data for accepted payload","properties":{"NrOfItemsInTotal":{"description":"Total number of items in payload.","type":"integer","format":"int32"},"NrOfValidationFailures":{"description":"Number of items that failed initial validation.","type":"integer","format":"int32"},"Messages":{"description":"Messages concerning the validation.","type":"array","items":{"type":"string"}}},"type":"object","format":"ValidationSummary"},"Image":{"description":"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.","properties":{"ExternalCode":{"description":"Must match code from Administration setting in Norce Commerce.","type":"string"},"FileTypeName":{"description":"File type. Should match file info set up in Norce Commerce, e.g. \"MainImage\", \"Additional\", \"Embedded\".","type":"string"},"Url":{"description":"Ulr to image that is accessible for Norce Commerce Connect for upload to the CDN.","type":"string","format":"uri"},"Filename":{"description":"Image file name. If omitted will be parsed from the url.","type":"string"},"LastModified":{"description":"Deprecated","type":"string","format":"DateTime"}},"type":"object","format":"Image","required":["ExternalCode","FileTypeName","Url"]},"Parametric":{"description":"Represents a content attribute on an article.","properties":{"ParametricCode":{"description":"Must be set to the specific code the parameter has in Norce Commerce. Max length: 50","type":"string"},"MultipleValues":{"description":"If parameter is of type multiple list this field is used and all other fields are ignored.","type":"array","items":{"$ref":"#/components/schemas/ParametricMultipleCodeValuePair"}},"ValueBoolean":{"description":"If parameter is of type boolean this field is used and all other fields are ignored.","type":"boolean"},"ValueCode":{"description":"If parameter is of type list this field is used and all other fields are ignored. Max length: 255","type":"string"},"ValueDateTime":{"description":"If parameter is of type datetime this field is used and all other fields are ignored.","type":"string","format":"DateTime"},"ValueDecimal":{"description":"If parameter is of type decimal this field is used and all other fields are ignored.","type":"number"},"ValueInt":{"description":"If parameter is of type integer this field is used and all other fields are ignored.","type":"integer","format":"int32"},"ValueText":{"description":"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","type":"string"}},"type":"object","format":"Parametric","required":["ParametricCode"]},"ParametricMultipleCodeValuePair":{"description":"Represent a value item in an multuple value list.","properties":{"Code":{"description":"Parametric selection value code. Used for matching in Norce Commerce. Max length: 255","type":"string"},"Value":{"description":"Value for selection. Max length: 255","type":"string"}},"type":"object","format":"ParametricMultipleCodeValuePair","required":["Code","Value"]},"ProductCulture":{"description":"Represents article text information in different languages.","properties":{"CultureCode":{"description":"ISO language codes, e.g. \"sv-SE\".","type":"string"},"Description":{"description":"Article description.","type":"string"},"DescriptionHeader":{"description":"Article description header. Max length: 255","type":"string"},"IsUniqueUrlNameManuallyMaintained":{"description":"Determines if UniqueUrlName is manually maintained.","type":"boolean"},"MetaDescription":{"description":"Aricle meta descriptions.","type":"string"},"MetaTags":{"description":"Article meta tags.","type":"string"},"Name":{"description":"Article name. Max length: 255","type":"string"},"SubDescription":{"description":"Article additional description.","type":"string"},"SubHeader":{"description":"Article additional header. Max length: 255","type":"string"},"Synonyms":{"description":"List of words used in search. Max length: 500","type":"string"},"Tags":{"description":"Article tags.","type":"string"},"Title":{"description":"Article title. Max length: 255","type":"string"},"UniqueUrlName":{"description":"Used for bread crumbs, if provided and enabled in Admin GUI, it will override Norce Commerce automation tool.","type":"string"}},"type":"object","format":"ProductCulture","required":["CultureCode"]},"SupplierOnHand":{"description":"Represents stock value information on an article.","properties":{"LocationCode":{"description":"Name of location, must match supplier location name configured in Norce Commerce. Max length: 50","type":"string"},"WarehouseCode":{"description":"Name of Warehouse, must match supplier warehouse name configured in Norce Commerce. Max length: 50","type":"string"},"ExternalStockValue":{"description":"Stock value for external display.","type":"number"},"IncomingValue":{"description":"Quantity of items currently inbound to warehouse.","type":"number"},"IsActive":{"description":"Sets on hand information to active or inactive. Defaults to true.","type":"boolean"},"IsReturnable":{"description":"Determines if article is returnable.","type":"boolean"},"LeadTimeDayCount":{"description":"Indication of time for delivery from warehouse to client.","type":"integer","format":"int32"},"MinimumOrderValue":{"description":"Minimum quantity of items on a purchase order, default is 1.","type":"number"},"Name":{"description":"Storage site name, for presentation only. Max length: 255","type":"string"},"NextDeliveryDate":{"description":"Expected next delivery date for incoming stock.","type":"string","format":"DateTime"},"PackageValue":{"description":"Quantity of items in a package, default is 1.","type":"number"},"StoppedDate":{"description":"Date when on hand information was deactivated.","type":"string","format":"DateTime"},"Value":{"description":"Onhand value","type":"number"}},"type":"object","format":"SupplierOnHand","required":["LocationCode","WarehouseCode","Value"]},"SupplierPrice":{"description":"Represents supplier price information on article.","properties":{"PriceListCode":{"description":"Must match code from the supplier price list in Norce Commerce. Max length: 50","type":"string"},"CostFee":{"description":"Cost fee","type":"number"},"CostPurchase":{"description":"Supplier sale price","type":"number"},"CostPurchaseValidTo":{"description":"Valid to date for price information.","type":"string","format":"DateTime"},"CurrencyCode":{"description":"Currency Code, in ISO 4217 format. For example \"SEK\", \"EUR\", \"USD\", default is currency on configured sales area in Norce Commerce. Max length: 3","type":"string"},"DiscountPct":{"description":"Discount","type":"number"},"FreightCost":{"description":"Freight cost.","type":"number"},"IsActive":{"description":"Sets price to active or inactive. Defaults to true.","type":"boolean"},"IsFocus":{"description":"Is focus.","type":"boolean"},"IsPromotion":{"description":"True if price information is based on temporary campaign.","type":"boolean"},"PriceCatalog":{"description":"Catalog price.","type":"number"},"PriceDealer":{"description":"Dealer price.","type":"number"},"PriceMax":{"description":"Max price for end customer.","type":"number"},"PriceRanking":{"description":"Price ranking.","type":"integer","format":"int32"},"PriceRecommended":{"description":"Recommended price for end customer.","type":"number"},"QtyBreak":{"description":"Quantity of items required for price, default is 1. This is used for discounts for large orders.","type":"integer","format":"int32"}},"type":"object","format":"SupplierPrice","required":["PriceListCode"]},"SupplierProduct":{"description":"Represents an article from a Supplier. Product content import (e.g. contentlist, images, parametrics) via Supplier will soon be deprecated.","properties":{"SupplierPartNo":{"description":"Supplier article number. Max length: 50","type":"string"},"CategoryCode":{"description":"Name or code of the category, ideally this something readable, like \"Utensils\" or with a hierachy \"Kitchen|Utensils\". Max length: 255","type":"string"},"CommodityCode":{"description":"A classification of goods for import and export between countries. Max length: 50","type":"string"},"ContentList":{"description":"List of culture specific texts on article.","type":"array","items":{"$ref":"#/components/schemas/ProductCulture"}},"EanCode":{"description":"Bar code. Max length: 50","type":"string"},"GrossWeight":{"description":"Actual weight including package etc.","type":"number"},"Images":{"description":"Additional images, use high definition. Norce Commerce will provide real-time resizing when used in Norce Commerce Services and Norce Administration GUI.","type":"array","items":{"$ref":"#/components/schemas/Image"}},"LogisticDepth":{"description":"Logistic depth.","type":"number"},"LogisticHeight":{"description":"Logistic height","type":"number"},"LogisticWidth":{"description":"Logistic width","type":"number"},"MainImage":{"description":"Not required, use high definition. Norce Commerce will provide real-time resizing when used in Norce Storm Services or Norce Admin GUI.","$ref":"#/components/schemas/Image"},"Manufacturer":{"description":"Manufacturer code or name, required together with ManufacturerPartNo to be unique. Max length: 50","type":"string"},"ManufacturerPartNo":{"description":"Manufacturer article number, required together with Manufacturer to be unique. Max length: 50","type":"string"},"NetWeight":{"description":"Obsolete. Weight of item, without packaging.","type":"number"},"OnHand":{"description":"Stock values, at least one is required.","type":"array","items":{"$ref":"#/components/schemas/SupplierOnHand"}},"Parametrics":{"description":"List of supplier specific content attributes, like color or size.","type":"array","items":{"$ref":"#/components/schemas/Parametric"}},"PriceList":{"description":"Purchase cost and other price information. At least one is required.","type":"array","items":{"$ref":"#/components/schemas/SupplierPrice"}},"ProductInfo":{"description":"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\".","type":"array","items":{"$ref":"#/components/schemas/SupplierProductInfo"}},"ProductName":{"description":"Name of the article in default language. Max length: 500","type":"string"},"ProductType":{"description":"Product type.","type":"string"},"UnitOfMeasurementCode":{"description":"Unit of measurement code for item: 0 = Unknown, 1 = Pieces, 2 = Hours, 3 = Kilograms, 4 = Litres. Default is pieces.","type":"integer","format":"int32"},"UnitOfMeasurementCount":{"description":"Number of units in the package.","type":"integer","format":"int32"},"VatCode":{"description":"Vat rate in percent","type":"integer","format":"int32"}},"type":"object","format":"SupplierProduct","required":["SupplierPartNo"]},"SupplierProductHeader":{"description":"","properties":{"AccountId":{"description":"Account which initiated the import. Learn about system accounts here.","type":"integer","format":"int32"},"FieldsThatAreSet":{"description":"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","type":"array","items":{"type":"string","enum":["SupplierPartNo","ProductName","CategoryCode","ProductType","Manufacturer","ManufacturerPartNo","EanCode","CommodityCode","GrossWeight","NetWeight","UnitOfMeasurementCode","UnitOfMeasurementCount","VatCode","LogisticWidth","LogisticHeight","LogisticDepth"]}},"FullFile":{"description":"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.","type":"boolean"},"ContentFieldsThatAreSet":{"description":"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)","type":"array","items":{"type":"string","enum":["Name","NameCreateOnly","SubHeader","SubDescription","DescriptionHeader","Description","DescriptionCreateOnly","Synonyms","Title","Tags","MetaTags","MetaDescription","NameLimitedUpdate","UniqueUrlName","IsUniqueUrlNameManuallyMaintained","UniqueUrlNameCreateOnly"]}},"JobId":{"description":"Norce Commerce Connect job id. Only exists in import logs. Should be omitted in the import request.","type":"string"},"OnhandFieldsThatAreSet":{"description":"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","type":"array","items":{"type":"string","enum":["Value","IncomingValue","NextDeliveryDate","StoppedDate","IsReturnable","LeadTimeDayCount","ExternalStockValue","PackageValue","MinimumOrderValue","IsActive"]}},"PriceFieldsThatAreSet":{"description":"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","type":"array","items":{"type":"string","enum":["CostPurchase","CostPurchaseValidTo","PriceRecommended","PriceMax","PriceDealer","IsPromotion","IsFocus","PriceRanking","FreightCost","CostFee","DiscountPct","IsActive","PriceCatalog"]}},"ProductInfoFieldsThatAreSet":{"description":"Specifies which product info fields to be updated.
(Use the integer instead of the name for the xml content type)
0 = Value","type":"array","items":{"type":"string","enum":["Value"]}},"SerializationType":{"description":"Request serialization type.(Use the integer instead of the name for the xml content type)
0 = JSON, 1 = XML","type":"array","items":{"type":"string","enum":["JSON","XML"]}},"StorageName":{"description":"Location of the import file on Norce's file area. Can be used instead of sending data directly in payload.","type":"string","format":"uri"},"SupplierId":{"description":"Norce Commerce's internal Supplier identifier.","type":"integer","format":"int32"}},"type":"object","format":"SupplierProductHeader","required":["AccountId","FieldsThatAreSet","FullFile","SupplierId"]},"SupplierProductInfo":{"description":"Additional product information defined by 3rd party","properties":{"Code":{"description":"Information field code. Max length: 50","type":"string"},"Value":{"description":"Value to set. Max length: 255","type":"string"}},"type":"object","format":"SupplierProductInfo","required":["Code","Value"]}}}}