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": "706c8b51-66b4-4b27-8aa7-4a25770b58f7",
"TargetId": "47d4601c-f540-43f4-a855-4cee2882a212",
"ProductGroupDictionaryId": "e90fe972-6407-4e10-b1bf-ffee4b5f8442",
"ImprintId": "cf8859c2-c0c0-4a39-89d6-65828824c46f",
"LoginProviderTypes": [
1,
2
],
"SubProducts": [
"a6a44c9f-0726-41a9-87b0-35fa28526fa2",
"faf77d04-50e5-4d5b-86a0-6f44ebfc3c65"
],
"ParentProducts": [
"e08f082b-19a5-45e3-8112-ac178b5141cd",
"f84cd5a7-998d-43a4-8af9-091ec582bfef"
],
"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>cf8859c2-c0c0-4a39-89d6-65828824c46f</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>e08f082b-19a5-45e3-8112-ac178b5141cd</d2p1:guid>
<d2p1:guid>f84cd5a7-998d-43a4-8af9-091ec582bfef</d2p1:guid>
</ParentProducts>
<ProductGroupDictionaryId>e90fe972-6407-4e10-b1bf-ffee4b5f8442</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>a6a44c9f-0726-41a9-87b0-35fa28526fa2</d2p1:guid>
<d2p1:guid>faf77d04-50e5-4d5b-86a0-6f44ebfc3c65</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>47d4601c-f540-43f4-a855-4cee2882a212</TargetId>
<TopicId>706c8b51-66b4-4b27-8aa7-4a25770b58f7</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>