POST api/articles

Method for adding an article

Request Information

URI Parameters

None.

Body Parameters

ArticlePostRequest
NameDescriptionTypeAdditional information
ArticleListPrice

Information about the articles list price

 ArticleListPrice

Required
RecyclingArticleNumbers

Article numbers for recycling

 Collection of integer

None.
ArticleTexts

Article texts

 Collection of ArticleText

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.

Remarks

None.

Example

None.

Request Formats

application/json, text/json

Sample: 
{
  "ArticleListPrice": {
    "SupplierId": "3bca498f-b7cd-4e61-aaf4-7e1af875fbaa",
    "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": "12/21/2025 1:00:53 PM",
  "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
}

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>2025-12-21T13:00:53.0669863+00:00</DateOfTermination>
  <Ean>sample string 5</Ean>
  <InfoDocumentUri>sample string 8</InfoDocumentUri>
  <IsActive>true</IsActive>
  <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>
  <ProductLine>sample string 11</ProductLine>
  <ReplacementArticleNumber>1</ReplacementArticleNumber>
  <RequestCostAtSale>true</RequestCostAtSale>
  <SearchCode>sample string 14</SearchCode>
  <SubGroupId>3</SubGroupId>
  <SupplierArticleId>sample string 9</SupplierArticleId>
  <UnitId>1</UnitId>
  <VatId>1</VatId>
  <ArticleListPrice>
    <Discount>1</Discount>
    <Price>1</Price>
    <SupplierId>3bca498f-b7cd-4e61-aaf4-7e1af875fbaa</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:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ArticlePostRequest'.

Response Information

Resource Description

ArticlePostResponse
NameDescriptionTypeAdditional information
Errors

List of errors when adding article

 Collection of PostArticleError

None.
Success

Returns true if article is added

 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>