POST api/products/add
Creates product
Request Information
URI Parameters
None.
Body Parameters
UpsertProductRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Name | string |
None. |
|
| Isbn | string |
None. |
|
| Key | string |
None. |
|
| IsActive | boolean |
None. |
|
| TopicId | globally unique identifier |
None. |
|
| TargetId | globally unique identifier |
None. |
|
| ProductGroupDictionaryId | globally unique identifier |
None. |
|
| ImprintId | globally unique identifier |
None. |
|
| LoginProviderTypes | Collection of integer |
None. |
|
| SubProducts | Collection of globally unique identifier |
None. |
|
| ParentProducts | Collection of globally unique identifier |
None. |
|
| IsSubscriptionProduct | boolean |
None. |
|
| Tags | Collection of string |
None. |
|
| ProductPim | UpsertProductPimRequest |
None. |
Request Formats
application/json, text/json
Sample:
{
"Name": "sample string 1",
"Isbn": "sample string 2",
"Key": "sample string 3",
"IsActive": true,
"TopicId": "49960d5c-b589-405d-b324-49904452eed3",
"TargetId": "80e5bc68-90cc-462d-97a3-a2eb4396cba0",
"ProductGroupDictionaryId": "4d8e1b53-dbd8-4be5-a14b-77e93567ab4d",
"ImprintId": "056da594-99e1-4450-9576-b7d89f739488",
"LoginProviderTypes": [
1,
2
],
"SubProducts": [
"6af8866e-3665-4340-aea0-e2d1778b98a4",
"373f7148-3c09-4c65-b2cb-051fb8a5d53e"
],
"ParentProducts": [
"671940f2-85a7-49e1-9faf-b35a5771c72a",
"8d81030f-80f0-4181-9217-00f93a4f381e"
],
"IsSubscriptionProduct": true,
"Tags": [
"sample string 1",
"sample string 2"
],
"ProductPim": {
"PimMediaTypeName": "sample string 1",
"PimMediaTypeNo": "sample string 2",
"PimCategory": "sample string 3",
"PimSubCategory": "sample string 4"
}
}
application/xml, text/xml
Sample:
<UpsertProductRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Requests.Product">
<ImprintId>056da594-99e1-4450-9576-b7d89f739488</ImprintId>
<IsActive>true</IsActive>
<IsSubscriptionProduct>true</IsSubscriptionProduct>
<Isbn>sample string 2</Isbn>
<Key>sample string 3</Key>
<LoginProviderTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</LoginProviderTypes>
<Name>sample string 1</Name>
<ParentProducts xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>671940f2-85a7-49e1-9faf-b35a5771c72a</d2p1:guid>
<d2p1:guid>8d81030f-80f0-4181-9217-00f93a4f381e</d2p1:guid>
</ParentProducts>
<ProductGroupDictionaryId>4d8e1b53-dbd8-4be5-a14b-77e93567ab4d</ProductGroupDictionaryId>
<ProductPim>
<PimCategory>sample string 3</PimCategory>
<PimMediaTypeName>sample string 1</PimMediaTypeName>
<PimMediaTypeNo>sample string 2</PimMediaTypeNo>
<PimSubCategory>sample string 4</PimSubCategory>
</ProductPim>
<SubProducts xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>6af8866e-3665-4340-aea0-e2d1778b98a4</d2p1:guid>
<d2p1:guid>373f7148-3c09-4c65-b2cb-051fb8a5d53e</d2p1:guid>
</SubProducts>
<Tags xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Tags>
<TargetId>80e5bc68-90cc-462d-97a3-a2eb4396cba0</TargetId>
<TopicId>49960d5c-b589-405d-b324-49904452eed3</TopicId>
</UpsertProductRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ValidationResult| Name | Description | Type | Additional information |
|---|---|---|---|
| IsValid | boolean |
None. |
|
| Errors | Collection of ValidationFailure |
None. |
Response Formats
application/json, text/json
Sample:
{
"errors": []
}
application/xml, text/xml
Sample:
<ValidationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FluentValidation.Results"> <errors /> </ValidationResult>