POST api/itemapi/add?siteId={siteId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| siteId | globally unique identifier |
None. |
Body Parameters
ItemViewModel| Name | Description | Type | Additional 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": "1aca59ac-f2ca-438e-ab0d-4e9fd4b8001f",
"customer_id": "f102b6e9-25ae-4183-8d61-7ab9b85905cc",
"grouping_quantity": 1,
"id": "1aa9b202-203d-4216-b2e3-2fc7fb693495",
"item_service_id": "a0586611-9e1a-436a-8f44-898c606981ad",
"item_garment_type_id": "3c12ed8b-0b18-47ef-9d1e-2781294d098e",
"item_segment_id": "9fb50cb5-b0ac-409b-8462-9003008fedbb",
"item_type_id": "d0d33bca-859a-4603-a7b4-4a1d777f2769",
"purchase_price": 1.0,
"sale_price": 1.0,
"size_id": "e3d4665e-0c33-4efa-84b3-13c2d19f75ba",
"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>1aca59ac-f2ca-438e-ab0d-4e9fd4b8001f</color_id>
<customer_id>f102b6e9-25ae-4183-8d61-7ab9b85905cc</customer_id>
<grouping_quantity>1</grouping_quantity>
<id>1aa9b202-203d-4216-b2e3-2fc7fb693495</id>
<item_garment_type_id>3c12ed8b-0b18-47ef-9d1e-2781294d098e</item_garment_type_id>
<item_segment_id>9fb50cb5-b0ac-409b-8462-9003008fedbb</item_segment_id>
<item_service_id>a0586611-9e1a-436a-8f44-898c606981ad</item_service_id>
<item_type_id>d0d33bca-859a-4603-a7b4-4a1d777f2769</item_type_id>
<purchase_price>1</purchase_price>
<root_code>sample string 9</root_code>
<sale_price>1</sale_price>
<size_id>e3d4665e-0c33-4efa-84b3-13c2d19f75ba</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 identifierResponse Formats
application/json, text/json
Sample:
"11743ccf-8530-4d4d-bc56-ce493c801ebb"
application/xml, text/xml
Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">11743ccf-8530-4d4d-bc56-ce493c801ebb</guid>