GET api/Articles/{articleNumber}

Get a specific articles details.

Request Information

URI Parameters

Name	Description	Type	Additional information
articleNumber	Article number	integer	Required

Body Parameters

None.

Remarks

404 Not found is returned if the specified article cannot be found.

Example

//Gets the article with article number 1
http://localhost/api/articles/1

Response Information

Resource Description

The article with the specified article number

ArticleResponse

Name	Description	Type	Additional information
Id	The unique identifier for the article	globally unique identifier	Required
ArticleImageUrl	Article image URI used for getting the article image from the suppliers image bank. By setting the type property in the image URL it's possible to locate different image sizes: http://extranet.compilator.com/handlers/ImageHandler.ashx?comId=1&imgid=1&type={empty}\|thmb\|orig\|detail\|. type= : Retrieves a normal size image (type omitted or left empty). type=thmb: Retrieves a thumbnail size image. type=orig: Retrieves the image in original size (might be large). type=detail: Retrieves a detail size image. If none of the images in the ImageBankImages collection is set to primary, or the collection is empty, this is the primary image of the article.	string	None.
ImageBankImages	List of uploaded images for an article in DäckData. If none of the images in the ImageBankImages collection is set to primary, or the collection is empty, the primary image is the suppliers image in the property ArticleImageUrl.	Collection of ArticleImageBankResponse	None.
ArticleImageId	Article image id.	string	None.
MarketingText	Marketing text as HTML markup.	string	None.
MainGroupName	Name of the main group	string	Required Max length: 50
SubGroupName	Name of the sub group	string	Required Max length: 50
UnitName	Name of the unit	string	Max length: 100
VatRate	Vat rate in percentage.	decimal number	None.
Discontinued	True if article is discontinued (end of life)	boolean	Required
ShortText	Short text for article	string	Max length: 50
LongText	Long text for article	string	Max length: 4000
Tyre		ArticleTyreResponse	None.
Rim		ArticleRimResponse	None.
Service		ArticleServiceResponse	None.
Tube		ArticleTubeResponse	None.
Wheel		ArticleWheelResponse	None.
RecyclingArticles		Collection of RecyclingArticlesResponse	None.
ArticleNo	Article number	integer	Required
MainGroupId	Id of the main group	integer	Required
SubGroupId	Id of the sub group	integer	Required
IsActive	True if article is active	boolean	Required
Ean	European Article Number	string	Max length: 128
DateOfTermination	Date of termination	date	None.
UnitId	Id of the unit	integer	None.
AlternativeArticleNumber	Article number for alternative article	integer	None.
AccountingEntryTemplateId	Id for the accounting entry template	integer	Required
RequestCostAtSale	True if cost price must be set in order	boolean	Required
InfoDocumentUri	Uri where info about the article can be found	string	Max length: 1024
ReplacementArticleNumber	Article number	integer	None.
SupplierArticleId	Article id from supplier	string	Max length: 128
CompilatorId	Compilators id	integer	None.
VatId	Id of VAT	integer	None.
OriginalArticleNumber	Original article number	string	Max length: 100
ProductLine	Product line	string	Max length: 25
OriginalEquipment	True if it is original equipment	boolean	None.
Make	Make	string	Max length: 100
NetNetCalculationId	Id of net net calculation	integer	None.
OEM	Original equipment manufacturer	string	Max length: 20
SearchCode	Search code. Must be unique	string	Max length: 10
CommodityId		string	Max length: 10
ListPrice	The price for the article before discount.	decimal number	None.
ListPriceDiscountFactor	The discount used to calculate purchase price. Discount factor, 1.0 = 100% discount, 0.5 = 50% discount	decimal number	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": "433b31fd-702c-4063-bf59-5653cb81f363",
  "ArticleImageUrl": "sample string 2",
  "ImageBankImages": [
    {
      "Imageurl": "sample string 1",
      "ThumbnailImageUrl": "sample string 2",
      "OriginalImageUrl": "sample string 3",
      "IsPrimary": true
    },
    {
      "Imageurl": "sample string 1",
      "ThumbnailImageUrl": "sample string 2",
      "OriginalImageUrl": "sample string 3",
      "IsPrimary": true
    }
  ],
  "ArticleImageId": "sample string 3",
  "MarketingText": "sample string 4",
  "MainGroupName": "sample string 5",
  "SubGroupName": "sample string 6",
  "UnitName": "sample string 7",
  "VatRate": 1.0,
  "Discontinued": true,
  "ShortText": "sample string 9",
  "LongText": "sample string 10",
  "Tyre": {
    "SpeedRatingKey": "sample string 1",
    "LoadIndexValue": 1.0,
    "AlternativeLoadIndexValue": 1.0,
    "SectionWidth": 1.0,
    "AspectRatio": 1.0,
    "RimDiameter": 1.0,
    "SpeedRatingId": 1,
    "Circumference": 1.0,
    "OverallWidth": 1.0,
    "OverallDiameter": 1.0,
    "RecommendedPressure": 1.0,
    "TreadPattern": "sample string 2",
    "LoadIndexId": 1,
    "AlternativeLoadIndexId": 1,
    "Studs": true,
    "Option": "sample string 3",
    "RecomendedRimWidthMin": 1.0,
    "RecomendedRimWidthMax": 1.0,
    "Ply": "sample string 4",
    "Duration": "12/21/2025 1:06:15 PM",
    "ExtraLoad": true,
    "RunFlatTyre": true,
    "Wet": "sample string 5",
    "Fuel": "sample string 6",
    "Weight": 1.0,
    "Noise": 1,
    "NoiseClass": 1,
    "StudCount": 1,
    "RimEdgeProtection": true,
    "OECode": "sample string 7",
    "OEBrand": "sample string 8",
    "NordicFriction": true,
    "PricatProductType": "sample string 9",
    "RFID": true,
    "EUDirectiveNumber": "sample string 10",
    "SpecialCompound": "sample string 11",
    "ThreePMSFMark": true,
    "DistributerWebsiteUrl": "sample string 12",
    "DistributerProductinfoUrl": "sample string 13",
    "ReservedEUUrl1": "sample string 14",
    "ReservedEUUrl2": "sample string 15"
  },
  "Rim": {
    "VehicleInfo": [
      {
        "Make": "sample string 1",
        "Model": "sample string 2"
      },
      {
        "Make": "sample string 1",
        "Model": "sample string 2"
      }
    ],
    "Original": true,
    "Diameter": 1.0,
    "Width": 1.0,
    "Lugs": 1,
    "CircleDiameter": 1.0,
    "CentreBore": 1.0,
    "CentreBoreDesign": "sample string 2",
    "RecomendedSectionWidth": 1.0,
    "RecomendedAspectRatio": 1.0,
    "RecomendedRimDiameter": 1.0,
    "WheelOffset": 1.0,
    "Backspacing": 1.0,
    "Design": "sample string 3",
    "Kit": "sample string 4",
    "LockKit": "sample string 5",
    "Duration": "12/21/2025 1:06:15 PM",
    "IsAlloy": true,
    "Brand": "sample string 6",
    "Weight": 1.0
  },
  "Service": {
    "Duration": "12/21/2025 1:06:15 PM"
  },
  "Tube": {
    "SectionWidth": 1.0,
    "AspectRatio": 1.0,
    "RimDiameter": 1.0,
    "Valve": "sample string 1",
    "Weight": 1.0
  },
  "Wheel": {
    "VehicleInfo": [
      {
        "Make": "sample string 1",
        "Model": "sample string 2"
      },
      {
        "Make": "sample string 1",
        "Model": "sample string 2"
      }
    ],
    "SpeedRatingKey": "sample string 1",
    "LoadIndexValue": 1.0,
    "SectionWidth": 1.0,
    "AspectRatio": 1.0,
    "RimDiameter": 1.0,
    "SpeedRatingId": 1,
    "Circumference": 1.0,
    "RecommendedPressure": 1.0,
    "TreadPattern": "sample string 2",
    "LoadIndexId": 1,
    "Option": "sample string 3",
    "RimWidth": 1.0,
    "Lugs": 1,
    "CircleDiameter": 1.0,
    "CentreBore": 1.0,
    "WheelOffset": 1.0,
    "Backspacing": 1.0,
    "Design": "sample string 4",
    "Studs": true,
    "IsAlloyRim": true,
    "TyreTypeId": "sample string 5",
    "ExtraLoad": true,
    "RunFlatTyre": true,
    "Wet": "sample string 6",
    "Fuel": "sample string 7",
    "Noise": 1,
    "NoiseClass": 1,
    "Weight": 1.0,
    "TPMS": "sample string 8",
    "StudCount": 1,
    "RimEdgeProtection": true,
    "RimBrand": "sample string 9",
    "OECode": "sample string 10",
    "OEBrand": "sample string 11",
    "NordicFriction": true,
    "PricatProductType": "sample string 12",
    "RFID": true,
    "EUDirectiveNumber": "sample string 13",
    "SpecialCompound": "sample string 14",
    "ThreePMSFMark": true,
    "DistributerWebsiteUrl": "sample string 15",
    "DistributerProductinfoUrl": "sample string 16",
    "ReservedEUUrl1": "sample string 17",
    "ReservedEUUrl2": "sample string 18"
  },
  "RecyclingArticles": [
    {
      "ArticleNo": 1,
      "ArticleListPrice": {
        "SupplierId": "ab943678-d13f-4e85-ad70-90c3fcc6b4b1",
        "Price": 1.0,
        "Discount": 1.0
      }
    },
    {
      "ArticleNo": 1,
      "ArticleListPrice": {
        "SupplierId": "ab943678-d13f-4e85-ad70-90c3fcc6b4b1",
        "Price": 1.0,
        "Discount": 1.0
      }
    }
  ],
  "ArticleNo": 11,
  "MainGroupId": 12,
  "SubGroupId": 13,
  "IsActive": true,
  "Ean": "sample string 15",
  "DateOfTermination": "12/21/2025 1:06:15 PM",
  "UnitId": 1,
  "AlternativeArticleNumber": 1,
  "AccountingEntryTemplateId": 16,
  "RequestCostAtSale": true,
  "InfoDocumentUri": "sample string 18",
  "ReplacementArticleNumber": 1,
  "SupplierArticleId": "sample string 19",
  "CompilatorId": 1,
  "VatId": 1,
  "OriginalArticleNumber": "sample string 20",
  "ProductLine": "sample string 21",
  "OriginalEquipment": true,
  "Make": "sample string 22",
  "NetNetCalculationId": 1,
  "OEM": "sample string 23",
  "SearchCode": "sample string 24",
  "CommodityId": "sample string 25",
  "ListPrice": 26.0,
  "ListPriceDiscountFactor": 27.0
}

application/xml, text/xml