ce-storefront 0.13.1 → 0.13.3

package/docs/sdks/carts/README.md

@@ -52,7 +52,6 @@ async function run() {
     ],
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -93,15 +92,12 @@ async function run() {
       },
     ],
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("cartsCreateCart failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -147,7 +143,6 @@ async function run() {
     id: "<id>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -172,15 +167,12 @@ async function run() {
   const res = await cartsGetCart(ceStorefront, {
     id: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("cartsGetCart failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -225,7 +217,6 @@ async function run() {
     id: "<id>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -250,15 +241,12 @@ async function run() {
   const res = await cartsDeleteCart(ceStorefront, {
     id: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("cartsDeleteCart failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -303,7 +291,6 @@ async function run() {
     userId: "<id>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -328,15 +315,12 @@ async function run() {
   const res = await cartsGetUserCart(ceStorefront, {
     userId: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("cartsGetUserCart failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -381,7 +365,6 @@ async function run() {
     userId: "<id>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -406,15 +389,12 @@ async function run() {
   const res = await cartsRemoveUserCart(ceStorefront, {
     userId: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("cartsRemoveUserCart failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -464,7 +444,6 @@ async function run() {
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -494,15 +473,12 @@ async function run() {
       quantity: 1,
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("cartsUpdateCart failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -552,7 +528,6 @@ async function run() {
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -581,15 +556,12 @@ async function run() {
       shippingAddressId: "<id>",
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("cartsCreateCartAddress failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -639,7 +611,6 @@ async function run() {
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -668,15 +639,12 @@ async function run() {
       courierCompanyId: "<id>",
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("cartsAddShippingMethod failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -725,7 +693,6 @@ async function run() {
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -753,15 +720,12 @@ async function run() {
       couponCode: "FLAT100OFF",
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("cartsApplyCoupon failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -807,7 +771,6 @@ async function run() {
     id: "<id>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -832,15 +795,12 @@ async function run() {
   const res = await cartsRemoveCoupon(ceStorefront, {
     id: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("cartsRemoveCoupon failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -888,7 +848,6 @@ async function run() {
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -916,15 +875,12 @@ async function run() {
       loyaltyPointRedeemed: 1000,
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("cartsRedeemLoyaltyPoints failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -969,7 +925,6 @@ async function run() {
     id: "<id>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -994,15 +949,12 @@ async function run() {
   const res = await cartsRemoveLoyaltyPoints(ceStorefront, {
     id: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("cartsRemoveLoyaltyPoints failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/catalog/README.md

@@ -35,7 +35,6 @@ async function run() {
     sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -60,15 +59,12 @@ async function run() {
   const res = await catalogListProducts(ceStorefront, {
     sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("catalogListProducts failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -113,7 +109,6 @@ async function run() {
     sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -138,15 +133,12 @@ async function run() {
   const res = await catalogListSkus(ceStorefront, {
     sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("catalogListSkus failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -175,7 +167,7 @@ run();
 
 ## getProductDetail
 
-Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Commerce Engine will return the corresponding product information.
+Retrieves the details of an existing product. Supply either the unique product ID or the unique slug, and Commerce Engine will return the corresponding product information.
 
 ### Example Usage
 
@@ -188,10 +180,9 @@ const ceStorefront = new CeStorefront({
 
 async function run() {
   const result = await ceStorefront.catalog.getProductDetail({
-    productId: "41",
+    productIdOrSlug: "01XGCYCT8CRHXW4BG91JXCMDCW",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -214,17 +205,14 @@ const ceStorefront = new CeStorefrontCore({
 
 async function run() {
   const res = await catalogGetProductDetail(ceStorefront, {
-    productId: "41",
+    productIdOrSlug: "01XGCYCT8CRHXW4BG91JXCMDCW",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("catalogGetProductDetail failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -269,7 +257,6 @@ async function run() {
     productId: "01H7YK0C86V9PGT0HXRJVEZXJQ",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -294,15 +281,12 @@ async function run() {
   const res = await catalogListProductVariants(ceStorefront, {
     productId: "01H7YK0C86V9PGT0HXRJVEZXJQ",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("catalogListProductVariants failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -348,7 +332,6 @@ async function run() {
     variantId: "<id>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -374,15 +357,12 @@ async function run() {
     productId: "01H7YK0C86V9PGT0HXRJVEZXJQ",
     variantId: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("catalogGetVariantDetail failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -424,11 +404,11 @@ const ceStorefront = new CeStorefront({
 
 async function run() {
   const result = await ceStorefront.catalog.listCategories({
-    parentCategoryId: "a847641353e947d3bed69a4eea975634",
+    parentCategoryId: "01JWZW41Y3FBKTZSP399SKANY7",
     sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
+    parentCategorySlug: "vitals",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -451,18 +431,16 @@ const ceStorefront = new CeStorefrontCore({
 
 async function run() {
   const res = await catalogListCategories(ceStorefront, {
-    parentCategoryId: "a847641353e947d3bed69a4eea975634",
+    parentCategoryId: "01JWZW41Y3FBKTZSP399SKANY7",
     sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
+    parentCategorySlug: "vitals",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("catalogListCategories failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -509,7 +487,6 @@ async function run() {
     productId: "<id>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -535,15 +512,12 @@ async function run() {
     sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
     productId: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("catalogListProductReviews failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -586,7 +560,6 @@ const ceStorefront = new CeStorefront({
 async function run() {
   const result = await ceStorefront.catalog.listSimilarProducts({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -609,15 +582,12 @@ const ceStorefront = new CeStorefrontCore({
 
 async function run() {
   const res = await catalogListSimilarProducts(ceStorefront, {});
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("catalogListSimilarProducts failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -660,7 +630,6 @@ const ceStorefront = new CeStorefront({
 async function run() {
   const result = await ceStorefront.catalog.listUpsellProducts({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -683,15 +652,12 @@ const ceStorefront = new CeStorefrontCore({
 
 async function run() {
   const res = await catalogListUpsellProducts(ceStorefront, {});
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("catalogListUpsellProducts failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -734,7 +700,6 @@ const ceStorefront = new CeStorefront({
 async function run() {
   const result = await ceStorefront.catalog.listCrosssellProducts({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -757,15 +722,12 @@ const ceStorefront = new CeStorefrontCore({
 
 async function run() {
   const res = await catalogListCrosssellProducts(ceStorefront, {});
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("catalogListCrosssellProducts failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -810,7 +772,6 @@ async function run() {
     query: "<value>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -835,15 +796,12 @@ async function run() {
   const res = await catalogSearchProducts(ceStorefront, {
     query: "<value>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("catalogSearchProducts failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/common/README.md

@@ -25,7 +25,6 @@ async function run() {
     countryIsoCode: "<value>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -50,15 +49,12 @@ async function run() {
   const res = await commonListCountryPincodes(ceStorefront, {
     countryIsoCode: "<value>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("commonListCountryPincodes failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();