POST api/itemapi/add?siteId={siteId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
siteId

globally unique identifier

None.

Body Parameters

ItemViewModel
NameDescriptionTypeAdditional information
descriptions

Dictionary of string [key] and string [value]

None.

active

boolean

None.

code

string

Required

String length: inclusive between 0 and 30

color_id

globally unique identifier

None.

customer_id

globally unique identifier

Required

grouping_quantity

integer

None.

id

globally unique identifier

None.

item_service_id

globally unique identifier

None.

item_garment_type_id

globally unique identifier

None.

item_segment_id

globally unique identifier

None.

item_type_id

globally unique identifier

None.

purchase_price

decimal number

None.

sale_price

decimal number

None.

size_id

globally unique identifier

None.

supplier_code

string

String length: inclusive between 0 and 30

supplier_description

string

String length: inclusive between 0 and 100

unit

string

String length: inclusive between 0 and 10

weight

integer

None.

root_code

string

String length: inclusive between 0 and 30

Request Formats

application/json, text/json

Sample:
{
  "descriptions": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "active": true,
  "code": "sample string 2",
  "color_id": "da6ebf89-a747-4d8f-a3b6-4ee5db196c36",
  "customer_id": "9b557a68-ac13-4688-ba2c-9f31e6214fd3",
  "grouping_quantity": 1,
  "id": "750e5b4e-e255-4392-8563-50d5d8537b83",
  "item_service_id": "b4d2a854-6c83-4f2f-b14f-c5187b2f1391",
  "item_garment_type_id": "a1ae99eb-a841-4657-8038-dbe7fb3bba5c",
  "item_segment_id": "0fbcb7cb-3ee9-4436-97ed-26aaedf80af1",
  "item_type_id": "9939cd7d-a287-4963-8eab-916dce9fa9ba",
  "purchase_price": 1.0,
  "sale_price": 1.0,
  "size_id": "90b47e4e-15c2-48e7-b0d7-ee050000fc75",
  "supplier_code": "sample string 6",
  "supplier_description": "sample string 7",
  "unit": "sample string 8",
  "weight": 1,
  "root_code": "sample string 9"
}

application/xml, text/xml

Sample:
<item xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EntityModel">
  <active>true</active>
  <code>sample string 2</code>
  <color_id>da6ebf89-a747-4d8f-a3b6-4ee5db196c36</color_id>
  <customer_id>9b557a68-ac13-4688-ba2c-9f31e6214fd3</customer_id>
  <grouping_quantity>1</grouping_quantity>
  <id>750e5b4e-e255-4392-8563-50d5d8537b83</id>
  <item_garment_type_id>a1ae99eb-a841-4657-8038-dbe7fb3bba5c</item_garment_type_id>
  <item_segment_id>0fbcb7cb-3ee9-4436-97ed-26aaedf80af1</item_segment_id>
  <item_service_id>b4d2a854-6c83-4f2f-b14f-c5187b2f1391</item_service_id>
  <item_type_id>9939cd7d-a287-4963-8eab-916dce9fa9ba</item_type_id>
  <purchase_price>1</purchase_price>
  <root_code>sample string 9</root_code>
  <sale_price>1</sale_price>
  <size_id>90b47e4e-15c2-48e7-b0d7-ee050000fc75</size_id>
  <supplier_code>sample string 6</supplier_code>
  <supplier_description>sample string 7</supplier_description>
  <unit>sample string 8</unit>
  <weight>1</weight>
  <descriptions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </descriptions>
</item>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

globally unique identifier

Response Formats

application/json, text/json

Sample:
"f8380d38-a6e5-47c2-8aaf-b2e9938cab93"

application/xml, text/xml

Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">f8380d38-a6e5-47c2-8aaf-b2e9938cab93</guid>