From e3b93c679f74c42be12d34a13e94d79b9066d559 Mon Sep 17 00:00:00 2001
From: Shahed Nasser <shahednasser@gmail.com>
Date: Thu, 13 Feb 2025 15:30:56 +0200
Subject: [PATCH] chore(core-flows): update TSDocs of createProductsWorkflow
 (#11439)

* chore(core-flows): update TSDocs of createProductsWorkflow

* update example in js sdk
---
 .../core-flows/src/product/workflows/create-products.ts   | 8 +++++++-
 packages/core/js-sdk/src/admin/product.ts                 | 3 ++-
 2 files changed, 9 insertions(+), 2 deletions(-)

diff --git a/packages/core/core-flows/src/product/workflows/create-products.ts b/packages/core/core-flows/src/product/workflows/create-products.ts
index ea1796a0c8..d0884fbca4 100644
--- a/packages/core/core-flows/src/product/workflows/create-products.ts
+++ b/packages/core/core-flows/src/product/workflows/create-products.ts
@@ -40,7 +40,12 @@ export interface ValidateProductInputStepInput {
   /**
    * The shipping profiles to validate.
    */
-  shippingProfiles: { id: string }[]
+  shippingProfiles: {
+    /**
+     * The shipping profile's ID.
+     */ 
+    id: string
+  }[]
 }
 
 const validateProductInputStepId = "validate-product-input"
@@ -168,6 +173,7 @@ export const createProductsWorkflowId = "create-products"
  *         ]
  *       }
  *     ],
+ *     shipping_profile_id: "sp_123",
  *     additional_data: {
  *       erp_id: "123"
  *     }
diff --git a/packages/core/js-sdk/src/admin/product.ts b/packages/core/js-sdk/src/admin/product.ts
index 76e2c6df84..ca1aa4298e 100644
--- a/packages/core/js-sdk/src/admin/product.ts
+++ b/packages/core/js-sdk/src/admin/product.ts
@@ -213,7 +213,8 @@ export class Product {
    *       },
    *       prices: []
    *     }
-   *   ]
+   *   ],
+   *   shipping_profile_id: "sp_123"
    * })
    * .then(({ product }) => {
    *   console.log(product)