GET api/Pricing/{prixid}?productActive={productActive}&produitTypeId={produitTypeId}&produitId={produitId}&user={user}

Returns price information for a given price group

Request Information

URI Parameters

Name	Description	Type	Additional information
prixid	price group id	integer	Required
productActive	Filter active/inactive products	boolean	None.
produitTypeId	Filter on product type id	integer	None.
produitId	Filter on product id	integer	None.
user	Optional user handle - if empty logged in user will be used Additional filters: @tldsOnly - tld products only @tldName - tld name @categoryId - tld category id @promotionInProgress - is promotion on product @isCctld -is country code tld @registry_id - registry id @isLocalPresence - is local presence tld @isTldActive - is tld active @prixDefiniDansCategorie - is price defined @is_IDN - is IDN tld @produitPrix1 - price greater than @produitPrix2 - price less than @MargeEuros1 - marge greater than @MargeEuros2 - marge less than @priceEuro1 - cost greater than @priceEuro2 - cost less than @MargePercentEuros1 - marge percent greater than @MargePercentEuros2 - marge percent less than	string	None.

Body Parameters

None.

Response Information

Resource Description

A list of products with price information on success
Collection of errors on failure
Return codes
200 - ok
400 - bad request
401 - unauthorized
404 - not found
500 - internal server error

Collection of Pricing

Name	Description	Type	Additional information
nbrTldsForProduct	Number of tlds for product	integer	None.
produitID	Product id	integer	None.
produitCreDate	Product creation date	date	None.
orderID	Product order id	integer	None.
isProductActive	Is product active	boolean	None.
produitNom	Product name	string	None.
produitType	Product type	string	None.
produitTypeId	Product type id	integer	None.
tldName	Tld name	string	None.
is_IDN	Tld allows internationalized domain names	boolean	None.
pathFlag		string	None.
registry_id	Registry id	string	None.
isTldActive	Is tld active	boolean	None.
prixID	Price id - null if no price defined for this product on this price group	integer	None.
produitPrix	Product price - null if no price defined for this product on this price group	decimal number	None.
prixDefiniDansCategorie	Is a price defined in this price group or the default price group for this price group	boolean	None.
MargeEuros	Marge in euros - null if no price defined for this product on this price group	decimal number	None.
MargePercentEuros	Marge as a percentage - null if no price defined for this product on this price group	decimal number	None.
promotionInProgress	Is a promotion in progress for this product on this price group	boolean	None.
priceEuro	Cost price in euros	decimal number	None.
isCctld	Is country code tld	boolean	None.
isLocalPresence		boolean	None.
category	Tld category	string	None.
categoryId	Tld category id	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "nbrTldsForProduct": 1,
    "produitID": 2,
    "produitCreDate": "2024-07-10T00:41:48.5921946+02:00",
    "orderID": 4,
    "isProductActive": true,
    "produitNom": "sample string 6",
    "produitType": "sample string 7",
    "produitTypeId": 8,
    "tldName": "sample string 9",
    "is_IDN": true,
    "pathFlag": "sample string 11",
    "registry_id": "sample string 12",
    "isTldActive": true,
    "prixID": 14,
    "produitPrix": 15.0,
    "prixDefiniDansCategorie": true,
    "MargeEuros": 17.0,
    "MargePercentEuros": 18.0,
    "promotionInProgress": true,
    "priceEuro": 20.0,
    "isCctld": true,
    "isLocalPresence": true,
    "category": "sample string 23",
    "categoryId": 24
  },
  {
    "nbrTldsForProduct": 1,
    "produitID": 2,
    "produitCreDate": "2024-07-10T00:41:48.5921946+02:00",
    "orderID": 4,
    "isProductActive": true,
    "produitNom": "sample string 6",
    "produitType": "sample string 7",
    "produitTypeId": 8,
    "tldName": "sample string 9",
    "is_IDN": true,
    "pathFlag": "sample string 11",
    "registry_id": "sample string 12",
    "isTldActive": true,
    "prixID": 14,
    "produitPrix": 15.0,
    "prixDefiniDansCategorie": true,
    "MargeEuros": 17.0,
    "MargePercentEuros": 18.0,
    "promotionInProgress": true,
    "priceEuro": 20.0,
    "isCctld": true,
    "isLocalPresence": true,
    "category": "sample string 23",
    "categoryId": 24
  }
]

application/xml, text/xml

Sample:

<ArrayOfPricing xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Pricing">
  <Pricing>
    <MargeEuros>17</MargeEuros>
    <MargePercentEuros>18</MargePercentEuros>
    <category>sample string 23</category>
    <categoryId>24</categoryId>
    <isCctld>true</isCctld>
    <isLocalPresence>true</isLocalPresence>
    <isProductActive>true</isProductActive>
    <isTldActive>true</isTldActive>
    <is_IDN>true</is_IDN>
    <nbrTldsForProduct>1</nbrTldsForProduct>
    <orderID>4</orderID>
    <pathFlag>sample string 11</pathFlag>
    <priceEuro>20</priceEuro>
    <prixDefiniDansCategorie>true</prixDefiniDansCategorie>
    <prixID>14</prixID>
    <produitCreDate>2024-07-10T00:41:48.5921946+02:00</produitCreDate>
    <produitID>2</produitID>
    <produitNom>sample string 6</produitNom>
    <produitPrix>15</produitPrix>
    <produitType>sample string 7</produitType>
    <produitTypeId>8</produitTypeId>
    <promotionInProgress>true</promotionInProgress>
    <registry_id>sample string 12</registry_id>
    <tldName>sample string 9</tldName>
  </Pricing>
  <Pricing>
    <MargeEuros>17</MargeEuros>
    <MargePercentEuros>18</MargePercentEuros>
    <category>sample string 23</category>
    <categoryId>24</categoryId>
    <isCctld>true</isCctld>
    <isLocalPresence>true</isLocalPresence>
    <isProductActive>true</isProductActive>
    <isTldActive>true</isTldActive>
    <is_IDN>true</is_IDN>
    <nbrTldsForProduct>1</nbrTldsForProduct>
    <orderID>4</orderID>
    <pathFlag>sample string 11</pathFlag>
    <priceEuro>20</priceEuro>
    <prixDefiniDansCategorie>true</prixDefiniDansCategorie>
    <prixID>14</prixID>
    <produitCreDate>2024-07-10T00:41:48.5921946+02:00</produitCreDate>
    <produitID>2</produitID>
    <produitNom>sample string 6</produitNom>
    <produitPrix>15</produitPrix>
    <produitType>sample string 7</produitType>
    <produitTypeId>8</produitTypeId>
    <promotionInProgress>true</promotionInProgress>
    <registry_id>sample string 12</registry_id>
    <tldName>sample string 9</tldName>
  </Pricing>
</ArrayOfPricing>