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": "3529d0ae-3635-4da4-a4ac-8aed270b974e",
"TargetId": "058a8882-784e-423e-967b-be88f6f11a4b",
"ProductGroupDictionaryId": "ff711163-f29f-4899-a686-d3949d3b2e72",
"ImprintId": "afa1f26a-6bcf-47e7-a181-3fde3aff9fc7",
"LoginProviderTypes": [
1,
2
],
"SubProducts": [
"7754af10-d851-476a-80f8-35e9150df4b1",
"ed625e9f-e6e8-4693-82bd-6152367c5f8a"
],
"ParentProducts": [
"23afcf80-2744-4305-ae22-531a2b68fd52",
"5dd332a8-29b7-46eb-9992-967881343d6c"
],
"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>afa1f26a-6bcf-47e7-a181-3fde3aff9fc7</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>23afcf80-2744-4305-ae22-531a2b68fd52</d2p1:guid>
<d2p1:guid>5dd332a8-29b7-46eb-9992-967881343d6c</d2p1:guid>
</ParentProducts>
<ProductGroupDictionaryId>ff711163-f29f-4899-a686-d3949d3b2e72</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>7754af10-d851-476a-80f8-35e9150df4b1</d2p1:guid>
<d2p1:guid>ed625e9f-e6e8-4693-82bd-6152367c5f8a</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>058a8882-784e-423e-967b-be88f6f11a4b</TargetId>
<TopicId>3529d0ae-3635-4da4-a4ac-8aed270b974e</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>