POST api/Recommendations

Request Information

URI Parameters

None.

Body Parameters

RequestModel
NameDescriptionTypeAdditional information
RequestId

string

None.

StoreId

integer

None.

DozPlNumber

string

None.

FiscalNumber

string

None.

POFNumber

string

None.

Entries

Collection of RequestModelEntryViewModel

None.

Request Formats

application/json, text/json

Sample:
{
  "RequestId": "sample string 1",
  "StoreId": 1,
  "DozPlNumber": "sample string 2",
  "FiscalNumber": "sample string 3",
  "POFNumber": "sample string 4",
  "Entries": [
    {
      "Ckt": 1,
      "Amount": 1.0,
      "SalePriceBrutto": 1.0,
      "PaymentPriceBrutto": 1.0,
      "EquivalentCkt": 1,
      "EquivalentPaymentPriceBrutto": 1.0,
      "BaseSalePriceBrutto": 1.0,
      "DiscountCause": "sample string 1"
    },
    {
      "Ckt": 1,
      "Amount": 1.0,
      "SalePriceBrutto": 1.0,
      "PaymentPriceBrutto": 1.0,
      "EquivalentCkt": 1,
      "EquivalentPaymentPriceBrutto": 1.0,
      "BaseSalePriceBrutto": 1.0,
      "DiscountCause": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample:
<RequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api.Web.Models">
  <DozPlNumber>sample string 2</DozPlNumber>
  <Entries>
    <RequestModelEntryViewModel>
      <Amount>1</Amount>
      <BaseSalePriceBrutto>1</BaseSalePriceBrutto>
      <Ckt>1</Ckt>
      <DiscountCause>sample string 1</DiscountCause>
      <EquivalentCkt>1</EquivalentCkt>
      <EquivalentPaymentPriceBrutto>1</EquivalentPaymentPriceBrutto>
      <PaymentPriceBrutto>1</PaymentPriceBrutto>
      <SalePriceBrutto>1</SalePriceBrutto>
    </RequestModelEntryViewModel>
    <RequestModelEntryViewModel>
      <Amount>1</Amount>
      <BaseSalePriceBrutto>1</BaseSalePriceBrutto>
      <Ckt>1</Ckt>
      <DiscountCause>sample string 1</DiscountCause>
      <EquivalentCkt>1</EquivalentCkt>
      <EquivalentPaymentPriceBrutto>1</EquivalentPaymentPriceBrutto>
      <PaymentPriceBrutto>1</PaymentPriceBrutto>
      <SalePriceBrutto>1</SalePriceBrutto>
    </RequestModelEntryViewModel>
  </Entries>
  <FiscalNumber>sample string 3</FiscalNumber>
  <POFNumber>sample string 4</POFNumber>
  <RequestId>sample string 1</RequestId>
  <StoreId>1</StoreId>
</RequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseModel
NameDescriptionTypeAdditional information
RequestId

string

None.

ResponseId

string

None.

StoreId

integer

None.

IsSuccess

boolean

None.

Message

string

None.

Entries

Collection of ResponseModelEntryViewModel

None.

Response Formats

application/json, text/json

Sample:
{
  "RequestId": "sample string 1",
  "ResponseId": "sample string 2",
  "StoreId": 3,
  "IsSuccess": true,
  "Message": "sample string 5",
  "Entries": [
    {
      "RecommendationOrder": 1,
      "RecommendedProduct": 2,
      "RecommendationPriority": "sample string 3",
      "IsRuleMl": 4,
      "IsProductProductRule": 5,
      "IsCategoryProductRule": 6,
      "RuleSource": "sample string 7",
      "RuleId": 8,
      "Support": 9.0,
      "Confidence": 10.0,
      "Lift": 11.0
    },
    {
      "RecommendationOrder": 1,
      "RecommendedProduct": 2,
      "RecommendationPriority": "sample string 3",
      "IsRuleMl": 4,
      "IsProductProductRule": 5,
      "IsCategoryProductRule": 6,
      "RuleSource": "sample string 7",
      "RuleId": 8,
      "Support": 9.0,
      "Confidence": 10.0,
      "Lift": 11.0
    }
  ]
}

application/xml, text/xml

Sample:
<ResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api.Web.Models">
  <Entries>
    <ResponseModelEntryViewModel>
      <Confidence>10</Confidence>
      <IsCategoryProductRule>6</IsCategoryProductRule>
      <IsProductProductRule>5</IsProductProductRule>
      <IsRuleMl>4</IsRuleMl>
      <Lift>11</Lift>
      <RecommendationOrder>1</RecommendationOrder>
      <RecommendationPriority>sample string 3</RecommendationPriority>
      <RecommendedProduct>2</RecommendedProduct>
      <RuleId>8</RuleId>
      <RuleSource>sample string 7</RuleSource>
      <Support>9</Support>
    </ResponseModelEntryViewModel>
    <ResponseModelEntryViewModel>
      <Confidence>10</Confidence>
      <IsCategoryProductRule>6</IsCategoryProductRule>
      <IsProductProductRule>5</IsProductProductRule>
      <IsRuleMl>4</IsRuleMl>
      <Lift>11</Lift>
      <RecommendationOrder>1</RecommendationOrder>
      <RecommendationPriority>sample string 3</RecommendationPriority>
      <RecommendedProduct>2</RecommendedProduct>
      <RuleId>8</RuleId>
      <RuleSource>sample string 7</RuleSource>
      <Support>9</Support>
    </ResponseModelEntryViewModel>
  </Entries>
  <IsSuccess>true</IsSuccess>
  <Message>sample string 5</Message>
  <RequestId>sample string 1</RequestId>
  <ResponseId>sample string 2</ResponseId>
  <StoreId>3</StoreId>
</ResponseModel>