PATCH api/Products/GetBundleProducts

Module : Product; ADINA-7470 This method is called to get frequently bought products

Request Information

URI Parameters

None.

Body Parameters

BundleProductRequest
NameDescriptionTypeAdditional information
erpNumbers

Collection of string

None.

Request Formats

application/json, text/json

Sample: 
{
  "erpNumbers": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample: 
<BundleProductRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Adi.BusinessEntities">
  <erpNumbers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </erpNumbers>
</BundleProductRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'BundleProductRequest'.

Response Information

Resource Description

BundleProductResponse
NameDescriptionTypeAdditional information
erpNumbers

string

None.
products

Collection of FrequentlyBoughtProduct

None.
labelTexts

FrequentlyBoughtLabelTexts

None.
Message

string

None.
WebApiIsSuccess

boolean

None.
WebApiResponseMessage

string

None.
WebApiErrorCode

string

None.
error_description

string

None.
CookieData

Collection of AppCookie

None.

Response Formats

application/json, text/json

Sample: 
{
  "erpNumbers": "sample string 1",
  "products": [
    {
      "id": "40959819-826a-4e14-8193-f0097a62e8bf",
      "erpNumber": "sample string 2",
      "smallImagePath": "sample string 3",
      "mediumImagePath": "sample string 4",
      "largeImagePath": "sample string 5",
      "pricing": {
        "regularPrice": 1.1,
        "regularPriceDisplay": "sample string 2",
        "extendedRegularPrice": 3.1,
        "extendedRegularPriceDisplay": "sample string 4",
        "actualPrice": 5.1,
        "actualPriceDisplay": "sample string 6",
        "extendedActualPrice": 7.1,
        "extendedActualPriceDisplay": "sample string 8",
        "unitCost": 9.1,
        "unitCostDisplay": "sample string 10",
        "isOnSale": true,
        "regularBreakPrices": {
          "breakQty": 1,
          "breakPrice": 2,
          "breakPriceDisplay": "sample string 3",
          "savingsMessage": "sample string 4"
        },
        "actualBreakPrices": {
          "breakQty": 1,
          "breakPrice": 2,
          "breakPriceDisplay": "sample string 3",
          "savingsMessage": "sample string 4"
        },
        "additionalResults": {
          "saleEndDate": "sample string 1",
          "saleExpiryDays": "sample string 2"
        },
        "requiresRealTimePrice": true,
        "unitListPrice": 13.1,
        "unitListPriceDisplay": "sample string 14",
        "extendedUnitListPrice": 15.1,
        "extendedUnitListPriceDisplay": "sample string 16",
        "unitRegularPrice": 17.1,
        "unitRegularPriceDisplay": "sample string 18",
        "extendedUnitRegularPrice": 19.1,
        "extendedUnitRegularPriceDisplay": "sample string 20",
        "unitNetPrice": 21.1,
        "unitNetPriceDisplay": "sample string 22",
        "extendedUnitNetPrice": 23.1,
        "extendedUnitNetPriceDisplay": "sample string 24"
      },
      "manufacturerItem": "sample string 6",
      "shortDescription": "sample string 7",
      "properties": {
        "branD_ID": "sample string 1",
        "branD_SHORTDESC": "sample string 2",
        "branD_PATH": "sample string 3"
      },
      "altText": "sample string 8",
      "pageTitle": "sample string 9",
      "productDetailUrl": "sample string 10",
      "qtyOrdered": "sample string 11",
      "isSpecialOrder": true,
      "inventoryMessageCode": "sample string 13",
      "inventoryMessage": "sample string 14"
    },
    {
      "id": "40959819-826a-4e14-8193-f0097a62e8bf",
      "erpNumber": "sample string 2",
      "smallImagePath": "sample string 3",
      "mediumImagePath": "sample string 4",
      "largeImagePath": "sample string 5",
      "pricing": {
        "regularPrice": 1.1,
        "regularPriceDisplay": "sample string 2",
        "extendedRegularPrice": 3.1,
        "extendedRegularPriceDisplay": "sample string 4",
        "actualPrice": 5.1,
        "actualPriceDisplay": "sample string 6",
        "extendedActualPrice": 7.1,
        "extendedActualPriceDisplay": "sample string 8",
        "unitCost": 9.1,
        "unitCostDisplay": "sample string 10",
        "isOnSale": true,
        "regularBreakPrices": {
          "breakQty": 1,
          "breakPrice": 2,
          "breakPriceDisplay": "sample string 3",
          "savingsMessage": "sample string 4"
        },
        "actualBreakPrices": {
          "breakQty": 1,
          "breakPrice": 2,
          "breakPriceDisplay": "sample string 3",
          "savingsMessage": "sample string 4"
        },
        "additionalResults": {
          "saleEndDate": "sample string 1",
          "saleExpiryDays": "sample string 2"
        },
        "requiresRealTimePrice": true,
        "unitListPrice": 13.1,
        "unitListPriceDisplay": "sample string 14",
        "extendedUnitListPrice": 15.1,
        "extendedUnitListPriceDisplay": "sample string 16",
        "unitRegularPrice": 17.1,
        "unitRegularPriceDisplay": "sample string 18",
        "extendedUnitRegularPrice": 19.1,
        "extendedUnitRegularPriceDisplay": "sample string 20",
        "unitNetPrice": 21.1,
        "unitNetPriceDisplay": "sample string 22",
        "extendedUnitNetPrice": 23.1,
        "extendedUnitNetPriceDisplay": "sample string 24"
      },
      "manufacturerItem": "sample string 6",
      "shortDescription": "sample string 7",
      "properties": {
        "branD_ID": "sample string 1",
        "branD_SHORTDESC": "sample string 2",
        "branD_PATH": "sample string 3"
      },
      "altText": "sample string 8",
      "pageTitle": "sample string 9",
      "productDetailUrl": "sample string 10",
      "qtyOrdered": "sample string 11",
      "isSpecialOrder": true,
      "inventoryMessageCode": "sample string 13",
      "inventoryMessage": "sample string 14"
    }
  ],
  "labelTexts": {
    "Heading": "sample string 1",
    "DropDownText": "sample string 2",
    "CurrentItemText": "sample string 3",
    "PriceForSelectedText": "sample string 4",
    "AddSelectedToCartText": "sample string 5",
    "ToastMessage": "sample string 6",
    "Message": "sample string 7",
    "WebApiIsSuccess": true,
    "WebApiResponseMessage": "sample string 9",
    "WebApiErrorCode": "sample string 10",
    "error_description": "sample string 11",
    "CookieData": [
      {
        "Name": "sample string 1",
        "Value": "sample string 2",
        "NameValue": "sample string 3",
        "ExpiryDateTime": "sample string 4"
      },
      {
        "Name": "sample string 1",
        "Value": "sample string 2",
        "NameValue": "sample string 3",
        "ExpiryDateTime": "sample string 4"
      }
    ]
  },
  "Message": "sample string 2",
  "WebApiIsSuccess": true,
  "WebApiResponseMessage": "sample string 4",
  "WebApiErrorCode": "sample string 5",
  "error_description": "sample string 6",
  "CookieData": [
    {
      "Name": "sample string 1",
      "Value": "sample string 2",
      "NameValue": "sample string 3",
      "ExpiryDateTime": "sample string 4"
    },
    {
      "Name": "sample string 1",
      "Value": "sample string 2",
      "NameValue": "sample string 3",
      "ExpiryDateTime": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample: 
<BundleProductResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Adi.BusinessEntities">
  <CookieData>
    <AppCookie>
      <ExpiryDateTime>sample string 4</ExpiryDateTime>
      <Name>sample string 1</Name>
      <NameValue>sample string 3</NameValue>
      <Value>sample string 2</Value>
    </AppCookie>
    <AppCookie>
      <ExpiryDateTime>sample string 4</ExpiryDateTime>
      <Name>sample string 1</Name>
      <NameValue>sample string 3</NameValue>
      <Value>sample string 2</Value>
    </AppCookie>
  </CookieData>
  <Message>sample string 2</Message>
  <WebApiErrorCode>sample string 5</WebApiErrorCode>
  <WebApiIsSuccess>true</WebApiIsSuccess>
  <WebApiResponseMessage>sample string 4</WebApiResponseMessage>
  <error_description>sample string 6</error_description>
  <erpNumbers>sample string 1</erpNumbers>
  <labelTexts>
    <CookieData>
      <AppCookie>
        <ExpiryDateTime>sample string 4</ExpiryDateTime>
        <Name>sample string 1</Name>
        <NameValue>sample string 3</NameValue>
        <Value>sample string 2</Value>
      </AppCookie>
      <AppCookie>
        <ExpiryDateTime>sample string 4</ExpiryDateTime>
        <Name>sample string 1</Name>
        <NameValue>sample string 3</NameValue>
        <Value>sample string 2</Value>
      </AppCookie>
    </CookieData>
    <Message>sample string 7</Message>
    <WebApiErrorCode>sample string 10</WebApiErrorCode>
    <WebApiIsSuccess>true</WebApiIsSuccess>
    <WebApiResponseMessage>sample string 9</WebApiResponseMessage>
    <error_description>sample string 11</error_description>
    <AddSelectedToCartText>sample string 5</AddSelectedToCartText>
    <CurrentItemText>sample string 3</CurrentItemText>
    <DropDownText>sample string 2</DropDownText>
    <Heading>sample string 1</Heading>
    <PriceForSelectedText>sample string 4</PriceForSelectedText>
    <ToastMessage>sample string 6</ToastMessage>
  </labelTexts>
  <products>
    <FrequentlyBoughtProduct>
      <altText>sample string 8</altText>
      <erpNumber>sample string 2</erpNumber>
      <id>40959819-826a-4e14-8193-f0097a62e8bf</id>
      <inventoryMessage>sample string 14</inventoryMessage>
      <inventoryMessageCode>sample string 13</inventoryMessageCode>
      <isSpecialOrder>true</isSpecialOrder>
      <largeImagePath>sample string 5</largeImagePath>
      <manufacturerItem>sample string 6</manufacturerItem>
      <mediumImagePath>sample string 4</mediumImagePath>
      <pageTitle>sample string 9</pageTitle>
      <pricing>
        <actualBreakPrices>
          <breakPrice>2</breakPrice>
          <breakPriceDisplay>sample string 3</breakPriceDisplay>
          <breakQty>1</breakQty>
          <savingsMessage>sample string 4</savingsMessage>
        </actualBreakPrices>
        <actualPrice>5.1</actualPrice>
        <actualPriceDisplay>sample string 6</actualPriceDisplay>
        <additionalResults>
          <saleEndDate>sample string 1</saleEndDate>
          <saleExpiryDays>sample string 2</saleExpiryDays>
        </additionalResults>
        <extendedActualPrice>7.1</extendedActualPrice>
        <extendedActualPriceDisplay>sample string 8</extendedActualPriceDisplay>
        <extendedRegularPrice>3.1</extendedRegularPrice>
        <extendedRegularPriceDisplay>sample string 4</extendedRegularPriceDisplay>
        <extendedUnitListPrice>15.1</extendedUnitListPrice>
        <extendedUnitListPriceDisplay>sample string 16</extendedUnitListPriceDisplay>
        <extendedUnitNetPrice>23.1</extendedUnitNetPrice>
        <extendedUnitNetPriceDisplay>sample string 24</extendedUnitNetPriceDisplay>
        <extendedUnitRegularPrice>19.1</extendedUnitRegularPrice>
        <extendedUnitRegularPriceDisplay>sample string 20</extendedUnitRegularPriceDisplay>
        <isOnSale>true</isOnSale>
        <regularBreakPrices>
          <breakPrice>2</breakPrice>
          <breakPriceDisplay>sample string 3</breakPriceDisplay>
          <breakQty>1</breakQty>
          <savingsMessage>sample string 4</savingsMessage>
        </regularBreakPrices>
        <regularPrice>1.1</regularPrice>
        <regularPriceDisplay>sample string 2</regularPriceDisplay>
        <requiresRealTimePrice>true</requiresRealTimePrice>
        <unitCost>9.1</unitCost>
        <unitCostDisplay>sample string 10</unitCostDisplay>
        <unitListPrice>13.1</unitListPrice>
        <unitListPriceDisplay>sample string 14</unitListPriceDisplay>
        <unitNetPrice>21.1</unitNetPrice>
        <unitNetPriceDisplay>sample string 22</unitNetPriceDisplay>
        <unitRegularPrice>17.1</unitRegularPrice>
        <unitRegularPriceDisplay>sample string 18</unitRegularPriceDisplay>
      </pricing>
      <productDetailUrl>sample string 10</productDetailUrl>
      <properties>
        <branD_ID>sample string 1</branD_ID>
        <branD_PATH>sample string 3</branD_PATH>
        <branD_SHORTDESC>sample string 2</branD_SHORTDESC>
      </properties>
      <qtyOrdered>sample string 11</qtyOrdered>
      <shortDescription>sample string 7</shortDescription>
      <smallImagePath>sample string 3</smallImagePath>
    </FrequentlyBoughtProduct>
    <FrequentlyBoughtProduct>
      <altText>sample string 8</altText>
      <erpNumber>sample string 2</erpNumber>
      <id>40959819-826a-4e14-8193-f0097a62e8bf</id>
      <inventoryMessage>sample string 14</inventoryMessage>
      <inventoryMessageCode>sample string 13</inventoryMessageCode>
      <isSpecialOrder>true</isSpecialOrder>
      <largeImagePath>sample string 5</largeImagePath>
      <manufacturerItem>sample string 6</manufacturerItem>
      <mediumImagePath>sample string 4</mediumImagePath>
      <pageTitle>sample string 9</pageTitle>
      <pricing>
        <actualBreakPrices>
          <breakPrice>2</breakPrice>
          <breakPriceDisplay>sample string 3</breakPriceDisplay>
          <breakQty>1</breakQty>
          <savingsMessage>sample string 4</savingsMessage>
        </actualBreakPrices>
        <actualPrice>5.1</actualPrice>
        <actualPriceDisplay>sample string 6</actualPriceDisplay>
        <additionalResults>
          <saleEndDate>sample string 1</saleEndDate>
          <saleExpiryDays>sample string 2</saleExpiryDays>
        </additionalResults>
        <extendedActualPrice>7.1</extendedActualPrice>
        <extendedActualPriceDisplay>sample string 8</extendedActualPriceDisplay>
        <extendedRegularPrice>3.1</extendedRegularPrice>
        <extendedRegularPriceDisplay>sample string 4</extendedRegularPriceDisplay>
        <extendedUnitListPrice>15.1</extendedUnitListPrice>
        <extendedUnitListPriceDisplay>sample string 16</extendedUnitListPriceDisplay>
        <extendedUnitNetPrice>23.1</extendedUnitNetPrice>
        <extendedUnitNetPriceDisplay>sample string 24</extendedUnitNetPriceDisplay>
        <extendedUnitRegularPrice>19.1</extendedUnitRegularPrice>
        <extendedUnitRegularPriceDisplay>sample string 20</extendedUnitRegularPriceDisplay>
        <isOnSale>true</isOnSale>
        <regularBreakPrices>
          <breakPrice>2</breakPrice>
          <breakPriceDisplay>sample string 3</breakPriceDisplay>
          <breakQty>1</breakQty>
          <savingsMessage>sample string 4</savingsMessage>
        </regularBreakPrices>
        <regularPrice>1.1</regularPrice>
        <regularPriceDisplay>sample string 2</regularPriceDisplay>
        <requiresRealTimePrice>true</requiresRealTimePrice>
        <unitCost>9.1</unitCost>
        <unitCostDisplay>sample string 10</unitCostDisplay>
        <unitListPrice>13.1</unitListPrice>
        <unitListPriceDisplay>sample string 14</unitListPriceDisplay>
        <unitNetPrice>21.1</unitNetPrice>
        <unitNetPriceDisplay>sample string 22</unitNetPriceDisplay>
        <unitRegularPrice>17.1</unitRegularPrice>
        <unitRegularPriceDisplay>sample string 18</unitRegularPriceDisplay>
      </pricing>
      <productDetailUrl>sample string 10</productDetailUrl>
      <properties>
        <branD_ID>sample string 1</branD_ID>
        <branD_PATH>sample string 3</branD_PATH>
        <branD_SHORTDESC>sample string 2</branD_SHORTDESC>
      </properties>
      <qtyOrdered>sample string 11</qtyOrdered>
      <shortDescription>sample string 7</shortDescription>
      <smallImagePath>sample string 3</smallImagePath>
    </FrequentlyBoughtProduct>
  </products>
</BundleProductResponse>