Merge pull request #40 from FoxComm/feature/faster-cross-sell

Add crossSellRelatedFull endpoint

Author: anru

index.html

@@ -1830,14 +1830,18 @@ <h3 id='cart-method'>Methods</h3>
 	<tr id='cart-addgiftcard'>
 		<td><code><b>addGiftCard</b>(<nobr>&lt;<a href='#giftcardpaymentpayload'>GiftCardPaymentPayload</a>&gt;</nobr> <i>giftCardPayload</i>)</nobr></code></td>
 		<td><code>Promise&lt;<a href='#fullorder'>FullOrder</a>&gt;</code></td>
-		<td>Adds a gift card as payment method for the cart.
-<p>Creates payment method with a given amount using store credit.</p></td>
+		<td>Adds a gift card as payment method for the cart.</td>
 	</tr>
 	<tr id='cart-removegiftcard'>
 		<td><code><b>removeGiftCard</b>(<nobr>&lt;string&gt;</nobr> <i>giftCardCode</i>)</nobr></code></td>
 		<td><code>Promise&lt;<a href='#fullorder'>FullOrder</a>&gt;</code></td>
 		<td>Removes gift card with provided code payment method from the cart.</td>
 	</tr>
+	<tr id='cart-addstorecredit'>
+		<td><code><b>addStoreCredit</b>(<nobr>&lt;Number&gt;</nobr> <i>amount</i>)</nobr></code></td>
+		<td><code>Promise&lt;<a href='#fullorder'>FullOrder</a>&gt;</code></td>
+		<td>Adds store credit of specified amount to the cart.</td>
+	</tr>
 	<tr id='cart-removestorecredits'>
 		<td><code><b>removeStoreCredits</b>()</nobr></code></td>
 		<td><code>Promise&lt;<a href='#fullorder'>FullOrder</a>&gt;</code></td>
@@ -3246,7 +3250,8 @@ <h3 id='crosssell-example'>Usage example</h3>
    ]
 }
 </code></pre>
-<p>/v1/public/recommend/prod-prod/3?channel=2</p>
+<p>/v1/public/recommend/prod-prod/3?channel=2
+/v1/public/recommend/prod-prod/3?channel=2</p>
 
 <pre><code>{
    &quot;products&quot;: [
@@ -3264,6 +3269,39 @@ <h3 id='crosssell-example'>Usage example</h3>
      }
    ]
 }
+</code></pre><pre><code>{
+  &quot;products&quot;: [
+  {
+    &quot;product&quot;: {
+       &quot;id&quot;: 300,
+       &quot;productId&quot;: 60727,
+       &quot;scope&quot;: &quot;1&quot;,
+       &quot;albums&quot;: [ { &quot;images&quot;: [...], &quot;name&quot;: &quot;default&quot; } ],
+       &quot;context&quot;: &quot;default&quot;,
+       &quot;currency&quot;: &quot;USD&quot;,
+       &quot;description&quot;: &quot;...&quot;,
+       &quot;retailPrice&quot;: &quot;8500&quot;,
+       &quot;salePrice&quot;: &quot;8500&quot;,
+       &quot;skus&quot;: [ &quot;AB9403_310&quot;, &quot;AB9403_330&quot;, &quot;AB9403_350&quot;, &quot;AB9403_370&quot; ],
+       &quot;slug&quot;: &quot;dynamo-away-replica-jersey&quot;,
+       &quot;tags&quot;: [ &quot;Apparel&quot;, &quot;Soccer&quot; ],
+       &quot;taxonomies&quot;: [
+         { &quot;taxonomy&quot;: &quot;brand&quot;, &quot;taxons&quot;: [ [ &quot;Performance&quot; ] ] },
+         { &quot;taxonomy&quot;: &quot;category&quot;, &quot;taxons&quot;: [ [ &quot;Apparel&quot; ] ] },
+         { &quot;taxonomy&quot;: &quot;color&quot;, &quot;taxons&quot;: [ [ &quot;Black&quot; ], [ &quot;Light Orange&quot; ] ] },
+       ],
+       &quot;title&quot;: &quot;Dynamo Away Replica Jersey&quot;
+     },
+     &quot;score&quot;: 0.129*9944487358058
+  },
+  {
+    &quot;product&quot;: {
+       ... 
+    },
+    &quot;score&quot;: 0.07715167498104597
+  }
+ ]
+}
 </code></pre>
 
 
@@ -3300,6 +3338,14 @@ <h3 id='crosssell-method'>Methods</h3>
 		<td>Returns JSON of what products are similar to the productId in the query params.
 { &quot;products&quot;: [ RelatedProduct ] }
 Score == 1 means these products were purchased by the exact same set of customers. 
+Score == 0 means no customer has purchased both of these</td>
+	</tr>
+	<tr id='crosssell-crosssellrelatedfull'>
+		<td><code><b>crossSellRelatedFull</b>(<nobr>&lt;Int&gt;</nobr> <i>productId</i>, <nobr>&lt;Int&gt;</nobr> <i>channelId</i>, <nobr>&lt;Int&gt;</nobr> <i>size</i>, <i>{Int} productId</i>, <i>{Int} channelId</i>, <i>{Int} size</i>)</nobr></code></td>
+		<td><code>Promise</code></td>
+		<td>Returns JSON of what products are similar to the productId in the query params.
+{ &quot;products&quot;: [ RelatedProductFull ] }
+Score == 1 means these products were purchased by the exact same set of customers. 
 Score == 0 means no customer has purchased both of these</td>
 	</tr>
 </tbody></table>

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@foxcomm/api-js",
-  "version": "1.1.6",
+  "version": "1.1.7",
   "description": "Javascript Library for interacting with FoxCommerce API",
   "main": "lib/index.js",
   "publishConfig": {

src/api/cross-sell.js

@@ -78,6 +78,66 @@ export default class CrossSell {
     const url = `${endpoints.crossSellRelated}${productId}${query}`;
     return this.api.get(url);
   }
+
+  /**
+   * @method crossSellRelatedFull(productId: Int, channelId: Int, size: Int): Promise
+   * @param {Int} productId 
+   * @param {Int} channelId 
+   * @param {Int} size 
+   * 
+   * Returns JSON of what products are similar to the productId in the query params.
+   * { "products": [ RelatedProductFull ] }
+   * 
+   * Score == 1 means these products were purchased by the exact same set of customers. 
+   * Score == 0 means no customer has purchased both of these
+   * 
+   * @example Request
+   * 
+   * /v1/public/recommend/prod-prod/3?channel=2
+   * 
+   * @example Response
+   * 
+   * ```
+   * {
+   *   "products": [
+   *   {
+   *     "product": {
+   *        "id": 300,
+   *        "productId": 60727,
+   *        "scope": "1",
+   *        "albums": [ { "images": [...], "name": "default" } ],
+   *        "context": "default",
+   *        "currency": "USD",
+   *        "description": "...",
+   *        "retailPrice": "8500",
+   *        "salePrice": "8500",
+   *        "skus": [ "AB9403_310", "AB9403_330", "AB9403_350", "AB9403_370" ],
+   *        "slug": "dynamo-away-replica-jersey",
+   *        "tags": [ "Apparel", "Soccer" ],
+   *        "taxonomies": [
+   *          { "taxonomy": "brand", "taxons": [ [ "Performance" ] ] },
+   *          { "taxonomy": "category", "taxons": [ [ "Apparel" ] ] },
+   *          { "taxonomy": "color", "taxons": [ [ "Black" ], [ "Light Orange" ] ] },
+   *        ],
+   *        "title": "Dynamo Away Replica Jersey"
+   *      },
+   *      "score": 0.129*9944487358058
+   *   },
+   *   {
+   *     "product": {
+   *        ... 
+   *     },
+   *     "score": 0.07715167498104597
+   *   }
+   *  ]
+   *}
+   * ```
+   */
+  crossSellRelatedFull(productId, channelId, size) {
+    const query = `?channel=${channelId}&size=${size}`;
+    const url = `${endpoints.crossSellRelatedFull}${productId}${query}`;
+    return this.api.get(url);
+  }
 }
 
 // @miniclass Point (CrossSell)

src/endpoints.js

@@ -61,3 +61,4 @@ export const hal = '/v1/hal';
 // cross-sell endpoints
 export const crossSellTrain = '/v1/public/recommend/prod-prod/train';
 export const crossSellRelated = '/v1/public/recommend/prod-prod/';
+export const crossSellRelatedFull = '/v1/public/recommend/prod-prod/full/';