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": "7aa98364-fbf4-40f8-b718-dd5a3228d4fe",
"TargetId": "3922745b-2562-4c7a-ac41-e09f9781b4f0",
"ProductGroupDictionaryId": "698bbdaf-0182-428b-8064-ab2e7bf7def7",
"ImprintId": "7f17f1f5-150c-41ae-82d1-e9721be40f52",
"LoginProviderTypes": [
1,
2
],
"SubProducts": [
"d698f2eb-573a-407a-bdaa-bbdb552cc74f",
"4a5d6240-71fb-4bb2-bd1a-da71e9eebfd3"
],
"ParentProducts": [
"89eccf7d-ac0b-4b21-a8fe-bfd3ed640408",
"27ba141a-5474-4868-8518-f653669f5f11"
],
"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>7f17f1f5-150c-41ae-82d1-e9721be40f52</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>89eccf7d-ac0b-4b21-a8fe-bfd3ed640408</d2p1:guid>
<d2p1:guid>27ba141a-5474-4868-8518-f653669f5f11</d2p1:guid>
</ParentProducts>
<ProductGroupDictionaryId>698bbdaf-0182-428b-8064-ab2e7bf7def7</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>d698f2eb-573a-407a-bdaa-bbdb552cc74f</d2p1:guid>
<d2p1:guid>4a5d6240-71fb-4bb2-bd1a-da71e9eebfd3</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>3922745b-2562-4c7a-ac41-e09f9781b4f0</TargetId>
<TopicId>7aa98364-fbf4-40f8-b718-dd5a3228d4fe</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>