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": "c498e9b8-7789-4f47-860a-3d645dd93cf0",
"TargetId": "06aa61bb-c001-4201-be60-04663608ffbf",
"ProductGroupDictionaryId": "3a27f9fa-2998-4f47-b189-9a46ca853083",
"ImprintId": "5c71cb77-3fae-4465-b69d-7c0f62248ade",
"LoginProviderTypes": [
1,
2
],
"SubProducts": [
"651ef190-5fad-4848-96ed-8dcfc0bab372",
"608c53ff-5451-422c-b8f1-a7569ed2b2e3"
],
"ParentProducts": [
"cb2521cd-bbff-4db5-8ff5-d0a7f2c77c91",
"2837be4a-666d-4a1b-b601-09a248ceaa90"
],
"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>5c71cb77-3fae-4465-b69d-7c0f62248ade</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>cb2521cd-bbff-4db5-8ff5-d0a7f2c77c91</d2p1:guid>
<d2p1:guid>2837be4a-666d-4a1b-b601-09a248ceaa90</d2p1:guid>
</ParentProducts>
<ProductGroupDictionaryId>3a27f9fa-2998-4f47-b189-9a46ca853083</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>651ef190-5fad-4848-96ed-8dcfc0bab372</d2p1:guid>
<d2p1:guid>608c53ff-5451-422c-b8f1-a7569ed2b2e3</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>06aa61bb-c001-4201-be60-04663608ffbf</TargetId>
<TopicId>c498e9b8-7789-4f47-860a-3d645dd93cf0</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>