GET api/Product?reference={reference}&suffix={suffix}&amountincents={amountincents}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| reference | string |
Required |
|
| suffix | string |
Required |
|
| amountincents | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Product| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| ProductCodeMsisdn | string |
None. |
|
| ProductCodeSuffix | string |
None. |
|
| ProductCodeAmountInCentsStart | integer |
None. |
|
| ProductCodeAmountInCentsEnd | integer |
None. |
|
| ProductCodeSuffixRegex | string |
None. |
|
| CategoryId | integer |
None. |
|
| Description | string |
None. |
|
| SupplierId | integer |
None. |
|
| SupplierProductId | string |
None. |
|
| SupplierProductSubId | string |
None. |
|
| SupplierCommissionTypeCode | integer |
None. |
|
| SupplierCommissionFactor | decimal number |
None. |
|
| IsBlocked | boolean |
None. |
|
| IsBlockedReason | string |
None. |
|
| ExpireDateTimeUtc | date |
None. |
|
| OrderByIndex | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"id": "e290535b-4736-4888-b2d7-67c621cc0a7e",
"product-code-msisdn": "sample string 2",
"product-code-suffix": "sample string 3",
"product-code-amount-in-cents-start": 4,
"product-code-amount-in-cents-end": 5,
"product-code-suffix-regex": "sample string 6",
"category-id": 7,
"description": "sample string 8",
"supplier-id": 9,
"supplier-product-id": "sample string 10",
"supplier-product-sub-id": "sample string 11",
"supplier-commission-type-code": 12,
"supplier-commission-factor": 13.0,
"is-blocked": true,
"is-blocked-reason": "sample string 15",
"expire-date-time-utc": "2026-02-20T11:38:16.6477247+00:00",
"order-by-index": 17
}
application/xml, text/xml
Sample:
<Product xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Caprica.Models"> <CategoryId>7</CategoryId> <Description>sample string 8</Description> <ExpireDateTimeUtc>2026-02-20T11:38:16.6477247+00:00</ExpireDateTimeUtc> <Id>e290535b-4736-4888-b2d7-67c621cc0a7e</Id> <IsBlocked>true</IsBlocked> <IsBlockedReason>sample string 15</IsBlockedReason> <OrderByIndex>17</OrderByIndex> <ProductCodeAmountInCentsEnd>5</ProductCodeAmountInCentsEnd> <ProductCodeAmountInCentsStart>4</ProductCodeAmountInCentsStart> <ProductCodeMsisdn>sample string 2</ProductCodeMsisdn> <ProductCodeSuffix>sample string 3</ProductCodeSuffix> <ProductCodeSuffixRegex>sample string 6</ProductCodeSuffixRegex> <SupplierCommissionFactor>13</SupplierCommissionFactor> <SupplierCommissionTypeCode>12</SupplierCommissionTypeCode> <SupplierId>9</SupplierId> <SupplierProductId>sample string 10</SupplierProductId> <SupplierProductSubId>sample string 11</SupplierProductSubId> </Product>