POST api/Items

Request Information

URI Parameters

None.

Body Parameters

Item

Name	Type	Additional information
id	integer	None.
type	integer	Required Range: inclusive between 0 and 1
inactive	integer	Range: inclusive between 0 and 1
code	string	Required String length: inclusive between 0 and 50
name	string	Required String length: inclusive between 0 and 255
manufacturerCode	string	String length: inclusive between 0 and 50
vatRate	decimal number	Required
vatRateFlag	integer	Range: inclusive between 0 and 4
unit	string	Required String length: inclusive between 0 and 20
barcode	string	String length: inclusive between 0 and 40
description	string	None.
prices	Collection of Price	None.
supplierCode	string	String length: inclusive between 0 and 50
catalogNumber	string	String length: inclusive between 0 and 40
package_deposit	integer	Range: inclusive between 0 and 1
product	integer	Required Range: inclusive between 0 and 1
defaultGroup	string	None.
salesCategory	string	None.
height	integer	None.
width	integer	None.
length	integer	None.
weight	decimal number	None.
producerCode	string	None.
producerName	string	None.
customerName	string	None.
customerCode	string	None.
created	date	None.
updated	date	None.
attributes	Collection of Attribute	None.
companyData	CompanyData	None.
gettingElementsForFSPA	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "id": 1,
  "type": 2,
  "inactive": 3,
  "code": "sample string 4",
  "name": "sample string 5",
  "manufacturerCode": "sample string 6",
  "vatRate": 7.0,
  "vatRateFlag": 8,
  "unit": "sample string 9",
  "barcode": "sample string 10",
  "description": "sample string 11",
  "prices": [
    {
      "optimaItemId": "sample string 1",
      "itemBarcode": "sample string 2",
      "number": 3,
      "type": 4,
      "name": "sample string 5",
      "value": 6.0,
      "currency": "sample string 7",
      "vatRate": "sample string 8",
      "unit": "sample string 9",
      "itemCode": "sample string 10",
      "error": "sample string 11"
    },
    {
      "optimaItemId": "sample string 1",
      "itemBarcode": "sample string 2",
      "number": 3,
      "type": 4,
      "name": "sample string 5",
      "value": 6.0,
      "currency": "sample string 7",
      "vatRate": "sample string 8",
      "unit": "sample string 9",
      "itemCode": "sample string 10",
      "error": "sample string 11"
    }
  ],
  "supplierCode": "sample string 12",
  "catalogNumber": "sample string 13",
  "package_deposit": 14,
  "product": 15,
  "defaultGroup": "sample string 16",
  "salesCategory": "sample string 17",
  "height": 18,
  "width": 19,
  "length": 20,
  "weight": 21.0,
  "producerCode": "sample string 22",
  "producerName": "sample string 23",
  "customerName": "sample string 24",
  "customerCode": "sample string 25",
  "created": "2025-11-08T13:32:49.0108725+01:00",
  "updated": "2025-11-08T13:32:49.0108725+01:00",
  "attributes": [
    {
      "id": 1,
      "attributeId": 2,
      "objectId": 3,
      "code": "sample string 4",
      "value": "sample string 5",
      "copyToTransaction": 6,
      "copyToDelivery": 7,
      "companyData": {
        "companyName": "sample string 1",
        "databaseName": "sample string 2"
      }
    },
    {
      "id": 1,
      "attributeId": 2,
      "objectId": 3,
      "code": "sample string 4",
      "value": "sample string 5",
      "copyToTransaction": 6,
      "copyToDelivery": 7,
      "companyData": {
        "companyName": "sample string 1",
        "databaseName": "sample string 2"
      }
    }
  ],
  "companyData": {
    "companyName": "sample string 1",
    "databaseName": "sample string 2"
  },
  "gettingElementsForFSPA": 1
}

application/xml, text/xml

Sample:

<Item xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebApiOptima_v._2._0.Models">
  <attributes>
    <Attribute>
      <attributeId>2</attributeId>
      <code>sample string 4</code>
      <companyData>
        <companyName>sample string 1</companyName>
        <databaseName>sample string 2</databaseName>
      </companyData>
      <copyToDelivery>7</copyToDelivery>
      <copyToTransaction>6</copyToTransaction>
      <id>1</id>
      <objectId>3</objectId>
      <value>sample string 5</value>
    </Attribute>
    <Attribute>
      <attributeId>2</attributeId>
      <code>sample string 4</code>
      <companyData>
        <companyName>sample string 1</companyName>
        <databaseName>sample string 2</databaseName>
      </companyData>
      <copyToDelivery>7</copyToDelivery>
      <copyToTransaction>6</copyToTransaction>
      <id>1</id>
      <objectId>3</objectId>
      <value>sample string 5</value>
    </Attribute>
  </attributes>
  <barcode>sample string 10</barcode>
  <catalogNumber>sample string 13</catalogNumber>
  <code>sample string 4</code>
  <companyData>
    <companyName>sample string 1</companyName>
    <databaseName>sample string 2</databaseName>
  </companyData>
  <created>2025-11-08T13:32:49.0108725+01:00</created>
  <customerCode>sample string 25</customerCode>
  <customerName>sample string 24</customerName>
  <defaultGroup>sample string 16</defaultGroup>
  <description>sample string 11</description>
  <gettingElementsForFSPA>1</gettingElementsForFSPA>
  <height>18</height>
  <id>1</id>
  <inactive>3</inactive>
  <length>20</length>
  <manufacturerCode>sample string 6</manufacturerCode>
  <name>sample string 5</name>
  <package_deposit>14</package_deposit>
  <prices>
    <Price>
      <currency>sample string 7</currency>
      <error>sample string 11</error>
      <itemBarcode>sample string 2</itemBarcode>
      <itemCode>sample string 10</itemCode>
      <name>sample string 5</name>
      <number>3</number>
      <optimaItemId>sample string 1</optimaItemId>
      <type>4</type>
      <unit>sample string 9</unit>
      <value>6</value>
      <vatRate>sample string 8</vatRate>
    </Price>
    <Price>
      <currency>sample string 7</currency>
      <error>sample string 11</error>
      <itemBarcode>sample string 2</itemBarcode>
      <itemCode>sample string 10</itemCode>
      <name>sample string 5</name>
      <number>3</number>
      <optimaItemId>sample string 1</optimaItemId>
      <type>4</type>
      <unit>sample string 9</unit>
      <value>6</value>
      <vatRate>sample string 8</vatRate>
    </Price>
  </prices>
  <producerCode>sample string 22</producerCode>
  <producerName>sample string 23</producerName>
  <product>15</product>
  <salesCategory>sample string 17</salesCategory>
  <supplierCode>sample string 12</supplierCode>
  <type>2</type>
  <unit>sample string 9</unit>
  <updated>2025-11-08T13:32:49.0108725+01:00</updated>
  <vatRate>7</vatRate>
  <vatRateFlag>8</vatRateFlag>
  <weight>21</weight>
  <width>19</width>
</Item>

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 'Item'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.