GET api/Product/{id}?user={user}
Get a product by id
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id | integer |
Required |
|
user |
User handle (end user or reseller) |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
product on success
Collection of errors on failure
Return codes
200 - ok
400 - bad request
401 - unauthorized
404 - not found
500 - internal server error
Name | Description | Type | Additional information |
---|---|---|---|
Pu |
Unit price for this product for this user |
decimal number |
None. |
Promotions |
List of active promotions for this product and this user |
Collection of Promotion |
None. |
Id |
Product id. Use in ProduitID property of panier items |
integer |
None. |
Name | string |
None. |
|
ProductType |
Product type description |
string |
None. |
TypeId |
Product type id |
integer |
None. |
Type |
Product type |
string |
None. |
SubType |
Sub type |
string |
None. |
Package |
Indicates if the product is a package |
boolean |
None. |
Attributes |
List of attributes that are either mandatory, require validation or both |
Collection of ProductAttribute |
None. |
TrusteeProduct | boolean |
None. |
|
Tlds |
List of tlds associated with this product |
Collection of ProductTld |
None. |
ParentProducts |
List of products associated as a parent to this product |
Collection of ProductDetail |
None. |
ChildProducts |
List of products associated as a child to this product |
Collection of ProductDetail |
None. |
GlobalSignProduit |
GlobalSign correspondance |
string |
None. |
DiscountDependances |
Discounts that can be applied when ordering this product |
Collection of DiscountDependance |
None. |
DiscountParents |
Discounts that can be applied to this product |
Collection of DiscountParent |
None. |
Discounts |
Details of the discount if this is a dixcount product |
Collection of Discount |
None. |
Active | boolean |
None. |
Response Formats
application/json, text/json
{ "Pu": 1.0, "Promotions": [ { "Price": 1.0, "StartDate": "2025-04-04T00:07:04.2990545+02:00", "EndDate": "2025-04-04T00:07:04.2990545+02:00", "OriginalPrice": 4.0, "BeginPromotionProcessed": true, "Comment": "sample string 6" } ], "Id": 2, "Name": "sample string 3", "ProductType": "sample string 4", "TypeId": 5, "Type": "sample string 6", "SubType": "sample string 7", "Package": true, "Attributes": [ { "Name": "sample string 1", "Mandatory": true, "Validate": "sample string 3", "DefaultAttribute": "sample string 4", "DefaultType": "sample string 5", "Class": "sample string 6", "Header": 7, "MapTo": "sample string 8", "Conversion": "sample string 9", "Mode": 10, "MinLength": 1, "MaxLength": 1 }, { "Name": "sample string 1", "Mandatory": true, "Validate": "sample string 3", "DefaultAttribute": "sample string 4", "DefaultType": "sample string 5", "Class": "sample string 6", "Header": 7, "MapTo": "sample string 8", "Conversion": "sample string 9", "Mode": 10, "MinLength": 1, "MaxLength": 1 } ], "TrusteeProduct": true, "Tlds": [ { "Tld_id": 1, "Name": "sample string 2", "Registry_id": "sample string 3", "Country": "sample string 4" }, { "Tld_id": 1, "Name": "sample string 2", "Registry_id": "sample string 3", "Country": "sample string 4" } ], "ParentProducts": [ { "Id": 1, "Name": "sample string 2", "Type": "sample string 3", "SubType": "sample string 4", "TransactionId": "sample string 5", "Active": true }, { "Id": 1, "Name": "sample string 2", "Type": "sample string 3", "SubType": "sample string 4", "TransactionId": "sample string 5", "Active": true } ], "ChildProducts": [ { "Id": 1, "Name": "sample string 2", "Type": "sample string 3", "SubType": "sample string 4", "TransactionId": "sample string 5", "Active": true }, { "Id": 1, "Name": "sample string 2", "Type": "sample string 3", "SubType": "sample string 4", "TransactionId": "sample string 5", "Active": true } ], "GlobalSignProduit": "sample string 10", "DiscountDependances": [ { "RelatedProduct": { "Id": 1, "Name": "sample string 2", "Type": "sample string 3", "SubType": "sample string 4", "TransactionId": "sample string 5", "Active": true }, "DiscountProduct": { "Id": 1, "Name": "sample string 2", "Type": "sample string 3", "SubType": "sample string 4", "TransactionId": "sample string 5", "Active": true }, "MaxQuantity": 1 }, { "RelatedProduct": { "Id": 1, "Name": "sample string 2", "Type": "sample string 3", "SubType": "sample string 4", "TransactionId": "sample string 5", "Active": true }, "DiscountProduct": { "Id": 1, "Name": "sample string 2", "Type": "sample string 3", "SubType": "sample string 4", "TransactionId": "sample string 5", "Active": true }, "MaxQuantity": 1 } ], "DiscountParents": [ { "ParentProduct": { "Id": 1, "Name": "sample string 2", "Type": "sample string 3", "SubType": "sample string 4", "TransactionId": "sample string 5", "Active": true }, "DiscountProduct": { "Id": 1, "Name": "sample string 2", "Type": "sample string 3", "SubType": "sample string 4", "TransactionId": "sample string 5", "Active": true }, "MaxQuantity": 1 }, { "ParentProduct": { "Id": 1, "Name": "sample string 2", "Type": "sample string 3", "SubType": "sample string 4", "TransactionId": "sample string 5", "Active": true }, "DiscountProduct": { "Id": 1, "Name": "sample string 2", "Type": "sample string 3", "SubType": "sample string 4", "TransactionId": "sample string 5", "Active": true }, "MaxQuantity": 1 } ], "Discounts": [ { "ParentProduct": { "Id": 1, "Name": "sample string 2", "Type": "sample string 3", "SubType": "sample string 4", "TransactionId": "sample string 5", "Active": true }, "RelatedProduct": { "Id": 1, "Name": "sample string 2", "Type": "sample string 3", "SubType": "sample string 4", "TransactionId": "sample string 5", "Active": true }, "MaxQuantity": 1 }, { "ParentProduct": { "Id": 1, "Name": "sample string 2", "Type": "sample string 3", "SubType": "sample string 4", "TransactionId": "sample string 5", "Active": true }, "RelatedProduct": { "Id": 1, "Name": "sample string 2", "Type": "sample string 3", "SubType": "sample string 4", "TransactionId": "sample string 5", "Active": true }, "MaxQuantity": 1 } ], "Active": true }
application/xml, text/xml
<ProductEx xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models"> <Active>true</Active> <Attributes> <ProductAttribute> <Class>sample string 6</Class> <Conversion>sample string 9</Conversion> <DefaultAttribute>sample string 4</DefaultAttribute> <DefaultType>sample string 5</DefaultType> <Header>7</Header> <Mandatory>true</Mandatory> <MapTo>sample string 8</MapTo> <MaxLength>1</MaxLength> <MinLength>1</MinLength> <Mode>10</Mode> <Name>sample string 1</Name> <Validate>sample string 3</Validate> </ProductAttribute> <ProductAttribute> <Class>sample string 6</Class> <Conversion>sample string 9</Conversion> <DefaultAttribute>sample string 4</DefaultAttribute> <DefaultType>sample string 5</DefaultType> <Header>7</Header> <Mandatory>true</Mandatory> <MapTo>sample string 8</MapTo> <MaxLength>1</MaxLength> <MinLength>1</MinLength> <Mode>10</Mode> <Name>sample string 1</Name> <Validate>sample string 3</Validate> </ProductAttribute> </Attributes> <ChildProducts> <ProductDetail> <Active>true</Active> <Id>1</Id> <Name>sample string 2</Name> <SubType>sample string 4</SubType> <TransactionId>sample string 5</TransactionId> <Type>sample string 3</Type> </ProductDetail> <ProductDetail> <Active>true</Active> <Id>1</Id> <Name>sample string 2</Name> <SubType>sample string 4</SubType> <TransactionId>sample string 5</TransactionId> <Type>sample string 3</Type> </ProductDetail> </ChildProducts> <DiscountDependances> <DiscountDependance> <DiscountProduct> <Active>true</Active> <Id>1</Id> <Name>sample string 2</Name> <SubType>sample string 4</SubType> <TransactionId>sample string 5</TransactionId> <Type>sample string 3</Type> </DiscountProduct> <MaxQuantity>1</MaxQuantity> <RelatedProduct> <Active>true</Active> <Id>1</Id> <Name>sample string 2</Name> <SubType>sample string 4</SubType> <TransactionId>sample string 5</TransactionId> <Type>sample string 3</Type> </RelatedProduct> </DiscountDependance> <DiscountDependance> <DiscountProduct> <Active>true</Active> <Id>1</Id> <Name>sample string 2</Name> <SubType>sample string 4</SubType> <TransactionId>sample string 5</TransactionId> <Type>sample string 3</Type> </DiscountProduct> <MaxQuantity>1</MaxQuantity> <RelatedProduct> <Active>true</Active> <Id>1</Id> <Name>sample string 2</Name> <SubType>sample string 4</SubType> <TransactionId>sample string 5</TransactionId> <Type>sample string 3</Type> </RelatedProduct> </DiscountDependance> </DiscountDependances> <DiscountParents> <DiscountParent> <DiscountProduct> <Active>true</Active> <Id>1</Id> <Name>sample string 2</Name> <SubType>sample string 4</SubType> <TransactionId>sample string 5</TransactionId> <Type>sample string 3</Type> </DiscountProduct> <MaxQuantity>1</MaxQuantity> <ParentProduct> <Active>true</Active> <Id>1</Id> <Name>sample string 2</Name> <SubType>sample string 4</SubType> <TransactionId>sample string 5</TransactionId> <Type>sample string 3</Type> </ParentProduct> </DiscountParent> <DiscountParent> <DiscountProduct> <Active>true</Active> <Id>1</Id> <Name>sample string 2</Name> <SubType>sample string 4</SubType> <TransactionId>sample string 5</TransactionId> <Type>sample string 3</Type> </DiscountProduct> <MaxQuantity>1</MaxQuantity> <ParentProduct> <Active>true</Active> <Id>1</Id> <Name>sample string 2</Name> <SubType>sample string 4</SubType> <TransactionId>sample string 5</TransactionId> <Type>sample string 3</Type> </ParentProduct> </DiscountParent> </DiscountParents> <Discounts> <Discount> <MaxQuantity>1</MaxQuantity> <ParentProduct> <Active>true</Active> <Id>1</Id> <Name>sample string 2</Name> <SubType>sample string 4</SubType> <TransactionId>sample string 5</TransactionId> <Type>sample string 3</Type> </ParentProduct> <RelatedProduct> <Active>true</Active> <Id>1</Id> <Name>sample string 2</Name> <SubType>sample string 4</SubType> <TransactionId>sample string 5</TransactionId> <Type>sample string 3</Type> </RelatedProduct> </Discount> <Discount> <MaxQuantity>1</MaxQuantity> <ParentProduct> <Active>true</Active> <Id>1</Id> <Name>sample string 2</Name> <SubType>sample string 4</SubType> <TransactionId>sample string 5</TransactionId> <Type>sample string 3</Type> </ParentProduct> <RelatedProduct> <Active>true</Active> <Id>1</Id> <Name>sample string 2</Name> <SubType>sample string 4</SubType> <TransactionId>sample string 5</TransactionId> <Type>sample string 3</Type> </RelatedProduct> </Discount> </Discounts> <GlobalSignProduit>sample string 10</GlobalSignProduit> <Id>2</Id> <Name>sample string 3</Name> <Package>true</Package> <ParentProducts> <ProductDetail> <Active>true</Active> <Id>1</Id> <Name>sample string 2</Name> <SubType>sample string 4</SubType> <TransactionId>sample string 5</TransactionId> <Type>sample string 3</Type> </ProductDetail> <ProductDetail> <Active>true</Active> <Id>1</Id> <Name>sample string 2</Name> <SubType>sample string 4</SubType> <TransactionId>sample string 5</TransactionId> <Type>sample string 3</Type> </ProductDetail> </ParentProducts> <ProductType>sample string 4</ProductType> <SubType>sample string 7</SubType> <Tlds> <ProductTld> <Country>sample string 4</Country> <Name>sample string 2</Name> <Registry_id>sample string 3</Registry_id> <Tld_id>1</Tld_id> </ProductTld> <ProductTld> <Country>sample string 4</Country> <Name>sample string 2</Name> <Registry_id>sample string 3</Registry_id> <Tld_id>1</Tld_id> </ProductTld> </Tlds> <TrusteeProduct>true</TrusteeProduct> <Type>sample string 6</Type> <TypeId>5</TypeId> <Promotions> <Promotion> <BeginPromotionProcessed>true</BeginPromotionProcessed> <Comment>sample string 6</Comment> <EndDate>2025-04-04T00:07:04.2990545+02:00</EndDate> <OriginalPrice>4</OriginalPrice> <Price>1</Price> <StartDate>2025-04-04T00:07:04.2990545+02:00</StartDate> </Promotion> </Promotions> <Pu>1</Pu> </ProductEx>