POST api/articles

Method for adding an article

Request Information

URI Parameters

None.

Body Parameters

ArticlePostRequest
NameDescriptionTypeAdditional information
ArticleListPrice

ArticleListPriceRequest

Required
RecyclingArticleNumbers

Collection of integer

None.
ArticleTexts

Collection of ArticleText

None.
ArticleNo

integer

Required
MainGroupId

integer

Required
SubGroupId

integer

Required
IsActive

boolean

Required
Ean

string

Max length: 128
DateOfTermination

date

None.
UnitId

integer

None.
AlternativeArticleNumber

integer

None.
AccountingEntryTemplateId

integer

Required
RequestCostAtSale

boolean

Required
InfoDocumentUri

string

Max length: 1024
ReplacementArticleNumber

integer

None.
SupplierArticleId

string

Max length: 128
CompilatorId

integer

None.
VatId

integer

None.
OriginalArticleNumber

string

Max length: 100
ProductLine

string

Max length: 25
OriginalEquipment

boolean

None.
Make

string

Max length: 100
NetNetCalculationId

integer

None.
OEM

string

Max length: 20
SearchCode

string

Max length: 10
CommodityId

string

Max length: 10
ListPrice

decimal number

None.
ListPriceDiscountFactor

decimal number

None.
Prefix

string

Max length: 10
IsUsed

boolean

None.
Webshop

boolean

None.
VehicleCode

integer

None.
SellableFrom

date

None.

Remarks

None.

Example

None.

Request Formats

application/json, text/json

Sample: 
{
  "ArticleListPrice": {
    "SupplierId": "1dd11292-0f14-4d94-aea5-7bf58ffcede0",
    "Price": 1.0,
    "Discount": 1.0
  },
  "RecyclingArticleNumbers": [
    1,
    2
  ],
  "ArticleTexts": [
    {
      "ShortText": "sample string 1",
      "Text": "sample string 2",
      "Description": "sample string 3"
    },
    {
      "ShortText": "sample string 1",
      "Text": "sample string 2",
      "Description": "sample string 3"
    }
  ],
  "ArticleNo": 1,
  "MainGroupId": 2,
  "SubGroupId": 3,
  "IsActive": true,
  "Ean": "sample string 5",
  "DateOfTermination": "2026-01-21 22:49:21",
  "UnitId": 1,
  "AlternativeArticleNumber": 1,
  "AccountingEntryTemplateId": 6,
  "RequestCostAtSale": true,
  "InfoDocumentUri": "sample string 8",
  "ReplacementArticleNumber": 1,
  "SupplierArticleId": "sample string 9",
  "CompilatorId": 1,
  "VatId": 1,
  "OriginalArticleNumber": "sample string 10",
  "ProductLine": "sample string 11",
  "OriginalEquipment": true,
  "Make": "sample string 12",
  "NetNetCalculationId": 1,
  "OEM": "sample string 13",
  "SearchCode": "sample string 14",
  "CommodityId": "sample string 15",
  "ListPrice": 16.0,
  "ListPriceDiscountFactor": 17.0,
  "Prefix": "sample string 18",
  "IsUsed": true,
  "Webshop": true,
  "VehicleCode": 1,
  "SellableFrom": "2026-01-21 22:49:21"
}

application/xml, text/xml

Sample: 
<ArticlePostRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Article">
  <AccountingEntryTemplateId>6</AccountingEntryTemplateId>
  <AlternativeArticleNumber>1</AlternativeArticleNumber>
  <ArticleNo>1</ArticleNo>
  <CommodityId>sample string 15</CommodityId>
  <CompilatorId>1</CompilatorId>
  <DateOfTermination>2026-01-21T22:49:21.1533275+01:00</DateOfTermination>
  <Ean>sample string 5</Ean>
  <InfoDocumentUri>sample string 8</InfoDocumentUri>
  <IsActive>true</IsActive>
  <IsUsed>true</IsUsed>
  <ListPrice>16</ListPrice>
  <ListPriceDiscountFactor>17</ListPriceDiscountFactor>
  <MainGroupId>2</MainGroupId>
  <Make>sample string 12</Make>
  <NetNetCalculationId>1</NetNetCalculationId>
  <OEM>sample string 13</OEM>
  <OriginalArticleNumber>sample string 10</OriginalArticleNumber>
  <OriginalEquipment>true</OriginalEquipment>
  <Prefix>sample string 18</Prefix>
  <ProductLine>sample string 11</ProductLine>
  <ReplacementArticleNumber>1</ReplacementArticleNumber>
  <RequestCostAtSale>true</RequestCostAtSale>
  <SearchCode>sample string 14</SearchCode>
  <SellableFrom>2026-01-21T22:49:21.1533275+01:00</SellableFrom>
  <SubGroupId>3</SubGroupId>
  <SupplierArticleId>sample string 9</SupplierArticleId>
  <UnitId>1</UnitId>
  <VatId>1</VatId>
  <VehicleCode>1</VehicleCode>
  <Webshop>true</Webshop>
  <ArticleListPrice>
    <Discount>1</Discount>
    <Price>1</Price>
    <SupplierId>1dd11292-0f14-4d94-aea5-7bf58ffcede0</SupplierId>
  </ArticleListPrice>
  <ArticleTexts>
    <ArticleText>
      <Description>sample string 3</Description>
      <ShortText>sample string 1</ShortText>
      <Text>sample string 2</Text>
    </ArticleText>
    <ArticleText>
      <Description>sample string 3</Description>
      <ShortText>sample string 1</ShortText>
      <Text>sample string 2</Text>
    </ArticleText>
  </ArticleTexts>
  <RecyclingArticleNumbers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </RecyclingArticleNumbers>
</ArticlePostRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ArticlePostResponse
NameDescriptionTypeAdditional information
Errors

Collection of PostArticleError

None.
Success

boolean

None.

Response Formats

application/json, text/json

Sample: 
{
  "Errors": [
    {
      "ErrorCode": 1,
      "ErrorMessage": "sample string 1"
    },
    {
      "ErrorCode": 1,
      "ErrorMessage": "sample string 1"
    }
  ],
  "Success": true
}

application/xml, text/xml

Sample: 
<ArticlePostResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Article">
  <Errors>
    <PostArticleError>
      <ErrorCode>InternalServerError</ErrorCode>
      <ErrorMessage>sample string 1</ErrorMessage>
    </PostArticleError>
    <PostArticleError>
      <ErrorCode>InternalServerError</ErrorCode>
      <ErrorMessage>sample string 1</ErrorMessage>
    </PostArticleError>
  </Errors>
  <Success>true</Success>
</ArticlePostResponse>