diff --git a/.changeset/afraid-hotels-jam.md b/.changeset/afraid-hotels-jam.md new file mode 100644 index 0000000000..405765cbbe --- /dev/null +++ b/.changeset/afraid-hotels-jam.md @@ -0,0 +1,7 @@ +--- +"@medusajs/core-flows": patch +"@medusajs/cart": patch +"@medusajs/types": patch +--- + +chore: improve tax lines diff --git a/.changeset/many-cycles-count.md b/.changeset/many-cycles-count.md new file mode 100644 index 0000000000..f4fbcd8bde --- /dev/null +++ b/.changeset/many-cycles-count.md @@ -0,0 +1,5 @@ +--- +"@medusajs/core-flows": patch +--- + +fix(core-flows): fulfillment reservation check diff --git a/.changeset/metal-dryers-explain.md b/.changeset/metal-dryers-explain.md new file mode 100644 index 0000000000..7633dae356 --- /dev/null +++ b/.changeset/metal-dryers-explain.md @@ -0,0 +1,62 @@ +--- +"@medusajs/notification-sendgrid": patch +"@medusajs/fulfillment-manual": patch +"@medusajs/notification-local": patch +"@medusajs/locking-postgres": patch +"@medusajs/auth-emailpass": patch +"@medusajs/payment-stripe": patch +"@medusajs/workflow-engine-inmemory": patch +"@medusajs/locking-redis": patch +"@medusajs/auth-github": patch +"@medusajs/auth-google": patch +"@medusajs/workflow-engine-redis": patch +"@medusajs/file-local": patch +"@medusajs/file-s3": patch +"@medusajs/ui-preset": patch +"@medusajs/event-bus-local": patch +"@medusajs/event-bus-redis": patch +"@medusajs/medusa-oas-cli": patch +"@medusajs/cache-inmemory": patch +"@medusajs/stock-location": patch +"create-medusa-app": patch +"@medusajs/sales-channel": patch +"@medusajs/link-modules": patch +"@medusajs/notification": patch +"@medusajs/admin-bundler": patch +"@medusajs/icons": patch +"@medusajs/cache-redis": patch +"@medusajs/fulfillment": patch +"@medusajs/orchestration": patch +"@medusajs/workflows-sdk": patch +"@medusajs/test-utils": patch +"@medusajs/inventory": patch +"@medusajs/promotion": patch +"@medusajs/modules-sdk": patch +"@medusajs/ui": patch +"@medusajs/currency": patch +"@medusajs/customer": patch +"@medusajs/admin-sdk": patch +"@medusajs/dashboard": patch +"@medusajs/core-flows": patch +"@medusajs/api-key": patch +"@medusajs/locking": patch +"@medusajs/payment": patch +"@medusajs/pricing": patch +"@medusajs/product": patch +"@medusajs/cli": patch +"@medusajs/framework": patch +"@medusajs/region": patch +"@medusajs/index": patch +"@medusajs/order": patch +"@medusajs/store": patch +"@medusajs/auth": patch +"@medusajs/cart": patch +"@medusajs/file": patch +"@medusajs/user": patch +"@medusajs/js-sdk": patch +"@medusajs/tax": patch +"@medusajs/utils": patch +"@medusajs/medusa": patch +--- + +chore: Remove ranges on Medusa packages diff --git a/.changeset/odd-cycles-destroy.md b/.changeset/odd-cycles-destroy.md new file mode 100644 index 0000000000..16a5e6a190 --- /dev/null +++ b/.changeset/odd-cycles-destroy.md @@ -0,0 +1,5 @@ +--- +"@medusajs/framework": patch +--- + +Fix(framework): http cors middleware order and options diff --git a/.changeset/rich-drinks-punch.md b/.changeset/rich-drinks-punch.md new file mode 100644 index 0000000000..ca92df7667 --- /dev/null +++ b/.changeset/rich-drinks-punch.md @@ -0,0 +1,6 @@ +--- +"@medusajs/core-flows": patch +"@medusajs/workflows-sdk": patch +--- + +feat(workflows-sdk): Allow when then in parallelize diff --git a/.changeset/sharp-poems-impress.md b/.changeset/sharp-poems-impress.md new file mode 100644 index 0000000000..be0b6ffde6 --- /dev/null +++ b/.changeset/sharp-poems-impress.md @@ -0,0 +1,5 @@ +--- +"@medusajs/medusa": patch +--- + +chore: pin swc to 1.5.7 diff --git a/.changeset/tender-horses-jog.md b/.changeset/tender-horses-jog.md new file mode 100644 index 0000000000..96ce6c7714 --- /dev/null +++ b/.changeset/tender-horses-jog.md @@ -0,0 +1,5 @@ +--- +"@medusajs/pricing": patch +--- + +fix(pricing): emit events diff --git a/.changeset/thick-steaks-wait.md b/.changeset/thick-steaks-wait.md new file mode 100644 index 0000000000..8fb363377d --- /dev/null +++ b/.changeset/thick-steaks-wait.md @@ -0,0 +1,5 @@ +--- +"@medusajs/workflow-engine-redis": patch +--- + +fix(workflow-engine-redis): Split the queues and respect worker mode for job executions diff --git a/.github/workflows/docs-test.yml b/.github/workflows/docs-test.yml index dcc4c293f1..4f06538417 100644 --- a/.github/workflows/docs-test.yml +++ b/.github/workflows/docs-test.yml @@ -88,7 +88,7 @@ jobs: - name: Get Directories to Scan if: ${{ steps.pr-files.outputs.files_lt_threshold == 'true' }} working-directory: www/vale - run: ./get-files.sh book app + run: ./get-files.sh book/app/learn resources id: directories - name: Vale Linter @@ -145,7 +145,7 @@ jobs: - name: Get Directories to Scan working-directory: www/vale - run: ./get-files.sh resources app contribution-guidelines usage + run: ./get-files.sh resources/app id: directories - name: Vale Linter @@ -202,7 +202,7 @@ jobs: - name: Get Directories to Scan working-directory: www/vale - run: ./get-files.sh user-guide app + run: ./get-files.sh user-guide/app id: directories - name: Vale Linter @@ -260,7 +260,7 @@ jobs: - name: Get Directories to Scan if: ${{ steps.pr-files.outputs.files_lt_threshold == 'true' }} working-directory: www/vale - run: ./get-files.sh ui src/content/docs + run: ./get-files.sh ui/src/content/docs id: directories - name: Vale Linter @@ -318,7 +318,7 @@ jobs: - name: Get Directories to Scan if: ${{ steps.pr-files.outputs.files_lt_threshold == 'true' }} working-directory: www/vale - run: ./get-files.sh api-reference markdown + run: ./get-files.sh api-reference/markdown id: directories - name: Vale Linter diff --git a/integration-tests/http/__tests__/claims/claims.spec.ts b/integration-tests/http/__tests__/claims/claims.spec.ts index 91cac0ba73..266f1c9b16 100644 --- a/integration-tests/http/__tests__/claims/claims.spec.ts +++ b/integration-tests/http/__tests__/claims/claims.spec.ts @@ -331,6 +331,17 @@ medusaIntegrationTestRunner({ }, ]) + // create reservation for inventory item that is initially on the order + const inventoryModule = container.resolve(Modules.INVENTORY) + await inventoryModule.createReservationItems([ + { + inventory_item_id: inventoryItem.id, + location_id: location.id, + quantity: 2, + line_item_id: order.items[0].id, + }, + ]) + const shippingOptionPayload = { name: "Return shipping", service_zone_id: fulfillmentSet.service_zones[0].id, diff --git a/integration-tests/http/__tests__/exchanges/exchanges.spec.ts b/integration-tests/http/__tests__/exchanges/exchanges.spec.ts index afd731faef..b9d9aa100f 100644 --- a/integration-tests/http/__tests__/exchanges/exchanges.spec.ts +++ b/integration-tests/http/__tests__/exchanges/exchanges.spec.ts @@ -325,6 +325,17 @@ medusaIntegrationTestRunner({ }, ]) + // create reservation for inventory item that is initially on the order + const inventoryModule = container.resolve(Modules.INVENTORY) + await inventoryModule.createReservationItems([ + { + inventory_item_id: inventoryItem.id, + location_id: location.id, + quantity: 2, + line_item_id: order.items[0].id, + }, + ]) + const shippingOptionPayload = { name: "Return shipping", service_zone_id: fulfillmentSet.service_zones[0].id, diff --git a/integration-tests/http/__tests__/order/admin/rma-flows.spec.ts b/integration-tests/http/__tests__/order/admin/rma-flows.spec.ts index 4cbd0e3a7e..9b1c124ca6 100644 --- a/integration-tests/http/__tests__/order/admin/rma-flows.spec.ts +++ b/integration-tests/http/__tests__/order/admin/rma-flows.spec.ts @@ -17,6 +17,7 @@ medusaIntegrationTestRunner({ let location let item let returnShippingOption + let outboundShippingOption const shippingProviderId = "manual_test-provider" beforeEach(async () => { @@ -135,7 +136,7 @@ medusaIntegrationTestRunner({ prices: [ { currency_code: "usd", - amount: 20, + amount: 0, // Free shipping }, ], rules: [ @@ -160,7 +161,7 @@ medusaIntegrationTestRunner({ ) ).data.shipping_option - const outboundShippingOption = ( + outboundShippingOption = ( await api.post( "/admin/shipping-options", outboundShippingOptionPayload, @@ -289,6 +290,15 @@ medusaIntegrationTestRunner({ adminHeaders ) + // If claim has outbound items, we need to set the outbound shipping method for reservation to be created + // TODO: change condition in confirm workfow to crate reservation depending on shipping since we can have + // reservations for inventory items that don't require shipping + await api.post( + `/admin/claims/${singleOutboundClaim.id}/outbound/shipping-method`, + { shipping_option_id: outboundShippingOption.id }, + adminHeaders + ) + await api.post( `/admin/claims/${singleOutboundClaim.id}/request`, {}, diff --git a/integration-tests/http/__tests__/product/admin/product.spec.ts b/integration-tests/http/__tests__/product/admin/product.spec.ts index 5152a853e3..e472fbe77f 100644 --- a/integration-tests/http/__tests__/product/admin/product.spec.ts +++ b/integration-tests/http/__tests__/product/admin/product.spec.ts @@ -3100,6 +3100,25 @@ medusaIntegrationTestRunner({ ) }) + it("should successfully delete products", async () => { + const response = await api.post( + "/admin/products/batch", + { delete: [baseProduct.id] }, + adminHeaders + ) + + expect(response.status).toEqual(200) + expect(response.data.created).toHaveLength(0) + expect(response.data.updated).toHaveLength(0) + expect(response.data.deleted.ids).toHaveLength(1) + + expect(response.data.created).toEqual([]) + expect(response.data.updated).toEqual([]) + expect(response.data.deleted).toEqual( + expect.objectContaining({ ids: [baseProduct.id] }) + ) + }) + it("successfully creates, updates, and deletes product variants", async () => { const productWithMultipleVariants = getProductFixture({ title: "Test batch variants", diff --git a/integration-tests/http/__tests__/returns/returns.spec.ts b/integration-tests/http/__tests__/returns/returns.spec.ts index dda188fbf7..24896a7eb8 100644 --- a/integration-tests/http/__tests__/returns/returns.spec.ts +++ b/integration-tests/http/__tests__/returns/returns.spec.ts @@ -239,6 +239,17 @@ medusaIntegrationTestRunner({ }, ]) + // create reservation for inventory item that is initially on the order + const inventoryModule = container.resolve(Modules.INVENTORY) + await inventoryModule.createReservationItems([ + { + inventory_item_id: inventoryItem.id, + location_id: location.id, + quantity: 2, + line_item_id: order.items[0].id, + }, + ]) + const shippingOptionPayload = { name: "Return shipping", service_zone_id: fulfillmentSet.service_zones[0].id, @@ -866,7 +877,9 @@ medusaIntegrationTestRunner({ adminHeaders ) ).data.inventory_levels - expect(inventoryLevel[0].stocked_quantity).toEqual(2) + + // we had 2 items in stock that were reserved for the order and then fulfilled + expect(inventoryLevel[0].stocked_quantity).toEqual(0) let result = await api.post( `/admin/returns/${returnId}/receive`, @@ -987,7 +1000,7 @@ medusaIntegrationTestRunner({ adminHeaders ) ).data.inventory_levels - expect(inventoryLevel[0].stocked_quantity).toEqual(3) + expect(inventoryLevel[0].stocked_quantity).toEqual(1) }) }) diff --git a/integration-tests/modules/__tests__/order/workflows/create-fulfillment.spec.ts b/integration-tests/modules/__tests__/order/workflows/create-fulfillment.spec.ts index 6a9e025c6e..e84dbb4a79 100644 --- a/integration-tests/modules/__tests__/order/workflows/create-fulfillment.spec.ts +++ b/integration-tests/modules/__tests__/order/workflows/create-fulfillment.spec.ts @@ -486,6 +486,9 @@ medusaIntegrationTestRunner({ it("should revert an order fulfillment when it fails and recreate it when tried again", async () => { const order = await createOrderFixture({ container, product, location }) + const itemId = order.items?.find((i) => i.title === "Custom Item 2")! + .id as string + // Create a fulfillment const createOrderFulfillmentData: OrderWorkflow.CreateOrderFulfillmentWorkflowInput = { @@ -493,7 +496,7 @@ medusaIntegrationTestRunner({ created_by: "user_1", items: [ { - id: order.items![0].id, + id: itemId, quantity: 1, }, ], @@ -540,12 +543,14 @@ medusaIntegrationTestRunner({ const [orderFulfill] = await remoteQuery(remoteQueryObject) + const fulfilledItem = orderFulfill.items?.find((i) => i.id === itemId) + expect(orderFulfill.fulfillments).toHaveLength(1) - expect(orderFulfill.items[0].detail.fulfilled_quantity).toEqual(1) + expect(fulfilledItem?.detail.fulfilled_quantity).toEqual(1) const inventoryModule = container.resolve(Modules.INVENTORY) const reservation = await inventoryModule.listReservationItems({ - line_item_id: order.items![0].id, + line_item_id: itemId, }) expect(reservation).toHaveLength(0) diff --git a/packages/admin/admin-bundler/package.json b/packages/admin/admin-bundler/package.json index 0aa0642464..19516ca419 100644 --- a/packages/admin/admin-bundler/package.json +++ b/packages/admin/admin-bundler/package.json @@ -18,7 +18,7 @@ "package.json" ], "devDependencies": { - "@medusajs/types": "^2.6.0", + "@medusajs/types": "2.6.0", "@types/compression": "^1.7.5", "copyfiles": "^2.4.1", "express": "^4.21.0", diff --git a/packages/admin/admin-sdk/package.json b/packages/admin/admin-sdk/package.json index 9e4a7c605e..734054159c 100644 --- a/packages/admin/admin-sdk/package.json +++ b/packages/admin/admin-sdk/package.json @@ -24,7 +24,7 @@ "typescript": "^5.3.3" }, "dependencies": { - "@medusajs/admin-shared": "^2.6.0", + "@medusajs/admin-shared": "2.6.0", "zod": "3.22.4" }, "packageManager": "yarn@3.2.1" diff --git a/packages/admin/dashboard/package.json b/packages/admin/dashboard/package.json index 7a9476e7ed..8a0a72a89e 100644 --- a/packages/admin/dashboard/package.json +++ b/packages/admin/dashboard/package.json @@ -45,10 +45,10 @@ "@dnd-kit/sortable": "^8.0.0", "@hookform/error-message": "^2.0.1", "@hookform/resolvers": "3.4.2", - "@medusajs/admin-shared": "^2.6.0", - "@medusajs/icons": "^2.6.0", - "@medusajs/js-sdk": "^2.6.0", - "@medusajs/ui": "~4.0.6", + "@medusajs/admin-shared": "2.6.0", + "@medusajs/icons": "2.6.0", + "@medusajs/js-sdk": "2.6.0", + "@medusajs/ui": "4.0.6", "@tanstack/react-query": "5.64.2", "@tanstack/react-table": "8.20.5", "@tanstack/react-virtual": "^3.8.3", @@ -75,10 +75,10 @@ "zod": "3.22.4" }, "devDependencies": { - "@medusajs/admin-shared": "^2.6.0", - "@medusajs/admin-vite-plugin": "^2.6.0", - "@medusajs/types": "^2.6.0", - "@medusajs/ui-preset": "^2.6.0", + "@medusajs/admin-shared": "2.6.0", + "@medusajs/admin-vite-plugin": "2.6.0", + "@medusajs/types": "2.6.0", + "@medusajs/ui-preset": "2.6.0", "@types/node": "^20.11.15", "@types/react": "^18.2.79", "@types/react-dom": "^18.2.25", diff --git a/packages/admin/dashboard/src/routes/orders/order-create-fulfillment/components/order-create-fulfillment-form/order-create-fulfillment-form.tsx b/packages/admin/dashboard/src/routes/orders/order-create-fulfillment/components/order-create-fulfillment-form/order-create-fulfillment-form.tsx index ec5a49545f..91b14ec75d 100644 --- a/packages/admin/dashboard/src/routes/orders/order-create-fulfillment/components/order-create-fulfillment-form/order-create-fulfillment-form.tsx +++ b/packages/admin/dashboard/src/routes/orders/order-create-fulfillment/components/order-create-fulfillment-form/order-create-fulfillment-form.tsx @@ -111,30 +111,28 @@ export function OrderCreateFulfillmentForm({ return } - const selectedShippingProfileId = - selectedShippingOption?.shipping_profile_id - - const itemShippingProfileMap = order.items.reduce( - (acc, item) => { - acc[item.id] = item.variant?.product?.shipping_profile?.id - return acc - }, - {} as Record - ) - - const items = Object.entries(data.quantity) - .filter( - ([id, value]) => - !!value && itemShippingProfileMap[id] === selectedShippingProfileId - ) + let items = Object.entries(data.quantity) .map(([id, quantity]) => ({ id, quantity, })) + .filter(({ quantity }) => !!quantity) - if (!items.length) { - toast.error(t("orders.fulfillment.error.noItems")) - return + /** + * If items require shipping fulfill only items with matching shipping profile. + */ + if (requiresShipping) { + const selectedShippingProfileId = + selectedShippingOption?.shipping_profile_id + + const itemShippingProfileMap = order.items.reduce((acc, item) => { + acc[item.id] = item.variant?.product?.shipping_profile?.id + return acc + }, {} as any) + + items = items.filter( + ({ id }) => itemShippingProfileMap[id] === selectedShippingProfileId + ) } const payload: HttpTypes.AdminCreateOrderFulfillment = { @@ -357,7 +355,9 @@ export function OrderCreateFulfillmentForm({ form={form} item={item} locationId={selectedLocationId} - disabled={!isShippingProfileMatching} + disabled={ + requiresShipping && !isShippingProfileMatching + } itemReservedQuantitiesMap={ itemReservedQuantitiesMap } diff --git a/packages/cli/create-medusa-app/package.json b/packages/cli/create-medusa-app/package.json index b3c784fe73..a47c120d3f 100644 --- a/packages/cli/create-medusa-app/package.json +++ b/packages/cli/create-medusa-app/package.json @@ -13,7 +13,7 @@ "watch": "tsc --watch" }, "dependencies": { - "@medusajs/telemetry": "^2.6.0", + "@medusajs/telemetry": "2.6.0", "boxen": "^5", "chalk": "^5.2.0", "commander": "^10.0.1", diff --git a/packages/cli/medusa-cli/package.json b/packages/cli/medusa-cli/package.json index 3c839eda2d..cc0301e0aa 100644 --- a/packages/cli/medusa-cli/package.json +++ b/packages/cli/medusa-cli/package.json @@ -46,7 +46,7 @@ "typescript": "^5.6.2" }, "dependencies": { - "@medusajs/telemetry": "^2.6.0", + "@medusajs/telemetry": "2.6.0", "@medusajs/utils": "2.6.0", "@types/express": "^4.17.17", "chalk": "^4.0.0", diff --git a/packages/cli/oas/medusa-oas-cli/package.json b/packages/cli/oas/medusa-oas-cli/package.json index dc0c6547fe..4fce5504e0 100644 --- a/packages/cli/oas/medusa-oas-cli/package.json +++ b/packages/cli/oas/medusa-oas-cli/package.json @@ -21,7 +21,7 @@ "author": "Medusa", "license": "MIT", "devDependencies": { - "@medusajs/types": "^2.6.0", + "@medusajs/types": "2.6.0", "@types/js-yaml": "^4.0.9", "jest": "^29.1.0", "js-yaml": "^4.1.0", @@ -35,8 +35,8 @@ "medusa-oas": "ts-node src/index.ts" }, "dependencies": { - "@medusajs/medusa": "^2.6.0", - "@medusajs/utils": "^2.6.0", + "@medusajs/medusa": "2.6.0", + "@medusajs/utils": "2.6.0", "@readme/json-schema-ref-parser": "^1.2.0", "@readme/openapi-parser": "^2.4.0", "@redocly/cli": "^1.7.0", diff --git a/packages/core/core-flows/package.json b/packages/core/core-flows/package.json index 5e9c62eb38..0b48b9719c 100644 --- a/packages/core/core-flows/package.json +++ b/packages/core/core-flows/package.json @@ -26,7 +26,7 @@ "author": "Medusa", "license": "MIT", "devDependencies": { - "@medusajs/framework": "^2.6.0", + "@medusajs/framework": "2.6.0", "@mikro-orm/core": "6.4.3", "@mikro-orm/knex": "6.4.3", "@mikro-orm/migrations": "6.4.3", @@ -44,7 +44,7 @@ "json-2-csv": "^5.5.4" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0", + "@medusajs/framework": "2.6.0", "awilix": "^8.0.1" }, "scripts": { diff --git a/packages/core/core-flows/src/cart/steps/set-tax-lines-for-items.ts b/packages/core/core-flows/src/cart/steps/set-tax-lines-for-items.ts index 635490726a..10df4f4d21 100644 --- a/packages/core/core-flows/src/cart/steps/set-tax-lines-for-items.ts +++ b/packages/core/core-flows/src/cart/steps/set-tax-lines-for-items.ts @@ -6,7 +6,7 @@ import { ItemTaxLineDTO, ShippingTaxLineDTO, } from "@medusajs/framework/types" -import { Modules } from "@medusajs/framework/utils" +import { Modules, promiseAll } from "@medusajs/framework/utils" import { StepResponse, createStep } from "@medusajs/framework/workflows-sdk" /** @@ -30,13 +30,13 @@ export interface SetTaxLinesForItemsStepInput { export const setTaxLinesForItemsStepId = "set-tax-lines-for-items" /** * This step sets the tax lines of shipping methods and line items in a cart. - * + * * :::tip - * + * * You can use the {@link retrieveCartStep} to retrieve a cart's details. - * + * * ::: - * + * * @example * const data = setTaxLinesForItemsStep({ * // retrieve the details of the cart from another workflow @@ -64,21 +64,31 @@ export const setTaxLinesForItemsStep = createStep( const { cart, item_tax_lines, shipping_tax_lines } = data const cartService = container.resolve(Modules.CART) - const existingShippingMethodTaxLines = - await cartService.listShippingMethodTaxLines({ - shipping_method_id: shipping_tax_lines.map((t) => t.shipping_line_id), - }) + const [existingShippingMethodTaxLines, existingLineItemTaxLines] = + await promiseAll([ + shipping_tax_lines.length + ? cartService.listShippingMethodTaxLines({ + shipping_method_id: shipping_tax_lines.map( + (t) => t.shipping_line_id + ), + }) + : [], - const existingLineItemTaxLines = await cartService.listLineItemTaxLines({ - item_id: item_tax_lines.map((t) => t.line_item_id), - }) + item_tax_lines.length + ? cartService.listLineItemTaxLines({ + item_id: item_tax_lines.map((t) => t.line_item_id), + }) + : [], + ]) const itemsTaxLinesData = normalizeItemTaxLinesForCart(item_tax_lines) - await cartService.setLineItemTaxLines(cart.id, itemsTaxLinesData) - const shippingTaxLinesData = normalizeShippingTaxLinesForCart(shipping_tax_lines) - await cartService.setShippingMethodTaxLines(cart.id, shippingTaxLinesData) + + await promiseAll([ + cartService.setLineItemTaxLines(cart.id, itemsTaxLinesData), + cartService.setShippingMethodTaxLines(cart.id, shippingTaxLinesData), + ]) return new StepResponse(null, { cart, diff --git a/packages/core/core-flows/src/cart/steps/upsert-tax-lines-for-items.ts b/packages/core/core-flows/src/cart/steps/upsert-tax-lines-for-items.ts new file mode 100644 index 0000000000..d04eabfdf2 --- /dev/null +++ b/packages/core/core-flows/src/cart/steps/upsert-tax-lines-for-items.ts @@ -0,0 +1,176 @@ +import { + CartWorkflowDTO, + CreateLineItemTaxLineDTO, + CreateShippingMethodTaxLineDTO, + ICartModuleService, + ItemTaxLineDTO, + LineItemTaxLineDTO, + ShippingMethodTaxLineDTO, + ShippingTaxLineDTO, +} from "@medusajs/framework/types" +import { Modules, promiseAll } from "@medusajs/framework/utils" +import { StepResponse, createStep } from "@medusajs/framework/workflows-sdk" + +/** + * The details of the tax lines to set in a cart. + */ +export interface SetTaxLinesForItemsStepInput { + /** + * The cart's details. + */ + cart: CartWorkflowDTO + /** + * The tax lines to set for line items. + */ + item_tax_lines: ItemTaxLineDTO[] + /** + * The tax lines to set for shipping methods. + */ + shipping_tax_lines: ShippingTaxLineDTO[] +} + +export const upsertTaxLinesForItemsStepId = "set-tax-lines-for-items" +/** + * This step sets the tax lines of shipping methods and line items in a cart. + * + * :::tip + * + * You can use the {@link retrieveCartStep} to retrieve a cart's details. + * + * ::: + * + * @example + * const data = upsertTaxLinesForItemsStep({ + * // retrieve the details of the cart from another workflow + * // or in another step using the Cart Module's service + * cart, + * "item_tax_lines": [{ + * "rate": 48, + * "code": "CODE123", + * "name": "Tax rate 2", + * "provider_id": "provider_1", + * "line_item_id": "litem_123" + * }], + * "shipping_tax_lines": [{ + * "rate": 49, + * "code": "CODE456", + * "name": "Tax rate 1", + * "provider_id": "provider_1", + * "shipping_line_id": "sm_123" + * }] + * }) + */ +export const upsertTaxLinesForItemsStep = createStep( + upsertTaxLinesForItemsStepId, + async (data: SetTaxLinesForItemsStepInput, { container }) => { + const { cart, item_tax_lines, shipping_tax_lines } = data + const cartService = container.resolve(Modules.CART) + + const [existingShippingMethodTaxLines, existingLineItemTaxLines] = + await promiseAll([ + shipping_tax_lines.length + ? cartService.listShippingMethodTaxLines({ + shipping_method_id: shipping_tax_lines.map( + (t) => t.shipping_line_id + ), + }) + : [], + + item_tax_lines.length + ? cartService.listLineItemTaxLines({ + item_id: item_tax_lines.map((t) => t.line_item_id), + }) + : [], + ]) + + const itemsTaxLinesData = normalizeItemTaxLinesForCart( + item_tax_lines, + existingLineItemTaxLines + ) + const shippingTaxLinesData = normalizeShippingTaxLinesForCart( + shipping_tax_lines, + existingShippingMethodTaxLines + ) + + await promiseAll([ + itemsTaxLinesData.length + ? cartService.upsertLineItemTaxLines(itemsTaxLinesData) + : [], + shippingTaxLinesData.length + ? cartService.upsertShippingMethodTaxLines(shippingTaxLinesData) + : [], + ]) + + return new StepResponse(null, { + cart, + existingLineItemTaxLines, + existingShippingMethodTaxLines, + }) + }, + async (revertData, { container }) => { + if (!revertData) { + return + } + + const { existingLineItemTaxLines, existingShippingMethodTaxLines } = + revertData + + const cartService = container.resolve(Modules.CART) + + if (existingLineItemTaxLines) { + await cartService.upsertLineItemTaxLines( + existingLineItemTaxLines.map((taxLine) => ({ + description: taxLine.description, + tax_rate_id: taxLine.tax_rate_id, + code: taxLine.code, + rate: taxLine.rate, + provider_id: taxLine.provider_id, + item_id: taxLine.item_id, + })) + ) + } + + await cartService.upsertShippingMethodTaxLines( + existingShippingMethodTaxLines.map((taxLine) => ({ + description: taxLine.description, + tax_rate_id: taxLine.tax_rate_id, + code: taxLine.code, + rate: taxLine.rate, + provider_id: taxLine.provider_id, + shipping_method_id: taxLine.shipping_method_id, + })) + ) + } +) + +function normalizeItemTaxLinesForCart( + taxLines: ItemTaxLineDTO[], + existingTaxLines: LineItemTaxLineDTO[] +): CreateLineItemTaxLineDTO[] { + return taxLines.map((taxLine: ItemTaxLineDTO & { id?: string }) => ({ + id: existingTaxLines.find((t) => t.item_id === taxLine.line_item_id)?.id, + description: taxLine.name, + tax_rate_id: taxLine.rate_id, + code: taxLine.code!, + rate: taxLine.rate!, + provider_id: taxLine.provider_id, + item_id: taxLine.line_item_id, + })) +} + +function normalizeShippingTaxLinesForCart( + taxLines: ShippingTaxLineDTO[], + existingTaxLines: ShippingMethodTaxLineDTO[] +): CreateShippingMethodTaxLineDTO[] { + return taxLines.map((taxLine: ShippingTaxLineDTO & { id?: string }) => ({ + id: existingTaxLines.find( + (t) => t.shipping_method_id === taxLine.shipping_line_id + )?.id, + description: taxLine.name, + tax_rate_id: taxLine.rate_id, + code: taxLine.code!, + rate: taxLine.rate!, + provider_id: taxLine.provider_id, + shipping_method_id: taxLine.shipping_line_id, + })) +} diff --git a/packages/core/core-flows/src/cart/workflows/add-shipping-method-to-cart.ts b/packages/core/core-flows/src/cart/workflows/add-shipping-method-to-cart.ts index dfb991dedb..f0efa838d1 100644 --- a/packages/core/core-flows/src/cart/workflows/add-shipping-method-to-cart.ts +++ b/packages/core/core-flows/src/cart/workflows/add-shipping-method-to-cart.ts @@ -39,7 +39,7 @@ export interface AddShippingMethodToCartWorkflowInput { id: string /** * Custom data useful for the fulfillment provider processing the shipping option or method. - * + * * Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property). */ data?: Record @@ -48,11 +48,11 @@ export interface AddShippingMethodToCartWorkflowInput { export const addShippingMethodToCartWorkflowId = "add-shipping-method-to-cart" /** - * This workflow adds a shipping method to a cart. It's executed by the + * This workflow adds a shipping method to a cart. It's executed by the * [Add Shipping Method Store API Route](https://docs.medusajs.com/api/store#carts_postcartsidshippingmethods). - * + * * You can use this workflow within your own customizations or custom workflows, allowing you to wrap custom logic around adding a shipping method to the cart. - * + * * @example * const { result } = await addShippingMethodToCartWorkflow(container) * .run({ @@ -71,11 +71,11 @@ export const addShippingMethodToCartWorkflowId = "add-shipping-method-to-cart" * ] * } * }) - * + * * @summary - * + * * Add a shipping method to a cart. - * + * * @property hooks.validate - This hook is executed before all operations. You can consume this hook to perform any custom validation. If validation fails, you can throw an error to stop the workflow execution. */ export const addShippingMethodToCartWorkflow = createWorkflow( @@ -186,7 +186,7 @@ export const addShippingMethodToCartWorkflow = createWorkflow( cart.shipping_methods.map((sm) => sm.id) ) - parallelize( + const [, createdShippingMethods] = parallelize( removeShippingMethodFromCartStep({ shipping_method_ids: currentShippingMethods, }), @@ -200,7 +200,7 @@ export const addShippingMethodToCartWorkflow = createWorkflow( ) refreshCartItemsWorkflow.runAsStep({ - input: { cart_id: cart.id }, + input: { cart_id: cart.id, shipping_methods: createdShippingMethods }, }) return new WorkflowResponse(void 0, { diff --git a/packages/core/core-flows/src/cart/workflows/add-to-cart.ts b/packages/core/core-flows/src/cart/workflows/add-to-cart.ts index 3d566be1bd..554856dfe3 100644 --- a/packages/core/core-flows/src/cart/workflows/add-to-cart.ts +++ b/packages/core/core-flows/src/cart/workflows/add-to-cart.ts @@ -173,7 +173,7 @@ export const addToCartWorkflow = createWorkflow( }, }) - parallelize( + const [createdLineItems, updatedLineItems] = parallelize( createLineItemsStep({ id: cart.id, items: itemsToCreate, @@ -184,8 +184,15 @@ export const addToCartWorkflow = createWorkflow( }) ) + const allItems = transform( + { createdLineItems, updatedLineItems }, + ({ createdLineItems = [], updatedLineItems = [] }) => { + return createdLineItems.concat(updatedLineItems) + } + ) + refreshCartItemsWorkflow.runAsStep({ - input: { cart_id: cart.id }, + input: { cart_id: cart.id, items: allItems }, }) emitEventStep({ diff --git a/packages/core/core-flows/src/cart/workflows/refresh-cart-items.ts b/packages/core/core-flows/src/cart/workflows/refresh-cart-items.ts index 701e93cfe8..b64b090cc6 100644 --- a/packages/core/core-flows/src/cart/workflows/refresh-cart-items.ts +++ b/packages/core/core-flows/src/cart/workflows/refresh-cart-items.ts @@ -26,6 +26,7 @@ import { refreshCartShippingMethodsWorkflow } from "./refresh-cart-shipping-meth import { refreshPaymentCollectionForCartWorkflow } from "./refresh-payment-collection" import { updateCartPromotionsWorkflow } from "./update-cart-promotions" import { updateTaxLinesWorkflow } from "./update-tax-lines" +import { upsertTaxLinesWorkflow } from "./upsert-tax-lines" /** * The details of the cart to refresh. @@ -44,6 +45,23 @@ export type RefreshCartItemsWorkflowInput = { * Force refresh the cart items */ force_refresh?: boolean + + /** + * The items to refresh. + */ + items?: any[] + + /** + * The shipping methods to refresh. + */ + shipping_methods?: any[] + + /** + * Whether to force re-calculating tax amounts, which + * may include sending requests to a third-part tax provider, depending + * on the configurations of the cart's tax region. + */ + force_tax_calculation?: boolean } export const refreshCartItemsWorkflowId = "refresh-cart-items" @@ -162,8 +180,33 @@ export const refreshCartItemsWorkflow = createWorkflow( input: refreshCartInput, }) - updateTaxLinesWorkflow.runAsStep({ - input: refreshCartInput, + when({ input }, ({ input }) => { + return !!input.force_refresh + }).then(() => { + updateTaxLinesWorkflow.runAsStep({ + input: refreshCartInput, + }) + }) + + when({ input }, ({ input }) => { + return ( + !input.force_refresh && + (!!input.items?.length || !!input.shipping_methods?.length) + ) + }).then(() => { + upsertTaxLinesWorkflow.runAsStep({ + input: transform( + { refetchedCart, input }, + ({ refetchedCart, input }) => { + return { + cart: refetchedCart, + items: input.items ?? [], + shipping_methods: input.shipping_methods ?? [], + force_tax_calculation: input.force_tax_calculation, + } + } + ), + }) }) const cartPromoCodes = transform( diff --git a/packages/core/core-flows/src/cart/workflows/upsert-tax-lines.ts b/packages/core/core-flows/src/cart/workflows/upsert-tax-lines.ts new file mode 100644 index 0000000000..d297b2a45c --- /dev/null +++ b/packages/core/core-flows/src/cart/workflows/upsert-tax-lines.ts @@ -0,0 +1,154 @@ +import { + CartLineItemDTO, + CartShippingMethodDTO, +} from "@medusajs/framework/types" +import { + WorkflowData, + createWorkflow, + transform, + when, +} from "@medusajs/framework/workflows-sdk" +import { useRemoteQueryStep } from "../../common" +import { getItemTaxLinesStep } from "../../tax/steps/get-item-tax-lines" +import { upsertTaxLinesForItemsStep } from "../steps/upsert-tax-lines-for-items" + +const cartFields = [ + "id", + "currency_code", + "email", + "region.id", + "region.automatic_taxes", + "items.id", + "items.variant_id", + "items.product_id", + "items.product_title", + "items.product_description", + "items.product_subtitle", + "items.product_type", + "items.product_type_id", + "items.product_collection", + "items.product_handle", + "items.variant_sku", + "items.variant_barcode", + "items.variant_title", + "items.title", + "items.quantity", + "items.unit_price", + "items.tax_lines.id", + "items.tax_lines.description", + "items.tax_lines.code", + "items.tax_lines.rate", + "items.tax_lines.provider_id", + "shipping_methods.tax_lines.id", + "shipping_methods.tax_lines.description", + "shipping_methods.tax_lines.code", + "shipping_methods.tax_lines.rate", + "shipping_methods.tax_lines.provider_id", + "shipping_methods.shipping_option_id", + "shipping_methods.amount", + "customer.id", + "customer.email", + "customer.metadata", + "customer.groups.id", + "shipping_address.id", + "shipping_address.address_1", + "shipping_address.address_2", + "shipping_address.city", + "shipping_address.postal_code", + "shipping_address.country_code", + "shipping_address.region_code", + "shipping_address.province", + "shipping_address.metadata", +] + +/** + * The details of the cart to upsert tax lines for. + */ +export type UpsertTaxLinesWorkflowInput = { + /** + * The cart's ID. + */ + cart_id?: string + /** + * The Cart reference. + */ + cart?: any + /** + * The items to upsert their tax lines. + * If not specified, taxes are upsertd for all of the cart's + * line items. + */ + items: CartLineItemDTO[] + /** + * The shipping methods to upsert their tax lines. + * If not specified, taxes are upsertd for all of the cart's + * shipping methods. + */ + shipping_methods: CartShippingMethodDTO[] + + /** + * Whether to force re-calculating tax amounts, which + * may include sending requests to a third-part tax provider, depending + * on the configurations of the cart's tax region. + * + * @defaultValue false + */ + force_tax_calculation?: boolean +} + +export const upsertTaxLinesWorkflowId = "upsert-tax-lines" +/** + * This workflow upserts a cart's tax lines that are applied on line items and shipping methods. You can upsert the line item's quantity, unit price, and more. This workflow is executed + * by the [Calculate Taxes Store API Route](https://docs.medusajs.com/api/store#carts_postcartsidtaxes). + * + * You can use this workflow within your own customizations or custom workflows, allowing you to upsert a cart's tax lines in your custom flows. + * + * @example + * const { result } = await upsertTaxLinesWorkflow(container) + * .run({ + * input: { + * cart_id: "cart_123", + * items: [], + * shipping_methods: [], + * } + * }) + * + * @summary + * + * Update a cart's tax lines. + */ +export const upsertTaxLinesWorkflow = createWorkflow( + upsertTaxLinesWorkflowId, + (input: WorkflowData): WorkflowData => { + const fetchCart = when({ input }, ({ input }) => { + return !input.cart + }).then(() => { + return useRemoteQueryStep({ + entry_point: "cart", + fields: cartFields, + variables: { id: input.cart_id }, + throw_if_key_not_found: true, + list: false, + }) + }) + + const cart = transform({ fetchCart, input }, ({ fetchCart, input }) => { + return input.cart ?? fetchCart + }) + + const taxLineItems = getItemTaxLinesStep( + transform({ input, cart }, (data) => ({ + orderOrCart: data.cart, + items: data.input.items ?? [], + shipping_methods: data.input.shipping_methods ?? [], + force_tax_calculation: data.input.force_tax_calculation, + })) + ) + + upsertTaxLinesForItemsStep({ + cart, + item_tax_lines: taxLineItems.lineItemTaxLines, + shipping_tax_lines: taxLineItems.shippingMethodsTaxLines, + }) + } +) diff --git a/packages/core/core-flows/src/order/workflows/claim/claim-add-new-item.ts b/packages/core/core-flows/src/order/workflows/claim/claim-add-new-item.ts index d46d366612..6d21deaa08 100644 --- a/packages/core/core-flows/src/order/workflows/claim/claim-add-new-item.ts +++ b/packages/core/core-flows/src/order/workflows/claim/claim-add-new-item.ts @@ -42,16 +42,16 @@ export type OrderClaimAddNewItemValidationStepInput = { } /** - * This step validates that new items can be added to the claim. If the + * This step validates that new items can be added to the claim. If the * order or claim is canceled, or the order change is not active, the step will throw an error. - * + * * :::note - * + * * You can retrieve an order, order claim, and order change details using [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query), * or [useQueryGraphStep](https://docs.medusajs.com/resources/references/medusa-workflows/steps/useQueryGraphStep). - * + * * ::: - * + * * @example * const data = orderClaimAddNewItemValidationStep({ * order: { @@ -85,10 +85,10 @@ export const orderClaimAddNewItemWorkflowId = "claim-add-new-item" /** * This workflow adds outbound (or new) items to a claim. It's used by the * [Add Outbound Items Admin API Route](https://docs.medusajs.com/api/admin#claims_postclaimsidoutbounditems). - * + * * You can use this workflow within your customizations or your own custom workflows, allowing you to add outbound items to a claim * in your custom flows. - * + * * @example * const { result } = await orderClaimAddNewItemWorkflow(container) * .run({ @@ -102,9 +102,9 @@ export const orderClaimAddNewItemWorkflowId = "claim-add-new-item" * ] * } * }) - * + * * @summary - * + * * Add outbound or new items to a claim. */ export const orderClaimAddNewItemWorkflow = createWorkflow( diff --git a/packages/core/core-flows/src/order/workflows/claim/confirm-claim-request.ts b/packages/core/core-flows/src/order/workflows/claim/confirm-claim-request.ts index 599b4f9a71..5a76267626 100644 --- a/packages/core/core-flows/src/order/workflows/claim/confirm-claim-request.ts +++ b/packages/core/core-flows/src/order/workflows/claim/confirm-claim-request.ts @@ -239,7 +239,7 @@ function extractShippingOption({ orderPreview, orderClaim, returnId }) { for (const action of modifiedShippingMethod_.actions) { if (action.action === ChangeActionType.SHIPPING_ADD) { - if (action.return?.id === returnId) { + if (!!action.return_id && action.return_id === returnId) { returnShippingMethod = shippingMethod } else if (action.claim_id === orderClaim.id) { claimShippingMethod = shippingMethod diff --git a/packages/core/core-flows/src/order/workflows/create-fulfillment.ts b/packages/core/core-flows/src/order/workflows/create-fulfillment.ts index 4a764fa07d..bb71875344 100644 --- a/packages/core/core-flows/src/order/workflows/create-fulfillment.ts +++ b/packages/core/core-flows/src/order/workflows/create-fulfillment.ts @@ -241,10 +241,14 @@ function prepareInventoryUpdate({ }[] = [] const allItems = itemsList ?? order.items - for (const item of allItems) { + const itemsToFulfill = allItems.filter((i) => i.id in inputItemsMap) + + // iterate over items that are being fulfilled + for (const item of itemsToFulfill) { const reservation = reservationMap[item.id] + if (!reservation) { - if (item.manage_inventory) { + if (item.variant?.manage_inventory) { throw new Error( `No stock reservation found for item ${item.id} - ${item.title} (${item.variant_title})` ) @@ -345,6 +349,7 @@ export const createOrderFulfillmentWorkflow = createWorkflow( "items.variant.height", "items.variant.width", "items.variant.material", + "items.variant_title", "shipping_address.*", "shipping_methods.id", "shipping_methods.shipping_option_id", @@ -394,9 +399,11 @@ export const createOrderFulfillmentWorkflow = createWorkflow( }).config({ name: "get-shipping-option" }) const lineItemIds = transform( - { order, itemsList: input.items_list }, - ({ order, itemsList }) => { - return (itemsList ?? order.items)!.map((i) => i.id) + { order, itemsList: input.items_list, inputItemsMap }, + ({ order, itemsList, inputItemsMap }) => { + return (itemsList ?? order.items)! + .map((i) => i.id) + .filter((i) => i in inputItemsMap) } ) const reservations = useRemoteQueryStep({ diff --git a/packages/core/core-flows/src/product/workflows/batch-products.ts b/packages/core/core-flows/src/product/workflows/batch-products.ts index 9354c154ed..2954cde1c4 100644 --- a/packages/core/core-flows/src/product/workflows/batch-products.ts +++ b/packages/core/core-flows/src/product/workflows/batch-products.ts @@ -11,6 +11,7 @@ import { createWorkflow, parallelize, transform, + when, } from "@medusajs/framework/workflows-sdk" import { createProductsWorkflow } from "./create-products" import { deleteProductsWorkflow } from "./delete-products" @@ -19,19 +20,36 @@ import { updateProductsWorkflow } from "./update-products" /** * The products to manage. */ -export interface BatchProductWorkflowInput extends BatchWorkflowInput< - CreateProductWorkflowInputDTO, - UpdateProductWorkflowInputDTO -> {} +export interface BatchProductWorkflowInput + extends BatchWorkflowInput< + CreateProductWorkflowInputDTO, + UpdateProductWorkflowInputDTO + > {} + +const conditionallyCreateProducts = (input: BatchProductWorkflowInput) => + when({ input }, ({ input }) => !!input.create?.length).then(() => + createProductsWorkflow.runAsStep({ input: { products: input.create! } }) + ) + +const conditionallyUpdateProducts = (input: BatchProductWorkflowInput) => + when({ input }, ({ input }) => !!input.update?.length).then(() => + updateProductsWorkflow.runAsStep({ input: { products: input.update! } }) + ) + +const conditionallyDeleteProducts = (input: BatchProductWorkflowInput) => + when({ input }, ({ input }) => !!input.delete?.length).then(() => + deleteProductsWorkflow.runAsStep({ input: { ids: input.delete! } }) + ) + export const batchProductsWorkflowId = "batch-products" /** * This workflow creates, updates, or deletes products. It's used by the * [Manage Products Admin API Route](https://docs.medusajs.com/api/admin#products_postproductsbatch). - * + * * You can use this workflow within your own customizations or custom workflows to manage products in bulk. This is * also useful when writing a [seed script](https://docs.medusajs.com/learn/fundamentals/custom-cli-scripts/seed-data) or a custom import script. - * + * * @example * const { result } = await batchProductsWorkflow(container) * .run({ @@ -68,11 +86,11 @@ export const batchProductsWorkflowId = "batch-products" * } * ], * delete: ["prod_321"] - * } + * } * }) - * + * * @summary - * + * * Manage products in bulk. */ export const batchProductsWorkflow = createWorkflow( @@ -81,22 +99,16 @@ export const batchProductsWorkflow = createWorkflow( input: WorkflowData ): WorkflowResponse> => { const res = parallelize( - createProductsWorkflow.runAsStep({ - input: { products: input.create ?? [] }, - }), - updateProductsWorkflow.runAsStep({ - input: { products: input.update ?? [] }, - }), - deleteProductsWorkflow.runAsStep({ - input: { ids: input.delete ?? [] }, - }) + conditionallyCreateProducts(input), + conditionallyUpdateProducts(input), + conditionallyDeleteProducts(input) ) return new WorkflowResponse( transform({ res, input }, (data) => { return { - created: data.res[0], - updated: data.res[1], + created: data.res[0] ?? [], + updated: data.res[1] ?? [], deleted: data.input.delete ?? [], } }) diff --git a/packages/core/core-flows/src/tax/steps/get-item-tax-lines.ts b/packages/core/core-flows/src/tax/steps/get-item-tax-lines.ts index 71ba06ccdb..b1e377f0e5 100644 --- a/packages/core/core-flows/src/tax/steps/get-item-tax-lines.ts +++ b/packages/core/core-flows/src/tax/steps/get-item-tax-lines.ts @@ -129,14 +129,14 @@ function normalizeLineItemsForShipping( export const getItemTaxLinesStepId = "get-item-tax-lines" /** * This step retrieves the tax lines for an order or cart's line items and shipping methods. - * + * * :::note - * + * * You can retrieve an order, cart, item, shipping method, and address details using [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query), * or [useQueryGraphStep](https://docs.medusajs.com/resources/references/medusa-workflows/steps/useQueryGraphStep). - * + * * ::: - * + * * @example * const data = getItemTaxLinesStep({ * orderOrCart: { diff --git a/packages/core/framework/package.json b/packages/core/framework/package.json index 26de7b5e5c..eccbf93319 100644 --- a/packages/core/framework/package.json +++ b/packages/core/framework/package.json @@ -54,7 +54,7 @@ "test": "jest --runInBand --bail --forceExit -- src/**/__tests__/**/*.ts" }, "devDependencies": { - "@medusajs/cli": "^2.6.0", + "@medusajs/cli": "2.6.0", "@mikro-orm/core": "6.4.3", "@mikro-orm/knex": "6.4.3", "@mikro-orm/migrations": "6.4.3", @@ -74,12 +74,12 @@ }, "dependencies": { "@jercle/yargonaut": "^1.1.5", - "@medusajs/modules-sdk": "^2.6.0", - "@medusajs/orchestration": "^2.6.0", - "@medusajs/telemetry": "^2.6.0", - "@medusajs/types": "^2.6.0", - "@medusajs/utils": "^2.6.0", - "@medusajs/workflows-sdk": "^2.6.0", + "@medusajs/modules-sdk": "2.6.0", + "@medusajs/orchestration": "2.6.0", + "@medusajs/telemetry": "2.6.0", + "@medusajs/types": "2.6.0", + "@medusajs/utils": "2.6.0", + "@medusajs/workflows-sdk": "2.6.0", "@opentelemetry/api": "^1.9.0", "@types/express": "^4.17.17", "chokidar": "^3.4.2", @@ -98,7 +98,7 @@ "zod": "3.22.4" }, "peerDependencies": { - "@medusajs/cli": "^2.4.0", + "@medusajs/cli": "2.6.0", "@mikro-orm/cli": "6.4.3", "@mikro-orm/core": "6.4.3", "@mikro-orm/knex": "6.4.3", diff --git a/packages/core/framework/src/http/__fixtures__/routers/store/custom/route.ts b/packages/core/framework/src/http/__fixtures__/routers/store/custom/route.ts new file mode 100644 index 0000000000..bf62cefe1c --- /dev/null +++ b/packages/core/framework/src/http/__fixtures__/routers/store/custom/route.ts @@ -0,0 +1,3 @@ +export function GET(req, res) { + res.send("Hello from store custom route") +} diff --git a/packages/core/framework/src/http/__fixtures__/server/index.ts b/packages/core/framework/src/http/__fixtures__/server/index.ts index dba58cb86c..7180c3bd2f 100644 --- a/packages/core/framework/src/http/__fixtures__/server/index.ts +++ b/packages/core/framework/src/http/__fixtures__/server/index.ts @@ -110,6 +110,7 @@ export const createServer = async (rootDir) => { `${url}${queryParams ? "?" + queryParams : ""}` ) headers.Cookie = headers.Cookie || "" + if (opts.adminSession) { const token = generateJwtToken( { diff --git a/packages/core/framework/src/http/__tests__/index.spec.ts b/packages/core/framework/src/http/__tests__/index.spec.ts index 4a8ea7dc65..ec7c835e7b 100644 --- a/packages/core/framework/src/http/__tests__/index.spec.ts +++ b/packages/core/framework/src/http/__tests__/index.spec.ts @@ -46,12 +46,83 @@ describe("RoutesLoader", function () { }) expect(res.status).toBe(500) - console.log(res) expect(res.text).toBe( '{"code":"unknown_error","type":"unknown_error","message":"An unknown error occurred."}' ) }) + it("should not succeed on cors preflight admin request failing", async function () { + const res = await request("OPTIONS", "/admin/orders", { + headers: { + origin: "http://localhost:3000", + "access-control-request-method": "GET", + }, + adminSession: { + jwt: { + userId: "admin_user", + }, + }, + }) + + expect(res.status).toBe(204) + expect(res.headers["access-control-allow-origin"]).not.toBeTruthy() + }) + + it("should not succeed on cors preflight store request failing", async function () { + const res = await request("OPTIONS", "/store/custom", { + headers: { + origin: "http://localhost:3000", + "access-control-request-method": "GET", + }, + adminSession: { + jwt: { + userId: "admin_user", + }, + }, + }) + + expect(res.status).toBe(204) + expect(res.headers["access-control-allow-origin"]).not.toBeTruthy() + }) + + it("should succeed on cors preflight admin request", async function () { + const res = await request("OPTIONS", "/admin/orders", { + headers: { + origin: "http://localhost:7001", + "access-control-request-method": "GET", + }, + adminSession: { + jwt: { + userId: "admin_user", + }, + }, + }) + + expect(res.status).toBe(204) + expect(res.headers["access-control-allow-origin"]).toBe( + "http://localhost:7001" + ) + }) + + it("should succeed on cors preflight store request", async function () { + const res = await request("OPTIONS", "/store/custom", { + headers: { + origin: "http://localhost:8000", + "access-control-request-method": "GET", + }, + adminSession: { + jwt: { + userId: "admin_user", + }, + }, + }) + + expect(res.status).toBe(204) + expect(res.headers["access-control-allow-origin"]).toBe( + "http://localhost:8000" + ) + }) + it("should return a status 200 on GET admin/order/:id", async function () { const res = await request("GET", "/admin/orders/1000", { adminSession: { diff --git a/packages/core/framework/src/http/__tests__/routes-loader.spec.ts b/packages/core/framework/src/http/__tests__/routes-loader.spec.ts index 8ae0f86c9d..bc1df429e5 100644 --- a/packages/core/framework/src/http/__tests__/routes-loader.spec.ts +++ b/packages/core/framework/src/http/__tests__/routes-loader.spec.ts @@ -201,6 +201,18 @@ describe("Routes loader", () => { "shouldAppendAuthCors": false, "shouldAppendStoreCors": false, }, + { + "absolutePath": "${BASE_DIR}/store/custom/route.ts", + "handler": [Function], + "isRoute": true, + "matcher": "/store/custom", + "method": "GET", + "optedOutOfAuth": false, + "relativePath": "/store/custom/route.ts", + "shouldAppendAdminCors": false, + "shouldAppendAuthCors": false, + "shouldAppendStoreCors": true, + }, ] `) }) @@ -409,6 +421,18 @@ describe("Routes loader", () => { "shouldAppendAuthCors": false, "shouldAppendStoreCors": false, }, + { + "absolutePath": "${BASE_DIR}/store/custom/route.ts", + "handler": [Function], + "isRoute": true, + "matcher": "/store/custom", + "method": "GET", + "optedOutOfAuth": false, + "relativePath": "/store/custom/route.ts", + "shouldAppendAdminCors": false, + "shouldAppendAuthCors": false, + "shouldAppendStoreCors": true, + }, { "absolutePath": "${BASE_DIR_2}/store/[customer_id]/orders/[order_id]/route.ts", "handler": [Function], diff --git a/packages/core/framework/src/http/middlewares/ensure-publishable-api-key.ts b/packages/core/framework/src/http/middlewares/ensure-publishable-api-key.ts index e4ab7ebcb5..3ce2918f9a 100644 --- a/packages/core/framework/src/http/middlewares/ensure-publishable-api-key.ts +++ b/packages/core/framework/src/http/middlewares/ensure-publishable-api-key.ts @@ -19,14 +19,11 @@ export async function ensurePublishableApiKeyMiddleware( const publishableApiKey = req.get(PUBLISHABLE_KEY_HEADER) if (!isPresent(publishableApiKey)) { - try { - throw new MedusaError( - MedusaError.Types.NOT_ALLOWED, - `Publishable API key required in the request header: ${PUBLISHABLE_KEY_HEADER}. You can manage your keys in settings in the dashboard.` - ) - } catch (e) { - return next(e) - } + const error = new MedusaError( + MedusaError.Types.NOT_ALLOWED, + `Publishable API key required in the request header: ${PUBLISHABLE_KEY_HEADER}. You can manage your keys in settings in the dashboard.` + ) + return next(error) } let apiKey diff --git a/packages/core/framework/src/http/router.ts b/packages/core/framework/src/http/router.ts index acb4273b1c..02b57ff1b8 100644 --- a/packages/core/framework/src/http/router.ts +++ b/packages/core/framework/src/http/router.ts @@ -173,6 +173,7 @@ export class ApiLoader { return { origin: parseCorsOrigins(origin), credentials: true, + preflightContinue: false, } } @@ -194,11 +195,13 @@ export class ApiLoader { res, next ) { + let method: string = req.method + if (req.method === "OPTIONS") { + method = req.headers["access-control-request-method"] ?? req.method + } + const path = `${namespace}${req.path}` - const matchingRoute = routesFinder.find( - path, - req.method as MiddlewareVerb - ) + const matchingRoute = routesFinder.find(path, method as MiddlewareVerb) if (matchingRoute && matchingRoute[toggleKey] === true) { return corsFn(req, res, next) } @@ -213,7 +216,7 @@ export class ApiLoader { ? (ApiLoader.traceMiddleware(corsMiddleware, { route: namespace, }) as RequestHandler) - : cors(corsOptions) + : corsMiddleware ) } @@ -334,16 +337,17 @@ export class ApiLoader { "api-key", ]) - /** - * Publishable key check, CORS and auth setup for store routes. - */ - this.#applyStorePublishableKeyMiddleware("/store") this.#applyCorsMiddleware( routesFinder, "/store", "shouldAppendStoreCors", this.#createCorsOptions(configManager.config.projectConfig.http.storeCors) ) + /** + * Publishable key check, CORS and auth setup for store routes. + */ + this.#applyStorePublishableKeyMiddleware("/store") + this.#applyAuthMiddleware( routesFinder, "/store", diff --git a/packages/core/framework/src/http/routes-loader.ts b/packages/core/framework/src/http/routes-loader.ts index bcf4fc58bf..c9a05bd3c6 100644 --- a/packages/core/framework/src/http/routes-loader.ts +++ b/packages/core/framework/src/http/routes-loader.ts @@ -1,7 +1,7 @@ -import { join, parse, sep } from "path" import { dynamicImport, readDirRecursive } from "@medusajs/utils" +import { join, parse, sep } from "path" import { logger } from "../logger" -import { type RouteVerb, HTTP_METHODS, type RouteDescriptor } from "./types" +import { HTTP_METHODS, type RouteDescriptor, type RouteVerb } from "./types" /** * File name that is used to indicate that the file is a route file diff --git a/packages/core/js-sdk/package.json b/packages/core/js-sdk/package.json index fc4d319fdd..8b454c7028 100644 --- a/packages/core/js-sdk/package.json +++ b/packages/core/js-sdk/package.json @@ -35,7 +35,7 @@ "typescript": "^5.6.2" }, "dependencies": { - "@medusajs/types": "^2.6.0", + "@medusajs/types": "2.6.0", "fetch-event-stream": "^0.1.5", "qs": "^6.12.1" }, diff --git a/packages/core/js-sdk/src/admin/index.ts b/packages/core/js-sdk/src/admin/index.ts index 227ec715ec..f6c9b0d90a 100644 --- a/packages/core/js-sdk/src/admin/index.ts +++ b/packages/core/js-sdk/src/admin/index.ts @@ -128,7 +128,7 @@ export class Admin { */ public order: Order /** - * @tags draft order + * @tags order */ public draftOrder: DraftOrder /** diff --git a/packages/core/js-sdk/src/admin/product-collection.ts b/packages/core/js-sdk/src/admin/product-collection.ts index 4f4a1d64f9..f81aee9380 100644 --- a/packages/core/js-sdk/src/admin/product-collection.ts +++ b/packages/core/js-sdk/src/admin/product-collection.ts @@ -88,7 +88,7 @@ export class ProductCollection { * This method retrieves a paginated list of collections. It sends a request to the * [List Collections](https://docs.medusajs.com/api/admin#collections_getcollections) API route. * - * @param query - Filters and pagination configurations. + * @param queryParams - Filters and pagination configurations. * @param headers - Headers to pass in the request. * @returns The paginated list of collections. * diff --git a/packages/core/js-sdk/src/admin/product.ts b/packages/core/js-sdk/src/admin/product.ts index ca1aa4298e..286a5753d9 100644 --- a/packages/core/js-sdk/src/admin/product.ts +++ b/packages/core/js-sdk/src/admin/product.ts @@ -276,7 +276,7 @@ export class Product { * This method retrieves a paginated list of products. It sends a request to the * [List Products](https://docs.medusajs.com/api/admin#products_getproducts) API route. * - * @param query - Filters and pagination configurations. + * @param queryParams - Filters and pagination configurations. * @param headers - Headers to pass in the request. * @returns The paginated list of products. * diff --git a/packages/core/modules-sdk/package.json b/packages/core/modules-sdk/package.json index ff93bda8b9..74f3af16e5 100644 --- a/packages/core/modules-sdk/package.json +++ b/packages/core/modules-sdk/package.json @@ -45,9 +45,9 @@ "typescript": "^5.6.2" }, "dependencies": { - "@medusajs/orchestration": "^2.6.0", - "@medusajs/types": "^2.6.0", - "@medusajs/utils": "^2.6.0" + "@medusajs/orchestration": "2.6.0", + "@medusajs/types": "2.6.0", + "@medusajs/utils": "2.6.0" }, "peerDependencies": { "@mikro-orm/core": "6.4.3", diff --git a/packages/core/orchestration/package.json b/packages/core/orchestration/package.json index 14fb5f9efb..a89e40b6a6 100644 --- a/packages/core/orchestration/package.json +++ b/packages/core/orchestration/package.json @@ -39,8 +39,8 @@ "typescript": "^5.6.2" }, "dependencies": { - "@medusajs/types": "^2.6.0", - "@medusajs/utils": "^2.6.0" + "@medusajs/types": "2.6.0", + "@medusajs/utils": "2.6.0" }, "peerDependencies": { "@mikro-orm/core": "6.4.3", diff --git a/packages/core/types/src/cart/mutations.ts b/packages/core/types/src/cart/mutations.ts index b5b52a53e4..093e1047df 100644 --- a/packages/core/types/src/cart/mutations.ts +++ b/packages/core/types/src/cart/mutations.ts @@ -430,12 +430,24 @@ export interface UpdateTaxLineDTO { /** * The shipping method tax line to be created. */ -export interface CreateShippingMethodTaxLineDTO extends CreateTaxLineDTO {} +export interface CreateShippingMethodTaxLineDTO + extends Omit { + /** + * The associated shipping method's ID. + */ + shipping_method_id: string +} /** * The attributes to update in the shipping method tax line. */ -export interface UpdateShippingMethodTaxLineDTO extends UpdateTaxLineDTO {} +export interface UpdateShippingMethodTaxLineDTO + extends Omit { + /** + * The associated shipping method's ID. + */ + shipping_method_id?: string +} /** * The line item tax line to be created. diff --git a/packages/core/types/src/cart/service.ts b/packages/core/types/src/cart/service.ts index 9d4ac7dbd3..54232518ad 100644 --- a/packages/core/types/src/cart/service.ts +++ b/packages/core/types/src/cart/service.ts @@ -2075,4 +2075,123 @@ export interface ICartModuleService extends IModuleService { config?: RestoreReturn, sharedContext?: Context ): Promise | void> + + /** + * This method upserts line item adjustments. + * + * @param {UpsertLineItemAdjustmentDTO[]} data - The line item adjustments to create or update. If the `id` property is provided + * in an object, it means an existing line item adjustment will be updated. Otherwise, a new one is created. + * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module. + * @returns {Promise} The line item adjustments. + * + * @example + * const lineItemAdjustments = await orderModuleService.upsertLineItemAdjustments( + * [ + * { + * item_id: "1234", + * amount: 10 + * }, + * { + * id: "123", + * item_id: "4321", + * amount: 20 + * } + * ] + * ) + * + */ + upsertLineItemAdjustments( + data: UpsertLineItemAdjustmentDTO[], + sharedContext?: Context + ): Promise + + /** + * This method upserts shipping method adjustments. + * + * @param {(CreateShippingMethodAdjustmentDTO | UpdateShippingMethodAdjustmentDTO)[]} data - The shipping method adjustments to be created + * or updated. If an adjustment object has an `id` property, it's updated. Otherwise, a new adjustment is created. + * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module. + * @returns {Promise} The shipping method adjustments. + * + * @example + * const shippingMethodAdjustments = await orderModuleService + * .upsertShippingMethodAdjustments( + * [ + * { + * shipping_method_id: "123", + * code: "50OFF", + * amount: 5 + * }, + * { + * id: "321", + * amount: 5 + * } + * ] + * ) + * + */ + upsertShippingMethodAdjustments( + data: ( + | CreateShippingMethodAdjustmentDTO + | UpdateShippingMethodAdjustmentDTO + )[], + sharedContext?: Context + ): Promise + + /** + * This method upserts line item tax lines. + * + * @param {(CreateLineItemTaxLineDTO | UpdateLineItemTaxLineDTO)[]} taxLines - The line item tax lines to create or update. If the + * tax line object has an `id` property, it'll be updated. Otherwise, a tax line is created. + * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module. + * @returns {Promise} The line item tax lines. + * + * @example + * const lineItemTaxLines = await orderModuleService + * .upsertLineItemTaxLines( + * [ + * { + * code: "123", + * rate: 2 + * } + * ] + * ) + * + */ + upsertLineItemTaxLines( + taxLines: (CreateLineItemTaxLineDTO | UpdateLineItemTaxLineDTO)[], + sharedContext?: Context + ): Promise + + /** + * This method upsert shipping method tax lines. + * + * @param {(CreateShippingMethodTaxLineDTO | UpdateShippingMethodTaxLineDTO)[]} taxLines - The shipping method tax lines to create or update. + * If a tax line object has an `id` property, it's updated. Otherwise, a tax line is created. + * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module. + * @returns {Promise} The shipping method tax lines. + * + * @example + * const shippingMethodTaxLines = await orderModuleService + * .upsertShippingMethodTaxLines( + * [ + * { + * code: "123", + * rate: 2 + * }, + * { + * id: "321", + * rate: 2 + * } + * ] + * ) + * + */ + upsertShippingMethodTaxLines( + taxLines: ( + | CreateShippingMethodTaxLineDTO + | UpdateShippingMethodTaxLineDTO + )[], + sharedContext?: Context + ): Promise } diff --git a/packages/core/types/src/payment/common.ts b/packages/core/types/src/payment/common.ts index ffe72c5967..e65597b380 100644 --- a/packages/core/types/src/payment/common.ts +++ b/packages/core/types/src/payment/common.ts @@ -552,6 +552,16 @@ export interface PaymentSessionDTO { */ authorized_at?: Date + /** + * When the payment session was created + */ + created_at: Date | string + + /** + * When the payment session was updated + */ + updated_at: Date | string + /** * The ID of the associated payment collection. */ diff --git a/packages/core/utils/package.json b/packages/core/utils/package.json index 75ac605ef2..3755dd49e2 100644 --- a/packages/core/utils/package.json +++ b/packages/core/utils/package.json @@ -47,7 +47,7 @@ "@graphql-codegen/typescript": "^4.0.9", "@graphql-tools/merge": "^9.0.7", "@graphql-tools/schema": "^10.0.6", - "@medusajs/types": "^2.6.0", + "@medusajs/types": "2.6.0", "@types/pluralize": "^0.0.33", "bignumber.js": "^9.1.2", "dotenv": "^16.4.5", diff --git a/packages/core/workflows-sdk/package.json b/packages/core/workflows-sdk/package.json index 445215d442..7122746d6b 100644 --- a/packages/core/workflows-sdk/package.json +++ b/packages/core/workflows-sdk/package.json @@ -40,10 +40,10 @@ "typescript": "^5.6.2" }, "dependencies": { - "@medusajs/modules-sdk": "^2.6.0", - "@medusajs/orchestration": "^2.6.0", - "@medusajs/types": "^2.6.0", - "@medusajs/utils": "^2.6.0", + "@medusajs/modules-sdk": "2.6.0", + "@medusajs/orchestration": "2.6.0", + "@medusajs/types": "2.6.0", + "@medusajs/utils": "2.6.0", "ulid": "^2.3.0" }, "peerDependencies": { diff --git a/packages/core/workflows-sdk/src/utils/composer/__tests__/compose.ts b/packages/core/workflows-sdk/src/utils/composer/__tests__/compose.ts index 7e46d2d164..09f20b6dc2 100644 --- a/packages/core/workflows-sdk/src/utils/composer/__tests__/compose.ts +++ b/packages/core/workflows-sdk/src/utils/composer/__tests__/compose.ts @@ -19,10 +19,12 @@ import { StepFunction, StepResponse, transform, + when, WorkflowResponse, } from ".." import { MedusaWorkflow } from "../../../medusa-workflow" import { createHook } from "../create-hook" +import { setTimeout } from "timers/promises" jest.setTimeout(30000) @@ -742,6 +744,71 @@ describe("Workflow composer", function () { }) }) + it("should compose a new workflow with conditional parallelized steps", async () => { + const stepResults: string[] = [] + + const mockStep1Fn = jest.fn().mockImplementation(async () => { + await setTimeout(100) + stepResults.push("step1") + return new StepResponse(true) + }) as any + const mockStep2Fn = jest.fn().mockImplementation(() => { + stepResults.push("step2") + return new StepResponse(true) + }) as any + const mockStep3Fn = jest.fn().mockImplementation(() => { + stepResults.push("step3") + return new StepResponse(true) + }) as any + const mockStep4Fn = jest.fn().mockImplementation(() => { + stepResults.push("step4") + return new StepResponse(true) + }) as any + + const step1 = createStep("step1", mockStep1Fn) + const step2 = createStep("step2", mockStep2Fn) + const step3 = createStep("step3", mockStep3Fn) + const step4 = createStep("step4", mockStep4Fn) + + const callStep2IfNeeded = () => { + return when({}, () => false).then(() => { + return step2() + }) + } + + const callStep3IfNeeded = () => { + return when({}, () => false).then(() => { + return step4() + }) + } + + const workflow = createWorkflow("workflow1", function (input) { + const [ret1, ret2, ret3, ret4] = parallelize( + step1(), + callStep2IfNeeded(), + step3(), + callStep3IfNeeded() + ) + return new WorkflowResponse({ ret1, ret2, ret3, ret4 }) + }) + + const { result: workflowResult } = await workflow().run() + + expect(mockStep1Fn).toHaveBeenCalledTimes(1) + expect(mockStep2Fn).toHaveBeenCalledTimes(0) + expect(mockStep3Fn).toHaveBeenCalledTimes(1) + expect(mockStep4Fn).toHaveBeenCalledTimes(0) + + expect(workflowResult).toEqual({ + ret1: true, + ret2: undefined, + ret3: true, + ret4: undefined, + }) + + expect(stepResults).toEqual(["step3", "step1"]) + }) + it("should compose a new workflow with parallelize steps and rollback them all in case of error", async () => { const step1CompensationFn = jest.fn().mockImplementation(() => { return "step1 compensation" diff --git a/packages/core/workflows-sdk/src/utils/composer/parallelize.ts b/packages/core/workflows-sdk/src/utils/composer/parallelize.ts index 3ddf4e20b3..581f324075 100644 --- a/packages/core/workflows-sdk/src/utils/composer/parallelize.ts +++ b/packages/core/workflows-sdk/src/utils/composer/parallelize.ts @@ -19,21 +19,21 @@ import { OrchestrationUtils } from "@medusajs/utils" * createPricesStep, * attachProductToSalesChannelStep * } from "./steps" - * + * * interface WorkflowInput { * title: string * } - * + * * const myWorkflow = createWorkflow( * "my-workflow", * (input: WorkflowInput) => { * const product = createProductStep(input) - * + * * const [prices, productSalesChannel] = parallelize( * createPricesStep(product), * attachProductToSalesChannelStep(product) * ) - * + * * return new WorkflowResponse({ * prices, * productSalesChannel @@ -41,7 +41,7 @@ import { OrchestrationUtils } from "@medusajs/utils" * } * ) */ -export function parallelize( +export function parallelize( ...steps: TResult ): TResult { if (!global[OrchestrationUtils.SymbolMedusaWorkflowComposerContext]) { @@ -64,7 +64,7 @@ export function parallelize( const stepOntoMerge = steps.shift()! this.flow.mergeActions( stepOntoMerge.__step__, - ...steps.map((step) => step.__step__) + ...steps.map((step) => step!.__step__) ) return resultSteps as unknown as TResult diff --git a/packages/core/workflows-sdk/src/utils/composer/type.ts b/packages/core/workflows-sdk/src/utils/composer/type.ts index 5a816c14b1..6e2027de09 100644 --- a/packages/core/workflows-sdk/src/utils/composer/type.ts +++ b/packages/core/workflows-sdk/src/utils/composer/type.ts @@ -104,7 +104,9 @@ export type CreateWorkflowComposerContext = { fn: StepFunctionResult ) => WorkflowData hookBinder: (name: string, fn: () => HookHandler) => void - parallelizeBinder: ( + parallelizeBinder: < + TOutput extends (WorkflowData | undefined)[] = WorkflowData[] + >( fn: (this: CreateWorkflowComposerContext) => TOutput ) => TOutput } diff --git a/packages/design-system/icons/package.json b/packages/design-system/icons/package.json index 14e4b45ce8..100a2a5dee 100644 --- a/packages/design-system/icons/package.json +++ b/packages/design-system/icons/package.json @@ -29,7 +29,7 @@ }, "devDependencies": { "@atomico/rollup-plugin-sizes": "^1.1.4", - "@medusajs/toolbox": "^2.6.0", + "@medusajs/toolbox": "2.6.0", "@rollup/plugin-node-resolve": "^15.1.0", "@rollup/plugin-replace": "^5.0.2", "@testing-library/dom": "^9.3.1", diff --git a/packages/design-system/ui-preset/package.json b/packages/design-system/ui-preset/package.json index 3fd77cddfd..2e9176db2d 100644 --- a/packages/design-system/ui-preset/package.json +++ b/packages/design-system/ui-preset/package.json @@ -30,7 +30,7 @@ "tailwindcss": ">=3.0.0" }, "devDependencies": { - "@medusajs/toolbox": "^2.6.0", + "@medusajs/toolbox": "2.6.0", "tailwindcss": "^3.4.1", "tsup": "^7.1.0", "typescript": "^5.1.6" diff --git a/packages/design-system/ui/package.json b/packages/design-system/ui/package.json index d4f151f595..52991d1034 100644 --- a/packages/design-system/ui/package.json +++ b/packages/design-system/ui/package.json @@ -43,7 +43,7 @@ }, "devDependencies": { "@faker-js/faker": "^9.2.0", - "@medusajs/ui-preset": "^2.5.1", + "@medusajs/ui-preset": "2.6.0", "@storybook/addon-essentials": "^8.3.5", "@storybook/addon-interactions": "^8.3.5", "@storybook/addon-links": "^8.3.5", @@ -81,7 +81,7 @@ "vitest": "^3.0.5" }, "dependencies": { - "@medusajs/icons": "^2.5.1", + "@medusajs/icons": "2.6.0", "@tanstack/react-table": "8.20.5", "clsx": "^1.2.1", "copy-to-clipboard": "^3.3.3", diff --git a/packages/medusa-test-utils/package.json b/packages/medusa-test-utils/package.json index 1134a4b527..07436a7493 100644 --- a/packages/medusa-test-utils/package.json +++ b/packages/medusa-test-utils/package.json @@ -25,7 +25,7 @@ "author": "Medusa", "license": "MIT", "devDependencies": { - "@medusajs/framework": "^2.6.0", + "@medusajs/framework": "2.6.0", "@mikro-orm/core": "6.4.3", "@mikro-orm/knex": "6.4.3", "@mikro-orm/migrations": "6.4.3", @@ -45,8 +45,8 @@ "randomatic": "^3.1.1" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0", - "@medusajs/medusa": "^2.4.0", + "@medusajs/framework": "2.6.0", + "@medusajs/medusa": "2.6.0", "@mikro-orm/postgresql": "6.4.3", "awilix": "^8.0.1" }, diff --git a/packages/medusa/package.json b/packages/medusa/package.json index 1b45a3d27b..68ed8952a6 100644 --- a/packages/medusa/package.json +++ b/packages/medusa/package.json @@ -44,15 +44,15 @@ "test:integration": "jest --forceExit -- src/**/integration-tests/**/__tests__/**/*.ts" }, "devDependencies": { - "@medusajs/framework": "^2.6.0", + "@medusajs/framework": "2.6.0", "@opentelemetry/api": "^1.9.0", "@opentelemetry/instrumentation": "^0.53.0", "@opentelemetry/instrumentation-pg": "^0.44.0", "@opentelemetry/resources": "^1.26.0", "@opentelemetry/sdk-node": "^0.53.0", "@opentelemetry/sdk-trace-node": "^1.26.0", - "@swc/core": "^1.7.28", - "@swc/helpers": "^0.5.0", + "@swc/core": "1.5.7", + "@swc/helpers": "^0.5.11", "@swc/jest": "^0.2.36", "@types/express": "^4.17.17", "@types/jsonwebtoken": "^8.5.9", @@ -67,49 +67,49 @@ "dependencies": { "@inquirer/checkbox": "^2.3.11", "@inquirer/input": "^2.2.9", - "@medusajs/admin-bundler": "^2.6.0", - "@medusajs/api-key": "^2.6.0", - "@medusajs/auth": "^2.6.0", - "@medusajs/auth-emailpass": "^2.6.0", - "@medusajs/auth-github": "^2.6.0", - "@medusajs/auth-google": "^2.6.0", - "@medusajs/cache-inmemory": "^2.6.0", - "@medusajs/cache-redis": "^2.6.0", - "@medusajs/cart": "^2.6.0", - "@medusajs/core-flows": "^2.6.0", - "@medusajs/currency": "^2.6.0", - "@medusajs/customer": "^2.6.0", - "@medusajs/event-bus-local": "^2.6.0", - "@medusajs/event-bus-redis": "^2.6.0", - "@medusajs/file": "^2.6.0", - "@medusajs/file-local": "^2.6.0", - "@medusajs/file-s3": "^2.6.0", - "@medusajs/fulfillment": "^2.6.0", - "@medusajs/fulfillment-manual": "^2.6.0", - "@medusajs/index": "^2.6.0", - "@medusajs/inventory": "^2.6.0", - "@medusajs/link-modules": "^2.6.0", - "@medusajs/locking": "^2.6.0", - "@medusajs/locking-postgres": "^2.6.0", - "@medusajs/locking-redis": "^2.6.0", - "@medusajs/notification": "^2.6.0", - "@medusajs/notification-local": "^2.6.0", - "@medusajs/notification-sendgrid": "^2.6.0", - "@medusajs/order": "^2.6.0", - "@medusajs/payment": "^2.6.0", - "@medusajs/payment-stripe": "^2.6.0", - "@medusajs/pricing": "^2.6.0", - "@medusajs/product": "^2.6.0", - "@medusajs/promotion": "^2.6.0", - "@medusajs/region": "^2.6.0", - "@medusajs/sales-channel": "^2.6.0", - "@medusajs/stock-location": "^2.6.0", - "@medusajs/store": "^2.6.0", - "@medusajs/tax": "^2.6.0", - "@medusajs/telemetry": "^2.6.0", - "@medusajs/user": "^2.6.0", - "@medusajs/workflow-engine-inmemory": "^2.6.0", - "@medusajs/workflow-engine-redis": "^2.6.0", + "@medusajs/admin-bundler": "2.6.0", + "@medusajs/api-key": "2.6.0", + "@medusajs/auth": "2.6.0", + "@medusajs/auth-emailpass": "2.6.0", + "@medusajs/auth-github": "2.6.0", + "@medusajs/auth-google": "2.6.0", + "@medusajs/cache-inmemory": "2.6.0", + "@medusajs/cache-redis": "2.6.0", + "@medusajs/cart": "2.6.0", + "@medusajs/core-flows": "2.6.0", + "@medusajs/currency": "2.6.0", + "@medusajs/customer": "2.6.0", + "@medusajs/event-bus-local": "2.6.0", + "@medusajs/event-bus-redis": "2.6.0", + "@medusajs/file": "2.6.0", + "@medusajs/file-local": "2.6.0", + "@medusajs/file-s3": "2.6.0", + "@medusajs/fulfillment": "2.6.0", + "@medusajs/fulfillment-manual": "2.6.0", + "@medusajs/index": "2.6.0", + "@medusajs/inventory": "2.6.0", + "@medusajs/link-modules": "2.6.0", + "@medusajs/locking": "2.6.0", + "@medusajs/locking-postgres": "2.6.0", + "@medusajs/locking-redis": "2.6.0", + "@medusajs/notification": "2.6.0", + "@medusajs/notification-local": "2.6.0", + "@medusajs/notification-sendgrid": "2.6.0", + "@medusajs/order": "2.6.0", + "@medusajs/payment": "2.6.0", + "@medusajs/payment-stripe": "2.6.0", + "@medusajs/pricing": "2.6.0", + "@medusajs/product": "2.6.0", + "@medusajs/promotion": "2.6.0", + "@medusajs/region": "2.6.0", + "@medusajs/sales-channel": "2.6.0", + "@medusajs/stock-location": "2.6.0", + "@medusajs/store": "2.6.0", + "@medusajs/tax": "2.6.0", + "@medusajs/telemetry": "2.6.0", + "@medusajs/user": "2.6.0", + "@medusajs/workflow-engine-inmemory": "2.6.0", + "@medusajs/workflow-engine-redis": "2.6.0", "boxen": "^5.0.1", "chalk": "^4.0.0", "chokidar": "^3.4.2", @@ -127,12 +127,12 @@ "zod": "3.22.4" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0", + "@medusajs/framework": "2.6.0", "@mikro-orm/core": "6.4.3", "@mikro-orm/knex": "6.4.3", "@mikro-orm/migrations": "6.4.3", "@mikro-orm/postgresql": "6.4.3", - "@swc/core": "^1.7.28", + "@swc/core": "1.5.7", "awilix": "^8.0.1", "react-dom": "^18.0.0", "yalc": "1.0.0-pre.53" diff --git a/packages/modules/api-key/package.json b/packages/modules/api-key/package.json index dcf8f4f316..d097e7938a 100644 --- a/packages/modules/api-key/package.json +++ b/packages/modules/api-key/package.json @@ -36,8 +36,8 @@ "orm:cache:clear": " MIKRO_ORM_CLI_CONFIG=./mikro-orm.config.dev.ts medusa-mikro-orm cache:clear" }, "devDependencies": { - "@medusajs/framework": "^2.6.0", - "@medusajs/test-utils": "^2.6.0", + "@medusajs/framework": "2.6.0", + "@medusajs/test-utils": "2.6.0", "@mikro-orm/cli": "6.4.3", "@swc/core": "^1.7.28", "@swc/jest": "^0.2.36", @@ -47,7 +47,7 @@ "typescript": "^5.6.2" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0", + "@medusajs/framework": "2.6.0", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", "@mikro-orm/postgresql": "6.4.3", diff --git a/packages/modules/auth/package.json b/packages/modules/auth/package.json index ad730d4a28..1d86e8a829 100644 --- a/packages/modules/auth/package.json +++ b/packages/modules/auth/package.json @@ -36,8 +36,8 @@ "orm:cache:clear": " MIKRO_ORM_CLI_CONFIG=./mikro-orm.config.dev.ts medusa-mikro-orm cache:clear" }, "devDependencies": { - "@medusajs/framework": "^2.6.0", - "@medusajs/test-utils": "^2.6.0", + "@medusajs/framework": "2.6.0", + "@medusajs/test-utils": "2.6.0", "@mikro-orm/cli": "6.4.3", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", @@ -50,7 +50,7 @@ "typescript": "^5.6.2" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0", + "@medusajs/framework": "2.6.0", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", "@mikro-orm/postgresql": "6.4.3", diff --git a/packages/modules/cache-inmemory/package.json b/packages/modules/cache-inmemory/package.json index 64a06af2e0..5462105cff 100644 --- a/packages/modules/cache-inmemory/package.json +++ b/packages/modules/cache-inmemory/package.json @@ -23,7 +23,7 @@ "author": "Medusa", "license": "MIT", "devDependencies": { - "@medusajs/framework": "^2.6.0", + "@medusajs/framework": "2.6.0", "@swc/core": "^1.7.28", "@swc/jest": "^0.2.36", "jest": "^29.7.0", @@ -36,6 +36,6 @@ "test": "jest --passWithNoTests" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0" + "@medusajs/framework": "2.6.0" } } diff --git a/packages/modules/cache-redis/package.json b/packages/modules/cache-redis/package.json index ddae5cab40..8a69b0a87f 100644 --- a/packages/modules/cache-redis/package.json +++ b/packages/modules/cache-redis/package.json @@ -23,7 +23,7 @@ "author": "Medusa", "license": "MIT", "devDependencies": { - "@medusajs/framework": "^2.6.0", + "@medusajs/framework": "2.6.0", "@swc/core": "^1.7.28", "@swc/jest": "^0.2.36", "jest": "^29.7.0", @@ -39,7 +39,7 @@ "ioredis": "^5.4.1" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0", + "@medusajs/framework": "2.6.0", "awilix": "^8.0.1" } } diff --git a/packages/modules/cart/integration-tests/__tests__/services/cart-module/index.spec.ts b/packages/modules/cart/integration-tests/__tests__/services/cart-module/index.spec.ts index 0363633456..bdfa87d96e 100644 --- a/packages/modules/cart/integration-tests/__tests__/services/cart-module/index.spec.ts +++ b/packages/modules/cart/integration-tests/__tests__/services/cart-module/index.spec.ts @@ -2272,6 +2272,343 @@ moduleIntegrationTestRunner({ }) }) + describe("setShippingMethodTaxLines", () => { + it("should set shipping item tax lines for a cart", async () => { + const [createdCart] = await service.createCarts([ + { + currency_code: "eur", + }, + ]) + + const [itemOne] = await service.addShippingMethods(createdCart.id, [ + { + name: "test", + amount: 100, + }, + ]) + + const [itemTwo] = await service.addShippingMethods(createdCart.id, [ + { + name: "test-2", + amount: 200, + }, + ]) + + const taxLines = await service.setShippingMethodTaxLines( + createdCart.id, + [ + { + shipping_method_id: itemOne.id, + rate: 20, + code: "TX", + }, + { + shipping_method_id: itemTwo.id, + rate: 20, + code: "TX", + }, + ] + ) + + expect(taxLines).toEqual( + expect.arrayContaining([ + expect.objectContaining({ + shipping_method_id: itemOne.id, + rate: 20, + code: "TX", + }), + expect.objectContaining({ + shipping_method_id: itemTwo.id, + rate: 20, + code: "TX", + }), + ]) + ) + }) + + it("should replace shipping item tax lines for a cart", async () => { + const [createdCart] = await service.createCarts([ + { + currency_code: "eur", + }, + ]) + + const [itemOne] = await service.addShippingMethods(createdCart.id, [ + { + name: "test", + amount: 100, + }, + ]) + + const taxLines = await service.setShippingMethodTaxLines( + createdCart.id, + [ + { + shipping_method_id: itemOne.id, + rate: 20.753, + code: "TX", + }, + ] + ) + + expect(taxLines).toEqual( + expect.arrayContaining([ + expect.objectContaining({ + shipping_method_id: itemOne.id, + rate: 20.753, + code: "TX", + }), + ]) + ) + + await service.setShippingMethodTaxLines(createdCart.id, [ + { + shipping_method_id: itemOne.id, + rate: 25.14789, + code: "TX-2", + }, + ]) + + const cart = await service.retrieveCart(createdCart.id, { + relations: ["shipping_methods.tax_lines"], + }) + + expect(cart.shipping_methods).toEqual( + expect.arrayContaining([ + expect.objectContaining({ + id: itemOne.id, + tax_lines: expect.arrayContaining([ + expect.objectContaining({ + shipping_method_id: itemOne.id, + rate: 25.14789, + code: "TX-2", + }), + ]), + }), + ]) + ) + + expect(cart.shipping_methods?.length).toBe(1) + expect(cart.shipping_methods?.[0].tax_lines?.length).toBe(1) + }) + + it("should remove all shipping item tax lines for a cart", async () => { + const [createdCart] = await service.createCarts([ + { + currency_code: "eur", + }, + ]) + + const [itemOne] = await service.addShippingMethods(createdCart.id, [ + { + name: "test", + amount: 100, + }, + ]) + + const taxLines = await service.setShippingMethodTaxLines( + createdCart.id, + [ + { + shipping_method_id: itemOne.id, + rate: 20, + code: "TX", + }, + ] + ) + + expect(taxLines).toEqual( + expect.arrayContaining([ + expect.objectContaining({ + shipping_method_id: itemOne.id, + rate: 20, + code: "TX", + }), + ]) + ) + + await service.setShippingMethodTaxLines(createdCart.id, []) + + const cart = await service.retrieveCart(createdCart.id, { + relations: ["shipping_methods.tax_lines"], + }) + + expect(cart.shipping_methods).toEqual( + expect.arrayContaining([ + expect.objectContaining({ + id: itemOne.id, + tax_lines: [], + }), + ]) + ) + + expect(cart.shipping_methods?.length).toBe(1) + expect(cart.shipping_methods?.[0].tax_lines?.length).toBe(0) + }) + + it("should update shipping item tax lines for a cart", async () => { + const [createdCart] = await service.createCarts([ + { + currency_code: "eur", + }, + ]) + + const [itemOne] = await service.addShippingMethods(createdCart.id, [ + { + name: "test", + amount: 100, + }, + ]) + + const taxLines = await service.setShippingMethodTaxLines( + createdCart.id, + [ + { + shipping_method_id: itemOne.id, + rate: 20, + code: "TX", + }, + ] + ) + + expect(taxLines).toEqual( + expect.arrayContaining([ + expect.objectContaining({ + shipping_method_id: itemOne.id, + rate: 20, + code: "TX", + }), + ]) + ) + + await service.setShippingMethodTaxLines(createdCart.id, [ + { + id: taxLines[0].id, + shipping_method_id: itemOne.id, + rate: 25, + code: "TX", + }, + ]) + + const cart = await service.retrieveCart(createdCart.id, { + relations: ["shipping_methods.tax_lines"], + }) + + expect(cart.shipping_methods).toEqual( + expect.arrayContaining([ + expect.objectContaining({ + id: itemOne.id, + tax_lines: [ + expect.objectContaining({ + id: taxLines[0].id, + shipping_method_id: itemOne.id, + rate: 25, + code: "TX", + }), + ], + }), + ]) + ) + + expect(cart.shipping_methods?.length).toBe(1) + expect(cart.shipping_methods?.[0].tax_lines?.length).toBe(1) + }) + + it("should remove, update, and create shipping item tax lines for a cart", async () => { + const [createdCart] = await service.createCarts([ + { + currency_code: "eur", + }, + ]) + + const [itemOne] = await service.addShippingMethods(createdCart.id, [ + { + name: "test", + amount: 100, + }, + ]) + + const taxLines = await service.setShippingMethodTaxLines( + createdCart.id, + [ + { + shipping_method_id: itemOne.id, + rate: 20, + code: "TX", + }, + { + shipping_method_id: itemOne.id, + rate: 25, + code: "TX", + }, + ] + ) + + expect(taxLines).toEqual( + expect.arrayContaining([ + expect.objectContaining({ + shipping_method_id: itemOne.id, + rate: 20, + code: "TX", + }), + expect.objectContaining({ + shipping_method_id: itemOne.id, + rate: 25, + code: "TX", + }), + ]) + ) + + const taxLine = taxLines.find( + (tx) => tx.shipping_method_id === itemOne.id + ) + + await service.setShippingMethodTaxLines(createdCart.id, [ + // update + { + id: taxLine.id, + rate: 40, + code: "TX", + }, + // create + { + shipping_method_id: itemOne.id, + rate: 25, + code: "TX-2", + }, + // remove: should remove the initial tax line for itemOne + ]) + + const cart = await service.retrieveCart(createdCart.id, { + relations: ["shipping_methods.tax_lines"], + }) + + expect(cart.shipping_methods).toEqual( + expect.arrayContaining([ + expect.objectContaining({ + id: itemOne.id, + tax_lines: [ + expect.objectContaining({ + id: taxLine!.id, + shipping_method_id: itemOne.id, + rate: 40, + code: "TX", + }), + expect.objectContaining({ + shipping_method_id: itemOne.id, + rate: 25, + code: "TX-2", + }), + ], + }), + ]) + ) + + expect(cart.shipping_methods?.length).toBe(1) + expect(cart.shipping_methods?.[0].tax_lines?.length).toBe(2) + }) + }) + describe("addLineItemAdjustments", () => { it("should add line item tax lines for items in a cart", async () => { const [createdCart] = await service.createCarts([ diff --git a/packages/modules/cart/package.json b/packages/modules/cart/package.json index 57f4894997..fc75f2dd5a 100644 --- a/packages/modules/cart/package.json +++ b/packages/modules/cart/package.json @@ -36,8 +36,8 @@ "orm:cache:clear": " MIKRO_ORM_CLI_CONFIG=./mikro-orm.config.dev.ts medusa-mikro-orm cache:clear" }, "devDependencies": { - "@medusajs/framework": "^2.6.0", - "@medusajs/test-utils": "^2.6.0", + "@medusajs/framework": "2.6.0", + "@medusajs/test-utils": "2.6.0", "@mikro-orm/cli": "6.4.3", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", @@ -50,7 +50,7 @@ "typescript": "^5.6.2" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0", + "@medusajs/framework": "2.6.0", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", "@mikro-orm/postgresql": "6.4.3", diff --git a/packages/modules/cart/src/services/cart-module.ts b/packages/modules/cart/src/services/cart-module.ts index ebac8b3eb8..74f12bec28 100644 --- a/packages/modules/cart/src/services/cart-module.ts +++ b/packages/modules/cart/src/services/cart-module.ts @@ -13,6 +13,7 @@ import { createRawPropertiesFromBigNumber, decorateCartTotals, deduplicate, + generateEntityId, InjectManager, InjectTransactionManager, isObject, @@ -20,6 +21,7 @@ import { MedusaContext, MedusaError, ModulesSdkUtils, + promiseAll, } from "@medusajs/framework/utils" import { Address, @@ -357,9 +359,7 @@ export default class CartModuleService const serializedResult = await this.baseRepository_.serialize< CartTypes.CartDTO[] - >(result, { - populate: true, - }) + >(result) return isString(dataOrIdOrSelector) ? serializedResult[0] : serializedResult } @@ -448,10 +448,7 @@ export default class CartModuleService } return await this.baseRepository_.serialize( - items, - { - populate: true, - } + items ) } @@ -557,10 +554,7 @@ export default class CartModuleService ) return await this.baseRepository_.serialize( - items, - { - populate: true, - } + items ) } @@ -718,7 +712,7 @@ export default class CartModuleService return await this.baseRepository_.serialize< CartTypes.CartShippingMethodDTO[] - >(methods, { populate: true }) + >(methods) } @InjectTransactionManager() @@ -809,9 +803,79 @@ export default class CartModuleService return await this.baseRepository_.serialize< CartTypes.LineItemAdjustmentDTO[] - >(addedAdjustments, { - populate: true, - }) + >(addedAdjustments) + } + + @InjectTransactionManager() + async upsertLineItemTaxLines( + taxLines: ( + | CartTypes.CreateLineItemTaxLineDTO + | CartTypes.UpdateLineItemTaxLineDTO + )[], + @MedusaContext() sharedContext: Context = {} + ): Promise { + const result = await this.lineItemTaxLineService_.upsert( + taxLines as CartTypes.UpdateLineItemTaxLineDTO[], + sharedContext + ) + + return await this.baseRepository_.serialize( + result + ) + } + + @InjectTransactionManager() + async upsertLineItemAdjustments( + adjustments: ( + | CartTypes.CreateLineItemAdjustmentDTO + | CartTypes.UpdateLineItemAdjustmentDTO + )[], + @MedusaContext() sharedContext: Context = {} + ): Promise { + let result = await this.lineItemAdjustmentService_.upsert( + adjustments, + sharedContext + ) + + return await this.baseRepository_.serialize< + CartTypes.LineItemAdjustmentDTO[] + >(result) + } + + @InjectTransactionManager() + async upsertShippingMethodTaxLines( + taxLines: ( + | CartTypes.CreateShippingMethodTaxLineDTO + | CartTypes.UpdateShippingMethodTaxLineDTO + )[], + @MedusaContext() sharedContext: Context = {} + ): Promise { + const result = await this.shippingMethodTaxLineService_.upsert( + taxLines as UpdateShippingMethodTaxLineDTO[], + sharedContext + ) + + return await this.baseRepository_.serialize< + CartTypes.ShippingMethodTaxLineDTO[] + >(result) + } + + @InjectTransactionManager() + async upsertShippingMethodAdjustments( + adjustments: ( + | CartTypes.CreateShippingMethodAdjustmentDTO + | CartTypes.UpdateShippingMethodAdjustmentDTO + )[], + @MedusaContext() sharedContext: Context = {} + ): Promise { + const result = await this.shippingMethodAdjustmentService_.upsert( + adjustments, + sharedContext + ) + + return await this.baseRepository_.serialize< + CartTypes.ShippingMethodAdjustmentDTO[] + >(result) } @InjectTransactionManager() @@ -864,9 +928,7 @@ export default class CartModuleService return await this.baseRepository_.serialize< CartTypes.LineItemAdjustmentDTO[] - >(result, { - populate: true, - }) + >(result) } @InjectTransactionManager() @@ -921,9 +983,7 @@ export default class CartModuleService return await this.baseRepository_.serialize< CartTypes.ShippingMethodAdjustmentDTO[] - >(result, { - populate: true, - }) + >(result) } async addShippingMethodAdjustments( @@ -986,17 +1046,13 @@ export default class CartModuleService if (isObject(cartIdOrData)) { return await this.baseRepository_.serialize( addedAdjustments[0], - { - populate: true, - } + {} ) } return await this.baseRepository_.serialize< CartTypes.ShippingMethodAdjustmentDTO[] - >(addedAdjustments, { - populate: true, - }) + >(addedAdjustments) } addLineItemTaxLines( @@ -1046,9 +1102,7 @@ export default class CartModuleService const serialized = await this.baseRepository_.serialize< CartTypes.LineItemTaxLineDTO[] - >(addedTaxLines, { - populate: true, - }) + >(addedTaxLines) if (isObject(cartIdOrData)) { return serialized[0] @@ -1066,49 +1120,44 @@ export default class CartModuleService )[], @MedusaContext() sharedContext: Context = {} ): Promise { - const cart = await this.retrieveCart( - cartId, - { select: ["id"], relations: ["items.tax_lines"] }, - sharedContext - ) - - const existingTaxLines = await this.listLineItemTaxLines( - { item: { cart_id: cart.id } }, - { select: ["id"] }, - sharedContext - ) - - const taxLinesSet = new Set( - taxLines - .map((taxLine) => (taxLine as CartTypes.UpdateLineItemTaxLineDTO)?.id) - .filter(Boolean) - ) - - const toDelete: CartTypes.LineItemTaxLineDTO[] = [] - - // From the existing tax lines, find the ones that are not passed in taxLines - existingTaxLines.forEach((taxLine: CartTypes.LineItemTaxLineDTO) => { - if (!taxLinesSet.has(taxLine.id)) { - toDelete.push(taxLine) - } + const normalizedTaxLines = ( + taxLines as CartTypes.UpdateLineItemTaxLineDTO[] + ).map((taxLine) => { + // Pre generate the id so that we can optimized the actions below + taxLine.id = generateEntityId(taxLine.id, "calitxl") + return taxLine }) - if (toDelete.length) { - await this.lineItemTaxLineService_.softDelete( - toDelete.map((taxLine) => taxLine!.id), - sharedContext + const taxLineIdsSet = new Set( + normalizedTaxLines.map( + (taxLine) => (taxLine as CartTypes.UpdateLineItemTaxLineDTO)?.id ) + ) + + const deleteConstraints: { + id?: { + $nin: string[] + } + item: { cart_id: string } + } = { + item: { cart_id: cartId }, } - const result = taxLines.length - ? await this.lineItemTaxLineService_.upsert(taxLines, sharedContext) - : [] + if (taxLineIdsSet.size) { + deleteConstraints.id = { + $nin: Array.from(taxLineIdsSet), + } + } + + const [result] = await promiseAll([ + normalizedTaxLines.length + ? this.lineItemTaxLineService_.upsert(normalizedTaxLines, sharedContext) + : [], + this.lineItemTaxLineService_.softDelete(deleteConstraints, sharedContext), + ]) return await this.baseRepository_.serialize( - result, - { - populate: true, - } + result ) } @@ -1159,10 +1208,7 @@ export default class CartModuleService const serialized = await this.baseRepository_.serialize( - addedTaxLines[0], - { - populate: true, - } + addedTaxLines[0] ) if (isObject(cartIdOrData)) { @@ -1181,53 +1227,49 @@ export default class CartModuleService )[], @MedusaContext() sharedContext: Context = {} ): Promise { - const cart = await this.retrieveCart( - cartId, - { select: ["id"], relations: ["shipping_methods.tax_lines"] }, - sharedContext - ) - - const existingTaxLines = await this.listShippingMethodTaxLines( - { shipping_method: { cart_id: cart.id } }, - { select: ["id"] }, - sharedContext - ) - - const taxLinesSet = new Set( - taxLines - .map( - (taxLine) => (taxLine as CartTypes.UpdateShippingMethodTaxLineDTO)?.id - ) - .filter(Boolean) - ) - - const toDelete: CartTypes.ShippingMethodTaxLineDTO[] = [] - - // From the existing tax lines, find the ones that are not passed in taxLines - existingTaxLines.forEach((taxLine: CartTypes.ShippingMethodTaxLineDTO) => { - if (!taxLinesSet.has(taxLine.id)) { - toDelete.push(taxLine) - } + const normalizedTaxLines = ( + taxLines as CartTypes.UpdateShippingMethodTaxLineDTO[] + ).map((taxLine) => { + taxLine.id = generateEntityId(taxLine.id, "casmtxl") + return taxLine }) - if (toDelete.length) { - await this.shippingMethodTaxLineService_.softDelete( - toDelete.map((taxLine) => taxLine!.id), - sharedContext + const taxLineIdsSet = new Set( + normalizedTaxLines.map( + (taxLine) => (taxLine as CartTypes.UpdateShippingMethodTaxLineDTO)?.id ) + ) + + const deleteConstraints: { + id?: { + $nin: string[] + } + shipping_method: { cart_id: string } + } = { + shipping_method: { cart_id: cartId }, } - const result = taxLines.length - ? await this.shippingMethodTaxLineService_.upsert( - taxLines as UpdateShippingMethodTaxLineDTO[], - sharedContext - ) - : [] + if (taxLineIdsSet.size) { + deleteConstraints.id = { + $nin: Array.from(taxLineIdsSet), + } + } + + const [result] = await promiseAll([ + taxLines.length + ? this.shippingMethodTaxLineService_.upsert( + taxLines as UpdateShippingMethodTaxLineDTO[], + sharedContext + ) + : [], + this.shippingMethodTaxLineService_.softDelete( + deleteConstraints, + sharedContext + ), + ]) return await this.baseRepository_.serialize< CartTypes.ShippingMethodTaxLineDTO[] - >(result, { - populate: true, - }) + >(result) } } diff --git a/packages/modules/currency/package.json b/packages/modules/currency/package.json index 3f23a09319..fb55a457be 100644 --- a/packages/modules/currency/package.json +++ b/packages/modules/currency/package.json @@ -36,8 +36,8 @@ "orm:cache:clear": " MIKRO_ORM_CLI_CONFIG=./mikro-orm.config.dev.ts medusa-mikro-orm cache:clear" }, "devDependencies": { - "@medusajs/framework": "^2.6.0", - "@medusajs/test-utils": "^2.6.0", + "@medusajs/framework": "2.6.0", + "@medusajs/test-utils": "2.6.0", "@mikro-orm/cli": "6.4.3", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", @@ -50,7 +50,7 @@ "typescript": "^5.6.2" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0", + "@medusajs/framework": "2.6.0", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", "@mikro-orm/postgresql": "6.4.3", diff --git a/packages/modules/customer/package.json b/packages/modules/customer/package.json index 3fc9680399..ba159acff3 100644 --- a/packages/modules/customer/package.json +++ b/packages/modules/customer/package.json @@ -37,8 +37,8 @@ "orm:cache:clear": "MIKRO_ORM_CLI_CONFIG=./mikro-orm.config.dev.ts medusa-mikro-orm cache:clear" }, "devDependencies": { - "@medusajs/framework": "^2.6.0", - "@medusajs/test-utils": "^2.6.0", + "@medusajs/framework": "2.6.0", + "@medusajs/test-utils": "2.6.0", "@mikro-orm/cli": "6.4.3", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", @@ -51,7 +51,7 @@ "typescript": "^5.6.2" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0", + "@medusajs/framework": "2.6.0", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", "@mikro-orm/postgresql": "6.4.3", diff --git a/packages/modules/event-bus-local/package.json b/packages/modules/event-bus-local/package.json index 7f7c03f6d1..5aef7446c7 100644 --- a/packages/modules/event-bus-local/package.json +++ b/packages/modules/event-bus-local/package.json @@ -23,7 +23,7 @@ "author": "Medusa", "license": "MIT", "devDependencies": { - "@medusajs/framework": "^2.6.0", + "@medusajs/framework": "2.6.0", "@swc/core": "^1.7.28", "@swc/jest": "^0.2.36", "jest": "^29.7.0", @@ -39,6 +39,6 @@ "ulid": "^2.3.0" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0" + "@medusajs/framework": "2.6.0" } } diff --git a/packages/modules/event-bus-redis/package.json b/packages/modules/event-bus-redis/package.json index 821831c551..2c9244575a 100644 --- a/packages/modules/event-bus-redis/package.json +++ b/packages/modules/event-bus-redis/package.json @@ -23,7 +23,7 @@ "author": "Medusa", "license": "MIT", "devDependencies": { - "@medusajs/framework": "^2.6.0", + "@medusajs/framework": "2.6.0", "@swc/core": "^1.7.28", "@swc/jest": "^0.2.36", "jest": "^29.7.0", @@ -40,7 +40,7 @@ "ioredis": "^5.4.1" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0", + "@medusajs/framework": "2.6.0", "awilix": "^8.0.1" } } diff --git a/packages/modules/file/package.json b/packages/modules/file/package.json index 509c874b52..e06177247b 100644 --- a/packages/modules/file/package.json +++ b/packages/modules/file/package.json @@ -36,8 +36,8 @@ "orm:cache:clear": " MIKRO_ORM_CLI_CONFIG=./mikro-orm.config.dev.ts medusa-mikro-orm cache:clear" }, "devDependencies": { - "@medusajs/framework": "^2.6.0", - "@medusajs/test-utils": "^2.6.0", + "@medusajs/framework": "2.6.0", + "@medusajs/test-utils": "2.6.0", "@mikro-orm/cli": "6.4.3", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", @@ -50,7 +50,7 @@ "typescript": "^5.6.2" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0", + "@medusajs/framework": "2.6.0", "awilix": "^8.0.1" } } diff --git a/packages/modules/fulfillment/package.json b/packages/modules/fulfillment/package.json index 32498b4924..3e20d9b99b 100644 --- a/packages/modules/fulfillment/package.json +++ b/packages/modules/fulfillment/package.json @@ -36,8 +36,8 @@ "orm:cache:clear": " MIKRO_ORM_CLI_CONFIG=./mikro-orm.config.dev.ts medusa-mikro-orm cache:clear" }, "devDependencies": { - "@medusajs/framework": "^2.6.0", - "@medusajs/test-utils": "^2.6.0", + "@medusajs/framework": "2.6.0", + "@medusajs/test-utils": "2.6.0", "@mikro-orm/cli": "6.4.3", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", @@ -50,7 +50,7 @@ "typescript": "^5.6.2" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0", + "@medusajs/framework": "2.6.0", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", "@mikro-orm/postgresql": "6.4.3", diff --git a/packages/modules/index/package.json b/packages/modules/index/package.json index bae8d51af6..a6290c3eee 100644 --- a/packages/modules/index/package.json +++ b/packages/modules/index/package.json @@ -36,8 +36,8 @@ "orm:cache:clear": " MIKRO_ORM_CLI_CONFIG=./mikro-orm.config.dev.ts medusa-mikro-orm cache:clear" }, "devDependencies": { - "@medusajs/framework": "^2.6.0", - "@medusajs/test-utils": "^2.6.0", + "@medusajs/framework": "2.6.0", + "@medusajs/test-utils": "2.6.0", "@mikro-orm/cli": "6.4.3", "@mikro-orm/core": "6.4.3", "@mikro-orm/knex": "6.4.3", @@ -51,7 +51,7 @@ "typescript": "^5.6.2" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0", + "@medusajs/framework": "2.6.0", "@mikro-orm/core": "6.4.3", "@mikro-orm/knex": "6.4.3", "@mikro-orm/migrations": "6.4.3", diff --git a/packages/modules/inventory/package.json b/packages/modules/inventory/package.json index f21943b04b..b3fa0851d1 100644 --- a/packages/modules/inventory/package.json +++ b/packages/modules/inventory/package.json @@ -23,8 +23,8 @@ "author": "Medusa", "license": "MIT", "devDependencies": { - "@medusajs/framework": "^2.6.0", - "@medusajs/test-utils": "^2.6.0", + "@medusajs/framework": "2.6.0", + "@medusajs/test-utils": "2.6.0", "@mikro-orm/cli": "6.4.3", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", @@ -37,7 +37,7 @@ "typescript": "^5.6.2" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0", + "@medusajs/framework": "2.6.0", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", "@mikro-orm/postgresql": "6.4.3", diff --git a/packages/modules/link-modules/package.json b/packages/modules/link-modules/package.json index 34f430c9e6..8b0378239f 100644 --- a/packages/modules/link-modules/package.json +++ b/packages/modules/link-modules/package.json @@ -33,8 +33,8 @@ "test:integration": "jest --forceExit -- integration-tests/**/__tests__/**/*.ts" }, "devDependencies": { - "@medusajs/framework": "^2.6.0", - "@medusajs/test-utils": "^2.6.0", + "@medusajs/framework": "2.6.0", + "@medusajs/test-utils": "2.6.0", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", "@mikro-orm/postgresql": "6.4.3", @@ -47,7 +47,7 @@ "typescript": "^5.6.2" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0", + "@medusajs/framework": "2.6.0", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", "@mikro-orm/postgresql": "6.4.3", diff --git a/packages/modules/locking/package.json b/packages/modules/locking/package.json index 265f395504..eadce3d420 100644 --- a/packages/modules/locking/package.json +++ b/packages/modules/locking/package.json @@ -32,8 +32,8 @@ "orm:cache:clear": " MIKRO_ORM_CLI_CONFIG=./mikro-orm.config.dev.ts medusa-mikro-orm cache:clear" }, "devDependencies": { - "@medusajs/framework": "^2.6.0", - "@medusajs/test-utils": "^2.6.0", + "@medusajs/framework": "2.6.0", + "@medusajs/test-utils": "2.6.0", "@mikro-orm/cli": "6.4.3", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", @@ -46,7 +46,7 @@ "typescript": "^5.6.2" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0", + "@medusajs/framework": "2.6.0", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", "@mikro-orm/postgresql": "6.4.3", diff --git a/packages/modules/notification/package.json b/packages/modules/notification/package.json index da19119280..fe5d597103 100644 --- a/packages/modules/notification/package.json +++ b/packages/modules/notification/package.json @@ -36,8 +36,8 @@ "orm:cache:clear": " MIKRO_ORM_CLI_CONFIG=./mikro-orm.config.dev.ts medusa-mikro-orm cache:clear" }, "devDependencies": { - "@medusajs/framework": "^2.6.0", - "@medusajs/test-utils": "^2.6.0", + "@medusajs/framework": "2.6.0", + "@medusajs/test-utils": "2.6.0", "@mikro-orm/cli": "6.4.3", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", @@ -50,7 +50,7 @@ "typescript": "^5.6.2" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0", + "@medusajs/framework": "2.6.0", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", "@mikro-orm/postgresql": "6.4.3", diff --git a/packages/modules/order/package.json b/packages/modules/order/package.json index bed8c13a9c..2350c38076 100644 --- a/packages/modules/order/package.json +++ b/packages/modules/order/package.json @@ -36,8 +36,8 @@ "orm:cache:clear": " MIKRO_ORM_CLI_CONFIG=./mikro-orm.config.dev.ts medusa-mikro-orm cache:clear" }, "devDependencies": { - "@medusajs/framework": "^2.6.0", - "@medusajs/test-utils": "^2.6.0", + "@medusajs/framework": "2.6.0", + "@medusajs/test-utils": "2.6.0", "@mikro-orm/cli": "6.4.3", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", @@ -50,7 +50,7 @@ "typescript": "^5.6.2" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0", + "@medusajs/framework": "2.6.0", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", "@mikro-orm/postgresql": "6.4.3", diff --git a/packages/modules/payment/package.json b/packages/modules/payment/package.json index 49c966ff14..45bdd09a9e 100644 --- a/packages/modules/payment/package.json +++ b/packages/modules/payment/package.json @@ -36,8 +36,8 @@ "orm:cache:clear": " MIKRO_ORM_CLI_CONFIG=./mikro-orm.config.dev.ts medusa-mikro-orm cache:clear" }, "devDependencies": { - "@medusajs/framework": "^2.6.0", - "@medusajs/test-utils": "^2.6.0", + "@medusajs/framework": "2.6.0", + "@medusajs/test-utils": "2.6.0", "@mikro-orm/cli": "6.4.3", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", @@ -50,7 +50,7 @@ "typescript": "^5.6.2" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0", + "@medusajs/framework": "2.6.0", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", "@mikro-orm/postgresql": "6.4.3", diff --git a/packages/modules/pricing/integration-tests/__tests__/services/pricing-module/price-list.spec.ts b/packages/modules/pricing/integration-tests/__tests__/services/pricing-module/price-list.spec.ts index 8b3ecf89dd..0ccd07305c 100644 --- a/packages/modules/pricing/integration-tests/__tests__/services/pricing-module/price-list.spec.ts +++ b/packages/modules/pricing/integration-tests/__tests__/services/pricing-module/price-list.spec.ts @@ -825,6 +825,32 @@ moduleIntegrationTestRunner({ }, ]) + const events = eventBusEmitSpy.mock.calls[2][0] + expect(events).toEqual( + expect.arrayContaining([ + expect.objectContaining({ + name: "pricing.price-rule.created", + }), + expect.objectContaining({ + name: "pricing.price-rule.created", + }), + expect.objectContaining({ + name: "pricing.price.updated", + metadata: { + source: "pricing", + object: "price", + action: "updated", + }, + data: { + id: "test-price-id", + }, + }), + expect.objectContaining({ + name: "pricing.price-rule.deleted", + }), + ]) + ) + const [priceList] = await service.listPriceLists( { id: ["price-list-1"] }, { diff --git a/packages/modules/pricing/package.json b/packages/modules/pricing/package.json index eb78e6d04b..b55190486f 100644 --- a/packages/modules/pricing/package.json +++ b/packages/modules/pricing/package.json @@ -36,8 +36,8 @@ "orm:cache:clear": " MIKRO_ORM_CLI_CONFIG=./mikro-orm.config.dev.ts medusa-mikro-orm cache:clear" }, "devDependencies": { - "@medusajs/framework": "^2.6.0", - "@medusajs/test-utils": "^2.6.0", + "@medusajs/framework": "2.6.0", + "@medusajs/test-utils": "2.6.0", "@mikro-orm/cli": "6.4.3", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", @@ -50,7 +50,7 @@ "typescript": "^5.6.2" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0", + "@medusajs/framework": "2.6.0", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", "@mikro-orm/postgresql": "6.4.3", diff --git a/packages/modules/pricing/src/services/pricing-module.ts b/packages/modules/pricing/src/services/pricing-module.ts index 2905da23d9..b1d6896360 100644 --- a/packages/modules/pricing/src/services/pricing-module.ts +++ b/packages/modules/pricing/src/services/pricing-module.ts @@ -40,6 +40,7 @@ import { promiseAll, removeNullish, simpleHash, + upperCaseFirst, } from "@medusajs/framework/utils" import { @@ -472,6 +473,7 @@ export default class PricingModuleService ): Promise @InjectManager() + @EmitEvents() async upsertPriceSets( data: UpsertPriceSetDTO | UpsertPriceSetDTO[], @MedusaContext() sharedContext: Context = {} @@ -513,6 +515,7 @@ export default class PricingModuleService ): Promise @InjectManager() + @EmitEvents() // @ts-expect-error async updatePriceSets( idOrSelector: string | PricingTypes.FilterablePriceSetProps, @@ -563,13 +566,19 @@ export default class PricingModuleService }) const prices = normalizedData.flatMap((priceSet) => priceSet.prices || []) - const { entities: upsertedPrices } = + const { entities: upsertedPrices, performedActions } = await this.priceService_.upsertWithReplace( prices, { relations: ["price_rules"] }, sharedContext ) + composeAllEvents({ + eventBuilders, + performedActions, + sharedContext, + }) + const priceSetsToUpsert = normalizedData.map((priceSet) => { const { prices, ...rest } = priceSet return { @@ -594,13 +603,19 @@ export default class PricingModuleService } }) - const { entities: priceSets } = + const { entities: priceSets, performedActions: priceSetPerformedActions } = await this.priceSetService_.upsertWithReplace( priceSetsToUpsert, { relations: ["prices"] }, sharedContext ) + composeAllEvents({ + eventBuilders, + performedActions: priceSetPerformedActions, + sharedContext, + }) + return priceSets.map((ps) => { if (ps.prices) { ps.prices = (ps.prices as any).filter((p) => !p.price_list_id) @@ -747,6 +762,7 @@ export default class PricingModuleService } @InjectTransactionManager() + @EmitEvents() // @ts-ignore async updatePriceLists( data: PricingTypes.UpdatePriceListDTO[], @@ -760,6 +776,7 @@ export default class PricingModuleService } @InjectManager() + @EmitEvents() async updatePriceListPrices( data: PricingTypes.UpdatePriceListPricesDTO[], @MedusaContext() sharedContext: Context = {} @@ -770,6 +787,7 @@ export default class PricingModuleService } @InjectManager() + @EmitEvents() async removePrices( ids: string[], @MedusaContext() sharedContext: Context = {} @@ -789,6 +807,7 @@ export default class PricingModuleService } @InjectManager() + @EmitEvents() async setPriceListRules( data: PricingTypes.SetPriceListRulesDTO, @MedusaContext() sharedContext: Context = {} @@ -801,6 +820,7 @@ export default class PricingModuleService } @InjectManager() + @EmitEvents() async removePriceListRules( data: PricingTypes.RemovePriceListRulesDTO, @MedusaContext() sharedContext: Context = {} @@ -852,6 +872,7 @@ export default class PricingModuleService ): Promise @InjectManager() + @EmitEvents() async upsertPricePreferences( data: UpsertPricePreferenceDTO | UpsertPricePreferenceDTO[], @MedusaContext() sharedContext: Context = {} @@ -1081,29 +1102,10 @@ export default class PricingModuleService { relations: ["price_rules"] }, sharedContext ) - eventBuilders.createdPrice({ - data: performedActions.created[Price.name] ?? [], - sharedContext, - }) - eventBuilders.updatedPrice({ - data: performedActions.updated[Price.name] ?? [], - sharedContext, - }) - eventBuilders.deletedPrice({ - data: performedActions.deleted[Price.name] ?? [], - sharedContext, - }) - eventBuilders.createdPriceRule({ - data: performedActions.created[PriceRule.name] ?? [], - sharedContext, - }) - eventBuilders.updatedPriceRule({ - data: performedActions.updated[PriceRule.name] ?? [], - sharedContext, - }) - eventBuilders.deletedPriceRule({ - data: performedActions.deleted[PriceRule.name] ?? [], + composeAllEvents({ + eventBuilders, + performedActions, sharedContext, }) @@ -1277,12 +1279,16 @@ export default class PricingModuleService } ) - const { entities } = await this.priceListService_.upsertWithReplace( - normalizedData, - { + const { entities, performedActions } = + await this.priceListService_.upsertWithReplace(normalizedData, { relations: ["price_list_rules"], - } - ) + }) + + composeAllEvents({ + eventBuilders, + performedActions, + sharedContext, + }) return entities } @@ -1326,11 +1332,18 @@ export default class PricingModuleService } } - const { entities } = await this.priceService_.upsertWithReplace( - pricesToUpsert, - { relations: ["price_rules"] }, - sharedContext - ) + const { entities, performedActions } = + await this.priceService_.upsertWithReplace( + pricesToUpsert, + { relations: ["price_rules"] }, + sharedContext + ) + + composeAllEvents({ + eventBuilders, + performedActions, + sharedContext, + }) return entities } @@ -1388,29 +1401,9 @@ export default class PricingModuleService sharedContext ) - eventBuilders.createdPrice({ - data: performedActions.created[Price.name] ?? [], - sharedContext, - }) - eventBuilders.updatedPrice({ - data: performedActions.updated[Price.name] ?? [], - sharedContext, - }) - eventBuilders.deletedPrice({ - data: performedActions.deleted[Price.name] ?? [], - sharedContext, - }) - - eventBuilders.createdPriceRule({ - data: performedActions.created[PriceRule.name] ?? [], - sharedContext, - }) - eventBuilders.updatedPriceRule({ - data: performedActions.updated[PriceRule.name] ?? [], - sharedContext, - }) - eventBuilders.deletedPriceRule({ - data: performedActions.deleted[PriceRule.name] ?? [], + composeAllEvents({ + eventBuilders, + performedActions, sharedContext, }) @@ -1472,11 +1465,18 @@ export default class PricingModuleService }) .filter(Boolean) - const { entities } = await this.priceListService_.upsertWithReplace( - priceListsUpsert, - { relations: ["price_list_rules"] }, - sharedContext - ) + const { entities, performedActions } = + await this.priceListService_.upsertWithReplace( + priceListsUpsert, + { relations: ["price_list_rules"] }, + sharedContext + ) + + composeAllEvents({ + eventBuilders, + performedActions, + sharedContext, + }) return entities } @@ -1539,11 +1539,18 @@ export default class PricingModuleService }) .filter(Boolean) - const { entities } = await this.priceListService_.upsertWithReplace( - priceListsUpsert, - { relations: ["price_list_rules"] }, - sharedContext - ) + const { entities, performedActions } = + await this.priceListService_.upsertWithReplace( + priceListsUpsert, + { relations: ["price_list_rules"] }, + sharedContext + ) + + composeAllEvents({ + eventBuilders, + performedActions, + sharedContext, + }) return entities } @@ -1582,6 +1589,26 @@ export default class PricingModuleService } } +const composeAllEvents = ({ + eventBuilders, + performedActions, + sharedContext, +}) => { + for (const action of Object.keys(performedActions)) { + for (const entity of Object.keys(performedActions[action])) { + const eventName = action + upperCaseFirst(entity) + if (!eventBuilders[eventName]) { + continue + } + + eventBuilders[eventName]({ + data: performedActions[action][entity] ?? [], + sharedContext, + }) + } + } +} + const isTaxInclusive = ( priceRules: InferEntityType[], preferences: InferEntityType[], diff --git a/packages/modules/pricing/src/utils/events.ts b/packages/modules/pricing/src/utils/events.ts index 57d8b2f90b..3d9a8b398d 100644 --- a/packages/modules/pricing/src/utils/events.ts +++ b/packages/modules/pricing/src/utils/events.ts @@ -36,11 +36,11 @@ export const eventBuilders = { object: "price_list_rule", eventName: PricingEvents.PRICE_LIST_RULE_CREATED, }), - attachedPriceListRule: moduleEventBuilderFactory({ + updatedPriceSet: moduleEventBuilderFactory({ source: Modules.PRICING, - action: CommonEvents.ATTACHED, - object: "price_list_rule", - eventName: PricingEvents.PRICE_LIST_RULE_ATTACHED, + action: CommonEvents.UPDATED, + object: "price_set", + eventName: PricingEvents.PRICE_SET_UPDATED, }), updatedPrice: moduleEventBuilderFactory({ source: Modules.PRICING, @@ -48,18 +48,48 @@ export const eventBuilders = { object: "price", eventName: PricingEvents.PRICE_UPDATED, }), + updatedPriceList: moduleEventBuilderFactory({ + source: Modules.PRICING, + action: CommonEvents.UPDATED, + object: "price_list", + eventName: PricingEvents.PRICE_LIST_UPDATED, + }), + updatedPriceListRule: moduleEventBuilderFactory({ + source: Modules.PRICING, + action: CommonEvents.UPDATED, + object: "price_list_rule", + eventName: PricingEvents.PRICE_LIST_RULE_UPDATED, + }), updatedPriceRule: moduleEventBuilderFactory({ source: Modules.PRICING, action: CommonEvents.UPDATED, object: "price_rule", eventName: PricingEvents.PRICE_RULE_UPDATED, }), + deletedPriceSet: moduleEventBuilderFactory({ + source: Modules.PRICING, + action: CommonEvents.DELETED, + object: "price_set", + eventName: PricingEvents.PRICE_SET_DELETED, + }), deletedPrice: moduleEventBuilderFactory({ source: Modules.PRICING, action: CommonEvents.DELETED, object: "price", eventName: PricingEvents.PRICE_DELETED, }), + deletedPriceList: moduleEventBuilderFactory({ + source: Modules.PRICING, + action: CommonEvents.DELETED, + object: "price_list", + eventName: PricingEvents.PRICE_LIST_DELETED, + }), + deletedPriceListRule: moduleEventBuilderFactory({ + source: Modules.PRICING, + action: CommonEvents.DELETED, + object: "price_list_rule", + eventName: PricingEvents.PRICE_LIST_RULE_DELETED, + }), deletedPriceRule: moduleEventBuilderFactory({ source: Modules.PRICING, action: CommonEvents.DELETED, diff --git a/packages/modules/product/package.json b/packages/modules/product/package.json index a5e03aeb0a..69563143f4 100644 --- a/packages/modules/product/package.json +++ b/packages/modules/product/package.json @@ -36,8 +36,8 @@ "orm:cache:clear": " MIKRO_ORM_CLI_CONFIG=./mikro-orm.config.dev.ts medusa-mikro-orm cache:clear" }, "devDependencies": { - "@medusajs/framework": "^2.6.0", - "@medusajs/test-utils": "^2.6.0", + "@medusajs/framework": "2.6.0", + "@medusajs/test-utils": "2.6.0", "@mikro-orm/cli": "6.4.3", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", @@ -51,7 +51,7 @@ "typescript": "^5.6.2" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0", + "@medusajs/framework": "2.6.0", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", "@mikro-orm/postgresql": "6.4.3", diff --git a/packages/modules/promotion/package.json b/packages/modules/promotion/package.json index d93bc53d14..1d96410814 100644 --- a/packages/modules/promotion/package.json +++ b/packages/modules/promotion/package.json @@ -36,8 +36,8 @@ "orm:cache:clear": " MIKRO_ORM_CLI_CONFIG=./mikro-orm.config.dev.ts medusa-mikro-orm cache:clear" }, "devDependencies": { - "@medusajs/framework": "^2.6.0", - "@medusajs/test-utils": "^2.6.0", + "@medusajs/framework": "2.6.0", + "@medusajs/test-utils": "2.6.0", "@mikro-orm/cli": "6.4.3", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", @@ -50,7 +50,7 @@ "typescript": "^5.6.2" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0", + "@medusajs/framework": "2.6.0", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", "@mikro-orm/postgresql": "6.4.3", diff --git a/packages/modules/providers/auth-emailpass/package.json b/packages/modules/providers/auth-emailpass/package.json index f0746b63ea..f35ebe63da 100644 --- a/packages/modules/providers/auth-emailpass/package.json +++ b/packages/modules/providers/auth-emailpass/package.json @@ -26,7 +26,7 @@ "watch": "tsc --watch" }, "devDependencies": { - "@medusajs/framework": "^2.6.0", + "@medusajs/framework": "2.6.0", "@swc/core": "^1.7.28", "@swc/jest": "^0.2.36", "jest": "^29.7.0", @@ -37,7 +37,7 @@ "scrypt-kdf": "^2.0.1" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0" + "@medusajs/framework": "2.6.0" }, "keywords": [ "medusa-provider", diff --git a/packages/modules/providers/auth-github/package.json b/packages/modules/providers/auth-github/package.json index 371f239964..10b35560a6 100644 --- a/packages/modules/providers/auth-github/package.json +++ b/packages/modules/providers/auth-github/package.json @@ -26,7 +26,7 @@ "watch": "tsc --watch" }, "devDependencies": { - "@medusajs/framework": "^2.6.0", + "@medusajs/framework": "2.6.0", "@swc/core": "^1.7.28", "@swc/jest": "^0.2.36", "jest": "^29.7.0", @@ -35,7 +35,7 @@ "typescript": "^5.6.2" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0" + "@medusajs/framework": "2.6.0" }, "keywords": [ "medusa-provider", diff --git a/packages/modules/providers/auth-google/package.json b/packages/modules/providers/auth-google/package.json index c5e4c750b5..6e23d30973 100644 --- a/packages/modules/providers/auth-google/package.json +++ b/packages/modules/providers/auth-google/package.json @@ -26,7 +26,7 @@ "watch": "tsc --watch" }, "devDependencies": { - "@medusajs/framework": "^2.6.0", + "@medusajs/framework": "2.6.0", "@swc/core": "^1.7.28", "@swc/jest": "^0.2.36", "jest": "^29.7.0", @@ -38,7 +38,7 @@ "jsonwebtoken": "^9.0.2" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0" + "@medusajs/framework": "2.6.0" }, "keywords": [ "medusa-provider", diff --git a/packages/modules/providers/file-local/package.json b/packages/modules/providers/file-local/package.json index 9542e03dd9..d092623d92 100644 --- a/packages/modules/providers/file-local/package.json +++ b/packages/modules/providers/file-local/package.json @@ -25,7 +25,7 @@ "watch": "tsc --watch" }, "devDependencies": { - "@medusajs/framework": "^2.6.0", + "@medusajs/framework": "2.6.0", "@swc/core": "^1.7.28", "@swc/jest": "^0.2.36", "jest": "^29.7.0", @@ -33,7 +33,7 @@ "typescript": "^5.6.2" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0" + "@medusajs/framework": "2.6.0" }, "keywords": [ "medusa-plugin", diff --git a/packages/modules/providers/file-s3/package.json b/packages/modules/providers/file-s3/package.json index 1c177fe6eb..4cc8c80357 100644 --- a/packages/modules/providers/file-s3/package.json +++ b/packages/modules/providers/file-s3/package.json @@ -26,7 +26,7 @@ "watch": "tsc --watch" }, "devDependencies": { - "@medusajs/framework": "^2.6.0", + "@medusajs/framework": "2.6.0", "@swc/core": "^1.7.28", "@swc/jest": "^0.2.36", "axios": "^1.6.8", @@ -40,7 +40,7 @@ "ulid": "^2.3.0" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0" + "@medusajs/framework": "2.6.0" }, "keywords": [ "medusa-plugin", diff --git a/packages/modules/providers/fulfillment-manual/package.json b/packages/modules/providers/fulfillment-manual/package.json index b014f4ecb9..0ce56e999a 100644 --- a/packages/modules/providers/fulfillment-manual/package.json +++ b/packages/modules/providers/fulfillment-manual/package.json @@ -25,7 +25,7 @@ "watch": "tsc --watch" }, "devDependencies": { - "@medusajs/framework": "^2.6.0", + "@medusajs/framework": "2.6.0", "@swc/core": "^1.7.28", "@swc/jest": "^0.2.36", "jest": "^29.7.0", @@ -33,7 +33,7 @@ "typescript": "^5.6.2" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0" + "@medusajs/framework": "2.6.0" }, "keywords": [ "medusa-plugin", diff --git a/packages/modules/providers/locking-postgres/package.json b/packages/modules/providers/locking-postgres/package.json index 4dfecb09df..e33d0f2bc4 100644 --- a/packages/modules/providers/locking-postgres/package.json +++ b/packages/modules/providers/locking-postgres/package.json @@ -20,7 +20,7 @@ "author": "Medusa", "license": "MIT", "devDependencies": { - "@medusajs/framework": "^2.6.0", + "@medusajs/framework": "2.6.0", "@mikro-orm/cli": "6.4.3", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", @@ -32,7 +32,7 @@ "typescript": "^5.6.2" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0" + "@medusajs/framework": "2.6.0" }, "scripts": { "watch": "tsc --build --watch", diff --git a/packages/modules/providers/locking-redis/package.json b/packages/modules/providers/locking-redis/package.json index 0d13f1952d..9fdaf47b42 100644 --- a/packages/modules/providers/locking-redis/package.json +++ b/packages/modules/providers/locking-redis/package.json @@ -20,7 +20,7 @@ "author": "Medusa", "license": "MIT", "devDependencies": { - "@medusajs/framework": "^2.6.0", + "@medusajs/framework": "2.6.0", "@swc/core": "^1.7.28", "@swc/jest": "^0.2.36", "jest": "^29.7.0", @@ -28,7 +28,7 @@ "typescript": "^5.6.2" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0" + "@medusajs/framework": "2.6.0" }, "dependencies": { "ioredis": "^5.4.1" diff --git a/packages/modules/providers/notification-local/package.json b/packages/modules/providers/notification-local/package.json index 787ec31533..1cea6f0f5c 100644 --- a/packages/modules/providers/notification-local/package.json +++ b/packages/modules/providers/notification-local/package.json @@ -26,7 +26,7 @@ "watch": "tsc --watch" }, "devDependencies": { - "@medusajs/framework": "^2.6.0", + "@medusajs/framework": "2.6.0", "@swc/core": "^1.7.28", "@swc/jest": "^0.2.36", "jest": "^29.7.0", @@ -34,7 +34,7 @@ "typescript": "^5.6.2" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0" + "@medusajs/framework": "2.6.0" }, "keywords": [ "medusa-provider", diff --git a/packages/modules/providers/notification-sendgrid/package.json b/packages/modules/providers/notification-sendgrid/package.json index 91ec8478f2..9a82f0d112 100644 --- a/packages/modules/providers/notification-sendgrid/package.json +++ b/packages/modules/providers/notification-sendgrid/package.json @@ -26,7 +26,7 @@ "watch": "tsc --watch" }, "devDependencies": { - "@medusajs/framework": "^2.6.0", + "@medusajs/framework": "2.6.0", "@swc/core": "^1.7.28", "@swc/jest": "^0.2.36", "jest": "^29.7.0", @@ -37,7 +37,7 @@ "@sendgrid/mail": "^8.1.3" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0" + "@medusajs/framework": "2.6.0" }, "keywords": [ "medusa-provider", diff --git a/packages/modules/providers/payment-stripe/package.json b/packages/modules/providers/payment-stripe/package.json index 3f44066bb8..d883e9079b 100644 --- a/packages/modules/providers/payment-stripe/package.json +++ b/packages/modules/providers/payment-stripe/package.json @@ -25,7 +25,7 @@ "watch": "tsc --watch" }, "devDependencies": { - "@medusajs/framework": "^2.6.0", + "@medusajs/framework": "2.6.0", "@swc/core": "^1.7.28", "@swc/jest": "^0.2.36", "jest": "^29.7.0", @@ -33,7 +33,7 @@ "typescript": "^5.6.2" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0", + "@medusajs/framework": "2.6.0", "awilix": "^8.0.1" }, "dependencies": { diff --git a/packages/modules/region/package.json b/packages/modules/region/package.json index 29127d1fef..020089f99c 100644 --- a/packages/modules/region/package.json +++ b/packages/modules/region/package.json @@ -36,8 +36,8 @@ "orm:cache:clear": " MIKRO_ORM_CLI_CONFIG=./mikro-orm.config.dev.ts medusa-mikro-orm cache:clear" }, "devDependencies": { - "@medusajs/framework": "^2.6.0", - "@medusajs/test-utils": "^2.6.0", + "@medusajs/framework": "2.6.0", + "@medusajs/test-utils": "2.6.0", "@mikro-orm/cli": "6.4.3", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", @@ -50,7 +50,7 @@ "typescript": "^5.6.2" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0", + "@medusajs/framework": "2.6.0", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", "@mikro-orm/postgresql": "6.4.3", diff --git a/packages/modules/sales-channel/package.json b/packages/modules/sales-channel/package.json index cb922610c0..1c80440503 100644 --- a/packages/modules/sales-channel/package.json +++ b/packages/modules/sales-channel/package.json @@ -36,8 +36,8 @@ "orm:cache:clear": " MIKRO_ORM_CLI_CONFIG=./mikro-orm.config.dev.ts medusa-mikro-orm cache:clear" }, "devDependencies": { - "@medusajs/framework": "^2.6.0", - "@medusajs/test-utils": "^2.6.0", + "@medusajs/framework": "2.6.0", + "@medusajs/test-utils": "2.6.0", "@mikro-orm/cli": "6.4.3", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", @@ -50,7 +50,7 @@ "typescript": "^5.6.2" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0", + "@medusajs/framework": "2.6.0", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", "@mikro-orm/postgresql": "6.4.3", diff --git a/packages/modules/stock-location/package.json b/packages/modules/stock-location/package.json index 29f280fc2f..26daba84f0 100644 --- a/packages/modules/stock-location/package.json +++ b/packages/modules/stock-location/package.json @@ -23,8 +23,8 @@ "author": "Medusa", "license": "MIT", "devDependencies": { - "@medusajs/framework": "^2.6.0", - "@medusajs/test-utils": "^2.6.0", + "@medusajs/framework": "2.6.0", + "@medusajs/test-utils": "2.6.0", "@mikro-orm/cli": "6.4.3", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", @@ -37,7 +37,7 @@ "typescript": "^5.6.2" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0", + "@medusajs/framework": "2.6.0", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", "@mikro-orm/postgresql": "6.4.3", diff --git a/packages/modules/store/package.json b/packages/modules/store/package.json index 0a551ac6e1..38896ddec7 100644 --- a/packages/modules/store/package.json +++ b/packages/modules/store/package.json @@ -36,8 +36,8 @@ "orm:cache:clear": " MIKRO_ORM_CLI_CONFIG=./mikro-orm.config.dev.ts medusa-mikro-orm cache:clear" }, "devDependencies": { - "@medusajs/framework": "^2.6.0", - "@medusajs/test-utils": "^2.6.0", + "@medusajs/framework": "2.6.0", + "@medusajs/test-utils": "2.6.0", "@mikro-orm/cli": "6.4.3", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", @@ -50,7 +50,7 @@ "typescript": "^5.6.2" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0", + "@medusajs/framework": "2.6.0", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", "@mikro-orm/postgresql": "6.4.3", diff --git a/packages/modules/tax/package.json b/packages/modules/tax/package.json index dddbbd809a..37ce69cace 100644 --- a/packages/modules/tax/package.json +++ b/packages/modules/tax/package.json @@ -36,8 +36,8 @@ "orm:cache:clear": " MIKRO_ORM_CLI_CONFIG=./mikro-orm.config.dev.ts medusa-mikro-orm cache:clear" }, "devDependencies": { - "@medusajs/framework": "^2.6.0", - "@medusajs/test-utils": "^2.6.0", + "@medusajs/framework": "2.6.0", + "@medusajs/test-utils": "2.6.0", "@mikro-orm/cli": "6.4.3", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", @@ -50,7 +50,7 @@ "typescript": "^5.6.2" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0", + "@medusajs/framework": "2.6.0", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", "@mikro-orm/postgresql": "6.4.3", diff --git a/packages/modules/user/package.json b/packages/modules/user/package.json index 20b642c1ce..addf1afc9a 100644 --- a/packages/modules/user/package.json +++ b/packages/modules/user/package.json @@ -36,8 +36,8 @@ "orm:cache:clear": " MIKRO_ORM_CLI_CONFIG=./mikro-orm.config.dev.ts medusa-mikro-orm cache:clear" }, "devDependencies": { - "@medusajs/framework": "^2.6.0", - "@medusajs/test-utils": "^2.6.0", + "@medusajs/framework": "2.6.0", + "@medusajs/test-utils": "2.6.0", "@mikro-orm/cli": "6.4.3", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", @@ -53,7 +53,7 @@ "jsonwebtoken": "^9.0.2" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0", + "@medusajs/framework": "2.6.0", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", "@mikro-orm/postgresql": "6.4.3", diff --git a/packages/modules/workflow-engine-inmemory/package.json b/packages/modules/workflow-engine-inmemory/package.json index a391f753e1..87e5bc2191 100644 --- a/packages/modules/workflow-engine-inmemory/package.json +++ b/packages/modules/workflow-engine-inmemory/package.json @@ -36,8 +36,8 @@ "orm:cache:clear": " MIKRO_ORM_CLI_CONFIG=./mikro-orm.config.dev.ts medusa-mikro-orm cache:clear" }, "devDependencies": { - "@medusajs/framework": "^2.6.0", - "@medusajs/test-utils": "^2.6.0", + "@medusajs/framework": "2.6.0", + "@medusajs/test-utils": "2.6.0", "@mikro-orm/cli": "6.4.3", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", @@ -54,7 +54,7 @@ "ulid": "^2.3.0" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0", + "@medusajs/framework": "2.6.0", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", "@mikro-orm/postgresql": "6.4.3", diff --git a/packages/modules/workflow-engine-redis/package.json b/packages/modules/workflow-engine-redis/package.json index 0d39ff483e..28ee3fc1c2 100644 --- a/packages/modules/workflow-engine-redis/package.json +++ b/packages/modules/workflow-engine-redis/package.json @@ -36,8 +36,8 @@ "orm:cache:clear": " MIKRO_ORM_CLI_CONFIG=./mikro-orm.config.dev.ts medusa-mikro-orm cache:clear" }, "devDependencies": { - "@medusajs/framework": "^2.6.0", - "@medusajs/test-utils": "^2.6.0", + "@medusajs/framework": "2.6.0", + "@medusajs/test-utils": "2.6.0", "@mikro-orm/cli": "6.4.3", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", @@ -55,7 +55,7 @@ "ulid": "^2.3.0" }, "peerDependencies": { - "@medusajs/framework": "^2.4.0", + "@medusajs/framework": "2.6.0", "@mikro-orm/core": "6.4.3", "@mikro-orm/migrations": "6.4.3", "@mikro-orm/postgresql": "6.4.3", diff --git a/packages/modules/workflow-engine-redis/src/loaders/redis.ts b/packages/modules/workflow-engine-redis/src/loaders/redis.ts index 75cfd33266..2da145c109 100644 --- a/packages/modules/workflow-engine-redis/src/loaders/redis.ts +++ b/packages/modules/workflow-engine-redis/src/loaders/redis.ts @@ -1,14 +1,15 @@ -import { LoaderOptions } from "@medusajs/framework/types" +import { + InternalModuleDeclaration, + LoaderOptions, +} from "@medusajs/framework/types" import { asValue } from "awilix" import Redis from "ioredis" import { RedisWorkflowsOptions } from "../types" -export default async ({ - container, - logger, - options, - dataLoaderOnly, -}: LoaderOptions): Promise => { +export default async ( + { container, logger, options, dataLoaderOnly }: LoaderOptions, + moduleDeclaration: InternalModuleDeclaration +): Promise => { const { url, options: redisOptions, @@ -25,6 +26,7 @@ export default async ({ const cnnPubSub = pubsub ?? { url, options: redisOptions } const queueName = options?.queueName ?? "medusa-workflows" + const jobQueueName = options?.jobQueueName ?? "medusa-workflows-jobs" let connection let redisPublisher @@ -59,12 +61,14 @@ export default async ({ } container.register({ + isWorkerMode: asValue(moduleDeclaration.worker_mode !== "server"), partialLoading: asValue(true), redisConnection: asValue(connection), redisWorkerConnection: asValue(workerConnection), redisPublisher: asValue(redisPublisher), redisSubscriber: asValue(redisSubscriber), redisQueueName: asValue(queueName), + redisJobQueueName: asValue(jobQueueName), redisDisconnectHandler: asValue(async () => { connection.disconnect() workerConnection.disconnect() diff --git a/packages/modules/workflow-engine-redis/src/types/index.ts b/packages/modules/workflow-engine-redis/src/types/index.ts index 6d7f6d106a..1ea5613d9f 100644 --- a/packages/modules/workflow-engine-redis/src/types/index.ts +++ b/packages/modules/workflow-engine-redis/src/types/index.ts @@ -19,6 +19,11 @@ export type RedisWorkflowsOptions = { */ queueName?: string + /** + * Queue name used for job execution + */ + jobQueueName?: string + /** * Redis client options */ diff --git a/packages/modules/workflow-engine-redis/src/utils/workflow-orchestrator-storage.ts b/packages/modules/workflow-engine-redis/src/utils/workflow-orchestrator-storage.ts index c97a751eab..8365160509 100644 --- a/packages/modules/workflow-engine-redis/src/utils/workflow-orchestrator-storage.ts +++ b/packages/modules/workflow-engine-redis/src/utils/workflow-orchestrator-storage.ts @@ -36,37 +36,55 @@ export class RedisDistributedTransactionStorage private redisClient: Redis private redisWorkerConnection: Redis private queueName: string + private jobQueueName: string private queue: Queue + private jobQueue?: Queue private worker: Worker + private jobWorker?: Worker + + #isWorkerMode: boolean = false constructor({ workflowExecutionService, redisConnection, redisWorkerConnection, redisQueueName, + redisJobQueueName, logger, + isWorkerMode, }: { workflowExecutionService: ModulesSdkTypes.IMedusaInternalService redisConnection: Redis redisWorkerConnection: Redis redisQueueName: string + redisJobQueueName: string logger: Logger + isWorkerMode: boolean }) { this.workflowExecutionService_ = workflowExecutionService this.logger_ = logger this.redisClient = redisConnection this.redisWorkerConnection = redisWorkerConnection this.queueName = redisQueueName + this.jobQueueName = redisJobQueueName this.queue = new Queue(redisQueueName, { connection: this.redisClient }) + this.jobQueue = isWorkerMode + ? new Queue(redisJobQueueName, { + connection: this.redisClient, + }) + : undefined + this.#isWorkerMode = isWorkerMode } async onApplicationPrepareShutdown() { // Close worker gracefully, i.e. wait for the current jobs to finish await this.worker?.close() + await this.jobWorker?.close() } async onApplicationShutdown() { await this.queue?.close() + await this.jobQueue?.close() } async onApplicationStart() { @@ -76,6 +94,11 @@ export class RedisDistributedTransactionStorage JobType.TRANSACTION_TIMEOUT, ] + const workerOptions = { + connection: + this.redisWorkerConnection /*, runRetryDelay: 100000 for tests */, + } + this.worker = new Worker( this.queueName, async (job) => { @@ -86,19 +109,26 @@ export class RedisDistributedTransactionStorage ) } - // Note: We might even want a separate worker with different concurrency settings in the future, but for now we keep it simple if (job.name === JobType.SCHEDULE) { + // Remove repeatable job from the old queue since now we have a queue dedicated to scheduled jobs + await this.remove(job.data.jobId) + } + }, + workerOptions + ) + + if (this.#isWorkerMode) { + this.jobWorker = new Worker( + this.jobQueueName, + async (job) => { await this.executeScheduledJob( job.data.jobId, job.data.schedulerOptions ) - } - }, - { - connection: - this.redisWorkerConnection /*, runRetryDelay: 100000 for tests */, - } - ) + }, + workerOptions + ) + } } setWorkflowOrchestratorService(workflowOrchestratorService) { @@ -369,10 +399,18 @@ export class RedisDistributedTransactionStorage step?: TransactionStep ) { const jobId = this.getJobId(type, transaction, step) - const job = await this.queue.getJob(jobId) - if (job && job.attemptsStarted === 0) { - await job.remove() + if (type === JobType.SCHEDULE) { + const job = await this.jobQueue?.getJob(jobId) + if (job) { + await job.remove() + } + } else { + const job = await this.queue.getJob(jobId) + + if (job && job.attemptsStarted === 0) { + await job.remove() + } } } @@ -385,7 +423,7 @@ export class RedisDistributedTransactionStorage typeof jobDefinition === "string" ? jobDefinition : jobDefinition.jobId // If it is the same key (eg. the same workflow name), the old one will get overridden. - await this.queue.add( + await this.jobQueue?.add( JobType.SCHEDULE, { jobId, @@ -410,13 +448,13 @@ export class RedisDistributedTransactionStorage } async remove(jobId: string): Promise { - await this.queue.removeRepeatableByKey(`${JobType.SCHEDULE}_${jobId}`) + await this.jobQueue?.removeRepeatableByKey(`${JobType.SCHEDULE}_${jobId}`) } async removeAll(): Promise { - const repeatableJobs = await this.queue.getRepeatableJobs() + const repeatableJobs = (await this.jobQueue?.getRepeatableJobs()) ?? [] await promiseAll( - repeatableJobs.map((job) => this.queue.removeRepeatableByKey(job.key)) + repeatableJobs.map((job) => this.jobQueue?.removeRepeatableByKey(job.key)) ) } } diff --git a/www/apps/api-reference/app/layout.tsx b/www/apps/api-reference/app/layout.tsx index 962557a1e0..ca269efdce 100644 --- a/www/apps/api-reference/app/layout.tsx +++ b/www/apps/api-reference/app/layout.tsx @@ -58,9 +58,6 @@ export default function RootLayout({ gaId={process.env.NEXT_PUBLIC_GA_ID} > const H2 = ({ children, ...props }: H2Props) => { const headingRef = useRef(null) - const { activePath, addItems, removeItems } = useSidebar() + const { activePath, addItems, removeItems, shownSidebar } = useSidebar() const { scrollableElement, scrollToElement } = useScrollController() const [scrolledFirstTime, setScrolledFirstTime] = useState(false) @@ -29,7 +29,10 @@ const H2 = ({ children, ...props }: H2Props) => { }, [scrollableElement, headingRef, id]) useEffect(() => { - const item: SidebarItem[] = [ + if (!shownSidebar) { + return + } + const items: Sidebar.SidebarItem[] = [ { type: "link", path: `${id}`, @@ -37,12 +40,17 @@ const H2 = ({ children, ...props }: H2Props) => { loaded: true, }, ] - addItems(item) + addItems(items, { + sidebar_id: shownSidebar.sidebar_id, + }) return () => { - removeItems(item) + removeItems({ + items, + sidebar_id: shownSidebar.sidebar_id, + }) } - }, [id]) + }, [id, shownSidebar?.sidebar_id]) return ( diff --git a/www/apps/api-reference/components/Tags/Operation/index.tsx b/www/apps/api-reference/components/Tags/Operation/index.tsx index 02ef1ca8a8..c25c0c93cd 100644 --- a/www/apps/api-reference/components/Tags/Operation/index.tsx +++ b/www/apps/api-reference/components/Tags/Operation/index.tsx @@ -60,11 +60,12 @@ const TagOperation = ({ }, [isBrowser, scrollableElement]) const scrollIntoView = useCallback(() => { - if (!isBrowser) { + if (!isBrowser || !nodeRef.current) { + // repeat timeout + setTimeout(scrollIntoView, 200) return } - - if (nodeRef.current && !checkElementInViewport(nodeRef.current, 0)) { + if (!checkElementInViewport(nodeRef.current, 0)) { const elm = nodeRef.current as HTMLElement scrollToTop( elm.offsetTop + (elm.offsetParent as HTMLElement)?.offsetTop, diff --git a/www/apps/api-reference/components/Tags/Paths/index.tsx b/www/apps/api-reference/components/Tags/Paths/index.tsx index 2549c1683c..f4a0472317 100644 --- a/www/apps/api-reference/components/Tags/Paths/index.tsx +++ b/www/apps/api-reference/components/Tags/Paths/index.tsx @@ -1,8 +1,7 @@ "use client" -import type { OpenAPIV3 } from "openapi-types" -import type { Operation, PathsObject } from "@/types/openapi" -import { useSidebar } from "docs-ui" +import type { Operation, PathsObject, TagObject } from "@/types/openapi" +import { findSidebarItem, useSidebar } from "docs-ui" import { Fragment, Suspense, useEffect } from "react" import dynamic from "next/dynamic" import type { TagOperationProps } from "../Operation" @@ -10,32 +9,41 @@ import clsx from "clsx" import getTagChildSidebarItems from "@/utils/get-tag-child-sidebar-items" import { useLoading } from "@/providers/loading" import DividedLoading from "@/components/DividedLoading" -import { SidebarItemSections, SidebarItem, SidebarItemCategory } from "types" +import { Sidebar } from "types" const TagOperation = dynamic( async () => import("../Operation") ) as React.FC export type TagPathsProps = { - tag: OpenAPIV3.TagObject + tag: TagObject paths: PathsObject } & React.HTMLAttributes const TagPaths = ({ tag, className, paths }: TagPathsProps) => { - const { items, addItems, findItemInSection } = useSidebar() + const { shownSidebar, addItems } = useSidebar() const { loading } = useLoading() useEffect(() => { + if (!shownSidebar) { + return + } + if (paths) { - const parentItem = findItemInSection( - items[SidebarItemSections.DEFAULT], - { title: tag.name }, - false - ) as SidebarItemCategory - const pathItems: SidebarItem[] = getTagChildSidebarItems(paths) - if ((parentItem?.children?.length || 0) < pathItems.length) { + const parentItem = findSidebarItem({ + sidebarItems: + "items" in shownSidebar + ? shownSidebar.items + : shownSidebar.children || [], + item: { title: tag.name, type: "category" }, + checkChildren: false, + }) as Sidebar.SidebarItemCategory + const pathItems: Sidebar.SidebarItem[] = getTagChildSidebarItems(paths) + const targetLength = + pathItems.length + (tag["x-associatedSchema"] ? 1 : 0) + if ((parentItem.children?.length || 0) < targetLength) { addItems(pathItems, { - section: SidebarItemSections.DEFAULT, + sidebar_id: shownSidebar.sidebar_id, parent: { type: "category", title: tag.name, @@ -46,7 +54,7 @@ const TagPaths = ({ tag, className, paths }: TagPathsProps) => { } } // eslint-disable-next-line react-hooks/exhaustive-deps - }, [paths]) + }, [paths, shownSidebar?.sidebar_id]) return ( diff --git a/www/apps/api-reference/components/Tags/Section/Schema/index.tsx b/www/apps/api-reference/components/Tags/Section/Schema/index.tsx index f2e908a160..8043ffe327 100644 --- a/www/apps/api-reference/components/Tags/Section/Schema/index.tsx +++ b/www/apps/api-reference/components/Tags/Section/Schema/index.tsx @@ -1,6 +1,6 @@ "use client" -import { Suspense, useEffect, useMemo, useRef } from "react" +import { Suspense, useEffect, useMemo } from "react" import { SchemaObject } from "../../../../types/openapi" import TagOperationParameters from "../../Operation/Parameters" import { @@ -13,7 +13,6 @@ import { useScrollController, useSidebar, } from "docs-ui" -import { SidebarItemSections } from "types" import getSectionId from "../../../../utils/get-section-id" import DividedLayout from "../../../../layouts/Divided" import SectionContainer from "../../../Section/Container" @@ -30,7 +29,7 @@ export type TagSectionSchemaProps = { } const TagSectionSchema = ({ schema, tagName }: TagSectionSchemaProps) => { - const { addItems, setActivePath, activePath } = useSidebar() + const { addItems, setActivePath, activePath, shownSidebar } = useSidebar() const { displayedArea } = useArea() const formattedName = useMemo( () => singular(tagName).replaceAll(" ", ""), @@ -58,6 +57,9 @@ const TagSectionSchema = ({ schema, tagName }: TagSectionSchemaProps) => { }, [isBrowser, scrollableElement]) useEffect(() => { + if (!shownSidebar) { + return + } addItems( [ { @@ -69,7 +71,7 @@ const TagSectionSchema = ({ schema, tagName }: TagSectionSchemaProps) => { }, ], { - section: SidebarItemSections.DEFAULT, + sidebar_id: shownSidebar.sidebar_id, parent: { type: "category", title: tagName, @@ -80,7 +82,7 @@ const TagSectionSchema = ({ schema, tagName }: TagSectionSchemaProps) => { } ) // eslint-disable-next-line react-hooks/exhaustive-deps - }, [formattedName]) + }, [formattedName, shownSidebar?.sidebar_id]) useEffect(() => { if (!isBrowser) { diff --git a/www/apps/api-reference/components/Tags/Section/index.tsx b/www/apps/api-reference/components/Tags/Section/index.tsx index ac17dc0255..587eecb0f6 100644 --- a/www/apps/api-reference/components/Tags/Section/index.tsx +++ b/www/apps/api-reference/components/Tags/Section/index.tsx @@ -85,23 +85,24 @@ const TagSectionComponent = ({ tag }: TagSectionProps) => { ) useEffect(() => { - if (!isBrowser) { + if (!isBrowser || !activePath || !activePath.includes(slugTagName)) { return } - if (activePath && activePath.includes(slugTagName)) { - const tagName = activePath.split("_") - if (tagName.length === 1 && tagName[0] === slugTagName) { - const elm = document.getElementById(tagName[0]) - if (elm && !checkElementInViewport(elm, 0)) { - scrollToTop( - elm.offsetTop + (elm.offsetParent as HTMLElement)?.offsetTop, - 0 - ) - } - } else if (tagName.length > 1 && tagName[0] === slugTagName) { - setLoadData(true) + const tagName = activePath.split("_") + if (tagName[0] !== slugTagName) { + return + } + if (tagName.length === 1) { + const elm = document.getElementById(tagName[0]) + if (elm && !checkElementInViewport(elm, 0)) { + scrollToTop( + elm.offsetTop + (elm.offsetParent as HTMLElement)?.offsetTop, + 0 + ) } + } else if (tagName.length > 1) { + setLoadData(true) } }, [slugTagName, activePath, isBrowser]) diff --git a/www/apps/api-reference/config/index.ts b/www/apps/api-reference/config/index.ts index a9f53ea7d3..ea33d86448 100644 --- a/www/apps/api-reference/config/index.ts +++ b/www/apps/api-reference/config/index.ts @@ -8,17 +8,20 @@ export const config: DocsConfig = { baseUrl, basePath: process.env.NEXT_PUBLIC_BASE_PATH, // sidebar is auto generated - sidebar: { - default: [ - { - type: "link", - title: "Introduction", - path: "introduction", - loaded: true, - }, - ], - mobile: [], - }, + sidebars: [ + { + sidebar_id: "api-ref", + title: "API Reference", + items: [ + { + type: "link", + title: "Introduction", + path: "introduction", + loaded: true, + }, + ], + }, + ], project: { title: "API Reference", key: "api-reference", diff --git a/www/apps/api-reference/package.json b/www/apps/api-reference/package.json index 27a0b4c4eb..3e5549eee2 100644 --- a/www/apps/api-reference/package.json +++ b/www/apps/api-reference/package.json @@ -15,8 +15,8 @@ "dependencies": { "@mdx-js/loader": "^3.1.0", "@mdx-js/react": "^3.1.0", - "@medusajs/icons": "~2.5.1", - "@medusajs/ui": "~4.0.6", + "@medusajs/icons": "2.6.0", + "@medusajs/ui": "4.0.6", "@next/mdx": "15.0.4", "@react-hook/resize-observer": "^2.0.2", "@readme/openapi-parser": "^2.5.0", diff --git a/www/apps/api-reference/providers/base-specs.tsx b/www/apps/api-reference/providers/base-specs.tsx index a175f79fde..ff7363987b 100644 --- a/www/apps/api-reference/providers/base-specs.tsx +++ b/www/apps/api-reference/providers/base-specs.tsx @@ -2,7 +2,7 @@ import { ExpandedDocument, SecuritySchemeObject } from "@/types/openapi" import { ReactNode, createContext, useContext, useEffect, useMemo } from "react" -import { SidebarItem, SidebarItemSections } from "types" +import { Sidebar } from "types" import getSectionId from "../utils/get-section-id" import getTagChildSidebarItems from "../utils/get-tag-child-sidebar-items" import { useRouter } from "next/navigation" @@ -22,7 +22,8 @@ type BaseSpecsProviderProps = { const BaseSpecsProvider = ({ children, baseSpecs }: BaseSpecsProviderProps) => { const router = useRouter() - const { activePath, addItems, setActivePath, resetItems } = useSidebar() + const { activePath, addItems, setActivePath, resetItems, shownSidebar } = + useSidebar() const getSecuritySchema = ( securityName: string @@ -48,7 +49,7 @@ const BaseSpecsProvider = ({ children, baseSpecs }: BaseSpecsProviderProps) => { return [] } - const itemsToAdd: SidebarItem[] = [ + const itemsToAdd: Sidebar.SidebarItem[] = [ { type: "separator", }, @@ -67,6 +68,7 @@ const BaseSpecsProvider = ({ children, baseSpecs }: BaseSpecsProviderProps) => { children: childItems, loaded: childItems.length > 0, showLoadingIfEmpty: true, + initialOpen: false, onOpen: () => { if (location.hash !== tagPathName) { router.push(`#${tagPathName}`, { @@ -84,14 +86,14 @@ const BaseSpecsProvider = ({ children, baseSpecs }: BaseSpecsProviderProps) => { }, [baseSpecs]) useEffect(() => { - if (!itemsToAdd.length) { + if (!itemsToAdd.length || !shownSidebar) { return } addItems(itemsToAdd, { - section: SidebarItemSections.DEFAULT, + sidebar_id: shownSidebar.sidebar_id, }) - }, [itemsToAdd]) + }, [itemsToAdd, shownSidebar?.sidebar_id]) useEffect(() => { return () => { diff --git a/www/apps/api-reference/providers/page-title.tsx b/www/apps/api-reference/providers/page-title.tsx index 776b88a219..5b40e0200a 100644 --- a/www/apps/api-reference/providers/page-title.tsx +++ b/www/apps/api-reference/providers/page-title.tsx @@ -3,7 +3,7 @@ import { createContext, useEffect } from "react" import { useSidebar } from "docs-ui" import { useArea } from "./area" -import { SidebarItemLink } from "types" +import { Sidebar } from "types" const PageTitleContext = createContext(null) @@ -27,7 +27,7 @@ const PageTitleProvider = ({ children }: PageTitleProviderProps) => { // find the child that matches the active path const item = activeItem?.children?.find( (i) => i.type === "link" && i.path === activePath - ) as SidebarItemLink + ) as Sidebar.SidebarItemLink if (item) { document.title = `${item.title} - ${titleSuffix}` } diff --git a/www/apps/api-reference/providers/sidebar.tsx b/www/apps/api-reference/providers/sidebar.tsx index 59c6a662c5..6a4bb4de9f 100644 --- a/www/apps/api-reference/providers/sidebar.tsx +++ b/www/apps/api-reference/providers/sidebar.tsx @@ -20,10 +20,12 @@ const SidebarProvider = ({ children }: SidebarProviderProps) => { isLoading={isLoading} setIsLoading={setIsLoading} shouldHandleHashChange={true} + shouldHandlePathChange={false} scrollableElement={scrollableElement} - initialItems={config.sidebar} - persistState={false} - projectName="api" + sidebars={config.sidebars} + persistCategoryState={false} + disableActiveTransition={false} + isSidebarStatic={false} > {children} diff --git a/www/apps/api-reference/specs/admin/openapi.full.yaml b/www/apps/api-reference/specs/admin/openapi.full.yaml index ae338abeff..ed3213aa75 100644 --- a/www/apps/api-reference/specs/admin/openapi.full.yaml +++ b/www/apps/api-reference/specs/admin/openapi.full.yaml @@ -17443,7 +17443,7 @@ paths: operationId: GetInvites summary: List Invites description: Retrieve a list of invites. The invites can be filtered by fields such as `id`. The invites can also be sorted or paginated. - x-authenticated: false + x-authenticated: true parameters: - name: fields in: query @@ -17950,11 +17950,15 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] post: operationId: PostInvites summary: Create Invite description: Create a invite. - x-authenticated: false + x-authenticated: true parameters: - name: fields in: query @@ -18014,6 +18018,10 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createInvitesWorkflow + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] /admin/invites/accept: post: operationId: PostInvitesAccept @@ -18021,7 +18029,7 @@ paths: description: | Accept an invite and create a new user. Since the user isn't created yet, the JWT token used in the authorization header is retrieved from the `/auth/user/emailpass/register` API route (or a provider other than `emailpass`). The user can then authenticate using the `/auth/user/emailpass` API route. - x-authenticated: false + x-authenticated: true requestBody: content: application/json: @@ -18091,12 +18099,15 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: acceptInviteWorkflow + security: + - cookie_auth: [] + - jwt_token: [] /admin/invites/{id}: get: operationId: GetInvitesId summary: Get an Invite description: Retrieve an invite by its ID. You can expand the invite's relations or select the fields that should be returned. - x-authenticated: false + x-authenticated: true parameters: - name: id in: path @@ -18139,11 +18150,15 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] delete: operationId: DeleteInvitesId summary: Delete Invite description: Delete an invite. - x-authenticated: false + x-authenticated: true parameters: - name: id in: path @@ -18196,12 +18211,16 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: deleteInvitesWorkflow + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] /admin/invites/{id}/resend: post: operationId: PostInvitesIdResend summary: Refresh Invite Token description: Refresh the token of an invite. - x-authenticated: false + x-authenticated: true parameters: - name: id in: path @@ -18245,6 +18264,10 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: refreshInviteTokensWorkflow + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] /admin/notifications: get: operationId: GetNotifications @@ -41910,7 +41933,7 @@ paths: operationId: GetUsers summary: List Users description: Retrieve a list of users. The users can be filtered by fields such as `id`. The users can also be sorted or paginated. - x-authenticated: false + x-authenticated: true parameters: - name: fields in: query @@ -42379,12 +42402,15 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + security: + - cookie_auth: [] + - jwt_token: [] /admin/users/me: get: operationId: GetUsersMe summary: Get Logged-In User description: Retrieve the logged-in user's details. - x-authenticated: false + x-authenticated: true parameters: - name: fields in: query @@ -42421,12 +42447,15 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + security: + - cookie_auth: [] + - jwt_token: [] /admin/users/{id}: get: operationId: GetUsersId summary: Get a User description: Retrieve a user by its ID. You can expand the user's relations or select the fields that should be returned. - x-authenticated: false + x-authenticated: true parameters: - name: id in: path @@ -42469,11 +42498,14 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + security: + - cookie_auth: [] + - jwt_token: [] post: operationId: PostUsersId summary: Update a User description: Update a user's details. - x-authenticated: false + x-authenticated: true parameters: - name: id in: path @@ -42529,11 +42561,14 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateUsersWorkflow + security: + - cookie_auth: [] + - jwt_token: [] delete: operationId: DeleteUsersId summary: Delete a User description: Delete a user. - x-authenticated: false + x-authenticated: true parameters: - name: id in: path @@ -42567,6 +42602,9 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: removeUserAccountWorkflow + security: + - cookie_auth: [] + - jwt_token: [] /admin/workflows-executions: get: operationId: GetWorkflowsExecutions diff --git a/www/apps/api-reference/specs/admin/paths/admin_invites.yaml b/www/apps/api-reference/specs/admin/paths/admin_invites.yaml index 08be7736e6..1365bb7ef5 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_invites.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_invites.yaml @@ -4,7 +4,7 @@ get: description: >- Retrieve a list of invites. The invites can be filtered by fields such as `id`. The invites can also be sorted or paginated. - x-authenticated: false + x-authenticated: true parameters: - name: fields in: query @@ -589,11 +589,15 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] post: operationId: PostInvites summary: Create Invite description: Create a invite. - x-authenticated: false + x-authenticated: true parameters: - name: fields in: query @@ -657,3 +661,7 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createInvitesWorkflow + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_invites_accept.yaml b/www/apps/api-reference/specs/admin/paths/admin_invites_accept.yaml index 8eee8dea6f..61278e9669 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_invites_accept.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_invites_accept.yaml @@ -8,7 +8,7 @@ post: header is retrieved from the `/auth/user/emailpass/register` API route (or a provider other than `emailpass`). The user can then authenticate using the `/auth/user/emailpass` API route. - x-authenticated: false + x-authenticated: true requestBody: content: application/json: @@ -72,3 +72,6 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: acceptInviteWorkflow + security: + - cookie_auth: [] + - jwt_token: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_invites_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_invites_{id}.yaml index dd0631c2eb..933f808c6b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_invites_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_invites_{id}.yaml @@ -4,7 +4,7 @@ get: description: >- Retrieve an invite by its ID. You can expand the invite's relations or select the fields that should be returned. - x-authenticated: false + x-authenticated: true parameters: - name: id in: path @@ -56,11 +56,15 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] delete: operationId: DeleteInvitesId summary: Delete Invite description: Delete an invite. - x-authenticated: false + x-authenticated: true parameters: - name: id in: path @@ -114,3 +118,7 @@ delete: '500': $ref: ../components/responses/500_error.yaml x-workflow: deleteInvitesWorkflow + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_invites_{id}_resend.yaml b/www/apps/api-reference/specs/admin/paths/admin_invites_{id}_resend.yaml index 15cacdc41d..4d4e5cc876 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_invites_{id}_resend.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_invites_{id}_resend.yaml @@ -2,7 +2,7 @@ post: operationId: PostInvitesIdResend summary: Refresh Invite Token description: Refresh the token of an invite. - x-authenticated: false + x-authenticated: true parameters: - name: id in: path @@ -55,3 +55,7 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: refreshInviteTokensWorkflow + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_users.yaml b/www/apps/api-reference/specs/admin/paths/admin_users.yaml index da26ca3d5d..72ca4a2742 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_users.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_users.yaml @@ -4,7 +4,7 @@ get: description: >- Retrieve a list of users. The users can be filtered by fields such as `id`. The users can also be sorted or paginated. - x-authenticated: false + x-authenticated: true parameters: - name: fields in: query @@ -547,3 +547,6 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + security: + - cookie_auth: [] + - jwt_token: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_users_me.yaml b/www/apps/api-reference/specs/admin/paths/admin_users_me.yaml index 5948c6961f..6246d4f2e3 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_users_me.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_users_me.yaml @@ -2,7 +2,7 @@ get: operationId: GetUsersMe summary: Get Logged-In User description: Retrieve the logged-in user's details. - x-authenticated: false + x-authenticated: true parameters: - name: fields in: query @@ -48,3 +48,6 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + security: + - cookie_auth: [] + - jwt_token: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_users_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_users_{id}.yaml index 63046c022f..490eba4d36 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_users_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_users_{id}.yaml @@ -4,7 +4,7 @@ get: description: >- Retrieve a user by its ID. You can expand the user's relations or select the fields that should be returned. - x-authenticated: false + x-authenticated: true parameters: - name: id in: path @@ -56,11 +56,14 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + security: + - cookie_auth: [] + - jwt_token: [] post: operationId: PostUsersId summary: Update a User description: Update a user's details. - x-authenticated: false + x-authenticated: true parameters: - name: id in: path @@ -118,11 +121,14 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: updateUsersWorkflow + security: + - cookie_auth: [] + - jwt_token: [] delete: operationId: DeleteUsersId summary: Delete a User description: Delete a user. - x-authenticated: false + x-authenticated: true parameters: - name: id in: path @@ -157,3 +163,6 @@ delete: '500': $ref: ../components/responses/500_error.yaml x-workflow: removeUserAccountWorkflow + security: + - cookie_auth: [] + - jwt_token: [] diff --git a/www/apps/api-reference/utils/get-tag-child-sidebar-items.tsx b/www/apps/api-reference/utils/get-tag-child-sidebar-items.tsx index 5cbdebc1a0..b5e4f15a5d 100644 --- a/www/apps/api-reference/utils/get-tag-child-sidebar-items.tsx +++ b/www/apps/api-reference/utils/get-tag-child-sidebar-items.tsx @@ -1,9 +1,9 @@ -import type { SidebarItem } from "types" import type { Operation, PathsObject } from "@/types/openapi" import type { OpenAPIV3 } from "openapi-types" import dynamic from "next/dynamic" import type { MethodLabelProps } from "@/components/MethodLabel" import getSectionId from "./get-section-id" +import { Sidebar } from "types" const MethodLabel = dynamic( async () => import("../components/MethodLabel") @@ -11,8 +11,8 @@ const MethodLabel = dynamic( export default function getTagChildSidebarItems( paths: PathsObject -): SidebarItem[] { - const items: SidebarItem[] = [] +): Sidebar.SidebarItem[] { + const items: Sidebar.SidebarItem[] = [] Object.entries(paths).forEach(([, operations]) => { Object.entries(operations).map(([method, operation]) => { const definedOperation = operation as Operation diff --git a/www/apps/book/app/learn/debugging-and-testing/page.mdx b/www/apps/book/app/learn/debugging-and-testing/page.mdx deleted file mode 100644 index 689dc03520..0000000000 --- a/www/apps/book/app/learn/debugging-and-testing/page.mdx +++ /dev/null @@ -1,12 +0,0 @@ -export const metadata = { - title: `${pageNumber} Debugging and Testing`, -} - -# {metadata.title} - -In the next chapters, you’ll learn about the tools Medusa provides for testing and debugging your Medusa application. - -By the end of this chapter, you’ll learn: - -- How to use Medusa's `@medusajs/test-utils` test to write integration tests. -- How to use Medusa’s `Logger` utility to log messages. diff --git a/www/apps/book/app/learn/deployment/general/page.mdx b/www/apps/book/app/learn/deployment/general/page.mdx index 6e155bb923..82bceacb00 100644 --- a/www/apps/book/app/learn/deployment/general/page.mdx +++ b/www/apps/book/app/learn/deployment/general/page.mdx @@ -12,7 +12,7 @@ Find how-to guides for specific platforms in [this documentation](!resources!/de -Want Medusa to manage and maintain your infrastructure? [Sign up and learn more about Medusa Cloud](https://medusajs.com/contact) +Want Medusa to manage and maintain your infrastructure? [Sign up and learn more about Medusa Cloud](https://medusajs.com/pricing) Medusa Cloud is our managed services offering that makes deploying and operating Medusa applications possible without having to worry about configuring, scaling, and maintaining infrastructure. Medusa Cloud hosts your server, Admin dashboard, database, and Redis instance. diff --git a/www/apps/book/app/learn/deployment/page.mdx b/www/apps/book/app/learn/deployment/page.mdx index 3335b11758..cd645fe55d 100644 --- a/www/apps/book/app/learn/deployment/page.mdx +++ b/www/apps/book/app/learn/deployment/page.mdx @@ -42,7 +42,7 @@ With Medusa Cloud, you maintain full customization control as you deploy your ow - Preview environments for new PRs. - Test on production-like data. -[Sign up and learn more about Medusa Cloud](https://medusajs.com/contact) +[Sign up and learn more about Medusa Cloud](https://medusajs.com/pricing) To self-host Medusa, the [next chapter](./general/page.mdx) explains the general steps to deploy your Medusa application. Refer to [this reference](!resources!/deployment) to find how-to deployment guides for general and specific hosting providers. diff --git a/www/apps/book/app/learn/fundamentals/admin/tips/page.mdx b/www/apps/book/app/learn/fundamentals/admin/tips/page.mdx index c7b68490d6..207ea8376a 100644 --- a/www/apps/book/app/learn/fundamentals/admin/tips/page.mdx +++ b/www/apps/book/app/learn/fundamentals/admin/tips/page.mdx @@ -156,4 +156,4 @@ In your admin customizations, you can use the following global variables: The Medusa Admin dashboard can be displayed in languages other than English, which is the default. Other languages are added through community contributions. -Learn how to add a new language translation for the Medusa Admin in [this guide](!resources!/contribution-guidelines/admin-translations). +Learn how to add a new language translation for the Medusa Admin in [this guide](../../../resources/contribution-guidelines/admin-translations/page.mdx). diff --git a/www/apps/book/app/learn/fundamentals/environment-variables/page.mdx b/www/apps/book/app/learn/fundamentals/environment-variables/page.mdx index ab1fc2e5ed..ec751fdd77 100644 --- a/www/apps/book/app/learn/fundamentals/environment-variables/page.mdx +++ b/www/apps/book/app/learn/fundamentals/environment-variables/page.mdx @@ -226,7 +226,7 @@ You should opt for setting configurations in `medusa-config.ts` where possible. `MEDUSA_DISABLE_TELEMETRY` - Whether to disable analytics data collection. Learn more in [this documenation](!resources!/usage). + Whether to disable analytics data collection. Learn more in [this documenation](../../resources/usage/page.mdx). \- diff --git a/www/apps/book/app/learn/layout.tsx b/www/apps/book/app/learn/layout.tsx index 6d78aca13e..e5a0cf6f69 100644 --- a/www/apps/book/app/learn/layout.tsx +++ b/www/apps/book/app/learn/layout.tsx @@ -8,13 +8,7 @@ export default function RootLayout({ children: React.ReactNode }) { return ( - } - > + }> {children} ) diff --git a/www/apps/book/app/learn/more-resources/page.mdx b/www/apps/book/app/learn/more-resources/page.mdx deleted file mode 100644 index 5deb5a1ee9..0000000000 --- a/www/apps/book/app/learn/more-resources/page.mdx +++ /dev/null @@ -1,9 +0,0 @@ -export const metadata = { - title: `${pageNumber} More Resources`, -} - -# {metadata.title} - -The Development Resources documentation provides guides and references that are useful for your development. This documentation included links to parts of the Development Resources documentation where necessary. - -Check out the Development Resources documentation [here](!resources!). \ No newline at end of file diff --git a/www/apps/resources/app/contribution-guidelines/admin-translations/page.mdx b/www/apps/book/app/learn/resources/contribution-guidelines/admin-translations/page.mdx similarity index 100% rename from www/apps/resources/app/contribution-guidelines/admin-translations/page.mdx rename to www/apps/book/app/learn/resources/contribution-guidelines/admin-translations/page.mdx diff --git a/www/apps/resources/app/contribution-guidelines/docs/page.mdx b/www/apps/book/app/learn/resources/contribution-guidelines/docs/page.mdx similarity index 96% rename from www/apps/resources/app/contribution-guidelines/docs/page.mdx rename to www/apps/book/app/learn/resources/contribution-guidelines/docs/page.mdx index ee5de6f1d4..7e0a616d10 100644 --- a/www/apps/resources/app/contribution-guidelines/docs/page.mdx +++ b/www/apps/book/app/learn/resources/contribution-guidelines/docs/page.mdx @@ -147,11 +147,15 @@ cd www/vale ```bash # to lint content for the main documentation -./run-vale.sh docs content error references +./run-vale.sh book/app/learn error resources +# to lint content for the resources documentation +./run-vale.sh resources/app error # to lint content for the API reference -./run-vale.sh api-reference app/_mdx error +./run-vale.sh api-reference/markdown error # to lint content for the Medusa UI documentation -./run-vale.sh ui src/content/docs error +./run-vale.sh ui/src/content/docs error +# to lint content for the user guide +./run-vale.sh user-guide/app error ``` {/* TODO need to enable MDX v1 comments first. */} diff --git a/www/apps/resources/app/usage/page.mdx b/www/apps/book/app/learn/resources/usage/page.mdx similarity index 100% rename from www/apps/resources/app/usage/page.mdx rename to www/apps/book/app/learn/resources/usage/page.mdx diff --git a/www/apps/book/app/not-found.tsx b/www/apps/book/app/not-found.tsx index ac688a7972..2a51ed6abd 100644 --- a/www/apps/book/app/not-found.tsx +++ b/www/apps/book/app/not-found.tsx @@ -6,13 +6,7 @@ import Footer from "../components/Footer" const NotFoundPage = () => { return ( - } - ProvidersComponent={Providers} - > + } ProvidersComponent={Providers}> {/* @ts-ignore React v19 doesn't recognize MDX import as component */} diff --git a/www/apps/book/config/index.ts b/www/apps/book/config/index.ts index 78ccc4bc3d..3547e9ec87 100644 --- a/www/apps/book/config/index.ts +++ b/www/apps/book/config/index.ts @@ -1,6 +1,6 @@ -import { DocsConfig } from "types" -import { sidebarConfig } from "./sidebar" +import { DocsConfig, Sidebar } from "types" import { globalConfig } from "docs-ui" +import { generatedSidebars } from "../generated/sidebar.mjs" const baseUrl = process.env.NEXT_PUBLIC_BASE_URL || "http://localhost:3000" @@ -9,13 +9,18 @@ export const config: DocsConfig = { titleSuffix: "Medusa v2 Documentation", baseUrl, basePath: process.env.NEXT_PUBLIC_BASE_PATH, - sidebar: sidebarConfig, + sidebars: generatedSidebars as Sidebar.Sidebar[], project: { title: "Documentation", key: "book", }, - breadcrumbOptions: { - showCategories: false, - }, logo: `${process.env.NEXT_PUBLIC_BASE_PATH}/images/logo.png`, + breadcrumbOptions: { + startItems: [ + { + title: "Documentation", + link: "/", + }, + ], + }, } diff --git a/www/apps/book/config/sidebar.tsx b/www/apps/book/config/sidebar.tsx deleted file mode 100644 index 599f04de64..0000000000 --- a/www/apps/book/config/sidebar.tsx +++ /dev/null @@ -1,8 +0,0 @@ -import type { SidebarConfig } from "@/types" -import { generatedSidebar } from "../generated/sidebar.mjs" -import { SidebarItem } from "types" - -export const sidebarConfig: SidebarConfig = { - default: generatedSidebar as SidebarItem[], - mobile: [], -} diff --git a/www/apps/book/generated/edit-dates.mjs b/www/apps/book/generated/edit-dates.mjs index baf4b59610..2634a04f9b 100644 --- a/www/apps/book/generated/edit-dates.mjs +++ b/www/apps/book/generated/edit-dates.mjs @@ -1,20 +1,18 @@ export const generatedEditDates = { "app/learn/fundamentals/scheduled-jobs/page.mdx": "2024-12-09T10:51:40.570Z", "app/learn/fundamentals/workflows/page.mdx": "2024-12-09T14:45:17.837Z", - "app/learn/deployment/page.mdx": "2024-11-25T14:32:44.949Z", + "app/learn/deployment/page.mdx": "2025-03-06T09:15:39.707Z", "app/learn/page.mdx": "2025-02-05T16:04:32.325Z", "app/learn/fundamentals/modules/commerce-modules/page.mdx": "2024-12-09T10:46:29.339Z", "app/learn/fundamentals/workflows/retry-failed-steps/page.mdx": "2024-12-04T07:37:59.823Z", "app/learn/fundamentals/workflows/workflow-hooks/page.mdx": "2024-12-09T10:44:33.781Z", "app/learn/debugging-and-testing/logging/page.mdx": "2024-09-30T08:43:53.135Z", - "app/learn/more-resources/page.mdx": "2024-07-04T17:26:03+03:00", "app/learn/storefront-development/page.mdx": "2024-12-10T09:11:04.993Z", "app/learn/storefront-development/nextjs-starter/page.mdx": "2024-12-10T09:05:18.960Z", "app/learn/fundamentals/page.mdx": "2024-07-04T17:26:03+03:00", "app/learn/fundamentals/admin-customizations/page.mdx": "2024-10-07T12:41:39.218Z", "app/learn/fundamentals/workflows/workflow-timeout/page.mdx": "2024-10-21T13:30:21.372Z", "app/learn/fundamentals/workflows/parallel-steps/page.mdx": "2024-12-09T14:45:13.801Z", - "app/learn/debugging-and-testing/page.mdx": "2024-05-03T17:36:38+03:00", "app/learn/fundamentals/medusa-container/page.mdx": "2024-12-09T11:02:38.225Z", "app/learn/fundamentals/api-routes/page.mdx": "2024-12-04T11:02:57.134Z", "app/learn/fundamentals/modules/modules-directory-structure/page.mdx": "2024-12-09T10:32:46.839Z", @@ -50,7 +48,7 @@ export const generatedEditDates = { "app/learn/fundamentals/scheduled-jobs/execution-number/page.mdx": "2024-10-21T13:30:21.371Z", "app/learn/fundamentals/api-routes/parameters/page.mdx": "2025-02-14T08:34:03.184Z", "app/learn/fundamentals/api-routes/http-methods/page.mdx": "2024-10-21T13:30:21.367Z", - "app/learn/fundamentals/admin/tips/page.mdx": "2025-02-24T09:52:06.901Z", + "app/learn/fundamentals/admin/tips/page.mdx": "2025-03-06T07:30:06.322Z", "app/learn/fundamentals/api-routes/cors/page.mdx": "2024-12-09T13:04:04.357Z", "app/learn/fundamentals/admin/ui-routes/page.mdx": "2025-02-24T09:35:11.752Z", "app/learn/fundamentals/api-routes/middlewares/page.mdx": "2025-03-04T10:16:15.029Z", @@ -102,9 +100,9 @@ export const generatedEditDates = { "app/learn/introduction/architecture/page.mdx": "2025-01-16T10:25:10.780Z", "app/learn/fundamentals/data-models/infer-type/page.mdx": "2024-12-09T15:54:08.713Z", "app/learn/fundamentals/custom-cli-scripts/seed-data/page.mdx": "2024-12-09T14:38:06.385Z", - "app/learn/fundamentals/environment-variables/page.mdx": "2025-02-18T15:29:37.717Z", + "app/learn/fundamentals/environment-variables/page.mdx": "2025-03-06T07:30:22.986Z", "app/learn/build/page.mdx": "2024-12-09T11:05:17.383Z", - "app/learn/deployment/general/page.mdx": "2025-02-24T07:38:02.164Z", + "app/learn/deployment/general/page.mdx": "2025-03-06T09:15:35.452Z", "app/learn/fundamentals/workflows/multiple-step-usage/page.mdx": "2024-11-25T16:19:32.169Z", "app/learn/installation/page.mdx": "2025-01-31T13:16:57.883Z", "app/learn/fundamentals/data-models/check-constraints/page.mdx": "2024-12-06T14:34:50.384Z", @@ -118,5 +116,8 @@ export const generatedEditDates = { "app/learn/fundamentals/module-links/query-context/page.mdx": "2025-02-12T16:59:20.963Z", "app/learn/fundamentals/admin/environment-variables/page.mdx": "2025-02-18T14:48:17.731Z", "app/learn/fundamentals/api-routes/parse-body/page.mdx": "2025-02-14T08:32:25.596Z", - "app/learn/fundamentals/admin/routing/page.mdx": "2025-02-24T09:50:37.495Z" + "app/learn/fundamentals/admin/routing/page.mdx": "2025-02-24T09:50:37.495Z", + "app/learn/resources/contribution-guidelines/admin-translations/page.mdx": "2025-02-11T16:57:46.726Z", + "app/learn/resources/contribution-guidelines/docs/page.mdx": "2025-03-06T09:32:26.010Z", + "app/learn/resources/usage/page.mdx": "2025-02-26T13:35:34.824Z" } \ No newline at end of file diff --git a/www/apps/book/generated/sidebar.mjs b/www/apps/book/generated/sidebar.mjs index 17b779c11f..25e0351797 100644 --- a/www/apps/book/generated/sidebar.mjs +++ b/www/apps/book/generated/sidebar.mjs @@ -1,15 +1,25 @@ -export const generatedSidebar = [ +export const generatedSidebars = [ { - "type": "category", - "title": "1. Introduction", - "children": [ + "sidebar_id": "docs", + "title": "Get Started", + "items": [ { "loaded": true, "isPathHref": true, - "type": "link", - "path": "/learn", - "title": "Introduction", + "initialOpen": false, + "type": "category", + "title": "1. Get Started", "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn", + "title": "Introduction", + "children": [], + "chapterTitle": "1.1. Introduction", + "number": "1.1." + }, { "loaded": true, "isPathHref": true, @@ -17,7 +27,8 @@ export const generatedSidebar = [ "path": "/learn/installation", "title": "Installation", "children": [], - "chapterTitle": "1.1. Installation" + "chapterTitle": "1.2. Installation", + "number": "1.2." }, { "loaded": true, @@ -26,760 +37,895 @@ export const generatedSidebar = [ "title": "Architecture", "path": "/learn/introduction/architecture", "children": [], - "chapterTitle": "1.2. Architecture" + "chapterTitle": "1.3. Architecture", + "number": "1.3." } ], - "childrenSameLevel": true, - "chapterTitle": "1. Introduction" - } - ], - "loaded": true, - "initialOpen": false - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "2. Customize", - "children": [ + "chapterTitle": "1. Get Started", + "number": "1." + }, { "loaded": true, "isPathHref": true, - "type": "link", - "title": "Build Custom Features", - "path": "/learn/customization/custom-features", + "initialOpen": false, + "type": "category", + "title": "2. Customization Tutorial", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "title": "Brand Module", - "path": "/learn/customization/custom-features/module", - "children": [], - "chapterTitle": "2.1.1. Brand Module" + "title": "Build Custom Features", + "path": "/learn/customization/custom-features", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Brand Module", + "path": "/learn/customization/custom-features/module", + "children": [], + "chapterTitle": "2.1.1. Brand Module", + "number": "2.1.1." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Brand Workflow", + "path": "/learn/customization/custom-features/workflow", + "children": [], + "chapterTitle": "2.1.2. Brand Workflow", + "number": "2.1.2." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Brand API Route", + "path": "/learn/customization/custom-features/api-route", + "children": [], + "chapterTitle": "2.1.3. Brand API Route", + "number": "2.1.3." + } + ], + "chapterTitle": "2.1. Build Custom Features", + "number": "2.1." }, { "loaded": true, "isPathHref": true, "type": "link", - "title": "Brand Workflow", - "path": "/learn/customization/custom-features/workflow", - "children": [], - "chapterTitle": "2.1.2. Brand Workflow" + "title": "Extend Features", + "path": "/learn/customization/extend-features", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Link Brands and Products", + "path": "/learn/customization/extend-features/define-link", + "children": [], + "chapterTitle": "2.2.1. Link Brands and Products", + "number": "2.2.1." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Extend Core Flow", + "path": "/learn/customization/extend-features/extend-create-product", + "children": [], + "chapterTitle": "2.2.2. Extend Core Flow", + "number": "2.2.2." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Query Linked Records", + "path": "/learn/customization/extend-features/query-linked-records", + "children": [], + "chapterTitle": "2.2.3. Query Linked Records", + "number": "2.2.3." + } + ], + "chapterTitle": "2.2. Extend Features", + "number": "2.2." }, { "loaded": true, "isPathHref": true, "type": "link", - "title": "Brand API Route", - "path": "/learn/customization/custom-features/api-route", + "title": "Customize Admin", + "path": "/learn/customization/customize-admin", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Add Widget", + "path": "/learn/customization/customize-admin/widget", + "children": [], + "chapterTitle": "2.3.1. Add Widget", + "number": "2.3.1." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Add UI Route", + "path": "/learn/customization/customize-admin/route", + "children": [], + "chapterTitle": "2.3.2. Add UI Route", + "number": "2.3.2." + } + ], + "chapterTitle": "2.3. Customize Admin", + "number": "2.3." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Integrate Systems", + "path": "/learn/customization/integrate-systems", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "CMS Module", + "path": "/learn/customization/integrate-systems/service", + "children": [], + "chapterTitle": "2.4.1. CMS Module", + "number": "2.4.1." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Sync to CMS", + "path": "/learn/customization/integrate-systems/handle-event", + "children": [], + "chapterTitle": "2.4.2. Sync to CMS", + "number": "2.4.2." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Schedule Syncing", + "path": "/learn/customization/integrate-systems/schedule-task", + "children": [], + "chapterTitle": "2.4.3. Schedule Syncing", + "number": "2.4.3." + } + ], + "chapterTitle": "2.4. Integrate Systems", + "number": "2.4." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Re-Use Customizations", + "path": "/learn/customization/reuse-customizations", "children": [], - "chapterTitle": "2.1.3. Brand API Route" + "chapterTitle": "2.5. Re-Use Customizations", + "number": "2.5." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Next Steps", + "path": "/learn/customization/next-steps", + "children": [], + "chapterTitle": "2.6. Next Steps", + "number": "2.6." } ], - "chapterTitle": "2.1. Build Custom Features" + "chapterTitle": "2. Customization Tutorial", + "number": "2." }, { "loaded": true, "isPathHref": true, - "type": "link", - "title": "Extend Features", - "path": "/learn/customization/extend-features", + "initialOpen": false, + "type": "category", + "title": "3. Framework", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "title": "Link Brands and Products", - "path": "/learn/customization/extend-features/define-link", + "path": "/learn/fundamentals/medusa-container", + "title": "Medusa Container", "children": [], - "chapterTitle": "2.2.1. Link Brands and Products" + "chapterTitle": "3.1. Medusa Container", + "number": "3.1." }, { "loaded": true, "isPathHref": true, "type": "link", - "title": "Extend Core Flow", - "path": "/learn/customization/extend-features/extend-create-product", - "children": [], - "chapterTitle": "2.2.2. Extend Core Flow" + "path": "/learn/fundamentals/modules", + "title": "Modules", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/modules/modules-directory-structure", + "title": "Directory Structure", + "children": [], + "chapterTitle": "3.2.1. Directory Structure", + "number": "3.2.1." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/modules/loaders", + "title": "Loaders", + "children": [], + "chapterTitle": "3.2.2. Loaders", + "number": "3.2.2." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/modules/isolation", + "title": "Module Isolation", + "children": [], + "chapterTitle": "3.2.3. Module Isolation", + "number": "3.2.3." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/modules/container", + "title": "Module Container", + "children": [], + "chapterTitle": "3.2.4. Module Container", + "number": "3.2.4." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/modules/options", + "title": "Module Options", + "children": [], + "chapterTitle": "3.2.5. Module Options", + "number": "3.2.5." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/modules/service-factory", + "title": "Service Factory", + "children": [], + "chapterTitle": "3.2.6. Service Factory", + "number": "3.2.6." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/modules/service-constraints", + "title": "Service Constraints", + "children": [], + "chapterTitle": "3.2.7. Service Constraints", + "number": "3.2.7." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/modules/db-operations", + "title": "Database Operations", + "children": [], + "chapterTitle": "3.2.8. Database Operations", + "number": "3.2.8." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/modules/multiple-services", + "title": "Multiple Services", + "children": [], + "chapterTitle": "3.2.9. Multiple Services", + "number": "3.2.9." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/modules/commerce-modules", + "title": "Commerce Modules", + "children": [], + "chapterTitle": "3.2.10. Commerce Modules", + "number": "3.2.10." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/modules/architectural-modules", + "title": "Architectural Modules", + "children": [], + "chapterTitle": "3.2.11. Architectural Modules", + "number": "3.2.11." + } + ], + "chapterTitle": "3.2. Modules", + "number": "3.2." }, { "loaded": true, "isPathHref": true, "type": "link", - "title": "Query Linked Records", - "path": "/learn/customization/extend-features/query-linked-records", - "children": [], - "chapterTitle": "2.2.3. Query Linked Records" + "path": "/learn/fundamentals/module-links", + "title": "Module Links", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/module-links/directions", + "title": "Module Link Direction", + "children": [], + "chapterTitle": "3.3.1. Module Link Direction", + "number": "3.3.1." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/module-links/link", + "title": "Link", + "children": [], + "chapterTitle": "3.3.2. Link", + "number": "3.3.2." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/module-links/query", + "title": "Query", + "children": [], + "chapterTitle": "3.3.3. Query", + "number": "3.3.3." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/module-links/custom-columns", + "title": "Custom Columns", + "children": [], + "chapterTitle": "3.3.4. Custom Columns", + "number": "3.3.4." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/module-links/query-context", + "title": "Query Context", + "children": [], + "chapterTitle": "3.3.5. Query Context", + "number": "3.3.5." + } + ], + "chapterTitle": "3.3. Module Links", + "number": "3.3." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/data-models", + "title": "Data Models", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/data-models/infer-type", + "title": "Infer Type", + "children": [], + "chapterTitle": "3.4.1. Infer Type", + "number": "3.4.1." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/data-models/property-types", + "title": "Property Types", + "children": [], + "chapterTitle": "3.4.2. Property Types", + "number": "3.4.2." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/data-models/primary-key", + "title": "Primary Key", + "children": [], + "chapterTitle": "3.4.3. Primary Key", + "number": "3.4.3." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/data-models/default-properties", + "title": "Default Properties", + "children": [], + "chapterTitle": "3.4.4. Default Properties", + "number": "3.4.4." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/data-models/configure-properties", + "title": "Configure Properties", + "children": [], + "chapterTitle": "3.4.5. Configure Properties", + "number": "3.4.5." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/data-models/relationships", + "title": "Relationships", + "children": [], + "chapterTitle": "3.4.6. Relationships", + "number": "3.4.6." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/data-models/manage-relationships", + "title": "Manage Relationships", + "children": [], + "chapterTitle": "3.4.7. Manage Relationships", + "number": "3.4.7." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/data-models/index", + "title": "Define Index", + "children": [], + "chapterTitle": "3.4.8. Define Index", + "number": "3.4.8." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/data-models/check-constraints", + "title": "Check Constraints", + "children": [], + "chapterTitle": "3.4.9. Check Constraints", + "number": "3.4.9." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/data-models/searchable-property", + "title": "Searchable Property", + "children": [], + "chapterTitle": "3.4.10. Searchable Property", + "number": "3.4.10." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/data-models/write-migration", + "title": "Write Migration", + "children": [], + "chapterTitle": "3.4.11. Write Migration", + "number": "3.4.11." + } + ], + "chapterTitle": "3.4. Data Models", + "number": "3.4." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "API Routes", + "path": "/learn/fundamentals/api-routes", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/api-routes/http-methods", + "title": "HTTP Methods", + "children": [], + "chapterTitle": "3.5.1. HTTP Methods", + "number": "3.5.1." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/api-routes/parameters", + "title": "Parameters", + "children": [], + "chapterTitle": "3.5.2. Parameters", + "number": "3.5.2." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/api-routes/responses", + "title": "Response", + "children": [], + "chapterTitle": "3.5.3. Response", + "number": "3.5.3." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/api-routes/middlewares", + "title": "Middlewares", + "children": [], + "chapterTitle": "3.5.4. Middlewares", + "number": "3.5.4." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/api-routes/parse-body", + "title": "Body Parsing", + "children": [], + "chapterTitle": "3.5.5. Body Parsing", + "number": "3.5.5." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/api-routes/validation", + "title": "Validation", + "children": [], + "chapterTitle": "3.5.6. Validation", + "number": "3.5.6." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/api-routes/protected-routes", + "title": "Protected Routes", + "children": [], + "chapterTitle": "3.5.7. Protected Routes", + "number": "3.5.7." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/api-routes/errors", + "title": "Errors", + "children": [], + "chapterTitle": "3.5.8. Errors", + "number": "3.5.8." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/api-routes/cors", + "title": "Handling CORS", + "children": [], + "chapterTitle": "3.5.9. Handling CORS", + "number": "3.5.9." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/api-routes/additional-data", + "title": "Additional Data", + "children": [], + "chapterTitle": "3.5.10. Additional Data", + "number": "3.5.10." + } + ], + "chapterTitle": "3.5. API Routes", + "number": "3.5." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/workflows", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/workflows/constructor-constraints", + "title": "Constructor Constraints", + "children": [], + "chapterTitle": "3.6.1. Constructor Constraints", + "number": "3.6.1." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/workflows/variable-manipulation", + "title": "Transform Variables", + "children": [], + "chapterTitle": "3.6.2. Transform Variables", + "number": "3.6.2." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/workflows/conditions", + "title": "When-Then Conditions", + "children": [], + "chapterTitle": "3.6.3. When-Then Conditions", + "number": "3.6.3." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/workflows/compensation-function", + "title": "Compensation Function", + "children": [], + "chapterTitle": "3.6.4. Compensation Function", + "number": "3.6.4." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/workflows/workflow-hooks", + "title": "Workflow Hooks", + "children": [], + "chapterTitle": "3.6.5. Workflow Hooks", + "number": "3.6.5." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/workflows/add-workflow-hook", + "title": "Expose a Hook", + "children": [], + "chapterTitle": "3.6.6. Expose a Hook", + "number": "3.6.6." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/workflows/access-workflow-errors", + "title": "Access Workflow Errors", + "children": [], + "chapterTitle": "3.6.7. Access Workflow Errors", + "number": "3.6.7." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/workflows/retry-failed-steps", + "title": "Retry Failed Steps", + "children": [], + "chapterTitle": "3.6.8. Retry Failed Steps", + "number": "3.6.8." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/workflows/parallel-steps", + "title": "Run Steps in Parallel", + "children": [], + "chapterTitle": "3.6.9. Run Steps in Parallel", + "number": "3.6.9." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/workflows/workflow-timeout", + "title": "Workflow Timeout", + "children": [], + "chapterTitle": "3.6.10. Workflow Timeout", + "number": "3.6.10." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/workflows/store-executions", + "title": "Store Workflow Executions", + "children": [], + "chapterTitle": "3.6.11. Store Workflow Executions", + "number": "3.6.11." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/workflows/long-running-workflow", + "title": "Long-Running Workflow", + "children": [], + "chapterTitle": "3.6.12. Long-Running Workflow", + "number": "3.6.12." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/workflows/execute-another-workflow", + "title": "Execute Another Workflow", + "children": [], + "chapterTitle": "3.6.13. Execute Another Workflow", + "number": "3.6.13." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/workflows/multiple-step-usage", + "title": "Multiple Step Usage", + "children": [], + "chapterTitle": "3.6.14. Multiple Step Usage", + "number": "3.6.14." + } + ], + "chapterTitle": "3.6. Workflows", + "number": "3.6." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/events-and-subscribers", + "title": "Events and Subscribers", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/events-and-subscribers/data-payload", + "title": "Events Data Payload", + "children": [], + "chapterTitle": "3.7.1. Events Data Payload", + "number": "3.7.1." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/events-and-subscribers/emit-event", + "title": "Emit Event", + "children": [], + "chapterTitle": "3.7.2. Emit Event", + "number": "3.7.2." + } + ], + "chapterTitle": "3.7. Events and Subscribers", + "number": "3.7." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/scheduled-jobs", + "title": "Scheduled Jobs", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/scheduled-jobs/execution-number", + "title": "Execution Number", + "children": [], + "chapterTitle": "3.8.1. Execution Number", + "number": "3.8.1." + } + ], + "chapterTitle": "3.8. Scheduled Jobs", + "number": "3.8." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/plugins", + "title": "Plugins", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/plugins/create", + "title": "Create Plugin", + "children": [], + "chapterTitle": "3.9.1. Create Plugin", + "number": "3.9.1." + } + ], + "chapterTitle": "3.9. Plugins", + "number": "3.9." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/custom-cli-scripts", + "title": "Custom CLI Scripts", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/fundamentals/custom-cli-scripts/seed-data", + "title": "Seed Data", + "children": [], + "chapterTitle": "3.10.1. Seed Data", + "number": "3.10.1." + } + ], + "chapterTitle": "3.10. Custom CLI Scripts", + "number": "3.10." } ], - "chapterTitle": "2.2. Extend Features" + "chapterTitle": "3. Framework", + "number": "3." }, { "loaded": true, "isPathHref": true, - "type": "link", - "title": "Customize Admin", - "path": "/learn/customization/customize-admin", + "initialOpen": false, + "type": "category", + "title": "4. Admin Development", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "title": "Add Widget", - "path": "/learn/customization/customize-admin/widget", + "path": "/learn/fundamentals/admin", + "title": "Overview", "children": [], - "chapterTitle": "2.3.1. Add Widget" + "chapterTitle": "4.1. Overview", + "number": "4.1." }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Add UI Route", - "path": "/learn/customization/customize-admin/route", - "children": [], - "chapterTitle": "2.3.2. Add UI Route" - } - ], - "chapterTitle": "2.3. Customize Admin" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Integrate Systems", - "path": "/learn/customization/integrate-systems", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "CMS Module", - "path": "/learn/customization/integrate-systems/service", - "children": [], - "chapterTitle": "2.4.1. CMS Module" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Sync to CMS", - "path": "/learn/customization/integrate-systems/handle-event", - "children": [], - "chapterTitle": "2.4.2. Sync to CMS" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Schedule Syncing", - "path": "/learn/customization/integrate-systems/schedule-task", - "children": [], - "chapterTitle": "2.4.3. Schedule Syncing" - } - ], - "chapterTitle": "2.4. Integrate Systems" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Re-Use Customizations", - "path": "/learn/customization/reuse-customizations", - "children": [], - "chapterTitle": "2.5. Re-Use Customizations" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Next Steps", - "path": "/learn/customization/next-steps", - "children": [], - "chapterTitle": "2.6. Next Steps" - } - ], - "chapterTitle": "2. Customize" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "3. Fundamentals", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/medusa-container", - "title": "Medusa Container", - "children": [], - "chapterTitle": "3.1. Medusa Container" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/modules", - "title": "Modules", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/modules/modules-directory-structure", - "title": "Directory Structure", - "children": [], - "chapterTitle": "3.2.1. Directory Structure" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/modules/loaders", - "title": "Loaders", - "children": [], - "chapterTitle": "3.2.2. Loaders" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/modules/isolation", - "title": "Module Isolation", - "children": [], - "chapterTitle": "3.2.3. Module Isolation" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/modules/container", - "title": "Module Container", - "children": [], - "chapterTitle": "3.2.4. Module Container" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/modules/options", - "title": "Module Options", - "children": [], - "chapterTitle": "3.2.5. Module Options" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/modules/service-factory", - "title": "Service Factory", - "children": [], - "chapterTitle": "3.2.6. Service Factory" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/modules/service-constraints", - "title": "Service Constraints", - "children": [], - "chapterTitle": "3.2.7. Service Constraints" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/modules/db-operations", - "title": "Database Operations", - "children": [], - "chapterTitle": "3.2.8. Database Operations" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/modules/multiple-services", - "title": "Multiple Services", - "children": [], - "chapterTitle": "3.2.9. Multiple Services" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/modules/commerce-modules", - "title": "Commerce Modules", - "children": [], - "chapterTitle": "3.2.10. Commerce Modules" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/modules/architectural-modules", - "title": "Architectural Modules", - "children": [], - "chapterTitle": "3.2.11. Architectural Modules" - } - ], - "chapterTitle": "3.2. Modules" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/module-links", - "title": "Module Links", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/module-links/directions", - "title": "Module Link Direction", - "children": [], - "chapterTitle": "3.3.1. Module Link Direction" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/module-links/link", - "title": "Link", - "children": [], - "chapterTitle": "3.3.2. Link" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/module-links/query", - "title": "Query", - "children": [], - "chapterTitle": "3.3.3. Query" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/module-links/custom-columns", - "title": "Custom Columns", - "children": [], - "chapterTitle": "3.3.4. Custom Columns" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/module-links/query-context", - "title": "Query Context", - "children": [], - "chapterTitle": "3.3.5. Query Context" - } - ], - "chapterTitle": "3.3. Module Links" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/data-models", - "title": "Data Models", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/data-models/infer-type", - "title": "Infer Type", - "children": [], - "chapterTitle": "3.4.1. Infer Type" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/data-models/property-types", - "title": "Property Types", - "children": [], - "chapterTitle": "3.4.2. Property Types" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/data-models/primary-key", - "title": "Primary Key", - "children": [], - "chapterTitle": "3.4.3. Primary Key" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/data-models/default-properties", - "title": "Default Properties", - "children": [], - "chapterTitle": "3.4.4. Default Properties" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/data-models/configure-properties", - "title": "Configure Properties", - "children": [], - "chapterTitle": "3.4.5. Configure Properties" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/data-models/relationships", - "title": "Relationships", - "children": [], - "chapterTitle": "3.4.6. Relationships" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/data-models/manage-relationships", - "title": "Manage Relationships", - "children": [], - "chapterTitle": "3.4.7. Manage Relationships" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/data-models/index", - "title": "Define Index", - "children": [], - "chapterTitle": "3.4.8. Define Index" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/data-models/check-constraints", - "title": "Check Constraints", - "children": [], - "chapterTitle": "3.4.9. Check Constraints" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/data-models/searchable-property", - "title": "Searchable Property", - "children": [], - "chapterTitle": "3.4.10. Searchable Property" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/data-models/write-migration", - "title": "Write Migration", - "children": [], - "chapterTitle": "3.4.11. Write Migration" - } - ], - "chapterTitle": "3.4. Data Models" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "API Routes", - "path": "/learn/fundamentals/api-routes", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/api-routes/http-methods", - "title": "HTTP Methods", - "children": [], - "chapterTitle": "3.5.1. HTTP Methods" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/api-routes/parameters", - "title": "Parameters", - "children": [], - "chapterTitle": "3.5.2. Parameters" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/api-routes/responses", - "title": "Response", - "children": [], - "chapterTitle": "3.5.3. Response" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/api-routes/middlewares", - "title": "Middlewares", - "children": [], - "chapterTitle": "3.5.4. Middlewares" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/api-routes/parse-body", - "title": "Body Parsing", - "children": [], - "chapterTitle": "3.5.5. Body Parsing" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/api-routes/validation", - "title": "Validation", - "children": [], - "chapterTitle": "3.5.6. Validation" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/api-routes/protected-routes", - "title": "Protected Routes", - "children": [], - "chapterTitle": "3.5.7. Protected Routes" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/api-routes/errors", - "title": "Errors", - "children": [], - "chapterTitle": "3.5.8. Errors" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/api-routes/cors", - "title": "Handling CORS", - "children": [], - "chapterTitle": "3.5.9. Handling CORS" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/api-routes/additional-data", - "title": "Additional Data", - "children": [], - "chapterTitle": "3.5.10. Additional Data" - } - ], - "chapterTitle": "3.5. API Routes" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/workflows", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/workflows/constructor-constraints", - "title": "Constructor Constraints", - "children": [], - "chapterTitle": "3.6.1. Constructor Constraints" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/workflows/variable-manipulation", - "title": "Transform Variables", - "children": [], - "chapterTitle": "3.6.2. Transform Variables" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/workflows/conditions", - "title": "When-Then Conditions", - "children": [], - "chapterTitle": "3.6.3. When-Then Conditions" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/workflows/compensation-function", - "title": "Compensation Function", - "children": [], - "chapterTitle": "3.6.4. Compensation Function" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/workflows/workflow-hooks", - "title": "Workflow Hooks", - "children": [], - "chapterTitle": "3.6.5. Workflow Hooks" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/workflows/add-workflow-hook", - "title": "Expose a Hook", - "children": [], - "chapterTitle": "3.6.6. Expose a Hook" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/workflows/access-workflow-errors", - "title": "Access Workflow Errors", - "children": [], - "chapterTitle": "3.6.7. Access Workflow Errors" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/workflows/retry-failed-steps", - "title": "Retry Failed Steps", - "children": [], - "chapterTitle": "3.6.8. Retry Failed Steps" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/workflows/parallel-steps", - "title": "Run Steps in Parallel", - "children": [], - "chapterTitle": "3.6.9. Run Steps in Parallel" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/workflows/workflow-timeout", - "title": "Workflow Timeout", - "children": [], - "chapterTitle": "3.6.10. Workflow Timeout" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/workflows/store-executions", - "title": "Store Workflow Executions", - "children": [], - "chapterTitle": "3.6.11. Store Workflow Executions" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/workflows/long-running-workflow", - "title": "Long-Running Workflow", - "children": [], - "chapterTitle": "3.6.12. Long-Running Workflow" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/workflows/execute-another-workflow", - "title": "Execute Another Workflow", - "children": [], - "chapterTitle": "3.6.13. Execute Another Workflow" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/workflows/multiple-step-usage", - "title": "Multiple Step Usage", - "children": [], - "chapterTitle": "3.6.14. Multiple Step Usage" - } - ], - "chapterTitle": "3.6. Workflows" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/events-and-subscribers", - "title": "Events and Subscribers", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/events-and-subscribers/data-payload", - "title": "Events Data Payload", - "children": [], - "chapterTitle": "3.7.1. Events Data Payload" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/events-and-subscribers/emit-event", - "title": "Emit Event", - "children": [], - "chapterTitle": "3.7.2. Emit Event" - } - ], - "chapterTitle": "3.7. Events and Subscribers" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/scheduled-jobs", - "title": "Scheduled Jobs", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/scheduled-jobs/execution-number", - "title": "Execution Number", - "children": [], - "chapterTitle": "3.8.1. Execution Number" - } - ], - "chapterTitle": "3.8. Scheduled Jobs" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/admin", - "title": "Admin Development", - "children": [ { "loaded": true, "isPathHref": true, @@ -787,7 +933,8 @@ export const generatedSidebar = [ "path": "/learn/fundamentals/admin/widgets", "title": "Admin Widgets", "children": [], - "chapterTitle": "3.9.1. Admin Widgets" + "chapterTitle": "4.2. Admin Widgets", + "number": "4.2." }, { "loaded": true, @@ -796,7 +943,8 @@ export const generatedSidebar = [ "path": "/learn/fundamentals/admin/ui-routes", "title": "Admin UI Routes", "children": [], - "chapterTitle": "3.9.2. Admin UI Routes" + "chapterTitle": "4.3. Admin UI Routes", + "number": "4.3." }, { "loaded": true, @@ -805,7 +953,8 @@ export const generatedSidebar = [ "path": "/learn/fundamentals/admin/environment-variables", "title": "Environment Variables", "children": [], - "chapterTitle": "3.9.3. Environment Variables" + "chapterTitle": "4.4. Environment Variables", + "number": "4.4." }, { "loaded": true, @@ -814,7 +963,8 @@ export const generatedSidebar = [ "path": "/learn/fundamentals/admin/routing", "title": "Routing Customizations", "children": [], - "chapterTitle": "3.9.4. Routing Customizations" + "chapterTitle": "4.5. Routing Customizations", + "number": "4.5." }, { "loaded": true, @@ -823,7 +973,8 @@ export const generatedSidebar = [ "path": "/learn/fundamentals/admin/constraints", "title": "Constraints", "children": [], - "chapterTitle": "3.9.5. Constraints" + "chapterTitle": "4.6. Constraints", + "number": "4.6." }, { "loaded": true, @@ -832,108 +983,69 @@ export const generatedSidebar = [ "path": "/learn/fundamentals/admin/tips", "title": "Tips", "children": [], - "chapterTitle": "3.9.6. Tips" + "chapterTitle": "4.7. Tips", + "number": "4.7." } ], - "chapterTitle": "3.9. Admin Development" + "chapterTitle": "4. Admin Development", + "number": "4." }, { "loaded": true, "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/plugins", - "title": "Plugins", + "type": "category", + "title": "5. Storefront", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "path": "/learn/fundamentals/plugins/create", - "title": "Create Plugin", + "path": "/learn/storefront-development", + "title": "Storefront Development", + "chapterTitle": "5. Storefront", "children": [], - "chapterTitle": "3.10.1. Create Plugin" + "number": "5." } ], - "chapterTitle": "3.10. Plugins" + "initialOpen": false }, { "loaded": true, "isPathHref": true, - "type": "link", - "path": "/learn/fundamentals/custom-cli-scripts", - "title": "Custom CLI Scripts", + "initialOpen": false, + "type": "category", + "title": "6. Configurations", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "path": "/learn/fundamentals/custom-cli-scripts/seed-data", - "title": "Seed Data", + "title": "Environment Variables", + "path": "/learn/fundamentals/environment-variables", "children": [], - "chapterTitle": "3.11.1. Seed Data" + "chapterTitle": "6.1. Environment Variables", + "number": "6.1." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Type Aliases", + "path": "/learn/conventions/ts-aliases", + "children": [], + "chapterTitle": "6.2. Type Aliases", + "number": "6.2." } ], - "chapterTitle": "3.11. Custom CLI Scripts" + "chapterTitle": "6. Configurations", + "number": "6." }, { "loaded": true, "isPathHref": true, - "type": "link", - "title": "Environment Variables", - "path": "/learn/fundamentals/environment-variables", - "children": [], - "chapterTitle": "3.12. Environment Variables" - } - ], - "chapterTitle": "3. Fundamentals" - }, - { - "type": "category", - "title": "4. Storefront", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/storefront-development", - "title": "Storefront Development", - "chapterTitle": "4. Storefront", - "children": [], - "childrenSameLevel": true - } - ], - "loaded": true, - "initialOpen": false - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "5. Conventions", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Type Aliases", - "path": "/learn/conventions/ts-aliases", - "children": [], - "chapterTitle": "5.1. Type Aliases" - } - ], - "chapterTitle": "5. Conventions" - }, - { - "type": "category", - "title": "6. Debugging & Testing", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/debugging-and-testing", - "title": "Debugging and Testing", - "chapterTitle": "6. Debugging & Testing", + "initialOpen": false, + "type": "category", + "title": "7. Debugging & Testing", "children": [ { "loaded": true, @@ -942,7 +1054,8 @@ export const generatedSidebar = [ "path": "/learn/debugging-and-testing/testing-tools", "title": "Testing Tools", "children": [], - "chapterTitle": "6.1. Testing Tools" + "chapterTitle": "7.1. Testing Tools", + "number": "7.1." }, { "loaded": true, @@ -958,7 +1071,8 @@ export const generatedSidebar = [ "path": "/learn/debugging-and-testing/testing-tools/integration-tests/api-routes", "title": "Example: API Routes Tests", "children": [], - "chapterTitle": "6.2.1. Example: API Routes Tests" + "chapterTitle": "7.2.1. Example: API Routes Tests", + "number": "7.2.1." }, { "loaded": true, @@ -967,10 +1081,12 @@ export const generatedSidebar = [ "path": "/learn/debugging-and-testing/testing-tools/integration-tests/workflows", "title": "Example: Workflows Tests", "children": [], - "chapterTitle": "6.2.2. Example: Workflows Tests" + "chapterTitle": "7.2.2. Example: Workflows Tests", + "number": "7.2.2." } ], - "chapterTitle": "6.2. Integration Tests" + "chapterTitle": "7.2. Integration Tests", + "number": "7.2." }, { "loaded": true, @@ -986,10 +1102,12 @@ export const generatedSidebar = [ "path": "/learn/debugging-and-testing/testing-tools/modules-tests/module-example", "title": "Example", "children": [], - "chapterTitle": "6.3.1. Example" + "chapterTitle": "7.3.1. Example", + "number": "7.3.1." } ], - "chapterTitle": "6.3. Modules Tests" + "chapterTitle": "7.3. Modules Tests", + "number": "7.3." }, { "loaded": true, @@ -998,7 +1116,8 @@ export const generatedSidebar = [ "path": "/learn/debugging-and-testing/instrumentation", "title": "Instrumentation", "children": [], - "chapterTitle": "6.4. Instrumentation" + "chapterTitle": "7.4. Instrumentation", + "number": "7.4." }, { "loaded": true, @@ -1007,86 +1126,135 @@ export const generatedSidebar = [ "path": "/learn/debugging-and-testing/logging", "title": "Logging", "children": [], - "chapterTitle": "6.5. Logging" + "chapterTitle": "7.5. Logging", + "number": "7.5." } ], - "childrenSameLevel": true - } - ], - "loaded": true, - "initialOpen": false - }, - { - "type": "category", - "title": "7. Production", - "children": [ + "chapterTitle": "7. Debugging & Testing", + "number": "7." + }, { "loaded": true, "isPathHref": true, - "type": "link", - "path": "/learn/build", - "title": "Build", - "chapterTitle": "7. Production", + "type": "category", + "title": "8. Production", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "path": "/learn/deployment", - "title": "Deployment Overview", + "path": "/learn/build", + "title": "Build", + "chapterTitle": "8. Production", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/deployment", + "title": "Deployment Overview", + "children": [], + "chapterTitle": "8.1. Deployment Overview", + "number": "8.1." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/deployment/general", + "title": "General Deployment", + "children": [], + "chapterTitle": "8.2. General Deployment", + "number": "8.2." + } + ], + "number": "8." + } + ], + "initialOpen": false + }, + { + "loaded": true, + "isPathHref": true, + "initialOpen": false, + "type": "category", + "title": "9. Upgrade", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/update", + "title": "Update Medusa", "children": [], - "chapterTitle": "7.1. Deployment Overview" + "chapterTitle": "9.1. Update Medusa", + "number": "9.1." + }, + { + "loaded": true, + "isPathHref": true, + "type": "external", + "path": "https://github.com/medusajs/medusa/releases", + "title": "Release Notes", + "children": [], + "chapterTitle": "9.2. Release Notes", + "number": "9.2." + } + ], + "chapterTitle": "9. Upgrade", + "number": "9." + }, + { + "loaded": true, + "isPathHref": true, + "initialOpen": false, + "type": "category", + "title": "10. Resources", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Contribution Guidelines", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/resources/contribution-guidelines/docs", + "title": "Docs", + "children": [], + "chapterTitle": "10.1.1. Docs", + "number": "10.1.1." + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/learn/resources//contribution-guidelines/admin-translations", + "title": "Admin Translations", + "children": [], + "chapterTitle": "10.1.2. Admin Translations", + "number": "10.1.2." + } + ], + "chapterTitle": "10.1. Contribution Guidelines", + "number": "10.1." }, { "loaded": true, "isPathHref": true, "type": "link", - "path": "/learn/deployment/general", - "title": "General Deployment", + "path": "/learn/resources/usage", + "title": "Usage", "children": [], - "chapterTitle": "7.2. General Deployment" + "chapterTitle": "10.2. Usage", + "number": "10.2." } ], - "childrenSameLevel": true + "chapterTitle": "10. Resources", + "number": "10." } - ], - "loaded": true, - "initialOpen": false - }, - { - "type": "category", - "title": "8. Updates", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/update", - "title": "Updating Medusa", - "chapterTitle": "8. Updates", - "children": [], - "childrenSameLevel": true - } - ], - "loaded": true, - "initialOpen": false - }, - { - "type": "category", - "title": "9. More Resources", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/learn/more-resources", - "title": "More Resources", - "children": [], - "childrenSameLevel": true, - "chapterTitle": "9. More Resources" - } - ], - "loaded": true, - "initialOpen": false + ] } ] \ No newline at end of file diff --git a/www/apps/book/next.config.mjs b/www/apps/book/next.config.mjs index 6b699f1c5c..7986372d2b 100644 --- a/www/apps/book/next.config.mjs +++ b/www/apps/book/next.config.mjs @@ -8,9 +8,9 @@ import { pageNumberRehypePlugin, crossProjectLinksPlugin, } from "remark-rehype-plugins" -import { sidebar } from "./sidebar.mjs" import path from "path" import redirects from "./utils/redirects.mjs" +import { generatedSidebars } from "./generated/sidebar.mjs" const withMDX = mdx({ extension: /\.mdx?$/, @@ -82,7 +82,7 @@ const withMDX = mdx({ [ pageNumberRehypePlugin, { - sidebar: sidebar, + sidebar: generatedSidebars[0].items, }, ], ], diff --git a/www/apps/book/providers/sidebar.tsx b/www/apps/book/providers/sidebar.tsx index 3393d7b349..7b39f0587e 100644 --- a/www/apps/book/providers/sidebar.tsx +++ b/www/apps/book/providers/sidebar.tsx @@ -15,13 +15,8 @@ const SidebarProvider = ({ children }: SidebarProviderProps) => { return ( {children} diff --git a/www/apps/book/public/llms-full.txt b/www/apps/book/public/llms-full.txt index f802012bbe..4a60673853 100644 --- a/www/apps/book/public/llms-full.txt +++ b/www/apps/book/public/llms-full.txt @@ -131,6 +131,63 @@ The next chapter covers how you generally deploy the production build. You can also refer to the [deployment how-to guides](https://docs.medusajs.com/resources/deployment/index.html.md) for platform-specific how-to guides. +# Medusa Deployment Overview + +In this chapter, you’ll learn the general approach to deploying the Medusa application. + +## Medusa Project Components + +A standard Medusa project is made up of: + +- Medusa application: The Medusa server and the Medusa Admin. +- One or more storefronts + +![Diagram showcasing the connection between the three deployed components](https://res.cloudinary.com/dza7lstvk/image/upload/v1708600807/Medusa%20Book/deployment-options_ceuuvo.jpg) + +You deploy the Medusa application, with the server and admin, separately from the storefront. + +*** + +## Deploying the Medusa Application + +You must deploy the Medusa application before the storefront, as it connects to the server and won’t work without a deployed Medusa server URL. + +The Medusa application must be deployed to a hosting provider supporting Node.js server deployments, such as Railway, DigitalOcean, AWS, Heroku, etc… + +![Diagram showcasing how the Medusa server and its associated services would be deployed](https://res.cloudinary.com/dza7lstvk/image/upload/v1708600972/Medusa%20Book/backend_deployment_pgexo3.jpg) + +Your server connects to a PostgreSQL database, Redis, and other services relevant for your setup. Most hosting providers support deploying and managing these databases along with your Medusa server (such as Railway and DigitalOcean). + +When you deploy your Medusa application, you also deploy the Medusa Admin. For optimal experience, your hosting provider and plan must offer at least 2GB of RAM. + +### How to Deploy Medusa? + +Medusa Cloud is our managed services offering that makes deploying and operating Medusa applications possible without having to worry about configuring, scaling, and maintaining infrastructure. Medusa Cloud hosts your server, Admin dashboard, database, and Redis instance. + +With Medusa Cloud, you maintain full customization control as you deploy your own modules and customizations directly from GitHub: + +- Push to deploy. +- Multiple testing environments. +- Preview environments for new PRs. +- Test on production-like data. + +[Sign up and learn more about Medusa Cloud](https://medusajs.com/pricing) + +To self-host Medusa, the [next chapter](https://docs.medusajs.com/learn/deployment/general/index.html.md) explains the general steps to deploy your Medusa application. Refer to [this reference](https://docs.medusajs.com/resources/deployment/index.html.md) to find how-to deployment guides for general and specific hosting providers. + +*** + +## Deploying the Storefront + +The storefront is deployed separately from the Medusa application, and the hosting options depend on the tools and frameworks you use to create the storefront. + +If you’re using the Next.js Starter storefront, you may deploy the storefront to any hosting provider that supports frontend frameworks, such as Vercel. + +Per Vercel’s [license and plans](https://vercel.com/pricing), their free plan can only be used for personal, non-commercial projects. So, you can deploy the storefront on the free plan for development purposes, but for commercial projects, you must update your Vercel plan. + +Refer to [this reference](https://docs.medusajs.com/resources/deployment/index.html.md) to find how-to deployment guides for specific hosting providers. + + # Install Medusa In this chapter, you'll learn how to install and run a Medusa application. @@ -255,78 +312,26 @@ Refer to [this documentation](https://docs.medusajs.com/learn/update/index.html. In the next chapters, you'll learn about the architecture of your Medusa application, then learn how to customize your application to build custom features. -# Medusa Deployment Overview +# Storefront Development -In this chapter, you’ll learn the general approach to deploying the Medusa application. +The Medusa application is made up of a Node.js server and an admin dashboard. Storefronts are installed, built, and hosted separately from the Medusa application, giving you the flexibility to choose the frontend tech stack that you and your team are proficient in, and implement unique design systems and user experience. -## Medusa Project Components +You can build your storefront from scratch with your preferred tech stack, or start with our Next.js Starter storefront. The Next.js Starter storefront provides rich commerce features and a sleek design. Developers and businesses can use it as-is or build on top of it to tailor it for the business's unique use case, design, and customer experience. -A standard Medusa project is made up of: - -- Medusa application: The Medusa server and the Medusa Admin. -- One or more storefronts - -![Diagram showcasing the connection between the three deployed components](https://res.cloudinary.com/dza7lstvk/image/upload/v1708600807/Medusa%20Book/deployment-options_ceuuvo.jpg) - -You deploy the Medusa application, with the server and admin, separately from the storefront. +- [Install Next.js Starter Storefront](https://docs.medusajs.com/resources/nextjs-starter/index.html.md) +- [Build Custom Storefront](https://docs.medusajs.com/resources/storefront-development/index.html.md) *** -## Deploying the Medusa Application +## Passing a Publishable API Key in Storefront Requests -You must deploy the Medusa application before the storefront, as it connects to the server and won’t work without a deployed Medusa server URL. +When sending a request to an API route starting with `/store`, you must include a publishable API key in the header of your request. -The Medusa application must be deployed to a hosting provider supporting Node.js server deployments, such as Railway, DigitalOcean, AWS, Heroku, etc… +A publishable API key sets the scope of your request to one or more sales channels. -![Diagram showcasing how the Medusa server and its associated services would be deployed](https://res.cloudinary.com/dza7lstvk/image/upload/v1708600972/Medusa%20Book/backend_deployment_pgexo3.jpg) +Then, when you retrieve products, only products of those sales channels are retrieved. This also ensures you retrieve correct inventory data, and associate created orders with the scoped sales channel. -Your server connects to a PostgreSQL database, Redis, and other services relevant for your setup. Most hosting providers support deploying and managing these databases along with your Medusa server (such as Railway and DigitalOcean). - -When you deploy your Medusa application, you also deploy the Medusa Admin. For optimal experience, your hosting provider and plan must offer at least 2GB of RAM. - -### How to Deploy Medusa? - -Medusa Cloud is our managed services offering that makes deploying and operating Medusa applications possible without having to worry about configuring, scaling, and maintaining infrastructure. Medusa Cloud hosts your server, Admin dashboard, database, and Redis instance. - -With Medusa Cloud, you maintain full customization control as you deploy your own modules and customizations directly from GitHub: - -- Push to deploy. -- Multiple testing environments. -- Preview environments for new PRs. -- Test on production-like data. - -[Sign up and learn more about Medusa Cloud](https://medusajs.com/contact) - -To self-host Medusa, the [next chapter](https://docs.medusajs.com/learn/deployment/general/index.html.md) explains the general steps to deploy your Medusa application. Refer to [this reference](https://docs.medusajs.com/resources/deployment/index.html.md) to find how-to deployment guides for general and specific hosting providers. - -*** - -## Deploying the Storefront - -The storefront is deployed separately from the Medusa application, and the hosting options depend on the tools and frameworks you use to create the storefront. - -If you’re using the Next.js Starter storefront, you may deploy the storefront to any hosting provider that supports frontend frameworks, such as Vercel. - -Per Vercel’s [license and plans](https://vercel.com/pricing), their free plan can only be used for personal, non-commercial projects. So, you can deploy the storefront on the free plan for development purposes, but for commercial projects, you must update your Vercel plan. - -Refer to [this reference](https://docs.medusajs.com/resources/deployment/index.html.md) to find how-to deployment guides for specific hosting providers. - - -# Debugging and Testing - -In the next chapters, you’ll learn about the tools Medusa provides for testing and debugging your Medusa application. - -By the end of this chapter, you’ll learn: - -- How to use Medusa's `@medusajs/test-utils` test to write integration tests. -- How to use Medusa’s `Logger` utility to log messages. - - -# More Resources - -The Development Resources documentation provides guides and references that are useful for your development. This documentation included links to parts of the Development Resources documentation where necessary. - -Check out the Development Resources documentation [here](https://docs.medusajs.com/resources/index.html.md). +Learn more about passing the publishable API key in [this storefront development guide](https://docs.medusajs.com/resources/storefront-development/publishable-api-keys/index.html.md). # Updating Medusa @@ -435,28 +440,6 @@ npm install ``` -# Storefront Development - -The Medusa application is made up of a Node.js server and an admin dashboard. Storefronts are installed, built, and hosted separately from the Medusa application, giving you the flexibility to choose the frontend tech stack that you and your team are proficient in, and implement unique design systems and user experience. - -You can build your storefront from scratch with your preferred tech stack, or start with our Next.js Starter storefront. The Next.js Starter storefront provides rich commerce features and a sleek design. Developers and businesses can use it as-is or build on top of it to tailor it for the business's unique use case, design, and customer experience. - -- [Install Next.js Starter Storefront](https://docs.medusajs.com/resources/nextjs-starter/index.html.md) -- [Build Custom Storefront](https://docs.medusajs.com/resources/storefront-development/index.html.md) - -*** - -## Passing a Publishable API Key in Storefront Requests - -When sending a request to an API route starting with `/store`, you must include a publishable API key in the header of your request. - -A publishable API key sets the scope of your request to one or more sales channels. - -Then, when you retrieve products, only products of those sales channels are retrieved. This also ensures you retrieve correct inventory data, and associate created orders with the scoped sales channel. - -Learn more about passing the publishable API key in [this storefront development guide](https://docs.medusajs.com/resources/storefront-development/publishable-api-keys/index.html.md). - - # Using TypeScript Aliases By default, Medusa doesn't support TypeScript aliases in production. @@ -526,30 +509,6 @@ The next chapters will guide you to: 3. Expose an API route that allows admin users to create a brand using the workflow. -# Customizations Next Steps: Learn the Fundamentals - -The previous guides introduced Medusa's different concepts and how you can use them to customize Medusa for a realistic use case, You added brands to your application, linked them to products, customized the admin dashboard, and integrated a third-party CMS. - -The next chapters will cover each of these concepts in depth, with the different ways you can use them, their options or configurations, and more advanced features that weren't covered in the previous guides. While you can start building with Medusa, it's highly recommended to follow the next chapters for a better understanding of Medusa's fundamentals. - -## Helpful Resources Guides - -The [Development Resources](https://docs.medusajs.com/resources/index.html.md) documentation provides more helpful guides and references for your development journey. Some of these guides and references include: - -3. [Commerce Modules](https://docs.medusajs.com/resources/commerce-modules/index.html.md): Browse the list of commerce modules in Medusa and their references to learn how to use them. -4. [Service Factory Reference](https://docs.medusajs.com/resources/service-factory-reference/index.html.md): Learn about the methods generated by `MedusaService` with examples. -5. [Workflows Reference](https://docs.medusajs.com/resources/medusa-workflows-reference/index.html.md): Browse the list of core workflows and their hooks that are useful for your customizations. -6. [Admin Injection Zones](https://docs.medusajs.com/resources/admin-widget-injection-zones/index.html.md): Browse the injection zones in the Medusa Admin to learn where you can inject widgets. - -*** - -## More Examples in Recipes - -In the Development Resources documentation, you'll also find step-by-step guides for different use cases, such as building a marketplace, digital products, and more. - -Refer to the [Recipes](https://docs.medusajs.com/resources/recipes/index.html.md) documentation to learn more. - - # Customize Medusa Admin Dashboard In the previous chapters, you've customized your Medusa application to [add brands](https://docs.medusajs.com/learn/customization/custom-features/module/index.html.md), [expose an API route to create brands](https://docs.medusajs.com/learn/customization/custom-features/api-route/index.html.md), and [linked brands to products](https://docs.medusajs.com/learn/customization/extend-features/define-link/index.html.md). @@ -594,6 +553,45 @@ The next chapters explain how to use the tools mentioned above with step-by-step - Retrieve a product's associated brand's details. +# Customizations Next Steps: Learn the Fundamentals + +The previous guides introduced Medusa's different concepts and how you can use them to customize Medusa for a realistic use case, You added brands to your application, linked them to products, customized the admin dashboard, and integrated a third-party CMS. + +The next chapters will cover each of these concepts in depth, with the different ways you can use them, their options or configurations, and more advanced features that weren't covered in the previous guides. While you can start building with Medusa, it's highly recommended to follow the next chapters for a better understanding of Medusa's fundamentals. + +## Helpful Resources Guides + +The [Development Resources](https://docs.medusajs.com/resources/index.html.md) documentation provides more helpful guides and references for your development journey. Some of these guides and references include: + +3. [Commerce Modules](https://docs.medusajs.com/resources/commerce-modules/index.html.md): Browse the list of commerce modules in Medusa and their references to learn how to use them. +4. [Service Factory Reference](https://docs.medusajs.com/resources/service-factory-reference/index.html.md): Learn about the methods generated by `MedusaService` with examples. +5. [Workflows Reference](https://docs.medusajs.com/resources/medusa-workflows-reference/index.html.md): Browse the list of core workflows and their hooks that are useful for your customizations. +6. [Admin Injection Zones](https://docs.medusajs.com/resources/admin-widget-injection-zones/index.html.md): Browse the injection zones in the Medusa Admin to learn where you can inject widgets. + +*** + +## More Examples in Recipes + +In the Development Resources documentation, you'll also find step-by-step guides for different use cases, such as building a marketplace, digital products, and more. + +Refer to the [Recipes](https://docs.medusajs.com/resources/recipes/index.html.md) documentation to learn more. + + +# Re-Use Customizations with Plugins + +In the previous chapters, you've learned important concepts related to creating modules, implementing commerce features in workflows, exposing those features in API routes, customizing the Medusa Admin dashboard with Admin Extensions, and integrating third-party systems. + +You've implemented the brands example within a single Medusa application. However, this approach is not scalable when you want to reuse your customizations across multiple projects. + +To reuse your customizations across multiple Medusa applications, such as implementing brands in different projects, you can create a plugin. A plugin is an NPM package that encapsulates your customizations and can be installed in any Medusa application. Plugins can include modules, workflows, API routes, Admin Extensions, and more. + +![Diagram showcasing how the Brand Plugin would add its resources to any application it's installed in](https://res.cloudinary.com/dza7lstvk/image/upload/v1737540091/Medusa%20Book/brand-plugin_bk9zi9.jpg) + +Medusa provides the tooling to create a plugin package, test it in a local Medusa application, and publish it to NPM. + +To learn more about plugins and how to create them, refer to [this chapter](https://docs.medusajs.com/learn/fundamentals/plugins/index.html.md). + + # Integrate Third-Party Systems Commerce applications often connect to third-party systems that provide additional or specialized features. For example, you may integrate a Content-Management System (CMS) for rich content features, a payment provider to process credit-card payments, and a notification service to send emails. @@ -617,86 +615,13 @@ In the previous chapters, you've [added brands](https://docs.medusajs.com/learn/ 3. Sync brands from the CMS at a daily schedule. -# Re-Use Customizations with Plugins - -In the previous chapters, you've learned important concepts related to creating modules, implementing commerce features in workflows, exposing those features in API routes, customizing the Medusa Admin dashboard with Admin Extensions, and integrating third-party systems. - -You've implemented the brands example within a single Medusa application. However, this approach is not scalable when you want to reuse your customizations across multiple projects. - -To reuse your customizations across multiple Medusa applications, such as implementing brands in different projects, you can create a plugin. A plugin is an NPM package that encapsulates your customizations and can be installed in any Medusa application. Plugins can include modules, workflows, API routes, Admin Extensions, and more. - -![Diagram showcasing how the Brand Plugin would add its resources to any application it's installed in](https://res.cloudinary.com/dza7lstvk/image/upload/v1737540091/Medusa%20Book/brand-plugin_bk9zi9.jpg) - -Medusa provides the tooling to create a plugin package, test it in a local Medusa application, and publish it to NPM. - -To learn more about plugins and how to create them, refer to [this chapter](https://docs.medusajs.com/learn/fundamentals/plugins/index.html.md). - - -# Medusa's Architecture - -In this chapter, you'll learn about the architectural layers in Medusa. - -## HTTP, Workflow, and Module Layers - -Medusa is a headless commerce platform. So, storefronts, admin dashboards, and other clients consume Medusa's functionalities through its API routes. - -In a common Medusa application, requests go through four layers in the stack. In order of entry, those are: - -1. API Routes (HTTP): Our API Routes are the typical entry point. -2. Workflows: API Routes consume workflows that hold the opinionated business logic of your application. -3. Modules: Workflows use domain-specific modules for resource management. -4. Data store: Modules query the underlying datastore, which is a PostgreSQL database in common cases. - -These layers of stack can be implemented within [plugins](https://docs.medusajs.com/learn/fundamentals/plugins/index.html.md). - -![Diagram illustrating the HTTP layer](https://res.cloudinary.com/dza7lstvk/image/upload/v1727175296/Medusa%20Book/http-layer_sroafr.jpg) - -*** - -## Database Layer - -The Medusa application injects into each module a connection to the configured PostgreSQL database. Modules use that connection to read and write data to the database. - -Modules can be implemented within [plugins](https://docs.medusajs.com/learn/fundamentals/plugins/index.html.md). - -![Diagram illustrating the database layer](https://res.cloudinary.com/dza7lstvk/image/upload/v1727175379/Medusa%20Book/db-layer_pi7tix.jpg) - -*** - -## Service Integrations - -Third-party services are integrated through commerce and architectural modules. You also create custom third-party integrations through a custom module. - -Modules can be implemented within [plugins](https://docs.medusajs.com/learn/fundamentals/plugins/index.html.md). - -### Commerce Modules - -[Commerce modules](https://docs.medusajs.com/resources/commerce-modules/index.html.md) integrate third-party services relevant for commerce or user-facing features. For example, you integrate Stripe through a payment module provider. - -![Diagram illustrating the commerce modules integration to third-party services](https://res.cloudinary.com/dza7lstvk/image/upload/v1727175357/Medusa%20Book/service-commerce_qcbdsl.jpg) - -### Architectural Modules - -[Architectural modules](https://docs.medusajs.com/resources/architectural-modules/index.html.md) integrate third-party services and systems for architectural features. For example, you integrate Redis as a pub/sub service to send events, or SendGrid to send notifications. - -![Diagram illustrating the architectural modules integration to third-party services and systems](https://res.cloudinary.com/dza7lstvk/image/upload/v1727175342/Medusa%20Book/service-arch_ozvryw.jpg) - -*** - -## Full Diagram of Medusa's Architecture - -The following diagram illustrates Medusa's architecture over the three layers. - -![Full diagram illustrating Medusa's architecture](https://res.cloudinary.com/dza7lstvk/image/upload/v1727174897/Medusa%20Book/architectural-diagram-full.jpg) - - # General Medusa Application Deployment Guide In this document, you'll learn the general steps to deploy your Medusa application. How you apply these steps depend on your chosen hosting provider or platform. Find how-to guides for specific platforms in [this documentation](https://docs.medusajs.com/resources/deployment/index.html.md). -Want Medusa to manage and maintain your infrastructure? [Sign up and learn more about Medusa Cloud](https://medusajs.com/contact) +Want Medusa to manage and maintain your infrastructure? [Sign up and learn more about Medusa Cloud](https://medusajs.com/pricing) Medusa Cloud is our managed services offering that makes deploying and operating Medusa applications possible without having to worry about configuring, scaling, and maintaining infrastructure. Medusa Cloud hosts your server, Admin dashboard, database, and Redis instance. @@ -991,6 +916,410 @@ Replace the email `admin-medusa@test.com` and password `supersecret` with the cr You can use these credentials to log into the Medusa Admin dashboard. +# Medusa's Architecture + +In this chapter, you'll learn about the architectural layers in Medusa. + +## HTTP, Workflow, and Module Layers + +Medusa is a headless commerce platform. So, storefronts, admin dashboards, and other clients consume Medusa's functionalities through its API routes. + +In a common Medusa application, requests go through four layers in the stack. In order of entry, those are: + +1. API Routes (HTTP): Our API Routes are the typical entry point. +2. Workflows: API Routes consume workflows that hold the opinionated business logic of your application. +3. Modules: Workflows use domain-specific modules for resource management. +4. Data store: Modules query the underlying datastore, which is a PostgreSQL database in common cases. + +These layers of stack can be implemented within [plugins](https://docs.medusajs.com/learn/fundamentals/plugins/index.html.md). + +![Diagram illustrating the HTTP layer](https://res.cloudinary.com/dza7lstvk/image/upload/v1727175296/Medusa%20Book/http-layer_sroafr.jpg) + +*** + +## Database Layer + +The Medusa application injects into each module a connection to the configured PostgreSQL database. Modules use that connection to read and write data to the database. + +Modules can be implemented within [plugins](https://docs.medusajs.com/learn/fundamentals/plugins/index.html.md). + +![Diagram illustrating the database layer](https://res.cloudinary.com/dza7lstvk/image/upload/v1727175379/Medusa%20Book/db-layer_pi7tix.jpg) + +*** + +## Service Integrations + +Third-party services are integrated through commerce and architectural modules. You also create custom third-party integrations through a custom module. + +Modules can be implemented within [plugins](https://docs.medusajs.com/learn/fundamentals/plugins/index.html.md). + +### Commerce Modules + +[Commerce modules](https://docs.medusajs.com/resources/commerce-modules/index.html.md) integrate third-party services relevant for commerce or user-facing features. For example, you integrate Stripe through a payment module provider. + +![Diagram illustrating the commerce modules integration to third-party services](https://res.cloudinary.com/dza7lstvk/image/upload/v1727175357/Medusa%20Book/service-commerce_qcbdsl.jpg) + +### Architectural Modules + +[Architectural modules](https://docs.medusajs.com/resources/architectural-modules/index.html.md) integrate third-party services and systems for architectural features. For example, you integrate Redis as a pub/sub service to send events, or SendGrid to send notifications. + +![Diagram illustrating the architectural modules integration to third-party services and systems](https://res.cloudinary.com/dza7lstvk/image/upload/v1727175342/Medusa%20Book/service-arch_ozvryw.jpg) + +*** + +## Full Diagram of Medusa's Architecture + +The following diagram illustrates Medusa's architecture over the three layers. + +![Full diagram illustrating Medusa's architecture](https://res.cloudinary.com/dza7lstvk/image/upload/v1727174897/Medusa%20Book/architectural-diagram-full.jpg) + + +# Configure Instrumentation + +In this chapter, you'll learn about observability in Medusa and how to configure instrumentation with OpenTelemetry. + +## Observability with OpenTelemtry + +Medusa uses [OpenTelemetry](https://opentelemetry.io/) for instrumentation and reporting. When configured, it reports traces for: + +- HTTP requests +- Workflow executions +- Query usages +- Database queries and operations + +*** + +## How to Configure Instrumentation in Medusa? + +### Prerequisites + +- [An exporter to visualize your application's traces, such as Zipkin.](https://zipkin.io/pages/quickstart.html) + +### Install Dependencies + +Start by installing the following OpenTelemetry dependencies in your Medusa project: + +```bash npm2yarn +npm install @opentelemetry/sdk-node @opentelemetry/resources @opentelemetry/sdk-trace-node @opentelemetry/instrumentation-pg +``` + +Also, install the dependencies relevant for the exporter you use. If you're using Zipkin, install the following dependencies: + +```bash npm2yarn +npm install @opentelemetry/exporter-zipkin +``` + +### Add instrumentation.ts + +Next, create the file `instrumentation.ts` with the following content: + +```ts title="instrumentation.ts" +import { registerOtel } from "@medusajs/medusa" +import { ZipkinExporter } from "@opentelemetry/exporter-zipkin" + +// If using an exporter other than Zipkin, initialize it here. +const exporter = new ZipkinExporter({ + serviceName: "my-medusa-project", +}) + +export function register() { + registerOtel({ + serviceName: "medusajs", + // pass exporter + exporter, + instrument: { + http: true, + workflows: true, + query: true, + }, + }) +} +``` + +In the `instrumentation.ts` file, you export a `register` function that uses Medusa's `registerOtel` utility function. You also initialize an instance of the exporter, such as Zipkin, and pass it to the `registerOtel` function. + +`registerOtel` accepts an object where you can pass any [NodeSDKConfiguration](https://open-telemetry.github.io/opentelemetry-js/interfaces/_opentelemetry_sdk_node.NodeSDKConfiguration.html) property along with the following properties: + +The `NodeSDKConfiguration` properties are accepted since Medusa v2.5.1. + +- serviceName: (\`string\`) The name of the service traced. +- exporter: (\[SpanExporter]\(https://open-telemetry.github.io/opentelemetry-js/interfaces/\_opentelemetry\_sdk\_trace\_base.SpanExporter.html)) An instance of an exporter, such as Zipkin. +- instrument: (\`object\`) Options specifying what to trace. + + - http: (\`boolean\`) Whether to trace HTTP requests. + + - query: (\`boolean\`) Whether to trace Query usages. + + - workflows: (\`boolean\`) Whether to trace Workflow executions. + + - db: (\`boolean\`) Whether to trace database queries and operations. +- instrumentations: (\[Instrumentation\[]]\(https://open-telemetry.github.io/opentelemetry-js/interfaces/\_opentelemetry\_instrumentation.Instrumentation.html)) Additional instrumentation options that OpenTelemetry accepts. + +*** + +## Test it Out + +To test it out, start your exporter, such as Zipkin. + +Then, start your Medusa application: + +```bash npm2yarn +npm run dev +``` + +Try to open the Medusa Admin or send a request to an API route. + +If you check traces in your exporter, you'll find new traces reported. + +### Trace Span Names + +Trace span names start with the following keywords based on what it's reporting: + +- `{methodName} {URL}` when reporting HTTP requests, where `{methodName}` is the HTTP method, and `{URL}` is the URL the request is sent to. +- `route:` when reporting route handlers running on an HTTP request. +- `middleware:` when reporting a middleware running on an HTTP request. +- `workflow:` when reporting a workflow execution. +- `step:` when reporting a step in a workflow execution. +- `query.graph:` when reporting Query usages. +- `pg.query:` when reporting database queries and operations. + + +# Medusa Testing Tools + +In this chapter, you'll learn about Medusa's testing tools and how to install and configure them. + +## @medusajs/test-utils Package + +Medusa provides a Testing Framework to create integration tests for your custom API routes, modules, or other Medusa customizations. + +To use the Testing Framework, install `@medusajs/test-utils` as a `devDependency`: + +```bash npm2yarn +npm install --save-dev @medusajs/test-utils@latest +``` + +*** + +## Install and Configure Jest + +Writing tests with `@medusajs/test-utils`'s tools requires installing and configuring Jest in your project. + +Run the following command to install the required Jest dependencies: + +```bash npm2yarn +npm install --save-dev jest @types/jest @swc/jest +``` + +Then, create the file `jest.config.js` with the following content: + +```js title="jest.config.js" +const { loadEnv } = require("@medusajs/framework/utils") +loadEnv("test", process.cwd()) + +module.exports = { + transform: { + "^.+\\.[jt]s$": [ + "@swc/jest", + { + jsc: { + parser: { syntax: "typescript", decorators: true }, + }, + }, + ], + }, + testEnvironment: "node", + moduleFileExtensions: ["js", "ts", "json"], + modulePathIgnorePatterns: ["dist/"], + setupFiles: ["./integration-tests/setup.js"], +} + +if (process.env.TEST_TYPE === "integration:http") { + module.exports.testMatch = ["**/integration-tests/http/*.spec.[jt]s"] +} else if (process.env.TEST_TYPE === "integration:modules") { + module.exports.testMatch = ["**/src/modules/*/__tests__/**/*.[jt]s"] +} else if (process.env.TEST_TYPE === "unit") { + module.exports.testMatch = ["**/src/**/__tests__/**/*.unit.spec.[jt]s"] +} +``` + +Next, create the `integration-tests/setup.js` file with the following content: + +```js title="integration-tests/setup.js" +const { MetadataStorage } = require("@mikro-orm/core") + +MetadataStorage.clear() +``` + +*** + +## Add Test Commands + +Finally, add the following scripts to `package.json`: + +```json title="package.json" +"scripts": { + // ... + "test:integration:http": "TEST_TYPE=integration:http NODE_OPTIONS=--experimental-vm-modules jest --silent=false --runInBand --forceExit", + "test:integration:modules": "TEST_TYPE=integration:modules NODE_OPTIONS=--experimental-vm-modules jest --silent --runInBand --forceExit", + "test:unit": "TEST_TYPE=unit NODE_OPTIONS=--experimental-vm-modules jest --silent --runInBand --forceExit" +}, +``` + +You now have two commands: + +- `test:integration:http` to run integration tests (for example, for API routes and workflows) available under the `integration-tests/http` directory. +- `test:integration:modules` to run integration tests for modules available in any `__tests__` directory under `src/modules`. +- `test:unit` to run unit tests in any `__tests__` directory under the `src` directory. + +Medusa's Testing Framework works for integration tests only. You can write unit tests using Jest. + +*** + +## Test Tools and Writing Tests + +The next chapters explain how to use the testing tools provided by `@medusajs/test-utils` to write tests. + + +# Logging + +In this chapter, you’ll learn how to use Medusa’s logging utility. + +## Logger Class + +Medusa provides a `Logger` class with advanced logging functionalities. This includes configuring logging levels or saving logs to a file. + +The Medusa application registers the `Logger` class in the Medusa container and each module's container as `logger`. + +*** + +## How to Log a Message + +Resolve the `logger` using the Medusa container to log a message in your resource. + +For example, create the file `src/jobs/log-message.ts` with the following content: + +```ts title="src/jobs/log-message.ts" highlights={highlights} +import { MedusaContainer } from "@medusajs/framework/types" +import { ContainerRegistrationKeys } from "@medusajs/framework/utils" + +export default async function myCustomJob( + container: MedusaContainer +) { + const logger = container.resolve(ContainerRegistrationKeys.LOGGER) + + logger.info("I'm using the logger!") +} + +export const config = { + name: "test-logger", + // execute every minute + schedule: "* * * * *", +} +``` + +This creates a scheduled job that resolves the `logger` from the Medusa container and uses it to log a message. + +### Test the Scheduled Job + +To test out the above scheduled job, start the Medusa application: + +```bash npm2yarn +npm run dev +``` + +After a minute, you'll see the following message as part of the logged messages: + +```text +info: I'm using the logger! +``` + +*** + +## Log Levels + +The `Logger` class has the following methods: + +- `info`: The message is logged with level `info`. +- `warn`: The message is logged with level `warn`. +- `error`: The message is logged with level `error`. +- `debug`: The message is logged with level `debug`. + +Each of these methods accepts a string parameter to log in the terminal with the associated level. + +*** + +## Logging Configurations + +### Log Level + +The available log levels, from lowest to highest levels, are: + +1. `silly` (default, meaning messages of all levels are logged) +2. `debug` +3. `info` +4. `warn` +5. `error` + +You can change that by setting the `LOG_LEVEL` environment variable to the minimum level you want to be logged. + +For example: + +```bash +LOG_LEVEL=error +``` + +This logs `error` messages only. + +The environment variable must be set as a system environment variable and not in `.env`. + +### Save Logs in a File + +Aside from showing the logs in the terminal, you can save the logs in a file by setting the `LOG_FILE` environment variable to the path of the file relative to the Medusa server’s root directory. + +For example: + +```bash +LOG_FILE=all.log +``` + +Your logs are now saved in the `all.log` file at the root of your Medusa application. + +The environment variable must be set as a system environment variable and not in `.env`. + +*** + +## Show Log with Progress + +The `Logger` class has an `activity` method used to log a message of level `info`. If the Medusa application is running in a development environment, a spinner starts to show the activity's progress. + +For example: + +```ts title="src/jobs/log-message.ts" +import { MedusaContainer } from "@medusajs/framework/types" +import { ContainerRegistrationKeys } from "@medusajs/framework/utils" + +export default async function myCustomJob( + container: MedusaContainer +) { + const logger = container.resolve(ContainerRegistrationKeys.LOGGER) + + const activityId = logger.activity("First log message") + + logger.progress(activityId, `Second log message`) + + logger.success(activityId, "Last log message") +} +``` + +The `activity` method returns the ID of the started activity. This ID can then be passed to one of the following methods of the `Logger` class: + +- `progress`: Log a message of level `info` that indicates progress within that same activity. +- `success`: Log a message of level `info` that indicates that the activity has succeeded. This also ends the associated activity. +- `failure`: Log a message of level `error` that indicates that the activity has failed. This also ends the associated activity. + +If you configured the `LOG_LEVEL` environment variable to a level higher than those associated with the above methods, their messages won’t be logged. + + # Admin Development In the next chapters, you'll learn more about possible admin customizations. @@ -1074,6 +1403,19 @@ curl http://localhost:9000/hello-world You're exposing custom functionality to be used by a storefront, admin dashboard, or any external application. +# Data Models Advanced Guides + +Data models are created and managed in a module. To learn how to create a data model in a custom module, refer to the [Modules chapter](https://docs.medusajs.com/learn/fundamentals/modules/index.html.md). + +In the next chapters, you'll learn about defining data models in more details. You'll learn about: + +- The different property types available. +- How to set a property as a primary key. +- How to create and manage relationships. +- How to configure properties, such as making them nullable or searchable. +- How to manually write migrations. + + # Environment Variables In this chapter, you'll learn how environment variables are loaded in Medusa. @@ -1153,6 +1495,76 @@ You should opt for setting configurations in `medusa-config.ts` where possible. ||Whether to disable analytics data collection. Learn more in || +# Custom CLI Scripts + +In this chapter, you'll learn how to create and execute custom scripts from Medusa's CLI tool. + +## What is a Custom CLI Script? + +A custom CLI script is a function to execute through Medusa's CLI tool. This is useful when creating custom Medusa tooling to run through the CLI. + +*** + +## How to Create a Custom CLI Script? + +To create a custom CLI script, create a TypeScript or JavaScript file under the `src/scripts` directory. The file must default export a function. + +For example, create the file `src/scripts/my-script.ts` with the following content: + +```ts title="src/scripts/my-script.ts" +import { + ExecArgs, + IProductModuleService, +} from "@medusajs/framework/types" +import { Modules } from "@medusajs/framework/utils" + +export default async function myScript({ container }: ExecArgs) { + const productModuleService: IProductModuleService = container.resolve( + Modules.PRODUCT + ) + + const [, count] = await productModuleService + .listAndCountProducts() + + console.log(`You have ${count} product(s)`) +} +``` + +The function receives as a parameter an object having a `container` property, which is an instance of the Medusa Container. Use it to resolve resources in your Medusa application. + +*** + +## How to Run Custom CLI Script? + +To run the custom CLI script, run the Medusa CLI's `exec` command: + +```bash +npx medusa exec ./src/scripts/my-script.ts +``` + +*** + +## Custom CLI Script Arguments + +Your script can accept arguments from the command line. Arguments are passed to the function's object parameter in the `args` property. + +For example: + +```ts +import { ExecArgs } from "@medusajs/framework/types" + +export default async function myScript({ args }: ExecArgs) { + console.log(`The arguments you passed: ${args}`) +} +``` + +Then, pass the arguments in the `exec` command after the file path: + +```bash +npx medusa exec ./src/scripts/my-script.ts arg1 arg2 +``` + + # Events and Subscribers In this chapter, you’ll learn about Medusa's event system, and how to handle events with subscribers. @@ -1255,76 +1667,6 @@ Medusa provides two Event Modules out of the box: Medusa's [architecture](https://docs.medusajs.com/learn/introduction/architecture/index.html.md) also allows you to build a custom Event Module that uses a different service or logic to implement the pub/sub system. Learn how to build an Event Module in [this guide](https://docs.medusajs.com/resources/architectural-modules/event/create/index.html.md). -# Custom CLI Scripts - -In this chapter, you'll learn how to create and execute custom scripts from Medusa's CLI tool. - -## What is a Custom CLI Script? - -A custom CLI script is a function to execute through Medusa's CLI tool. This is useful when creating custom Medusa tooling to run through the CLI. - -*** - -## How to Create a Custom CLI Script? - -To create a custom CLI script, create a TypeScript or JavaScript file under the `src/scripts` directory. The file must default export a function. - -For example, create the file `src/scripts/my-script.ts` with the following content: - -```ts title="src/scripts/my-script.ts" -import { - ExecArgs, - IProductModuleService, -} from "@medusajs/framework/types" -import { Modules } from "@medusajs/framework/utils" - -export default async function myScript({ container }: ExecArgs) { - const productModuleService: IProductModuleService = container.resolve( - Modules.PRODUCT - ) - - const [, count] = await productModuleService - .listAndCountProducts() - - console.log(`You have ${count} product(s)`) -} -``` - -The function receives as a parameter an object having a `container` property, which is an instance of the Medusa Container. Use it to resolve resources in your Medusa application. - -*** - -## How to Run Custom CLI Script? - -To run the custom CLI script, run the Medusa CLI's `exec` command: - -```bash -npx medusa exec ./src/scripts/my-script.ts -``` - -*** - -## Custom CLI Script Arguments - -Your script can accept arguments from the command line. Arguments are passed to the function's object parameter in the `args` property. - -For example: - -```ts -import { ExecArgs } from "@medusajs/framework/types" - -export default async function myScript({ args }: ExecArgs) { - console.log(`The arguments you passed: ${args}`) -} -``` - -Then, pass the arguments in the `exec` command after the file path: - -```bash -npx medusa exec ./src/scripts/my-script.ts arg1 arg2 -``` - - # Medusa Container In this chapter, you’ll learn about the Medusa container and how to use it. @@ -1599,411 +1941,6 @@ export default defineLink( In this example, when a product is deleted, its linked `myCustom` record is also deleted. -# Data Models Advanced Guides - -Data models are created and managed in a module. To learn how to create a data model in a custom module, refer to the [Modules chapter](https://docs.medusajs.com/learn/fundamentals/modules/index.html.md). - -In the next chapters, you'll learn about defining data models in more details. You'll learn about: - -- The different property types available. -- How to set a property as a primary key. -- How to create and manage relationships. -- How to configure properties, such as making them nullable or searchable. -- How to manually write migrations. - - -# Scheduled Jobs - -In this chapter, you’ll learn about scheduled jobs and how to use them. - -## What is a Scheduled Job? - -When building your commerce application, you may need to automate tasks and run them repeatedly at a specific schedule. For example, you need to automatically sync products to a third-party service once a day. - -In other commerce platforms, this feature isn't natively supported. Instead, you have to setup a separate application to execute cron jobs, which adds complexity as to how you expose this task to be executed in a cron job, or how do you debug it when it's not running within the platform's tooling. - -Medusa removes this overhead by supporting this feature natively with scheduled jobs. A scheduled job is an asynchronous function that the Medusa application runs at the interval you specify during the Medusa application's runtime. Your efforts are only spent on implementing the functionality performed by the job, such as syncing products to an ERP. - -- You want the action to execute at a specified schedule while the Medusa application **isn't** running. Instead, use the operating system's equivalent of a cron job. -- You want to execute the action once when the application loads. Use [loaders](https://docs.medusajs.com/learn/fundamentals/modules/loaders/index.html.md) instead. -- You want to execute the action if an event occurs. Use [subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers/index.html.md) instead. - -*** - -## How to Create a Scheduled Job? - -You create a scheduled job in a TypeScript or JavaScript file under the `src/jobs` directory. The file exports the asynchronous function to run, and the configurations indicating the schedule to run the function. - -For example, create the file `src/jobs/hello-world.ts` with the following content: - -![Example of scheduled job file in the application's directory structure](https://res.cloudinary.com/dza7lstvk/image/upload/v1732866423/Medusa%20Book/scheduled-job-dir-overview_ediqgm.jpg) - -```ts title="src/jobs/hello-world.ts" highlights={highlights} -import { MedusaContainer } from "@medusajs/framework/types" - -export default async function greetingJob(container: MedusaContainer) { - const logger = container.resolve("logger") - - logger.info("Greeting!") -} - -export const config = { - name: "greeting-every-minute", - schedule: "* * * * *", -} -``` - -You export an asynchronous function that receives the [Medusa container](https://docs.medusajs.com/learn/fundamentals/medusa-container/index.html.md) as a parameter. In the function, you resolve the [Logger utility](https://docs.medusajs.com/learn/debugging-and-testing/logging/index.html.md) from the Medusa container and log a message. - -You also export a `config` object that has the following properties: - -- `name`: A unique name for the job. -- `schedule`: A string that holds a [cron expression](https://crontab.guru/) indicating the schedule to run the job. - -This scheduled job executes every minute and logs into the terminal `Greeting!`. - -### Test the Scheduled Job - -To test out your scheduled job, start the Medusa application: - -```bash npm2yarn -npm run dev -``` - -After a minute, the following message will be logged to the terminal: - -```bash -info: Greeting! -``` - -*** - -## Example: Sync Products Once a Day - -In this section, you'll find a brief example of how you use a scheduled job to sync products to a third-party service. - -When implementing flows spanning across systems or [modules](https://docs.medusajs.com/learn/fundamentals/modules/index.html.md), you use [workflows](https://docs.medusajs.com/learn/fundamentals/workflows/index.html.md). A workflow is a task made up of a series of steps, and you construct it like you would a regular function, but it's a special function that supports rollback mechanism in case of errors, background execution, and more. - -You can learn how to create a workflow in [this chapter](https://docs.medusajs.com/learn/fundamentals/workflows/index.html.md), but this example assumes you already have a `syncProductToErpWorkflow` implemented. To execute this workflow once a day, create a scheduled job at `src/jobs/sync-products.ts` with the following content: - -```ts title="src/jobs/sync-products.ts" -import { MedusaContainer } from "@medusajs/framework/types" -import { syncProductToErpWorkflow } from "../workflows/sync-products-to-erp" - -export default async function syncProductsJob(container: MedusaContainer) { - await syncProductToErpWorkflow(container) - .run() -} - -export const config = { - name: "sync-products-job", - schedule: "0 0 * * *", -} -``` - -In the scheduled job function, you execute the `syncProductToErpWorkflow` by invoking it and passing it the container, then invoking the `run` method. You also specify in the exported configurations the schedule `0 0 * * *` which indicates midnight time of every day. - -The next time you start the Medusa application, it will run this job every day at midnight. - - -# Plugins - -In this chapter, you'll learn what a plugin is in Medusa. - -Plugins are available starting from [Medusa v2.3.0](https://github.com/medusajs/medusa/releases/tag/v2.3.0). - -## What is a Plugin? - -A plugin is a package of reusable Medusa customizations that you can install in any Medusa application. The supported customizations are [Modules](https://docs.medusajs.com/learn/fundamentals/modules/index.html.md), [API Routes](https://docs.medusajs.com/learn/fundamentals/api-routes/index.html.md), [Workflows](https://docs.medusajs.com/learn/fundamentals/workflows/index.html.md), [Workflow Hooks](https://docs.medusajs.com/learn/fundamentals/workflows/workflow-hooks/index.html.md), [Links](https://docs.medusajs.com/learn/fundamentals/module-links/index.html.md), [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers/index.html.md), [Scheduled Jobs](https://docs.medusajs.com/learn/fundamentals/scheduled-jobs/index.html.md), and [Admin Extensions](https://docs.medusajs.com/learn/fundamentals/admin/index.html.md). - -Plugins allow you to reuse your Medusa customizations across multiple projects or share them with the community. They can be published to npm and installed in any Medusa project. - -![Diagram showcasing a wishlist plugin installed in a Medusa application](https://res.cloudinary.com/dza7lstvk/image/upload/v1737540762/Medusa%20Book/plugin-diagram_oepiis.jpg) - -Learn how to create a wishlist plugin in [this guide](https://docs.medusajs.com/resources/plugins/guides/wishlist/index.html.md). - -*** - -## Plugin vs Module - -A [module](https://docs.medusajs.com/learn/fundamentals/modules/index.html.md) is an isolated package related to a single domain or functionality, such as product reviews or integrating a Content Management System. A module can't access any resources in the Medusa application that are outside its codebase. - -A plugin, on the other hand, can contain multiple Medusa customizations, including modules. Your plugin can define a module, then build flows around it. - -For example, in a plugin, you can define a module that integrates a third-party service, then add a workflow that uses the module when a certain event occurs to sync data to that service. - -- You want to reuse your Medusa customizations across multiple projects. -- You want to share your Medusa customizations with the community. - -- You want to build a custom feature related to a single domain or integrate a third-party service. Instead, use a [module](https://docs.medusajs.com/learn/fundamentals/modules/index.html.md). You can wrap that module in a plugin if it's used in other customizations, such as if it has a module link or it's used in a workflow. - -*** - -## How to Create a Plugin? - -The next chapter explains how you can create and publish a plugin. - -*** - -## Plugin Guides and Resources - -For more resources and guides related to plugins, refer to the [Resources documentation](https://docs.medusajs.com/resources/plugins/index.html.md). - - -# Workflows - -In this chapter, you’ll learn about workflows and how to define and execute them. - -## What is a Workflow? - -In digital commerce you typically have many systems involved in your operations. For example, you may have an ERP system that holds product master data and accounting reports, a CMS system for content, a CRM system for managing customer campaigns, a payment service to process credit cards, and so on. Sometimes you may even have custom built applications that need to participate in the commerce stack. One of the biggest challenges when operating a stack like this is ensuring consistency in the data spread across systems. - -Medusa has a built-in durable execution engine to help complete tasks that span multiple systems. You orchestrate your operations across systems in Medusa instead of having to manage it yourself. Other commerce platforms don't have this capability, which makes them a bottleneck to building customizations and iterating quickly. - -A workflow is a series of queries and actions, called steps, that complete a task. You construct a workflow similar to how you create a JavaScript function. - -However, unlike regular functions, workflows: - -- Create an internal representation of your steps, allowing you to track them and their progress. -- Support defining roll-back logic for each step, so that you can handle errors gracefully and your data remain consistent across systems. -- Perform long actions asynchronously, giving you control over when a step starts and finishes. - -You implement all custom flows within workflows, then execute them from [API routes](https://docs.medusajs.com/learn/fundamentals/api-routes/index.html.md), [subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers/index.html.md), and [scheduled jobs](https://docs.medusajs.com/learn/fundamentals/scheduled-jobs/index.html.md). - -*** - -## How to Create and Execute a Workflow? - -### 1. Create the Steps - -A workflow is made of a series of steps. A step is created using `createStep` from the Workflows SDK. - -Create the file `src/workflows/hello-world.ts` with the following content: - -![Example of workflow file in the application's directory structure](https://res.cloudinary.com/dza7lstvk/image/upload/v1732866980/Medusa%20Book/workflow-dir-overview_xklukj.jpg) - -```ts title="src/workflows/hello-world.ts" highlights={step1Highlights} -import { createStep, StepResponse } from "@medusajs/framework/workflows-sdk" - -const step1 = createStep( - "step-1", - async () => { - return new StepResponse(`Hello from step one!`) - } -) -``` - -The `createStep` function accepts the step's unique name as a first parameter, and the step's function as a second parameter. - -Steps must return an instance of `StepResponse`, whose parameter is the data to return to the workflow executing the step. - -Steps can accept input parameters. For example, add the following to `src/workflows/hello-world.ts`: - -```ts title="src/workflows/hello-world.ts" highlights={step2Highlights} -type WorkflowInput = { - name: string -} - -const step2 = createStep( - "step-2", - async ({ name }: WorkflowInput) => { - return new StepResponse(`Hello ${name} from step two!`) - } -) -``` - -This adds another step whose function accepts as a parameter an object with a `name` property. - -### 2. Create a Workflow - -Next, add the following to the same file to create the workflow using the `createWorkflow` function: - -```ts title="src/workflows/hello-world.ts" highlights={workflowHighlights} -import { - // other imports... - createWorkflow, - WorkflowResponse, -} from "@medusajs/framework/workflows-sdk" - -// ... - -const myWorkflow = createWorkflow( - "hello-world", - function (input: WorkflowInput) { - const str1 = step1() - // to pass input - const str2 = step2(input) - - return new WorkflowResponse({ - message: str2, - }) - } -) - -export default myWorkflow -``` - -The `createWorkflow` function accepts the workflow's unique name as a first parameter, and the workflow's function as a second parameter. The workflow can accept input which is passed as a parameter to the function. - -The workflow must return an instance of `WorkflowResponse`, whose parameter is returned to workflow executors. - -### 3. Execute the Workflow - -You can execute a workflow from different customizations: - -- Execute in an API route to expose the workflow's functionalities to clients. -- Execute in a subscriber to use the workflow's functionalities when a commerce operation is performed. -- Execute in a scheduled job to run the workflow's functionalities automatically at a specified repeated interval. - -To execute the workflow, invoke it passing the [Medusa container](https://docs.medusajs.com/learn/fundamentals/medusa-container/index.html.md) as a parameter. Then, use its `run` method: - -### API Route - -```ts title="src/api/workflow/route.ts" highlights={[["11"], ["12"], ["13"], ["14"], ["15"], ["16"]]} collapsibleLines="1-6" expandButtonLabel="Show Imports" -import type { - MedusaRequest, - MedusaResponse, -} from "@medusajs/framework/http" -import myWorkflow from "../../workflows/hello-world" - -export async function GET( - req: MedusaRequest, - res: MedusaResponse -) { - const { result } = await myWorkflow(req.scope) - .run({ - input: { - name: "John", - }, - }) - - res.send(result) -} -``` - -### Subscriber - -```ts title="src/subscribers/order-placed.ts" highlights={[["11"], ["12"], ["13"], ["14"], ["15"], ["16"]]} collapsibleLines="1-6" expandButtonLabel="Show Imports" -import { - type SubscriberConfig, - type SubscriberArgs, -} from "@medusajs/framework" -import myWorkflow from "../workflows/hello-world" - -export default async function handleOrderPlaced({ - event: { data }, - container, -}: SubscriberArgs<{ id: string }>) { - const { result } = await myWorkflow(container) - .run({ - input: { - name: "John", - }, - }) - - console.log(result) -} - -export const config: SubscriberConfig = { - event: "order.placed", -} -``` - -### Scheduled Job - -```ts title="src/jobs/message-daily.ts" highlights={[["7"], ["8"], ["9"], ["10"], ["11"], ["12"]]} -import { MedusaContainer } from "@medusajs/framework/types" -import myWorkflow from "../workflows/hello-world" - -export default async function myCustomJob( - container: MedusaContainer -) { - const { result } = await myWorkflow(container) - .run({ - input: { - name: "John", - }, - }) - - console.log(result.message) -} - -export const config = { - name: "run-once-a-day", - schedule: `0 0 * * *`, -}; -``` - -### 4. Test Workflow - -To test out your workflow, start your Medusa application: - -```bash npm2yarn -npm run dev -``` - -Then, if you added the API route above, send a `GET` request to `/workflow`: - -```bash -curl http://localhost:9000/workflow -``` - -You’ll receive the following response: - -```json title="Example Response" -{ - "message": "Hello John from step two!" -} -``` - -*** - -## Access Medusa Container in Workflow Steps - -A step receives an object as a second parameter with configurations and context-related properties. One of these properties is the `container` property, which is the [Medusa container](https://docs.medusajs.com/learn/fundamentals/medusa-container/index.html.md) to allow you to resolve framework and commerce tools in your application. - -For example, consider you want to implement a workflow that returns the total products in your application. Create the file `src/workflows/product-count.ts` with the following content: - -```ts title="src/workflows/product-count.ts" highlights={highlights} collapsibleLines="1-7" expandButtonLabel="Show Imports" -import { - createStep, - StepResponse, - createWorkflow, - WorkflowResponse, -} from "@medusajs/framework/workflows-sdk" - -const getProductCountStep = createStep( - "get-product-count", - async (_, { container }) => { - const productModuleService = container.resolve("product") - - const [, count] = await productModuleService.listAndCountProducts() - - return new StepResponse(count) - } -) - -const productCountWorkflow = createWorkflow( - "product-count", - function () { - const count = getProductCountStep() - - return new WorkflowResponse({ - count, - }) - } -) - -export default productCountWorkflow -``` - -In `getProductCountStep`, you use the `container` to resolve the Product Module's main service. Then, you use its `listAndCountProducts` method to retrieve the total count of products and return it in the step's response. You then execute this step in the `productCountWorkflow`. - -You can now execute this workflow in a custom API route, scheduled job, or subscriber to get the total count of products. - -Find a full list of the registered resources in the Medusa container and their registration key in [this reference](https://docs.medusajs.com/resources/medusa-container-resources/index.html.md). You can use these resources in your custom workflows. - - # Modules In this chapter, you’ll learn about modules and how to create them. @@ -2304,350 +2241,708 @@ This will create a post and return it in the response: You can also execute the workflow from a [subscriber](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers/index.html.md) when an event occurs, or from a [scheduled job](https://docs.medusajs.com/learn/fundamentals/scheduled-jobs/index.html.md) to run it at a specified interval. -# Configure Instrumentation +# Plugins -In this chapter, you'll learn about observability in Medusa and how to configure instrumentation with OpenTelemetry. +In this chapter, you'll learn what a plugin is in Medusa. -## Observability with OpenTelemtry +Plugins are available starting from [Medusa v2.3.0](https://github.com/medusajs/medusa/releases/tag/v2.3.0). -Medusa uses [OpenTelemetry](https://opentelemetry.io/) for instrumentation and reporting. When configured, it reports traces for: +## What is a Plugin? -- HTTP requests -- Workflow executions -- Query usages -- Database queries and operations +A plugin is a package of reusable Medusa customizations that you can install in any Medusa application. The supported customizations are [Modules](https://docs.medusajs.com/learn/fundamentals/modules/index.html.md), [API Routes](https://docs.medusajs.com/learn/fundamentals/api-routes/index.html.md), [Workflows](https://docs.medusajs.com/learn/fundamentals/workflows/index.html.md), [Workflow Hooks](https://docs.medusajs.com/learn/fundamentals/workflows/workflow-hooks/index.html.md), [Links](https://docs.medusajs.com/learn/fundamentals/module-links/index.html.md), [Subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers/index.html.md), [Scheduled Jobs](https://docs.medusajs.com/learn/fundamentals/scheduled-jobs/index.html.md), and [Admin Extensions](https://docs.medusajs.com/learn/fundamentals/admin/index.html.md). + +Plugins allow you to reuse your Medusa customizations across multiple projects or share them with the community. They can be published to npm and installed in any Medusa project. + +![Diagram showcasing a wishlist plugin installed in a Medusa application](https://res.cloudinary.com/dza7lstvk/image/upload/v1737540762/Medusa%20Book/plugin-diagram_oepiis.jpg) + +Learn how to create a wishlist plugin in [this guide](https://docs.medusajs.com/resources/plugins/guides/wishlist/index.html.md). *** -## How to Configure Instrumentation in Medusa? +## Plugin vs Module -### Prerequisites +A [module](https://docs.medusajs.com/learn/fundamentals/modules/index.html.md) is an isolated package related to a single domain or functionality, such as product reviews or integrating a Content Management System. A module can't access any resources in the Medusa application that are outside its codebase. -- [An exporter to visualize your application's traces, such as Zipkin.](https://zipkin.io/pages/quickstart.html) +A plugin, on the other hand, can contain multiple Medusa customizations, including modules. Your plugin can define a module, then build flows around it. -### Install Dependencies +For example, in a plugin, you can define a module that integrates a third-party service, then add a workflow that uses the module when a certain event occurs to sync data to that service. -Start by installing the following OpenTelemetry dependencies in your Medusa project: +- You want to reuse your Medusa customizations across multiple projects. +- You want to share your Medusa customizations with the community. -```bash npm2yarn -npm install @opentelemetry/sdk-node @opentelemetry/resources @opentelemetry/sdk-trace-node @opentelemetry/instrumentation-pg -``` - -Also, install the dependencies relevant for the exporter you use. If you're using Zipkin, install the following dependencies: - -```bash npm2yarn -npm install @opentelemetry/exporter-zipkin -``` - -### Add instrumentation.ts - -Next, create the file `instrumentation.ts` with the following content: - -```ts title="instrumentation.ts" -import { registerOtel } from "@medusajs/medusa" -import { ZipkinExporter } from "@opentelemetry/exporter-zipkin" - -// If using an exporter other than Zipkin, initialize it here. -const exporter = new ZipkinExporter({ - serviceName: "my-medusa-project", -}) - -export function register() { - registerOtel({ - serviceName: "medusajs", - // pass exporter - exporter, - instrument: { - http: true, - workflows: true, - query: true, - }, - }) -} -``` - -In the `instrumentation.ts` file, you export a `register` function that uses Medusa's `registerOtel` utility function. You also initialize an instance of the exporter, such as Zipkin, and pass it to the `registerOtel` function. - -`registerOtel` accepts an object where you can pass any [NodeSDKConfiguration](https://open-telemetry.github.io/opentelemetry-js/interfaces/_opentelemetry_sdk_node.NodeSDKConfiguration.html) property along with the following properties: - -The `NodeSDKConfiguration` properties are accepted since Medusa v2.5.1. - -- serviceName: (\`string\`) The name of the service traced. -- exporter: (\[SpanExporter]\(https://open-telemetry.github.io/opentelemetry-js/interfaces/\_opentelemetry\_sdk\_trace\_base.SpanExporter.html)) An instance of an exporter, such as Zipkin. -- instrument: (\`object\`) Options specifying what to trace. - - - http: (\`boolean\`) Whether to trace HTTP requests. - - - query: (\`boolean\`) Whether to trace Query usages. - - - workflows: (\`boolean\`) Whether to trace Workflow executions. - - - db: (\`boolean\`) Whether to trace database queries and operations. -- instrumentations: (\[Instrumentation\[]]\(https://open-telemetry.github.io/opentelemetry-js/interfaces/\_opentelemetry\_instrumentation.Instrumentation.html)) Additional instrumentation options that OpenTelemetry accepts. +- You want to build a custom feature related to a single domain or integrate a third-party service. Instead, use a [module](https://docs.medusajs.com/learn/fundamentals/modules/index.html.md). You can wrap that module in a plugin if it's used in other customizations, such as if it has a module link or it's used in a workflow. *** -## Test it Out +## How to Create a Plugin? -To test it out, start your exporter, such as Zipkin. - -Then, start your Medusa application: - -```bash npm2yarn -npm run dev -``` - -Try to open the Medusa Admin or send a request to an API route. - -If you check traces in your exporter, you'll find new traces reported. - -### Trace Span Names - -Trace span names start with the following keywords based on what it's reporting: - -- `{methodName} {URL}` when reporting HTTP requests, where `{methodName}` is the HTTP method, and `{URL}` is the URL the request is sent to. -- `route:` when reporting route handlers running on an HTTP request. -- `middleware:` when reporting a middleware running on an HTTP request. -- `workflow:` when reporting a workflow execution. -- `step:` when reporting a step in a workflow execution. -- `query.graph:` when reporting Query usages. -- `pg.query:` when reporting database queries and operations. - - -# Logging - -In this chapter, you’ll learn how to use Medusa’s logging utility. - -## Logger Class - -Medusa provides a `Logger` class with advanced logging functionalities. This includes configuring logging levels or saving logs to a file. - -The Medusa application registers the `Logger` class in the Medusa container and each module's container as `logger`. +The next chapter explains how you can create and publish a plugin. *** -## How to Log a Message +## Plugin Guides and Resources -Resolve the `logger` using the Medusa container to log a message in your resource. +For more resources and guides related to plugins, refer to the [Resources documentation](https://docs.medusajs.com/resources/plugins/index.html.md). -For example, create the file `src/jobs/log-message.ts` with the following content: -```ts title="src/jobs/log-message.ts" highlights={highlights} +# Scheduled Jobs + +In this chapter, you’ll learn about scheduled jobs and how to use them. + +## What is a Scheduled Job? + +When building your commerce application, you may need to automate tasks and run them repeatedly at a specific schedule. For example, you need to automatically sync products to a third-party service once a day. + +In other commerce platforms, this feature isn't natively supported. Instead, you have to setup a separate application to execute cron jobs, which adds complexity as to how you expose this task to be executed in a cron job, or how do you debug it when it's not running within the platform's tooling. + +Medusa removes this overhead by supporting this feature natively with scheduled jobs. A scheduled job is an asynchronous function that the Medusa application runs at the interval you specify during the Medusa application's runtime. Your efforts are only spent on implementing the functionality performed by the job, such as syncing products to an ERP. + +- You want the action to execute at a specified schedule while the Medusa application **isn't** running. Instead, use the operating system's equivalent of a cron job. +- You want to execute the action once when the application loads. Use [loaders](https://docs.medusajs.com/learn/fundamentals/modules/loaders/index.html.md) instead. +- You want to execute the action if an event occurs. Use [subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers/index.html.md) instead. + +*** + +## How to Create a Scheduled Job? + +You create a scheduled job in a TypeScript or JavaScript file under the `src/jobs` directory. The file exports the asynchronous function to run, and the configurations indicating the schedule to run the function. + +For example, create the file `src/jobs/hello-world.ts` with the following content: + +![Example of scheduled job file in the application's directory structure](https://res.cloudinary.com/dza7lstvk/image/upload/v1732866423/Medusa%20Book/scheduled-job-dir-overview_ediqgm.jpg) + +```ts title="src/jobs/hello-world.ts" highlights={highlights} import { MedusaContainer } from "@medusajs/framework/types" -import { ContainerRegistrationKeys } from "@medusajs/framework/utils" -export default async function myCustomJob( - container: MedusaContainer -) { - const logger = container.resolve(ContainerRegistrationKeys.LOGGER) +export default async function greetingJob(container: MedusaContainer) { + const logger = container.resolve("logger") - logger.info("I'm using the logger!") + logger.info("Greeting!") } export const config = { - name: "test-logger", - // execute every minute + name: "greeting-every-minute", schedule: "* * * * *", } ``` -This creates a scheduled job that resolves the `logger` from the Medusa container and uses it to log a message. +You export an asynchronous function that receives the [Medusa container](https://docs.medusajs.com/learn/fundamentals/medusa-container/index.html.md) as a parameter. In the function, you resolve the [Logger utility](https://docs.medusajs.com/learn/debugging-and-testing/logging/index.html.md) from the Medusa container and log a message. + +You also export a `config` object that has the following properties: + +- `name`: A unique name for the job. +- `schedule`: A string that holds a [cron expression](https://crontab.guru/) indicating the schedule to run the job. + +This scheduled job executes every minute and logs into the terminal `Greeting!`. ### Test the Scheduled Job -To test out the above scheduled job, start the Medusa application: +To test out your scheduled job, start the Medusa application: ```bash npm2yarn npm run dev ``` -After a minute, you'll see the following message as part of the logged messages: - -```text -info: I'm using the logger! -``` - -*** - -## Log Levels - -The `Logger` class has the following methods: - -- `info`: The message is logged with level `info`. -- `warn`: The message is logged with level `warn`. -- `error`: The message is logged with level `error`. -- `debug`: The message is logged with level `debug`. - -Each of these methods accepts a string parameter to log in the terminal with the associated level. - -*** - -## Logging Configurations - -### Log Level - -The available log levels, from lowest to highest levels, are: - -1. `silly` (default, meaning messages of all levels are logged) -2. `debug` -3. `info` -4. `warn` -5. `error` - -You can change that by setting the `LOG_LEVEL` environment variable to the minimum level you want to be logged. - -For example: +After a minute, the following message will be logged to the terminal: ```bash -LOG_LEVEL=error +info: Greeting! ``` -This logs `error` messages only. - -The environment variable must be set as a system environment variable and not in `.env`. - -### Save Logs in a File - -Aside from showing the logs in the terminal, you can save the logs in a file by setting the `LOG_FILE` environment variable to the path of the file relative to the Medusa server’s root directory. - -For example: - -```bash -LOG_FILE=all.log -``` - -Your logs are now saved in the `all.log` file at the root of your Medusa application. - -The environment variable must be set as a system environment variable and not in `.env`. - *** -## Show Log with Progress +## Example: Sync Products Once a Day -The `Logger` class has an `activity` method used to log a message of level `info`. If the Medusa application is running in a development environment, a spinner starts to show the activity's progress. +In this section, you'll find a brief example of how you use a scheduled job to sync products to a third-party service. -For example: +When implementing flows spanning across systems or [modules](https://docs.medusajs.com/learn/fundamentals/modules/index.html.md), you use [workflows](https://docs.medusajs.com/learn/fundamentals/workflows/index.html.md). A workflow is a task made up of a series of steps, and you construct it like you would a regular function, but it's a special function that supports rollback mechanism in case of errors, background execution, and more. -```ts title="src/jobs/log-message.ts" +You can learn how to create a workflow in [this chapter](https://docs.medusajs.com/learn/fundamentals/workflows/index.html.md), but this example assumes you already have a `syncProductToErpWorkflow` implemented. To execute this workflow once a day, create a scheduled job at `src/jobs/sync-products.ts` with the following content: + +```ts title="src/jobs/sync-products.ts" import { MedusaContainer } from "@medusajs/framework/types" -import { ContainerRegistrationKeys } from "@medusajs/framework/utils" +import { syncProductToErpWorkflow } from "../workflows/sync-products-to-erp" + +export default async function syncProductsJob(container: MedusaContainer) { + await syncProductToErpWorkflow(container) + .run() +} + +export const config = { + name: "sync-products-job", + schedule: "0 0 * * *", +} +``` + +In the scheduled job function, you execute the `syncProductToErpWorkflow` by invoking it and passing it the container, then invoking the `run` method. You also specify in the exported configurations the schedule `0 0 * * *` which indicates midnight time of every day. + +The next time you start the Medusa application, it will run this job every day at midnight. + + +# Workflows + +In this chapter, you’ll learn about workflows and how to define and execute them. + +## What is a Workflow? + +In digital commerce you typically have many systems involved in your operations. For example, you may have an ERP system that holds product master data and accounting reports, a CMS system for content, a CRM system for managing customer campaigns, a payment service to process credit cards, and so on. Sometimes you may even have custom built applications that need to participate in the commerce stack. One of the biggest challenges when operating a stack like this is ensuring consistency in the data spread across systems. + +Medusa has a built-in durable execution engine to help complete tasks that span multiple systems. You orchestrate your operations across systems in Medusa instead of having to manage it yourself. Other commerce platforms don't have this capability, which makes them a bottleneck to building customizations and iterating quickly. + +A workflow is a series of queries and actions, called steps, that complete a task. You construct a workflow similar to how you create a JavaScript function. + +However, unlike regular functions, workflows: + +- Create an internal representation of your steps, allowing you to track them and their progress. +- Support defining roll-back logic for each step, so that you can handle errors gracefully and your data remain consistent across systems. +- Perform long actions asynchronously, giving you control over when a step starts and finishes. + +You implement all custom flows within workflows, then execute them from [API routes](https://docs.medusajs.com/learn/fundamentals/api-routes/index.html.md), [subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers/index.html.md), and [scheduled jobs](https://docs.medusajs.com/learn/fundamentals/scheduled-jobs/index.html.md). + +*** + +## How to Create and Execute a Workflow? + +### 1. Create the Steps + +A workflow is made of a series of steps. A step is created using `createStep` from the Workflows SDK. + +Create the file `src/workflows/hello-world.ts` with the following content: + +![Example of workflow file in the application's directory structure](https://res.cloudinary.com/dza7lstvk/image/upload/v1732866980/Medusa%20Book/workflow-dir-overview_xklukj.jpg) + +```ts title="src/workflows/hello-world.ts" highlights={step1Highlights} +import { createStep, StepResponse } from "@medusajs/framework/workflows-sdk" + +const step1 = createStep( + "step-1", + async () => { + return new StepResponse(`Hello from step one!`) + } +) +``` + +The `createStep` function accepts the step's unique name as a first parameter, and the step's function as a second parameter. + +Steps must return an instance of `StepResponse`, whose parameter is the data to return to the workflow executing the step. + +Steps can accept input parameters. For example, add the following to `src/workflows/hello-world.ts`: + +```ts title="src/workflows/hello-world.ts" highlights={step2Highlights} +type WorkflowInput = { + name: string +} + +const step2 = createStep( + "step-2", + async ({ name }: WorkflowInput) => { + return new StepResponse(`Hello ${name} from step two!`) + } +) +``` + +This adds another step whose function accepts as a parameter an object with a `name` property. + +### 2. Create a Workflow + +Next, add the following to the same file to create the workflow using the `createWorkflow` function: + +```ts title="src/workflows/hello-world.ts" highlights={workflowHighlights} +import { + // other imports... + createWorkflow, + WorkflowResponse, +} from "@medusajs/framework/workflows-sdk" + +// ... + +const myWorkflow = createWorkflow( + "hello-world", + function (input: WorkflowInput) { + const str1 = step1() + // to pass input + const str2 = step2(input) + + return new WorkflowResponse({ + message: str2, + }) + } +) + +export default myWorkflow +``` + +The `createWorkflow` function accepts the workflow's unique name as a first parameter, and the workflow's function as a second parameter. The workflow can accept input which is passed as a parameter to the function. + +The workflow must return an instance of `WorkflowResponse`, whose parameter is returned to workflow executors. + +### 3. Execute the Workflow + +You can execute a workflow from different customizations: + +- Execute in an API route to expose the workflow's functionalities to clients. +- Execute in a subscriber to use the workflow's functionalities when a commerce operation is performed. +- Execute in a scheduled job to run the workflow's functionalities automatically at a specified repeated interval. + +To execute the workflow, invoke it passing the [Medusa container](https://docs.medusajs.com/learn/fundamentals/medusa-container/index.html.md) as a parameter. Then, use its `run` method: + +### API Route + +```ts title="src/api/workflow/route.ts" highlights={[["11"], ["12"], ["13"], ["14"], ["15"], ["16"]]} collapsibleLines="1-6" expandButtonLabel="Show Imports" +import type { + MedusaRequest, + MedusaResponse, +} from "@medusajs/framework/http" +import myWorkflow from "../../workflows/hello-world" + +export async function GET( + req: MedusaRequest, + res: MedusaResponse +) { + const { result } = await myWorkflow(req.scope) + .run({ + input: { + name: "John", + }, + }) + + res.send(result) +} +``` + +### Subscriber + +```ts title="src/subscribers/order-placed.ts" highlights={[["11"], ["12"], ["13"], ["14"], ["15"], ["16"]]} collapsibleLines="1-6" expandButtonLabel="Show Imports" +import { + type SubscriberConfig, + type SubscriberArgs, +} from "@medusajs/framework" +import myWorkflow from "../workflows/hello-world" + +export default async function handleOrderPlaced({ + event: { data }, + container, +}: SubscriberArgs<{ id: string }>) { + const { result } = await myWorkflow(container) + .run({ + input: { + name: "John", + }, + }) + + console.log(result) +} + +export const config: SubscriberConfig = { + event: "order.placed", +} +``` + +### Scheduled Job + +```ts title="src/jobs/message-daily.ts" highlights={[["7"], ["8"], ["9"], ["10"], ["11"], ["12"]]} +import { MedusaContainer } from "@medusajs/framework/types" +import myWorkflow from "../workflows/hello-world" export default async function myCustomJob( container: MedusaContainer ) { - const logger = container.resolve(ContainerRegistrationKeys.LOGGER) - - const activityId = logger.activity("First log message") - - logger.progress(activityId, `Second log message`) - - logger.success(activityId, "Last log message") -} -``` - -The `activity` method returns the ID of the started activity. This ID can then be passed to one of the following methods of the `Logger` class: - -- `progress`: Log a message of level `info` that indicates progress within that same activity. -- `success`: Log a message of level `info` that indicates that the activity has succeeded. This also ends the associated activity. -- `failure`: Log a message of level `error` that indicates that the activity has failed. This also ends the associated activity. - -If you configured the `LOG_LEVEL` environment variable to a level higher than those associated with the above methods, their messages won’t be logged. - - -# Medusa Testing Tools - -In this chapter, you'll learn about Medusa's testing tools and how to install and configure them. - -## @medusajs/test-utils Package - -Medusa provides a Testing Framework to create integration tests for your custom API routes, modules, or other Medusa customizations. - -To use the Testing Framework, install `@medusajs/test-utils` as a `devDependency`: - -```bash npm2yarn -npm install --save-dev @medusajs/test-utils@latest -``` - -*** - -## Install and Configure Jest - -Writing tests with `@medusajs/test-utils`'s tools requires installing and configuring Jest in your project. - -Run the following command to install the required Jest dependencies: - -```bash npm2yarn -npm install --save-dev jest @types/jest @swc/jest -``` - -Then, create the file `jest.config.js` with the following content: - -```js title="jest.config.js" -const { loadEnv } = require("@medusajs/framework/utils") -loadEnv("test", process.cwd()) - -module.exports = { - transform: { - "^.+\\.[jt]s$": [ - "@swc/jest", - { - jsc: { - parser: { syntax: "typescript", decorators: true }, - }, + const { result } = await myWorkflow(container) + .run({ + input: { + name: "John", }, - ], - }, - testEnvironment: "node", - moduleFileExtensions: ["js", "ts", "json"], - modulePathIgnorePatterns: ["dist/"], - setupFiles: ["./integration-tests/setup.js"], + }) + + console.log(result.message) } -if (process.env.TEST_TYPE === "integration:http") { - module.exports.testMatch = ["**/integration-tests/http/*.spec.[jt]s"] -} else if (process.env.TEST_TYPE === "integration:modules") { - module.exports.testMatch = ["**/src/modules/*/__tests__/**/*.[jt]s"] -} else if (process.env.TEST_TYPE === "unit") { - module.exports.testMatch = ["**/src/**/__tests__/**/*.unit.spec.[jt]s"] -} +export const config = { + name: "run-once-a-day", + schedule: `0 0 * * *`, +}; ``` -Next, create the `integration-tests/setup.js` file with the following content: +### 4. Test Workflow -```js title="integration-tests/setup.js" -const { MetadataStorage } = require("@mikro-orm/core") +To test out your workflow, start your Medusa application: -MetadataStorage.clear() +```bash npm2yarn +npm run dev +``` + +Then, if you added the API route above, send a `GET` request to `/workflow`: + +```bash +curl http://localhost:9000/workflow +``` + +You’ll receive the following response: + +```json title="Example Response" +{ + "message": "Hello John from step two!" +} ``` *** -## Add Test Commands +## Access Medusa Container in Workflow Steps -Finally, add the following scripts to `package.json`: +A step receives an object as a second parameter with configurations and context-related properties. One of these properties is the `container` property, which is the [Medusa container](https://docs.medusajs.com/learn/fundamentals/medusa-container/index.html.md) to allow you to resolve framework and commerce tools in your application. -```json title="package.json" -"scripts": { +For example, consider you want to implement a workflow that returns the total products in your application. Create the file `src/workflows/product-count.ts` with the following content: + +```ts title="src/workflows/product-count.ts" highlights={highlights} collapsibleLines="1-7" expandButtonLabel="Show Imports" +import { + createStep, + StepResponse, + createWorkflow, + WorkflowResponse, +} from "@medusajs/framework/workflows-sdk" + +const getProductCountStep = createStep( + "get-product-count", + async (_, { container }) => { + const productModuleService = container.resolve("product") + + const [, count] = await productModuleService.listAndCountProducts() + + return new StepResponse(count) + } +) + +const productCountWorkflow = createWorkflow( + "product-count", + function () { + const count = getProductCountStep() + + return new WorkflowResponse({ + count, + }) + } +) + +export default productCountWorkflow +``` + +In `getProductCountStep`, you use the `container` to resolve the Product Module's main service. Then, you use its `listAndCountProducts` method to retrieve the total count of products and return it in the step's response. You then execute this step in the `productCountWorkflow`. + +You can now execute this workflow in a custom API route, scheduled job, or subscriber to get the total count of products. + +Find a full list of the registered resources in the Medusa container and their registration key in [this reference](https://docs.medusajs.com/resources/medusa-container-resources/index.html.md). You can use these resources in your custom workflows. + + +# Next.js Starter Storefront + +The Medusa application is made up of a Node.js server and an admin dashboard. The storefront is installed and hosted separately from the Medusa application, giving you the flexibility to choose the frontend tech stack that you and your team are proficient in, and implement unique design systems and user experience. + +The Next.js Starter storefront provides rich commerce features and a sleek design. Developers and businesses can use it as-is or build on top of it to tailor it for the business's unique use case, design, and customer experience. + +In this chapter, you’ll learn how to install the Next.js Starter storefront separately from the Medusa application. You can also install it while installing the Medusa application as explained in [the installation chapter](https://docs.medusajs.com/learn/installation/index.html.md). + +## Install Next.js Starter + +### Prerequisites + +- [Node.js v20+](https://nodejs.org/en/download) +- [Git CLI tool](https://git-scm.com/downloads) + +If you already have a Medusa application installed with at least one region, you can install the Next.js Starter storefront with the following steps: + +1. Clone the [Next.js Starter](https://github.com/medusajs/nextjs-starter-medusa): + +```bash +git clone https://github.com/medusajs/nextjs-starter-medusa my-medusa-storefront +``` + +2. Change to the `my-medusa-storefront` directory, install the dependencies, and rename the template environment variable file: + +```bash npm2yarn +cd my-medusa-storefront +npm install +mv .env.template .env.local +``` + +3. Set the Medusa application's publishable API key in the `NEXT_PUBLIC_MEDUSA_PUBLISHABLE_KEY` environment variable. You can retrieve the publishable API key in on the Medusa Admin dashboard by going to Settings -> Publishable API Keys + +```bash +NEXT_PUBLIC_MEDUSA_PUBLISHABLE_KEY=pk_123... +``` + +4. While the Medusa application is running, start the Next.js Starter storefront: + +```bash npm2yarn +npm run dev +``` + +Your Next.js Starter storefront is now running at `http://localhost:8000`. + +*** + +## Customize Storefront + +To customize the storefront, refer to the following directories: + +- `src/app`: The storefront’s pages. +- `src/modules`: The storefront’s components. +- `src/styles`: The storefront’s styles. + +You can learn more about development with Next.js through [their documentation](https://nextjs.org/docs/getting-started). + +*** + +## Configurations and Integrations + +The Next.js Starter is compatible with some Medusa integrations out-of-the-box, such as the Stripe provider module. You can also change some of its configurations if necessary. + +Refer to the [Next.js Starter reference](https://docs.medusajs.com/resources/nextjs-starter/index.html.md) for more details. + + +# Usage Information + +At Medusa, we strive to provide the best experience for developers using our platform. For that reason, Medusa collects anonymous and non-sensitive data that provides a global understanding of how users are using Medusa. + +*** + +## Purpose + +As an open source solution, we work closely and constantly interact with our community to ensure that we provide the best experience for everyone using Medusa. + +We are capable of getting a general understanding of how developers use Medusa and what general issues they run into through different means such as our Discord server, GitHub issues and discussions, and occasional one-on-one sessions. + +However, although these methods can be insightful, they’re not enough to get a full and global understanding of how developers are using Medusa, especially in production. + +Collecting this data allows us to understand certain details such as: + +- What operating system do most Medusa developers use? +- What version of Medusa is widely used? +- What parts of the Medusa Admin are generally undiscovered by our users? +- How much data do users manage through our Medusa Admin? Is it being used for large number of products, orders, and other types of data? +- What Node version is globally used? Should we focus our efforts on providing support for versions that we don’t currently support? + +*** + +## Medusa Application Analytics + +This section covers which data in the Medusa application are collected and how to opt out of it. + +### Collected Data in the Medusa Application + +The following data is being collected on your Medusa application: + +- Unique project ID generated with UUID. +- Unique machine ID generated with UUID. +- Operating system information including Node version or operating system platform used. +- The version of the Medusa application and Medusa CLI are used. + +Data is only collected when the Medusa application is run with the command `medusa start`. + +### How to Opt Out + +If you prefer to disable data collection, you can do it either by setting the following environment variable to true: + +```bash +MEDUSA_DISABLE_TELEMETRY=true +``` + +Or, you can run the following command in the root of your Medusa application project to disable it: + +```bash +npx medusa telemetry --disable +``` + +*** + +## Admin Analytics + +This section covers which data in the admin are collected and how to opt out of it. + +### Collected Data in Admin + +Users have the option to [enable or disable the anonymization](#how-to-enable-anonymization) of the collected data. + +The following data is being collected on your admin: + +- The name of the store. +- The email of the user. +- The total number of products, orders, discounts, and users. +- The number of regions and their names. +- The currencies used in the store. +- Errors that occur while using the admin. + +### How to Enable Anonymization + +To enable anonymization of your data from the Medusa Admin: + +1. Go to Settings → Personal Information. +2. In the Usage insights section, click on the “Edit preferences” button. +3. Enable the "Anonymize my usage data” toggle. +4. Click on the “Submit and close” button. + +### How to Opt-Out + +To opt out of analytics collection in the Medusa Admin, set the following environment variable: + +```bash +MEDUSA_FF_ANALYTICS=false +``` + + +# Guide: Implement Brand Module + +In this chapter, you'll build a Brand Module that adds a `brand` table to the database and provides data-management features for it. + +A module is a reusable package of functionalities related to a single domain or integration. Medusa comes with multiple pre-built modules for core commerce needs, such as the [Cart Module](https://docs.medusajs.com/resources/commerce-modules/cart/index.html.md) that holds the data models and business logic for cart operations. + +In a module, you create data models and business logic to manage them. In the next chapters, you'll see how you use the module to build commerce features. + +Learn more about modules in [this chapter](https://docs.medusajs.com/learn/fundamentals/modules/index.html.md). + +## 1. Create Module Directory + +Modules are created in a sub-directory of `src/modules`. So, start by creating the directory `src/modules/brand` that will hold the Brand Module's files. + +![Directory structure in Medusa project after adding the brand directory](https://res.cloudinary.com/dza7lstvk/image/upload/v1732868844/Medusa%20Book/brand-dir-overview-1_hxwvgx.jpg) + +*** + +## 2. Create Data Model + +A data model represents a table in the database. You create data models using Medusa's Data Model Language (DML). It simplifies defining a table's columns, relations, and indexes with straightforward methods and configurations. + +Learn more about data models in [this chapter](https://docs.medusajs.com/learn/fundamentals/modules#1-create-data-model/index.html.md). + +You create a data model in a TypeScript or JavaScript file under the `models` directory of a module. So, to create a data model that represents a new `brand` table in the database, create the file `src/modules/brand/models/brand.ts` with the following content: + +![Directory structure in module after adding the brand data model](https://res.cloudinary.com/dza7lstvk/image/upload/v1732868920/Medusa%20Book/brand-dir-overview-2_lexhdl.jpg) + +```ts title="src/modules/brand/models/brand.ts" +import { model } from "@medusajs/framework/utils" + +export const Brand = model.define("brand", { + id: model.id().primaryKey(), + name: model.text(), +}) +``` + +You create a `Brand` data model which has an `id` primary key property, and a `name` text property. + +You define the data model using the `define` method of the DML. It accepts two parameters: + +1. The first one is the name of the data model's table in the database. Use snake-case names. +2. The second is an object, which is the data model's schema. + +Learn about other property types in [this chapter](https://docs.medusajs.com/learn/fundamentals/data-models/property-types/index.html.md). + +*** + +## 3. Create Module Service + +You perform database operations on your data models in a service, which is a class exported by the module and acts like an interface to its functionalities. + +In this step, you'll create the Brand Module's service that provides methods to manage the `Brand` data model. In the next chapters, you'll use this service when exposing custom features that involve managing brands. + +Learn more about services in [this chapter](https://docs.medusajs.com/learn/fundamentals/modules#2-create-service/index.html.md). + +You define a service in a `service.ts` or `service.js` file at the root of your module's directory. So, create the file `src/modules/brand/service.ts` with the following content: + +![Directory structure in module after adding the service](https://res.cloudinary.com/dza7lstvk/image/upload/v1732868984/Medusa%20Book/brand-dir-overview-3_jo7baj.jpg) + +```ts title="src/modules/brand/service.ts" highlights={serviceHighlights} +import { MedusaService } from "@medusajs/framework/utils" +import { Brand } from "./models/brand" + +class BrandModuleService extends MedusaService({ + Brand, +}) { + +} + +export default BrandModuleService +``` + +The `BrandModuleService` extends a class returned by `MedusaService` from the Modules SDK. This function generates a class with data-management methods for your module's data models. + +The `MedusaService` function receives an object of the module's data models as a parameter, and generates methods to manage those data models. So, the `BrandModuleService` now has methods like `createBrands` and `retrieveBrand` to manage the `Brand` data model. + +You'll use these methods in the [next chapter](https://docs.medusajs.com/learn/customization/custom-features/workflow/index.html.md). + +Find a reference of all generated methods in [this guide](https://docs.medusajs.com/resources/service-factory-reference/index.html.md). + +*** + +## 4. Export Module Definition + +A module must export a definition that tells Medusa the name of the module and its main service. This definition is exported in an `index.ts` file at the module's root directory. + +So, to export the Brand Module's definition, create the file `src/modules/brand/index.ts` with the following content: + +![Directory structure in module after adding the definition file](https://res.cloudinary.com/dza7lstvk/image/upload/v1732869045/Medusa%20Book/brand-dir-overview-4_nf8ymw.jpg) + +```ts title="src/modules/brand/index.ts" +import { Module } from "@medusajs/framework/utils" +import BrandModuleService from "./service" + +export const BRAND_MODULE = "brand" + +export default Module(BRAND_MODULE, { + service: BrandModuleService, +}) +``` + +You use `Module` from the Modules SDK to create the module's definition. It accepts two parameters: + +1. The module's name (`brand`). You'll use this name when you use this module in other customizations. +2. An object with a required property `service` indicating the module's main service. + +You export `BRAND_MODULE` to reference the module's name more reliably in other customizations. + +*** + +## 5. Add Module to Medusa's Configurations + +To start using your module, you must add it to Medusa's configurations in `medusa-config.ts`. + +The object passed to `defineConfig` in `medusa-config.ts` accepts a `modules` property, whose value is an array of modules to add to the application. So, add the following in `medusa-config.ts`: + +```ts title="medusa-config.ts" +module.exports = defineConfig({ // ... - "test:integration:http": "TEST_TYPE=integration:http NODE_OPTIONS=--experimental-vm-modules jest --silent=false --runInBand --forceExit", - "test:integration:modules": "TEST_TYPE=integration:modules NODE_OPTIONS=--experimental-vm-modules jest --silent --runInBand --forceExit", - "test:unit": "TEST_TYPE=unit NODE_OPTIONS=--experimental-vm-modules jest --silent --runInBand --forceExit" -}, + modules: [ + { + resolve: "./src/modules/brand", + }, + ], +}) ``` -You now have two commands: - -- `test:integration:http` to run integration tests (for example, for API routes and workflows) available under the `integration-tests/http` directory. -- `test:integration:modules` to run integration tests for modules available in any `__tests__` directory under `src/modules`. -- `test:unit` to run unit tests in any `__tests__` directory under the `src` directory. - -Medusa's Testing Framework works for integration tests only. You can write unit tests using Jest. +The Brand Module is now added to your Medusa application. You'll start using it in the [next chapter](https://docs.medusajs.com/learn/customization/custom-features/workflow/index.html.md). *** -## Test Tools and Writing Tests +## 6. Generate and Run Migrations -The next chapters explain how to use the testing tools provided by `@medusajs/test-utils` to write tests. +A migration is a TypeScript or JavaScript file that defines database changes made by a module. Migrations ensure that your module is re-usable and removes friction when working in a team, making it easy to reflect changes across team members' databases. + +Learn more about migrations in [this chapter](https://docs.medusajs.com/learn/fundamentals/modules#5-generate-migrations/index.html.md). + +[Medusa's CLI tool](https://docs.medusajs.com/resources/medusa-cli/index.html.md) allows you to generate migration files for your module, then run those migrations to reflect the changes in the database. So, run the following commands in your Medusa application's directory: + +```bash +npx medusa db:generate brand +npx medusa db:migrate +``` + +The `db:generate` command accepts as an argument the name of the module to generate the migrations for, and the `db:migrate` command runs all migrations that haven't been run yet in the Medusa application. + +*** + +## Next Step: Create Brand Workflow + +The Brand Module now creates a `brand` table in the database and provides a class to manage its records. + +In the next chapter, you'll implement the functionality to create a brand in a workflow. You'll then use that workflow in a later chapter to expose an endpoint that allows admin users to create a brand. # Guide: Create Brand API Route @@ -2996,226 +3291,286 @@ You now have a `createBrandWorkflow` that you can execute to create a brand. In the next chapter, you'll add an API route that allows admin users to create a brand. You'll learn how to create the API route, and execute in it the workflow you implemented in this chapter. -# Guide: Implement Brand Module +# Guide: Define Module Link Between Brand and Product -In this chapter, you'll build a Brand Module that adds a `brand` table to the database and provides data-management features for it. +In this chapter, you'll learn how to define a module link between a brand defined in the [custom Brand Module](https://docs.medusajs.com/learn/customization/custom-features/module/index.html.md), and a product defined in the [Product Module](https://docs.medusajs.com/resources/commerce-modules/product/index.html.md) that's available in your Medusa application out-of-the-box. -A module is a reusable package of functionalities related to a single domain or integration. Medusa comes with multiple pre-built modules for core commerce needs, such as the [Cart Module](https://docs.medusajs.com/resources/commerce-modules/cart/index.html.md) that holds the data models and business logic for cart operations. +Modules are [isolated](https://docs.medusajs.com/learn/fundamentals/modules/isolation/index.html.md) from other resources, ensuring that they're integrated into the Medusa application without side effects. However, you may need to associate data models of different modules, or you're trying to extend data models from commerce modules with custom properties. To do that, you define module links. -In a module, you create data models and business logic to manage them. In the next chapters, you'll see how you use the module to build commerce features. +A module link forms an association between two data models of different modules while maintaining module isolation. You can then manage and query linked records of the data models using Medusa's Modules SDK. -Learn more about modules in [this chapter](https://docs.medusajs.com/learn/fundamentals/modules/index.html.md). +In this chapter, you'll define a module link between the `Brand` data model of the Brand Module, and the `Product` data model of the Product Module. In later chapters, you'll manage and retrieve linked product and brand records. -## 1. Create Module Directory +Learn more about module links in [this chapters](https://docs.medusajs.com/learn/fundamentals/module-links/index.html.md). -Modules are created in a sub-directory of `src/modules`. So, start by creating the directory `src/modules/brand` that will hold the Brand Module's files. +### Prerequisites -![Directory structure in Medusa project after adding the brand directory](https://res.cloudinary.com/dza7lstvk/image/upload/v1732868844/Medusa%20Book/brand-dir-overview-1_hxwvgx.jpg) +- [Brand Module having a Brand data model](https://docs.medusajs.com/learn/customization/custom-features/module/index.html.md) -*** +## 1. Define Link -## 2. Create Data Model +Links are defined in a TypeScript or JavaScript file under the `src/links` directory. The file defines and exports the link using `defineLink` from the Modules SDK. -A data model represents a table in the database. You create data models using Medusa's Data Model Language (DML). It simplifies defining a table's columns, relations, and indexes with straightforward methods and configurations. +So, to define a link between the `Product` and `Brand` models, create the file `src/links/product-brand.ts` with the following content: -Learn more about data models in [this chapter](https://docs.medusajs.com/learn/fundamentals/modules#1-create-data-model/index.html.md). +![The directory structure of the Medusa application after adding the link.](https://res.cloudinary.com/dza7lstvk/image/upload/v1733329897/Medusa%20Book/brands-link-dir-overview_t1rhlp.jpg) -You create a data model in a TypeScript or JavaScript file under the `models` directory of a module. So, to create a data model that represents a new `brand` table in the database, create the file `src/modules/brand/models/brand.ts` with the following content: +```ts title="src/links/product-brand.ts" highlights={highlights} +import BrandModule from "../modules/brand" +import ProductModule from "@medusajs/medusa/product" +import { defineLink } from "@medusajs/framework/utils" -![Directory structure in module after adding the brand data model](https://res.cloudinary.com/dza7lstvk/image/upload/v1732868920/Medusa%20Book/brand-dir-overview-2_lexhdl.jpg) - -```ts title="src/modules/brand/models/brand.ts" -import { model } from "@medusajs/framework/utils" - -export const Brand = model.define("brand", { - id: model.id().primaryKey(), - name: model.text(), -}) +export default defineLink( + { + linkable: ProductModule.linkable.product, + isList: true, + }, + BrandModule.linkable.brand +) ``` -You create a `Brand` data model which has an `id` primary key property, and a `name` text property. +You import each module's definition object from the `index.ts` file of the module's directory. Each module object has a special `linkable` property that holds the data models' link configurations. -You define the data model using the `define` method of the DML. It accepts two parameters: +The `defineLink` function accepts two parameters of the same type, which is either: -1. The first one is the name of the data model's table in the database. Use snake-case names. -2. The second is an object, which is the data model's schema. +- The data model's link configuration, which you access from the Module's `linkable` property; +- Or an object that has two properties: + - `linkable`: the data model's link configuration, which you access from the Module's `linkable` property. + - `isList`: A boolean indicating whether many records of the data model can be linked to the other model. -Learn about other property types in [this chapter](https://docs.medusajs.com/learn/fundamentals/data-models/property-types/index.html.md). +So, in the above code snippet, you define a link between the `Product` and `Brand` data models. Since a brand can be associated with multiple products, you enable `isList` in the `Product` model's object. *** -## 3. Create Module Service +## 2. Sync the Link to the Database -You perform database operations on your data models in a service, which is a class exported by the module and acts like an interface to its functionalities. +A module link is represented in the database as a table that stores the IDs of linked records. So, after defining the link, run the following command to create the module link's table in the database: -In this step, you'll create the Brand Module's service that provides methods to manage the `Brand` data model. In the next chapters, you'll use this service when exposing custom features that involve managing brands. +```bash +npx medusa db:migrate +``` -Learn more about services in [this chapter](https://docs.medusajs.com/learn/fundamentals/modules#2-create-service/index.html.md). +This command reflects migrations on the database and syncs module links, which creates a table for the `product-brand` link. -You define a service in a `service.ts` or `service.js` file at the root of your module's directory. So, create the file `src/modules/brand/service.ts` with the following content: +You can also run the `npx medusa db:sync-links` to just sync module links without running migrations. -![Directory structure in module after adding the service](https://res.cloudinary.com/dza7lstvk/image/upload/v1732868984/Medusa%20Book/brand-dir-overview-3_jo7baj.jpg) +*** -```ts title="src/modules/brand/service.ts" highlights={serviceHighlights} -import { MedusaService } from "@medusajs/framework/utils" -import { Brand } from "./models/brand" +## Next Steps: Extend Create Product Flow -class BrandModuleService extends MedusaService({ - Brand, -}) { +In the next chapter, you'll extend Medusa's workflow and API route that create a product to allow associating a brand with a product. You'll also learn how to link brand and product records. + +# Guide: Extend Create Product Flow + +After linking the [custom Brand data model](https://docs.medusajs.com/learn/customization/custom-features/module/index.html.md) and Medusa's [Product Module](https://docs.medusajs.com/resources/commerce-modules/product/index.html.md) in the [previous chapter](https://docs.medusajs.com/learn/customization/extend-features/define-link/index.html.md), you'll extend the create product workflow and API route to allow associating a brand with a product. + +Some API routes, including the [Create Product API route](https://docs.medusajs.com/api/admin#products_postproducts), accept an `additional_data` request body parameter. This parameter can hold custom data that's passed to the [hooks](https://docs.medusajs.com/learn/fundamentals/workflows/workflow-hooks/index.html.md) of the workflow executed in the API route, allowing you to consume those hooks and perform actions with the custom data. + +So, in this chapter, to extend the create product flow and associate a brand with a product, you will: + +- Consume the [productsCreated](https://docs.medusajs.com/resources/references/medusa-workflows/createProductsWorkflow#productsCreated/index.html.md) hook of the [createProductsWorkflow](https://docs.medusajs.com/resources/references/medusa-workflows/createProductsWorkflow/index.html.md), which is executed within the workflow after the product is created. You'll link the product with the brand passed in the `additional_data` parameter. +- Extend the Create Product API route to allow passing a brand ID in `additional_data`. + +To learn more about the `additional_data` property and the API routes that accept additional data, refer to [this chapter](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data/index.html.md). + +### Prerequisites + +- [Brand Module](https://docs.medusajs.com/learn/customization/custom-features/module/index.html.md) +- [Defined link between the Brand and Product data models.](https://docs.medusajs.com/learn/customization/extend-features/define-link/index.html.md) + +*** + +## 1. Consume the productsCreated Hook + +A workflow hook is a point in a workflow where you can inject a step to perform a custom functionality. Consuming a workflow hook allows you to extend the features of a workflow and, consequently, the API route that uses it. + +Learn more about the workflow hooks in [this chapter](https://docs.medusajs.com/learn/fundamentals/workflows/workflow-hooks/index.html.md). + +The [createProductsWorkflow](https://docs.medusajs.com/resources/references/medusa-workflows/createProductsWorkflow/index.html.md) used in the [Create Product API route](https://docs.medusajs.com/api/admin#products_postproducts) has a `productsCreated` hook that runs after the product is created. You'll consume this hook to link the created product with the brand specified in the request parameters. + +To consume the `productsCreated` hook, create the file `src/workflows/hooks/created-product.ts` with the following content: + +![Directory structure after creating the hook's file.](https://res.cloudinary.com/dza7lstvk/image/upload/v1733384338/Medusa%20Book/brands-hook-dir-overview_ltwr5h.jpg) + +```ts title="src/workflows/hooks/created-product.ts" highlights={hook1Highlights} +import { createProductsWorkflow } from "@medusajs/medusa/core-flows" +import { StepResponse } from "@medusajs/framework/workflows-sdk" +import { Modules } from "@medusajs/framework/utils" +import { LinkDefinition } from "@medusajs/framework/types" +import { BRAND_MODULE } from "../../modules/brand" +import BrandModuleService from "../../modules/brand/service" + +createProductsWorkflow.hooks.productsCreated( + (async ({ products, additional_data }, { container }) => { + if (!additional_data?.brand_id) { + return new StepResponse([], []) + } + + const brandModuleService: BrandModuleService = container.resolve( + BRAND_MODULE + ) + // if the brand doesn't exist, an error is thrown. + await brandModuleService.retrieveBrand(additional_data.brand_id as string) + + // TODO link brand to product + }) +) +``` + +Workflows have a special `hooks` property to access its hooks and consume them. Each hook, such as `productsCreated`, accepts a step function as a parameter. The step function accepts the following parameters: + +1. An object having an `additional_data` property, which is the custom data passed in the request body under `additional_data`. The object will also have properties passed from the workflow to the hook, which in this case is the `products` property that holds an array of the created products. +2. An object of properties related to the step's context. It has a `container` property whose value is the [Medusa container](https://docs.medusajs.com/learn/fundamentals/medusa-container/index.html.md) to resolve framework and commerce tools. + +In the step, if a brand ID is passed in `additional_data`, you resolve the Brand Module's service and use its generated `retrieveBrand` method to retrieve the brand by its ID. The `retrieveBrand` method will throw an error if the brand doesn't exist. + +### Link Brand to Product + +Next, you want to create a link between the created products and the brand. To do so, you use Link, which is a class from the Modules SDK that provides methods to manage linked records. + +Learn more about Link in [this chapter](https://docs.medusajs.com/learn/fundamentals/module-links/link/index.html.md). + +To use Link in the `productsCreated` hook, replace the `TODO` with the following: + +```ts title="src/workflows/hooks/created-product.ts" highlights={hook2Highlights} +const link = container.resolve("link") +const logger = container.resolve("logger") + +const links: LinkDefinition[] = [] + +for (const product of products) { + links.push({ + [Modules.PRODUCT]: { + product_id: product.id, + }, + [BRAND_MODULE]: { + brand_id: additional_data.brand_id, + }, + }) } -export default BrandModuleService +await link.create(links) + +logger.info("Linked brand to products") + +return new StepResponse(links, links) ``` -The `BrandModuleService` extends a class returned by `MedusaService` from the Modules SDK. This function generates a class with data-management methods for your module's data models. +You resolve Link from the container. Then you loop over the created products to assemble an array of links to be created. After that, you pass the array of links to Link's `create` method, which will link the product and brand records. -The `MedusaService` function receives an object of the module's data models as a parameter, and generates methods to manage those data models. So, the `BrandModuleService` now has methods like `createBrands` and `retrieveBrand` to manage the `Brand` data model. +Each property in the link object is the name of a module, and its value is an object having a `{model_name}_id` property, where `{model_name}` is the snake-case name of the module's data model. Its value is the ID of the record to be linked. The link object's properties must be set in the same order as the link configurations passed to `defineLink`. -You'll use these methods in the [next chapter](https://docs.medusajs.com/learn/customization/custom-features/workflow/index.html.md). +![Diagram showcasing how the order of defining a link affects creating the link](https://res.cloudinary.com/dza7lstvk/image/upload/v1733386156/Medusa%20Book/remote-link-brand-product-exp_fhjmg4.jpg) -Find a reference of all generated methods in [this guide](https://docs.medusajs.com/resources/service-factory-reference/index.html.md). +Finally, you return an instance of `StepResponse` returning the created links. -*** +### Dismiss Links in Compensation -## 4. Export Module Definition +You can pass as a second parameter of the hook a compensation function that undoes what the step did. It receives as a first parameter the returned `StepResponse`'s second parameter, and the step context object as a second parameter. -A module must export a definition that tells Medusa the name of the module and its main service. This definition is exported in an `index.ts` file at the module's root directory. +To undo creating the links in the hook, pass the following compensation function as a second parameter to `productsCreated`: -So, to export the Brand Module's definition, create the file `src/modules/brand/index.ts` with the following content: - -![Directory structure in module after adding the definition file](https://res.cloudinary.com/dza7lstvk/image/upload/v1732869045/Medusa%20Book/brand-dir-overview-4_nf8ymw.jpg) - -```ts title="src/modules/brand/index.ts" -import { Module } from "@medusajs/framework/utils" -import BrandModuleService from "./service" - -export const BRAND_MODULE = "brand" - -export default Module(BRAND_MODULE, { - service: BrandModuleService, -}) -``` - -You use `Module` from the Modules SDK to create the module's definition. It accepts two parameters: - -1. The module's name (`brand`). You'll use this name when you use this module in other customizations. -2. An object with a required property `service` indicating the module's main service. - -You export `BRAND_MODULE` to reference the module's name more reliably in other customizations. - -*** - -## 5. Add Module to Medusa's Configurations - -To start using your module, you must add it to Medusa's configurations in `medusa-config.ts`. - -The object passed to `defineConfig` in `medusa-config.ts` accepts a `modules` property, whose value is an array of modules to add to the application. So, add the following in `medusa-config.ts`: - -```ts title="medusa-config.ts" -module.exports = defineConfig({ +```ts title="src/workflows/hooks/created-product.ts" +createProductsWorkflow.hooks.productsCreated( // ... - modules: [ + (async (links, { container }) => { + if (!links?.length) { + return + } + + const link = container.resolve("link") + + await link.dismiss(links) + }) +) +``` + +In the compensation function, if the `links` parameter isn't empty, you resolve Link from the container and use its `dismiss` method. This method removes a link between two records. It accepts the same parameter as the `create` method. + +*** + +## 2. Configure Additional Data Validation + +Now that you've consumed the `productsCreated` hook, you want to configure the `/admin/products` API route that creates a new product to accept a brand ID in its `additional_data` parameter. + +You configure the properties accepted in `additional_data` in the `src/api/middlewares.ts` that exports middleware configurations. So, create the file (or, if already existing, add to the file) `src/api/middlewares.ts` the following content: + +![Directory structure after adding the middelwares file](https://res.cloudinary.com/dza7lstvk/image/upload/v1733386868/Medusa%20Book/brands-middleware-dir-overview_uczos1.jpg) + +```ts title="src/api/middlewares.ts" +import { defineMiddlewares } from "@medusajs/framework/http" +import { z } from "zod" + +// ... + +export default defineMiddlewares({ + routes: [ + // ... { - resolve: "./src/modules/brand", + matcher: "/admin/products", + method: ["POST"], + additionalDataValidator: { + brand_id: z.string().optional(), + }, }, ], }) ``` -The Brand Module is now added to your Medusa application. You'll start using it in the [next chapter](https://docs.medusajs.com/learn/customization/custom-features/workflow/index.html.md). +Objects in `routes` accept an `additionalDataValidator` property that configures the validation rules for custom properties passed in the `additional_data` request parameter. It accepts an object whose keys are custom property names, and their values are validation rules created using [Zod](https://zod.dev/). + +So, `POST` requests sent to `/admin/products` can now pass the ID of a brand in the `brand_id` property of `additional_data`. *** -## 6. Generate and Run Migrations +## Test it Out -A migration is a TypeScript or JavaScript file that defines database changes made by a module. Migrations ensure that your module is re-usable and removes friction when working in a team, making it easy to reflect changes across team members' databases. - -Learn more about migrations in [this chapter](https://docs.medusajs.com/learn/fundamentals/modules#5-generate-migrations/index.html.md). - -[Medusa's CLI tool](https://docs.medusajs.com/resources/medusa-cli/index.html.md) allows you to generate migration files for your module, then run those migrations to reflect the changes in the database. So, run the following commands in your Medusa application's directory: +To test it out, first, retrieve the authentication token of your admin user by sending a `POST` request to `/auth/user/emailpass`: ```bash -npx medusa db:generate brand -npx medusa db:migrate +curl -X POST 'http://localhost:9000/auth/user/emailpass' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "email": "admin@medusa-test.com", + "password": "supersecret" +}' ``` -The `db:generate` command accepts as an argument the name of the module to generate the migrations for, and the `db:migrate` command runs all migrations that haven't been run yet in the Medusa application. +Make sure to replace the email and password in the request body with your user's credentials. -*** - -## Next Step: Create Brand Workflow - -The Brand Module now creates a `brand` table in the database and provides a class to manage its records. - -In the next chapter, you'll implement the functionality to create a brand in a workflow. You'll then use that workflow in a later chapter to expose an endpoint that allows admin users to create a brand. - - -# Next.js Starter Storefront - -The Medusa application is made up of a Node.js server and an admin dashboard. The storefront is installed and hosted separately from the Medusa application, giving you the flexibility to choose the frontend tech stack that you and your team are proficient in, and implement unique design systems and user experience. - -The Next.js Starter storefront provides rich commerce features and a sleek design. Developers and businesses can use it as-is or build on top of it to tailor it for the business's unique use case, design, and customer experience. - -In this chapter, you’ll learn how to install the Next.js Starter storefront separately from the Medusa application. You can also install it while installing the Medusa application as explained in [the installation chapter](https://docs.medusajs.com/learn/installation/index.html.md). - -## Install Next.js Starter - -### Prerequisites - -- [Node.js v20+](https://nodejs.org/en/download) -- [Git CLI tool](https://git-scm.com/downloads) - -If you already have a Medusa application installed with at least one region, you can install the Next.js Starter storefront with the following steps: - -1. Clone the [Next.js Starter](https://github.com/medusajs/nextjs-starter-medusa): +Then, send a `POST` request to `/admin/products` to create a product, and pass in the `additional_data` parameter a brand's ID: ```bash -git clone https://github.com/medusajs/nextjs-starter-medusa my-medusa-storefront +curl -X POST 'http://localhost:9000/admin/products' \ +-H 'Content-Type: application/json' \ +-H 'Authorization: Bearer {token}' \ +--data '{ + "title": "Product 1", + "options": [ + { + "title": "Default option", + "values": ["Default option value"] + } + ], + "shipping_profile_id": "{shipping_profile_id}", + "additional_data": { + "brand_id": "{brand_id}" + } +}' ``` -2. Change to the `my-medusa-storefront` directory, install the dependencies, and rename the template environment variable file: +Make sure to replace `{token}` with the token you received from the previous request, `shipping_profile_id` with the ID of a shipping profile in your application, and `{brand_id}` with the ID of a brand in your application. You can retrieve the ID of a shipping profile either from the Medusa Admin, or the [List Shipping Profiles API route](https://docs.medusajs.com/api/admin#shipping-profiles_getshippingprofiles). -```bash npm2yarn -cd my-medusa-storefront -npm install -mv .env.template .env.local -``` +The request creates a product and returns it. -3. Set the Medusa application's publishable API key in the `NEXT_PUBLIC_MEDUSA_PUBLISHABLE_KEY` environment variable. You can retrieve the publishable API key in on the Medusa Admin dashboard by going to Settings -> Publishable API Keys - -```bash -NEXT_PUBLIC_MEDUSA_PUBLISHABLE_KEY=pk_123... -``` - -4. While the Medusa application is running, start the Next.js Starter storefront: - -```bash npm2yarn -npm run dev -``` - -Your Next.js Starter storefront is now running at `http://localhost:8000`. +In the Medusa application's logs, you'll find the message `Linked brand to products`, indicating that the workflow hook handler ran and linked the brand to the products. *** -## Customize Storefront +## Next Steps: Query Linked Brands and Products -To customize the storefront, refer to the following directories: - -- `src/app`: The storefront’s pages. -- `src/modules`: The storefront’s components. -- `src/styles`: The storefront’s styles. - -You can learn more about development with Next.js through [their documentation](https://nextjs.org/docs/getting-started). - -*** - -## Configurations and Integrations - -The Next.js Starter is compatible with some Medusa integrations out-of-the-box, such as the Stripe provider module. You can also change some of its configurations if necessary. - -Refer to the [Next.js Starter reference](https://docs.medusajs.com/resources/nextjs-starter/index.html.md) for more details. +Now that you've extending the create-product flow to link a brand to it, you want to retrieve the brand details of a product. You'll learn how to do so in the next chapter. # Create Brands UI Route in Admin @@ -3744,74 +4099,140 @@ The [Admin Components guides](https://docs.medusajs.com/resources/admin-componen In the next chapter, you'll add a UI route that displays the list of brands in your application and allows admin users. -# Guide: Define Module Link Between Brand and Product +# Guide: Query Product's Brands -In this chapter, you'll learn how to define a module link between a brand defined in the [custom Brand Module](https://docs.medusajs.com/learn/customization/custom-features/module/index.html.md), and a product defined in the [Product Module](https://docs.medusajs.com/resources/commerce-modules/product/index.html.md) that's available in your Medusa application out-of-the-box. +In the previous chapters, you [defined a link](https://docs.medusajs.com/learn/customization/extend-features/define-link/index.html.md) between the [custom Brand Module](https://docs.medusajs.com/learn/customization/custom-features/module/index.html.md) and Medusa's [Product Module](https://docs.medusajs.com/resources/commerce-modules/product/index.html.md), then [extended the create-product flow](https://docs.medusajs.com/learn/customization/extend-features/extend-create-product/index.html.md) to link a product to a brand. -Modules are [isolated](https://docs.medusajs.com/learn/fundamentals/modules/isolation/index.html.md) from other resources, ensuring that they're integrated into the Medusa application without side effects. However, you may need to associate data models of different modules, or you're trying to extend data models from commerce modules with custom properties. To do that, you define module links. - -A module link forms an association between two data models of different modules while maintaining module isolation. You can then manage and query linked records of the data models using Medusa's Modules SDK. - -In this chapter, you'll define a module link between the `Brand` data model of the Brand Module, and the `Product` data model of the Product Module. In later chapters, you'll manage and retrieve linked product and brand records. - -Learn more about module links in [this chapters](https://docs.medusajs.com/learn/fundamentals/module-links/index.html.md). +In this chapter, you'll learn how to retrieve a product's brand (and vice-versa) in two ways: Using Medusa's existing API route, or in customizations, such as a custom API route. ### Prerequisites -- [Brand Module having a Brand data model](https://docs.medusajs.com/learn/customization/custom-features/module/index.html.md) - -## 1. Define Link - -Links are defined in a TypeScript or JavaScript file under the `src/links` directory. The file defines and exports the link using `defineLink` from the Modules SDK. - -So, to define a link between the `Product` and `Brand` models, create the file `src/links/product-brand.ts` with the following content: - -![The directory structure of the Medusa application after adding the link.](https://res.cloudinary.com/dza7lstvk/image/upload/v1733329897/Medusa%20Book/brands-link-dir-overview_t1rhlp.jpg) - -```ts title="src/links/product-brand.ts" highlights={highlights} -import BrandModule from "../modules/brand" -import ProductModule from "@medusajs/medusa/product" -import { defineLink } from "@medusajs/framework/utils" - -export default defineLink( - { - linkable: ProductModule.linkable.product, - isList: true, - }, - BrandModule.linkable.brand -) -``` - -You import each module's definition object from the `index.ts` file of the module's directory. Each module object has a special `linkable` property that holds the data models' link configurations. - -The `defineLink` function accepts two parameters of the same type, which is either: - -- The data model's link configuration, which you access from the Module's `linkable` property; -- Or an object that has two properties: - - `linkable`: the data model's link configuration, which you access from the Module's `linkable` property. - - `isList`: A boolean indicating whether many records of the data model can be linked to the other model. - -So, in the above code snippet, you define a link between the `Product` and `Brand` data models. Since a brand can be associated with multiple products, you enable `isList` in the `Product` model's object. +- [Brand Module](https://docs.medusajs.com/learn/customization/custom-features/module/index.html.md) +- [Defined link between the Brand and Product data models.](https://docs.medusajs.com/learn/customization/extend-features/define-link/index.html.md) *** -## 2. Sync the Link to the Database +## Approach 1: Retrieve Brands in Existing API Routes -A module link is represented in the database as a table that stores the IDs of linked records. So, after defining the link, run the following command to create the module link's table in the database: +Medusa's existing API routes accept a `fields` query parameter that allows you to specify the fields and relations of a model to retrieve. So, when you send a request to the [List Products](https://docs.medusajs.com/api/admin#products_getproducts), [Get Product](https://docs.medusajs.com/api/admin#products_getproductsid), or any product-related store or admin routes that accept a `fields` query parameter, you can specify in this parameter to return the product's brands. + +Learn more about selecting fields and relations in the [API Reference](https://docs.medusajs.com/api/admin#select-fields-and-relations). + +For example, send the following request to retrieve the list of products with their brands: ```bash -npx medusa db:migrate +curl 'http://localhost:9000/admin/products?fields=+brand.*' \ +--header 'Authorization: Bearer {token}' ``` -This command reflects migrations on the database and syncs module links, which creates a table for the `product-brand` link. +Make sure to replace `{token}` with your admin user's authentication token. Learn how to retrieve it in the [API reference](https://docs.medusajs.com/api/store#authentication). -You can also run the `npx medusa db:sync-links` to just sync module links without running migrations. +Any product that is linked to a brand will have a `brand` property in its object: + +```json title="Example Product Object" +{ + "id": "prod_123", + // ... + "brand": { + "id": "01JEB44M61BRM3ARM2RRMK7GJF", + "name": "Acme", + "created_at": "2024-12-05T09:59:08.737Z", + "updated_at": "2024-12-05T09:59:08.737Z", + "deleted_at": null + } +} +``` + +By using the `fields` query parameter, you don't have to re-create existing API routes to get custom data models that you linked to core data models. *** -## Next Steps: Extend Create Product Flow +## Approach 2: Use Query to Retrieve Linked Records -In the next chapter, you'll extend Medusa's workflow and API route that create a product to allow associating a brand with a product. You'll also learn how to link brand and product records. +You can also retrieve linked records using Query. Query allows you to retrieve data across modules with filters, pagination, and more. You can resolve Query from the Medusa container and use it in your API route or workflow. + +Learn more about Query in [this chapter](https://docs.medusajs.com/learn/fundamentals/module-links/query/index.html.md). + +For example, you can create an API route that retrieves brands and their products. If you followed the [Create Brands API route chapter](https://docs.medusajs.com/learn/customization/custom-features/api-route/index.html.md), you'll have the file `src/api/admin/brands/route.ts` with a `POST` API route. Add a new `GET` function to the same file: + +```ts title="src/api/admin/brands/route.ts" highlights={highlights} +// other imports... +import { + MedusaRequest, + MedusaResponse, +} from "@medusajs/framework/http" + +export const GET = async ( + req: MedusaRequest, + res: MedusaResponse +) => { + const query = req.scope.resolve("query") + + const { data: brands } = await query.graph({ + entity: "brand", + fields: ["*", "products.*"], + }) + + res.json({ brands }) +} +``` + +This adds a `GET` API route at `/admin/brands`. In the API route, you resolve Query from the Medusa container. Query has a `graph` method that runs a query to retrieve data. It accepts an object having the following properties: + +- `entity`: The data model's name as specified in the first parameter of `model.define`. +- `fields`: An array of properties and relations to retrieve. You can pass: + - A property's name, such as `id`, or `*` for all properties. + - A relation or linked model's name, such as `products` (use the plural name since brands are linked to list of products). You suffix the name with `.*` to retrieve all its properties. + +`graph` returns an object having a `data` property, which is the retrieved brands. You return the brands in the response. + +### Test it Out + +To test the API route out, send a `GET` request to `/admin/brands`: + +```bash +curl 'http://localhost:9000/admin/brands' \ +-H 'Authorization: Bearer {token}' +``` + +Make sure to replace `{token}` with your admin user's authentication token. Learn how to retrieve it in the [API reference](https://docs.medusajs.com/api/store#authentication). + +This returns the brands in your store with their linked products. For example: + +```json title="Example Response" +{ + "brands": [ + { + "id": "123", + // ... + "products": [ + { + "id": "prod_123", + // ... + } + ] + } + ] +} +``` + +*** + +## Summary + +By following the examples of the previous chapters, you: + +- Defined a link between the Brand and Product modules's data models, allowing you to associate a product with a brand. +- Extended the create-product workflow and route to allow setting the product's brand while creating the product. +- Queried a product's brand, and vice versa. + +*** + +## Next Steps: Customize Medusa Admin + +Clients, such as the Medusa Admin dashboard, can now use brand-related features, such as creating a brand or setting the brand of a product. + +In the next chapters, you'll learn how to customize the Medusa Admin to show a product's brand on its details page, and to show a new page with the list of brands in your store. # Guide: Sync Brands from Medusa to CMS @@ -4395,399 +4816,6 @@ By following the previous chapters, you utilized Medusa's framework and orchestr With Medusa, you can integrate any service from your commerce ecosystem with ease. You don't have to set up separate applications to manage your different customizations, or worry about data inconsistency across systems. Your efforts only go into implementing the business logic that ties your systems together. -# Guide: Query Product's Brands - -In the previous chapters, you [defined a link](https://docs.medusajs.com/learn/customization/extend-features/define-link/index.html.md) between the [custom Brand Module](https://docs.medusajs.com/learn/customization/custom-features/module/index.html.md) and Medusa's [Product Module](https://docs.medusajs.com/resources/commerce-modules/product/index.html.md), then [extended the create-product flow](https://docs.medusajs.com/learn/customization/extend-features/extend-create-product/index.html.md) to link a product to a brand. - -In this chapter, you'll learn how to retrieve a product's brand (and vice-versa) in two ways: Using Medusa's existing API route, or in customizations, such as a custom API route. - -### Prerequisites - -- [Brand Module](https://docs.medusajs.com/learn/customization/custom-features/module/index.html.md) -- [Defined link between the Brand and Product data models.](https://docs.medusajs.com/learn/customization/extend-features/define-link/index.html.md) - -*** - -## Approach 1: Retrieve Brands in Existing API Routes - -Medusa's existing API routes accept a `fields` query parameter that allows you to specify the fields and relations of a model to retrieve. So, when you send a request to the [List Products](https://docs.medusajs.com/api/admin#products_getproducts), [Get Product](https://docs.medusajs.com/api/admin#products_getproductsid), or any product-related store or admin routes that accept a `fields` query parameter, you can specify in this parameter to return the product's brands. - -Learn more about selecting fields and relations in the [API Reference](https://docs.medusajs.com/api/admin#select-fields-and-relations). - -For example, send the following request to retrieve the list of products with their brands: - -```bash -curl 'http://localhost:9000/admin/products?fields=+brand.*' \ ---header 'Authorization: Bearer {token}' -``` - -Make sure to replace `{token}` with your admin user's authentication token. Learn how to retrieve it in the [API reference](https://docs.medusajs.com/api/store#authentication). - -Any product that is linked to a brand will have a `brand` property in its object: - -```json title="Example Product Object" -{ - "id": "prod_123", - // ... - "brand": { - "id": "01JEB44M61BRM3ARM2RRMK7GJF", - "name": "Acme", - "created_at": "2024-12-05T09:59:08.737Z", - "updated_at": "2024-12-05T09:59:08.737Z", - "deleted_at": null - } -} -``` - -By using the `fields` query parameter, you don't have to re-create existing API routes to get custom data models that you linked to core data models. - -*** - -## Approach 2: Use Query to Retrieve Linked Records - -You can also retrieve linked records using Query. Query allows you to retrieve data across modules with filters, pagination, and more. You can resolve Query from the Medusa container and use it in your API route or workflow. - -Learn more about Query in [this chapter](https://docs.medusajs.com/learn/fundamentals/module-links/query/index.html.md). - -For example, you can create an API route that retrieves brands and their products. If you followed the [Create Brands API route chapter](https://docs.medusajs.com/learn/customization/custom-features/api-route/index.html.md), you'll have the file `src/api/admin/brands/route.ts` with a `POST` API route. Add a new `GET` function to the same file: - -```ts title="src/api/admin/brands/route.ts" highlights={highlights} -// other imports... -import { - MedusaRequest, - MedusaResponse, -} from "@medusajs/framework/http" - -export const GET = async ( - req: MedusaRequest, - res: MedusaResponse -) => { - const query = req.scope.resolve("query") - - const { data: brands } = await query.graph({ - entity: "brand", - fields: ["*", "products.*"], - }) - - res.json({ brands }) -} -``` - -This adds a `GET` API route at `/admin/brands`. In the API route, you resolve Query from the Medusa container. Query has a `graph` method that runs a query to retrieve data. It accepts an object having the following properties: - -- `entity`: The data model's name as specified in the first parameter of `model.define`. -- `fields`: An array of properties and relations to retrieve. You can pass: - - A property's name, such as `id`, or `*` for all properties. - - A relation or linked model's name, such as `products` (use the plural name since brands are linked to list of products). You suffix the name with `.*` to retrieve all its properties. - -`graph` returns an object having a `data` property, which is the retrieved brands. You return the brands in the response. - -### Test it Out - -To test the API route out, send a `GET` request to `/admin/brands`: - -```bash -curl 'http://localhost:9000/admin/brands' \ --H 'Authorization: Bearer {token}' -``` - -Make sure to replace `{token}` with your admin user's authentication token. Learn how to retrieve it in the [API reference](https://docs.medusajs.com/api/store#authentication). - -This returns the brands in your store with their linked products. For example: - -```json title="Example Response" -{ - "brands": [ - { - "id": "123", - // ... - "products": [ - { - "id": "prod_123", - // ... - } - ] - } - ] -} -``` - -*** - -## Summary - -By following the examples of the previous chapters, you: - -- Defined a link between the Brand and Product modules's data models, allowing you to associate a product with a brand. -- Extended the create-product workflow and route to allow setting the product's brand while creating the product. -- Queried a product's brand, and vice versa. - -*** - -## Next Steps: Customize Medusa Admin - -Clients, such as the Medusa Admin dashboard, can now use brand-related features, such as creating a brand or setting the brand of a product. - -In the next chapters, you'll learn how to customize the Medusa Admin to show a product's brand on its details page, and to show a new page with the list of brands in your store. - - -# Guide: Extend Create Product Flow - -After linking the [custom Brand data model](https://docs.medusajs.com/learn/customization/custom-features/module/index.html.md) and Medusa's [Product Module](https://docs.medusajs.com/resources/commerce-modules/product/index.html.md) in the [previous chapter](https://docs.medusajs.com/learn/customization/extend-features/define-link/index.html.md), you'll extend the create product workflow and API route to allow associating a brand with a product. - -Some API routes, including the [Create Product API route](https://docs.medusajs.com/api/admin#products_postproducts), accept an `additional_data` request body parameter. This parameter can hold custom data that's passed to the [hooks](https://docs.medusajs.com/learn/fundamentals/workflows/workflow-hooks/index.html.md) of the workflow executed in the API route, allowing you to consume those hooks and perform actions with the custom data. - -So, in this chapter, to extend the create product flow and associate a brand with a product, you will: - -- Consume the [productsCreated](https://docs.medusajs.com/resources/references/medusa-workflows/createProductsWorkflow#productsCreated/index.html.md) hook of the [createProductsWorkflow](https://docs.medusajs.com/resources/references/medusa-workflows/createProductsWorkflow/index.html.md), which is executed within the workflow after the product is created. You'll link the product with the brand passed in the `additional_data` parameter. -- Extend the Create Product API route to allow passing a brand ID in `additional_data`. - -To learn more about the `additional_data` property and the API routes that accept additional data, refer to [this chapter](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data/index.html.md). - -### Prerequisites - -- [Brand Module](https://docs.medusajs.com/learn/customization/custom-features/module/index.html.md) -- [Defined link between the Brand and Product data models.](https://docs.medusajs.com/learn/customization/extend-features/define-link/index.html.md) - -*** - -## 1. Consume the productsCreated Hook - -A workflow hook is a point in a workflow where you can inject a step to perform a custom functionality. Consuming a workflow hook allows you to extend the features of a workflow and, consequently, the API route that uses it. - -Learn more about the workflow hooks in [this chapter](https://docs.medusajs.com/learn/fundamentals/workflows/workflow-hooks/index.html.md). - -The [createProductsWorkflow](https://docs.medusajs.com/resources/references/medusa-workflows/createProductsWorkflow/index.html.md) used in the [Create Product API route](https://docs.medusajs.com/api/admin#products_postproducts) has a `productsCreated` hook that runs after the product is created. You'll consume this hook to link the created product with the brand specified in the request parameters. - -To consume the `productsCreated` hook, create the file `src/workflows/hooks/created-product.ts` with the following content: - -![Directory structure after creating the hook's file.](https://res.cloudinary.com/dza7lstvk/image/upload/v1733384338/Medusa%20Book/brands-hook-dir-overview_ltwr5h.jpg) - -```ts title="src/workflows/hooks/created-product.ts" highlights={hook1Highlights} -import { createProductsWorkflow } from "@medusajs/medusa/core-flows" -import { StepResponse } from "@medusajs/framework/workflows-sdk" -import { Modules } from "@medusajs/framework/utils" -import { LinkDefinition } from "@medusajs/framework/types" -import { BRAND_MODULE } from "../../modules/brand" -import BrandModuleService from "../../modules/brand/service" - -createProductsWorkflow.hooks.productsCreated( - (async ({ products, additional_data }, { container }) => { - if (!additional_data?.brand_id) { - return new StepResponse([], []) - } - - const brandModuleService: BrandModuleService = container.resolve( - BRAND_MODULE - ) - // if the brand doesn't exist, an error is thrown. - await brandModuleService.retrieveBrand(additional_data.brand_id as string) - - // TODO link brand to product - }) -) -``` - -Workflows have a special `hooks` property to access its hooks and consume them. Each hook, such as `productsCreated`, accepts a step function as a parameter. The step function accepts the following parameters: - -1. An object having an `additional_data` property, which is the custom data passed in the request body under `additional_data`. The object will also have properties passed from the workflow to the hook, which in this case is the `products` property that holds an array of the created products. -2. An object of properties related to the step's context. It has a `container` property whose value is the [Medusa container](https://docs.medusajs.com/learn/fundamentals/medusa-container/index.html.md) to resolve framework and commerce tools. - -In the step, if a brand ID is passed in `additional_data`, you resolve the Brand Module's service and use its generated `retrieveBrand` method to retrieve the brand by its ID. The `retrieveBrand` method will throw an error if the brand doesn't exist. - -### Link Brand to Product - -Next, you want to create a link between the created products and the brand. To do so, you use Link, which is a class from the Modules SDK that provides methods to manage linked records. - -Learn more about Link in [this chapter](https://docs.medusajs.com/learn/fundamentals/module-links/link/index.html.md). - -To use Link in the `productsCreated` hook, replace the `TODO` with the following: - -```ts title="src/workflows/hooks/created-product.ts" highlights={hook2Highlights} -const link = container.resolve("link") -const logger = container.resolve("logger") - -const links: LinkDefinition[] = [] - -for (const product of products) { - links.push({ - [Modules.PRODUCT]: { - product_id: product.id, - }, - [BRAND_MODULE]: { - brand_id: additional_data.brand_id, - }, - }) -} - -await link.create(links) - -logger.info("Linked brand to products") - -return new StepResponse(links, links) -``` - -You resolve Link from the container. Then you loop over the created products to assemble an array of links to be created. After that, you pass the array of links to Link's `create` method, which will link the product and brand records. - -Each property in the link object is the name of a module, and its value is an object having a `{model_name}_id` property, where `{model_name}` is the snake-case name of the module's data model. Its value is the ID of the record to be linked. The link object's properties must be set in the same order as the link configurations passed to `defineLink`. - -![Diagram showcasing how the order of defining a link affects creating the link](https://res.cloudinary.com/dza7lstvk/image/upload/v1733386156/Medusa%20Book/remote-link-brand-product-exp_fhjmg4.jpg) - -Finally, you return an instance of `StepResponse` returning the created links. - -### Dismiss Links in Compensation - -You can pass as a second parameter of the hook a compensation function that undoes what the step did. It receives as a first parameter the returned `StepResponse`'s second parameter, and the step context object as a second parameter. - -To undo creating the links in the hook, pass the following compensation function as a second parameter to `productsCreated`: - -```ts title="src/workflows/hooks/created-product.ts" -createProductsWorkflow.hooks.productsCreated( - // ... - (async (links, { container }) => { - if (!links?.length) { - return - } - - const link = container.resolve("link") - - await link.dismiss(links) - }) -) -``` - -In the compensation function, if the `links` parameter isn't empty, you resolve Link from the container and use its `dismiss` method. This method removes a link between two records. It accepts the same parameter as the `create` method. - -*** - -## 2. Configure Additional Data Validation - -Now that you've consumed the `productsCreated` hook, you want to configure the `/admin/products` API route that creates a new product to accept a brand ID in its `additional_data` parameter. - -You configure the properties accepted in `additional_data` in the `src/api/middlewares.ts` that exports middleware configurations. So, create the file (or, if already existing, add to the file) `src/api/middlewares.ts` the following content: - -![Directory structure after adding the middelwares file](https://res.cloudinary.com/dza7lstvk/image/upload/v1733386868/Medusa%20Book/brands-middleware-dir-overview_uczos1.jpg) - -```ts title="src/api/middlewares.ts" -import { defineMiddlewares } from "@medusajs/framework/http" -import { z } from "zod" - -// ... - -export default defineMiddlewares({ - routes: [ - // ... - { - matcher: "/admin/products", - method: ["POST"], - additionalDataValidator: { - brand_id: z.string().optional(), - }, - }, - ], -}) -``` - -Objects in `routes` accept an `additionalDataValidator` property that configures the validation rules for custom properties passed in the `additional_data` request parameter. It accepts an object whose keys are custom property names, and their values are validation rules created using [Zod](https://zod.dev/). - -So, `POST` requests sent to `/admin/products` can now pass the ID of a brand in the `brand_id` property of `additional_data`. - -*** - -## Test it Out - -To test it out, first, retrieve the authentication token of your admin user by sending a `POST` request to `/auth/user/emailpass`: - -```bash -curl -X POST 'http://localhost:9000/auth/user/emailpass' \ --H 'Content-Type: application/json' \ ---data-raw '{ - "email": "admin@medusa-test.com", - "password": "supersecret" -}' -``` - -Make sure to replace the email and password in the request body with your user's credentials. - -Then, send a `POST` request to `/admin/products` to create a product, and pass in the `additional_data` parameter a brand's ID: - -```bash -curl -X POST 'http://localhost:9000/admin/products' \ --H 'Content-Type: application/json' \ --H 'Authorization: Bearer {token}' \ ---data '{ - "title": "Product 1", - "options": [ - { - "title": "Default option", - "values": ["Default option value"] - } - ], - "shipping_profile_id": "{shipping_profile_id}", - "additional_data": { - "brand_id": "{brand_id}" - } -}' -``` - -Make sure to replace `{token}` with the token you received from the previous request, `shipping_profile_id` with the ID of a shipping profile in your application, and `{brand_id}` with the ID of a brand in your application. You can retrieve the ID of a shipping profile either from the Medusa Admin, or the [List Shipping Profiles API route](https://docs.medusajs.com/api/admin#shipping-profiles_getshippingprofiles). - -The request creates a product and returns it. - -In the Medusa application's logs, you'll find the message `Linked brand to products`, indicating that the workflow hook handler ran and linked the brand to the products. - -*** - -## Next Steps: Query Linked Brands and Products - -Now that you've extending the create-product flow to link a brand to it, you want to retrieve the brand details of a product. You'll learn how to do so in the next chapter. - - -# Admin Development Constraints - -This chapter lists some constraints of admin widgets and UI routes. - -## Arrow Functions - -Widget and UI route components must be created as arrow functions. - -```ts highlights={arrowHighlights} -// Don't -function ProductWidget() { - // ... -} - -// Do -const ProductWidget = () => { - // ... -} -``` - -*** - -## Widget Zone - -A widget zone's value must be wrapped in double or single quotes. It can't be a template literal or a variable. - -```ts highlights={zoneHighlights} -// Don't -export const config = defineWidgetConfig({ - zone: `product.details.before`, -}) - -// Don't -const ZONE = "product.details.after" -export const config = defineWidgetConfig({ - zone: ZONE, -}) - -// Do -export const config = defineWidgetConfig({ - zone: "product.details.before", -}) -``` - - # Guide: Integrate CMS Brand System In the previous chapters, you've created a [Brand Module](https://docs.medusajs.com/learn/customization/custom-features/module/index.html.md) that adds brands to your application. In this chapter, you'll integrate a dummy Content-Management System (CMS) in a new module. The module's service will provide methods to retrieve and manage brands in the CMS. You'll later use this service to sync data from and to the CMS. @@ -4947,6 +4975,383 @@ You can now use the CMS Module's service to perform actions on the third-party C In the next chapter, you'll learn how to emit an event when a brand is created, then handle that event to sync the brand from Medusa to the third-party service. +# Write Tests for Modules + +In this chapter, you'll learn about `moduleIntegrationTestRunner` from Medusa's Testing Framework and how to use it to write integration tests for a module's main service. + +### Prerequisites + +- [Testing Tools Setup](https://docs.medusajs.com/learn/debugging-and-testing/testing-tools/index.html.md) + +## moduleIntegrationTestRunner Utility + +`moduleIntegrationTestRunner` creates integration tests for a module. The integration tests run on a test Medusa application with only the specified module enabled. + +For example, assuming you have a `hello` module, create a test file at `src/modules/hello/__tests__/service.spec.ts`: + +```ts title="src/modules/hello/__tests__/service.spec.ts" +import { moduleIntegrationTestRunner } from "@medusajs/test-utils" +import { HELLO_MODULE } from ".." +import HelloModuleService from "../service" +import MyCustom from "../models/my-custom" + +moduleIntegrationTestRunner({ + moduleName: HELLO_MODULE, + moduleModels: [MyCustom], + resolve: "./src/modules/hello", + testSuite: ({ service }) => { + // TODO write tests + }, +}) + +jest.setTimeout(60 * 1000) +``` + +The `moduleIntegrationTestRunner` function accepts as a parameter an object with the following properties: + +- `moduleName`: The name of the module. +- `moduleModels`: An array of models in the module. Refer to [this section](#write-tests-for-modules-without-data-models) if your module doesn't have data models. +- `resolve`: The path to the model. +- `testSuite`: A function that defines the tests to run. + +The `testSuite` function accepts as a parameter an object having the `service` property, which is an instance of the module's main service. + +The type argument provided to the `moduleIntegrationTestRunner` function is used as the type of the `service` property. + +The tests in the `testSuite` function are written using [Jest](https://jestjs.io/). + +*** + +## Run Tests + +Run the following command to run your module integration tests: + +```bash npm2yarn +npm run test:integration:modules +``` + +If you don't have a `test:integration:modules` script in `package.json`, refer to the [Medusa Testing Tools chapter](https://docs.medusajs.com/learn/debugging-and-testing/testing-tools#add-test-commands/index.html.md). + +This runs your Medusa application and runs the tests available in any `__tests__` directory under the `src/modules` directory. + +*** + +## Pass Module Options + +If your module accepts options, you can set them using the `moduleOptions` property of the `moduleIntegrationTestRunner`'s parameter. + +For example: + +```ts +import { moduleIntegrationTestRunner } from "@medusajs/test-utils" +import HelloModuleService from "../service" + +moduleIntegrationTestRunner({ + moduleOptions: { + apiKey: "123", + }, + // ... +}) +``` + +*** + +## Write Tests for Modules without Data Models + +If your module doesn't have a data model, pass a dummy model in the `moduleModels` property. + +For example: + +```ts +import { moduleIntegrationTestRunner } from "@medusajs/test-utils" +import HelloModuleService from "../service" +import { model } from "@medusajs/framework/utils" + +const DummyModel = model.define("dummy_model", { + id: model.id().primaryKey(), +}) + +moduleIntegrationTestRunner({ + moduleModels: [DummyModel], + // ... +}) + +jest.setTimeout(60 * 1000) +``` + +*** + +### Other Options and Inputs + +Refer to [this reference in the Development Resources documentation](https://docs.medusajs.com/resources/test-tools-reference/moduleIntegrationTestRunner/index.html.md) for other available parameter options and inputs of the `testSuite` function. + +*** + +## Database Used in Tests + +The `moduleIntegrationTestRunner` function creates a database with a random name before running the tests. Then, it drops that database after all the tests end. + +To manage that database, such as changing its name or perform operations on it in your tests, refer to the [references in the Development Resources documentation](https://docs.medusajs.com/resources/test-tools-reference/moduleIntegrationTestRunner/index.html.md). + + +# Write Integration Tests + +In this chapter, you'll learn about `medusaIntegrationTestRunner` from Medusa's Testing Framework and how to use it to write integration tests. + +### Prerequisites + +- [Testing Tools Setup](https://docs.medusajs.com/learn/debugging-and-testing/testing-tools/index.html.md) + +## medusaIntegrationTestRunner Utility + +The `medusaIntegrationTestRunner` is from Medusa's Testing Framework and it's used to create integration tests in your Medusa project. It runs a full Medusa application, allowing you test API routes, workflows, or other customizations. + +For example: + +```ts title="integration-tests/http/test.spec.ts" highlights={highlights} +import { medusaIntegrationTestRunner } from "@medusajs/test-utils" + +medusaIntegrationTestRunner({ + testSuite: ({ api, getContainer }) => { + // TODO write tests... + }, +}) + +jest.setTimeout(60 * 1000) +``` + +The `medusaIntegrationTestRunner` function accepts an object as a parameter. The object has a required property `testSuite`. + +`testSuite`'s value is a function that defines the tests to run. The function accepts as a parameter an object that has the following properties: + +- `api`: a set of utility methods used to send requests to the Medusa application. It has the following methods: + - `get`: Send a `GET` request to an API route. + - `post`: Send a `POST` request to an API route. + - `delete`: Send a `DELETE` request to an API route. +- `getContainer`: a function that retrieves the Medusa Container. Use the `getContainer().resolve` method to resolve resources from the Medusa Container. + +The tests in the `testSuite` function are written using [Jest](https://jestjs.io/). + +### Jest Timeout + +Since your tests connect to the database and perform actions that require more time than the typical tests, make sure to increase the timeout in your test: + +```ts title="integration-tests/http/test.spec.ts" +// in your test's file +jest.setTimeout(60 * 1000) +``` + +*** + +### Run Tests + +Run the following command to run your tests: + +```bash npm2yarn +npm run test:integration +``` + +If you don't have a `test:integration` script in `package.json`, refer to the [Medusa Testing Tools chapter](https://docs.medusajs.com/learn/debugging-and-testing/testing-tools#add-test-commands/index.html.md). + +This runs your Medusa application and runs the tests available under the `src/integrations/http` directory. + +*** + +## Other Options and Inputs + +Refer to [this reference in the Development Resources documentation](https://docs.medusajs.com/resources/test-tools-reference/medusaIntegrationTestRunner/index.html.md) for other available parameter options and inputs of the `testSuite` function. + +*** + +## Database Used in Tests + +The `medusaIntegrationTestRunner` function creates a database with a random name before running the tests. Then, it drops that database after all the tests end. + +To manage that database, such as changing its name or perform operations on it in your tests, refer to the [references in the Development Resources documentation](https://docs.medusajs.com/resources/test-tools-reference/medusaIntegrationTestRunner/index.html.md). + +*** + +## Example Integration Tests + +The next chapters provide examples of writing integration tests for API routes and workflows. + + +# Admin Development Constraints + +This chapter lists some constraints of admin widgets and UI routes. + +## Arrow Functions + +Widget and UI route components must be created as arrow functions. + +```ts highlights={arrowHighlights} +// Don't +function ProductWidget() { + // ... +} + +// Do +const ProductWidget = () => { + // ... +} +``` + +*** + +## Widget Zone + +A widget zone's value must be wrapped in double or single quotes. It can't be a template literal or a variable. + +```ts highlights={zoneHighlights} +// Don't +export const config = defineWidgetConfig({ + zone: `product.details.before`, +}) + +// Don't +const ZONE = "product.details.after" +export const config = defineWidgetConfig({ + zone: ZONE, +}) + +// Do +export const config = defineWidgetConfig({ + zone: "product.details.before", +}) +``` + + +# Admin Development Tips + +In this chapter, you'll find some tips for your admin development. + +## Send Requests to API Routes + +To send a request to an API route in the Medusa Application, use Medusa's [JS SDK](https://docs.medusajs.com/resources/js-sdk/index.html.md) with [Tanstack Query](https://tanstack.com/query/latest). Both of these tools are installed in your project by default. + +Do not install Tanstack Query as that will cause unexpected errors in your development. If you prefer installing it for better auto-completion in your code editor, make sure to install `v5.64.2` as a development dependency. + +First, create the file `src/admin/lib/config.ts` to setup the SDK for use in your customizations: + +```ts +import Medusa from "@medusajs/js-sdk" + +export const sdk = new Medusa({ + baseUrl: import.meta.env.VITE_BACKEND_URL || "/", + debug: import.meta.env.DEV, + auth: { + type: "session", + }, +}) +``` + +Notice that you use `import.meta.env` to access environment variables in your customizations, as explained in [this chapter](https://docs.medusajs.com/learn/fundamentals/admin/environment-variables/index.html.md). + +Learn more about the JS SDK's configurations [this documentation](https://docs.medusajs.com/resources/js-sdk#js-sdk-configurations/index.html.md). + +Then, use the configured SDK with the `useQuery` Tanstack Query hook to send `GET` requests, and `useMutation` hook to send `POST` or `DELETE` requests. + +For example: + +### Query + +```tsx title="src/admin/widgets/product-widget.ts" highlights={queryHighlights} +import { defineWidgetConfig } from "@medusajs/admin-sdk" +import { Button, Container } from "@medusajs/ui" +import { useQuery } from "@tanstack/react-query" +import { sdk } from "../lib/config" +import { DetailWidgetProps, HttpTypes } from "@medusajs/framework/types" + +const ProductWidget = () => { + const { data, isLoading } = useQuery({ + queryFn: () => sdk.admin.product.list(), + queryKey: ["products"], + }) + + return ( + + {isLoading && Loading...} + {data?.products && ( +
    + {data.products.map((product) => ( +
  • {product.title}
    • + ))} +
+ )} + + ) +} + +export const config = defineWidgetConfig({ + zone: "product.list.before", +}) + +export default ProductWidget +``` + +### Mutation + +```tsx title="src/admin/widgets/product-widget.ts" highlights={mutationHighlights} +import { defineWidgetConfig } from "@medusajs/admin-sdk" +import { Button, Container } from "@medusajs/ui" +import { useMutation } from "@tanstack/react-query" +import { sdk } from "../lib/config" +import { DetailWidgetProps, HttpTypes } from "@medusajs/framework/types" + +const ProductWidget = ({ + data: productData, +}: DetailWidgetProps) => { + const { mutateAsync } = useMutation({ + mutationFn: (payload: HttpTypes.AdminUpdateProduct) => + sdk.admin.product.update(productData.id, payload), + onSuccess: () => alert("updated product"), + }) + + const handleUpdate = () => { + mutateAsync({ + title: "New Product Title", + }) + } + + return ( + + + + ) +} + +export const config = defineWidgetConfig({ + zone: "product.details.before", +}) + +export default ProductWidget +``` + +You can also send requests to custom routes as explained in the [JS SDK reference](https://docs.medusajs.com/resources/js-sdk/index.html.md). + +### Use Route Loaders for Initial Data + +You may need to retrieve data before your component is rendered, or you may need to pass some initial data to your component to be used while data is being fetched. In those cases, you can use a [route loader](https://docs.medusajs.com/learn/fundamentals/admin/routing/index.html.md). + +*** + +## Global Variables in Admin Customizations + +In your admin customizations, you can use the following global variables: + +- `__BASE__`: The base path of the Medusa Admin, as set in the [admin.path](https://docs.medusajs.com/resources/references/medusa-config#path/index.html.md) configuration in `medusa-config.ts`. +- `__BACKEND_URL__`: The URL to the Medusa backend, as set in the [admin.backendUrl](https://docs.medusajs.com/resources/references/medusa-config#backendurl/index.html.md) configuration in `medusa-config.ts`. +- `__STOREFRONT_URL__`: The URL to the storefront, as set in the [admin.storefrontUrl](https://docs.medusajs.com/resources/references/medusa-config#storefrontUrl/index.html.md) configuration in `medusa-config.ts`. + +*** + +## Admin Translations + +The Medusa Admin dashboard can be displayed in languages other than English, which is the default. Other languages are added through community contributions. + +Learn how to add a new language translation for the Medusa Admin in [this guide](https://docs.medusajs.com/learn/resources/contribution-guidelines/admin-translations/index.html.md). + + # Environment Variables in Admin Customizations In this chapter, you'll learn how to use environment variables in your admin customizations. @@ -5169,125 +5574,6 @@ export const handle = { Refer to [react-router-dom’s documentation](https://reactrouter.com/en/6.29.0) for components and hooks that you can use in your admin customizations. -# Admin Widgets - -In this chapter, you’ll learn more about widgets and how to use them. - -## What is an Admin Widget? - -The Medusa Admin dashboard's pages are customizable to insert widgets of custom content in pre-defined injection zones. You create these widgets as React components that allow admin users to perform custom actions. - -For example, you can add a widget on the product details page that allow admin users to sync products to a third-party service. - -*** - -## How to Create a Widget? - -### Prerequisites - -- [Medusa application installed](https://docs.medusajs.com/learn/installation/index.html.md) - -You create a widget in a `.tsx` file under the `src/admin/widgets` directory. The file’s default export must be the widget, which is the React component that renders the custom content. The file must also export the widget’s configurations indicating where to insert the widget. - -For example, create the file `src/admin/widgets/product-widget.tsx` with the following content: - -![Example of widget file in the application's directory structure](https://res.cloudinary.com/dza7lstvk/image/upload/v1732867137/Medusa%20Book/widget-dir-overview_dqsbct.jpg) - -```tsx title="src/admin/widgets/product-widget.tsx" highlights={widgetHighlights} -import { defineWidgetConfig } from "@medusajs/admin-sdk" -import { Container, Heading } from "@medusajs/ui" - -// The widget -const ProductWidget = () => { - return ( - -
- Product Widget -
- - ) -} - -// The widget's configurations -export const config = defineWidgetConfig({ - zone: "product.details.before", -}) - -export default ProductWidget -``` - -You export the `ProductWidget` component, which shows the heading `Product Widget`. In the widget, you use [Medusa UI](https://docs.medusajs.com/ui/index.html.md), a package that Medusa maintains to allow you to customize the dashboard with the same components used to build it. - -To export the widget's configurations, you use `defineWidgetConfig` from the Admin Extension SDK. It accepts as a parameter an object with the `zone` property, whose value is a string or an array of strings, each being the name of the zone to inject the widget into. - -In the example above, the widget is injected at the top of a product’s details. - -The widget component must be created as an arrow function. - -### Test the Widget - -To test out the widget, start the Medusa application: - -```bash npm2yarn -npm run dev -``` - -Then, open a product’s details page. You’ll find your custom widget at the top of the page. - -*** - -## Props Passed in Detail Pages - -Widgets that are injected into a details page receive a `data` prop, which is the main data of the details page. - -For example, a widget injected into the `product.details.before` zone receives the product's details in the `data` prop: - -```tsx title="src/admin/widgets/product-widget.tsx" highlights={detailHighlights} -import { defineWidgetConfig } from "@medusajs/admin-sdk" -import { Container, Heading } from "@medusajs/ui" -import { - DetailWidgetProps, - AdminProduct, -} from "@medusajs/framework/types" - -// The widget -const ProductWidget = ({ - data, -}: DetailWidgetProps) => { - return ( - -
- - Product Widget {data.title} - -
- - ) -} - -// The widget's configurations -export const config = defineWidgetConfig({ - zone: "product.details.before", -}) - -export default ProductWidget -``` - -The props type is `DetailWidgetProps`, and it accepts as a type argument the expected type of `data`. For the product details page, it's `AdminProduct`. - -*** - -## Injection Zone - -Refer to [this reference](https://docs.medusajs.com/resources/admin-widget-injection-zones/index.html.md) for the full list of injection zones and their props. - -*** - -## Admin Components List - -To build admin customizations that match the Medusa Admin's designs and layouts, refer to [this guide](https://docs.medusajs.com/resources/admin-components/index.html.md) to find common components. - - # Admin UI Routes In this chapter, you’ll learn how to create a UI route in the admin dashboard. @@ -5524,6 +5810,125 @@ To build admin customizations that match the Medusa Admin's designs and layouts, For more customizations related to routes, refer to the [Routing Customizations chapter](https://docs.medusajs.com/learn/fundamentals/admin/routing/index.html.md). +# Admin Widgets + +In this chapter, you’ll learn more about widgets and how to use them. + +## What is an Admin Widget? + +The Medusa Admin dashboard's pages are customizable to insert widgets of custom content in pre-defined injection zones. You create these widgets as React components that allow admin users to perform custom actions. + +For example, you can add a widget on the product details page that allow admin users to sync products to a third-party service. + +*** + +## How to Create a Widget? + +### Prerequisites + +- [Medusa application installed](https://docs.medusajs.com/learn/installation/index.html.md) + +You create a widget in a `.tsx` file under the `src/admin/widgets` directory. The file’s default export must be the widget, which is the React component that renders the custom content. The file must also export the widget’s configurations indicating where to insert the widget. + +For example, create the file `src/admin/widgets/product-widget.tsx` with the following content: + +![Example of widget file in the application's directory structure](https://res.cloudinary.com/dza7lstvk/image/upload/v1732867137/Medusa%20Book/widget-dir-overview_dqsbct.jpg) + +```tsx title="src/admin/widgets/product-widget.tsx" highlights={widgetHighlights} +import { defineWidgetConfig } from "@medusajs/admin-sdk" +import { Container, Heading } from "@medusajs/ui" + +// The widget +const ProductWidget = () => { + return ( + +
+ Product Widget +
+ + ) +} + +// The widget's configurations +export const config = defineWidgetConfig({ + zone: "product.details.before", +}) + +export default ProductWidget +``` + +You export the `ProductWidget` component, which shows the heading `Product Widget`. In the widget, you use [Medusa UI](https://docs.medusajs.com/ui/index.html.md), a package that Medusa maintains to allow you to customize the dashboard with the same components used to build it. + +To export the widget's configurations, you use `defineWidgetConfig` from the Admin Extension SDK. It accepts as a parameter an object with the `zone` property, whose value is a string or an array of strings, each being the name of the zone to inject the widget into. + +In the example above, the widget is injected at the top of a product’s details. + +The widget component must be created as an arrow function. + +### Test the Widget + +To test out the widget, start the Medusa application: + +```bash npm2yarn +npm run dev +``` + +Then, open a product’s details page. You’ll find your custom widget at the top of the page. + +*** + +## Props Passed in Detail Pages + +Widgets that are injected into a details page receive a `data` prop, which is the main data of the details page. + +For example, a widget injected into the `product.details.before` zone receives the product's details in the `data` prop: + +```tsx title="src/admin/widgets/product-widget.tsx" highlights={detailHighlights} +import { defineWidgetConfig } from "@medusajs/admin-sdk" +import { Container, Heading } from "@medusajs/ui" +import { + DetailWidgetProps, + AdminProduct, +} from "@medusajs/framework/types" + +// The widget +const ProductWidget = ({ + data, +}: DetailWidgetProps) => { + return ( + +
+ + Product Widget {data.title} + +
+ + ) +} + +// The widget's configurations +export const config = defineWidgetConfig({ + zone: "product.details.before", +}) + +export default ProductWidget +``` + +The props type is `DetailWidgetProps`, and it accepts as a type argument the expected type of `data`. For the product details page, it's `AdminProduct`. + +*** + +## Injection Zone + +Refer to [this reference](https://docs.medusajs.com/resources/admin-widget-injection-zones/index.html.md) for the full list of injection zones and their props. + +*** + +## Admin Components List + +To build admin customizations that match the Medusa Admin's designs and layouts, refer to [this guide](https://docs.medusajs.com/resources/admin-components/index.html.md) to find common components. + + # Pass Additional Data to Medusa's API Route In this chapter, you'll learn how to pass additional data in requests to Medusa's API Route. @@ -5723,244 +6128,6 @@ createProductsWorkflow.hooks.productsCreated( This updates the products to their original state before adding the brand to their `metadata` property. -# Admin Development Tips - -In this chapter, you'll find some tips for your admin development. - -## Send Requests to API Routes - -To send a request to an API route in the Medusa Application, use Medusa's [JS SDK](https://docs.medusajs.com/resources/js-sdk/index.html.md) with [Tanstack Query](https://tanstack.com/query/latest). Both of these tools are installed in your project by default. - -Do not install Tanstack Query as that will cause unexpected errors in your development. If you prefer installing it for better auto-completion in your code editor, make sure to install `v5.64.2` as a development dependency. - -First, create the file `src/admin/lib/config.ts` to setup the SDK for use in your customizations: - -```ts -import Medusa from "@medusajs/js-sdk" - -export const sdk = new Medusa({ - baseUrl: import.meta.env.VITE_BACKEND_URL || "/", - debug: import.meta.env.DEV, - auth: { - type: "session", - }, -}) -``` - -Notice that you use `import.meta.env` to access environment variables in your customizations, as explained in [this chapter](https://docs.medusajs.com/learn/fundamentals/admin/environment-variables/index.html.md). - -Learn more about the JS SDK's configurations [this documentation](https://docs.medusajs.com/resources/js-sdk#js-sdk-configurations/index.html.md). - -Then, use the configured SDK with the `useQuery` Tanstack Query hook to send `GET` requests, and `useMutation` hook to send `POST` or `DELETE` requests. - -For example: - -### Query - -```tsx title="src/admin/widgets/product-widget.ts" highlights={queryHighlights} -import { defineWidgetConfig } from "@medusajs/admin-sdk" -import { Button, Container } from "@medusajs/ui" -import { useQuery } from "@tanstack/react-query" -import { sdk } from "../lib/config" -import { DetailWidgetProps, HttpTypes } from "@medusajs/framework/types" - -const ProductWidget = () => { - const { data, isLoading } = useQuery({ - queryFn: () => sdk.admin.product.list(), - queryKey: ["products"], - }) - - return ( - - {isLoading && Loading...} - {data?.products && ( -
    - {data.products.map((product) => ( -
  • {product.title}
    • - ))} -
- )} - - ) -} - -export const config = defineWidgetConfig({ - zone: "product.list.before", -}) - -export default ProductWidget -``` - -### Mutation - -```tsx title="src/admin/widgets/product-widget.ts" highlights={mutationHighlights} -import { defineWidgetConfig } from "@medusajs/admin-sdk" -import { Button, Container } from "@medusajs/ui" -import { useMutation } from "@tanstack/react-query" -import { sdk } from "../lib/config" -import { DetailWidgetProps, HttpTypes } from "@medusajs/framework/types" - -const ProductWidget = ({ - data: productData, -}: DetailWidgetProps) => { - const { mutateAsync } = useMutation({ - mutationFn: (payload: HttpTypes.AdminUpdateProduct) => - sdk.admin.product.update(productData.id, payload), - onSuccess: () => alert("updated product"), - }) - - const handleUpdate = () => { - mutateAsync({ - title: "New Product Title", - }) - } - - return ( - - - - ) -} - -export const config = defineWidgetConfig({ - zone: "product.details.before", -}) - -export default ProductWidget -``` - -You can also send requests to custom routes as explained in the [JS SDK reference](https://docs.medusajs.com/resources/js-sdk/index.html.md). - -### Use Route Loaders for Initial Data - -You may need to retrieve data before your component is rendered, or you may need to pass some initial data to your component to be used while data is being fetched. In those cases, you can use a [route loader](https://docs.medusajs.com/learn/fundamentals/admin/routing/index.html.md). - -*** - -## Global Variables in Admin Customizations - -In your admin customizations, you can use the following global variables: - -- `__BASE__`: The base path of the Medusa Admin, as set in the [admin.path](https://docs.medusajs.com/resources/references/medusa-config#path/index.html.md) configuration in `medusa-config.ts`. -- `__BACKEND_URL__`: The URL to the Medusa backend, as set in the [admin.backendUrl](https://docs.medusajs.com/resources/references/medusa-config#backendurl/index.html.md) configuration in `medusa-config.ts`. -- `__STOREFRONT_URL__`: The URL to the storefront, as set in the [admin.storefrontUrl](https://docs.medusajs.com/resources/references/medusa-config#storefrontUrl/index.html.md) configuration in `medusa-config.ts`. - -*** - -## Admin Translations - -The Medusa Admin dashboard can be displayed in languages other than English, which is the default. Other languages are added through community contributions. - -Learn how to add a new language translation for the Medusa Admin in [this guide](https://docs.medusajs.com/resources/contribution-guidelines/admin-translations/index.html.md). - - -# Throwing and Handling Errors - -In this guide, you'll learn how to throw errors in your Medusa application, how it affects an API route's response, and how to change the default error handler of your Medusa application. - -## Throw MedusaError - -When throwing an error in your API routes, middlewares, workflows, or any customization, throw a `MedusaError` from the Medusa Framework. - -The Medusa application's API route error handler then wraps your thrown error in a uniform object and returns it in the response. - -For example: - -```ts -import { MedusaRequest, MedusaResponse } from "@medusajs/framework/http" -import { MedusaError } from "@medusajs/framework/utils" - -export const GET = async ( - req: MedusaRequest, - res: MedusaResponse -) => { - if (!req.query.q) { - throw new MedusaError( - MedusaError.Types.INVALID_DATA, - "The `q` query parameter is required." - ) - } - - // ... -} -``` - -The `MedusaError` class accepts in its constructor two parameters: - -1. The first is the error's type. `MedusaError` has a static property `Types` that you can use. `Types` is an enum whose possible values are explained in the next section. -2. The second is the message to show in the error response. - -### Error Object in Response - -The error object returned in the response has two properties: - -- `type`: The error's type. -- `message`: The error message, if available. -- `code`: A common snake-case code. Its values can be: - - `invalid_request_error` for the `DUPLICATE_ERROR` type. - - `api_error`: for the `DB_ERROR` type. - - `invalid_state_error` for `CONFLICT` error type. - - `unknown_error` for any unidentified error type. - - For other error types, this property won't be available unless you provide a code as a third parameter to the `MedusaError` constructor. - -### MedusaError Types - -|Type|Description|Status Code| -|---|---|---|---|---| -|\`DB\_ERROR\`|Indicates a database error.|\`500\`| -|\`DUPLICATE\_ERROR\`|Indicates a duplicate of a record already exists. For example, when trying to create a customer whose email is registered by another customer.|\`422\`| -|\`INVALID\_ARGUMENT\`|Indicates an error that occurred due to incorrect arguments or other unexpected state.|\`500\`| -|\`INVALID\_DATA\`|Indicates a validation error.|\`400\`| -|\`UNAUTHORIZED\`|Indicates that a user is not authorized to perform an action or access a route.|\`401\`| -|\`NOT\_FOUND\`|Indicates that the requested resource, such as a route or a record, isn't found.|\`404\`| -|\`NOT\_ALLOWED\`|Indicates that an operation isn't allowed.|\`400\`| -|\`CONFLICT\`|Indicates that a request conflicts with another previous or ongoing request. The error message in this case is ignored for a default message.|\`409\`| -|\`PAYMENT\_AUTHORIZATION\_ERROR\`|Indicates an error has occurred while authorizing a payment.|\`422\`| -|Other error types|Any other error type results in an |\`500\`| - -*** - -## Override Error Handler - -The `defineMiddlewares` function used to apply middlewares on routes accepts an `errorHandler` in its object parameter. Use it to override the default error handler for API routes. - -This error handler will also be used for errors thrown in Medusa's API routes and resources. - -For example, create `src/api/middlewares.ts` with the following: - -```ts title="src/api/middlewares.ts" collapsibleLines="1-8" expandMoreLabel="Show Imports" -import { - defineMiddlewares, - MedusaNextFunction, - MedusaRequest, - MedusaResponse, -} from "@medusajs/framework/http" -import { MedusaError } from "@medusajs/framework/utils" - -export default defineMiddlewares({ - errorHandler: ( - error: MedusaError | any, - req: MedusaRequest, - res: MedusaResponse, - next: MedusaNextFunction - ) => { - res.status(400).json({ - error: "Something happened.", - }) - }, -}) -``` - -The `errorHandler` property's value is a function that accepts four parameters: - -1. The error thrown. Its type can be `MedusaError` or any other thrown error type. -2. A request object of type `MedusaRequest`. -3. A response object of type `MedusaResponse`. -4. A function of type MedusaNextFunction that executes the next middleware in the stack. - -This example overrides Medusa's default error handler with a handler that always returns a `400` status code with the same message. - - # Handling CORS in API Routes In this chapter, you’ll learn about the CORS middleware and how to configure it for custom API routes. @@ -6073,6 +6240,113 @@ export default defineMiddlewares({ This retrieves the configurations exported from `medusa-config.ts` and applies the `storeCors` to routes starting with `/custom`. +# Throwing and Handling Errors + +In this guide, you'll learn how to throw errors in your Medusa application, how it affects an API route's response, and how to change the default error handler of your Medusa application. + +## Throw MedusaError + +When throwing an error in your API routes, middlewares, workflows, or any customization, throw a `MedusaError` from the Medusa Framework. + +The Medusa application's API route error handler then wraps your thrown error in a uniform object and returns it in the response. + +For example: + +```ts +import { MedusaRequest, MedusaResponse } from "@medusajs/framework/http" +import { MedusaError } from "@medusajs/framework/utils" + +export const GET = async ( + req: MedusaRequest, + res: MedusaResponse +) => { + if (!req.query.q) { + throw new MedusaError( + MedusaError.Types.INVALID_DATA, + "The `q` query parameter is required." + ) + } + + // ... +} +``` + +The `MedusaError` class accepts in its constructor two parameters: + +1. The first is the error's type. `MedusaError` has a static property `Types` that you can use. `Types` is an enum whose possible values are explained in the next section. +2. The second is the message to show in the error response. + +### Error Object in Response + +The error object returned in the response has two properties: + +- `type`: The error's type. +- `message`: The error message, if available. +- `code`: A common snake-case code. Its values can be: + - `invalid_request_error` for the `DUPLICATE_ERROR` type. + - `api_error`: for the `DB_ERROR` type. + - `invalid_state_error` for `CONFLICT` error type. + - `unknown_error` for any unidentified error type. + - For other error types, this property won't be available unless you provide a code as a third parameter to the `MedusaError` constructor. + +### MedusaError Types + +|Type|Description|Status Code| +|---|---|---|---|---| +|\`DB\_ERROR\`|Indicates a database error.|\`500\`| +|\`DUPLICATE\_ERROR\`|Indicates a duplicate of a record already exists. For example, when trying to create a customer whose email is registered by another customer.|\`422\`| +|\`INVALID\_ARGUMENT\`|Indicates an error that occurred due to incorrect arguments or other unexpected state.|\`500\`| +|\`INVALID\_DATA\`|Indicates a validation error.|\`400\`| +|\`UNAUTHORIZED\`|Indicates that a user is not authorized to perform an action or access a route.|\`401\`| +|\`NOT\_FOUND\`|Indicates that the requested resource, such as a route or a record, isn't found.|\`404\`| +|\`NOT\_ALLOWED\`|Indicates that an operation isn't allowed.|\`400\`| +|\`CONFLICT\`|Indicates that a request conflicts with another previous or ongoing request. The error message in this case is ignored for a default message.|\`409\`| +|\`PAYMENT\_AUTHORIZATION\_ERROR\`|Indicates an error has occurred while authorizing a payment.|\`422\`| +|Other error types|Any other error type results in an |\`500\`| + +*** + +## Override Error Handler + +The `defineMiddlewares` function used to apply middlewares on routes accepts an `errorHandler` in its object parameter. Use it to override the default error handler for API routes. + +This error handler will also be used for errors thrown in Medusa's API routes and resources. + +For example, create `src/api/middlewares.ts` with the following: + +```ts title="src/api/middlewares.ts" collapsibleLines="1-8" expandMoreLabel="Show Imports" +import { + defineMiddlewares, + MedusaNextFunction, + MedusaRequest, + MedusaResponse, +} from "@medusajs/framework/http" +import { MedusaError } from "@medusajs/framework/utils" + +export default defineMiddlewares({ + errorHandler: ( + error: MedusaError | any, + req: MedusaRequest, + res: MedusaResponse, + next: MedusaNextFunction + ) => { + res.status(400).json({ + error: "Something happened.", + }) + }, +}) +``` + +The `errorHandler` property's value is a function that accepts four parameters: + +1. The error thrown. Its type can be `MedusaError` or any other thrown error type. +2. A request object of type `MedusaRequest`. +3. A response object of type `MedusaResponse`. +4. A function of type MedusaNextFunction that executes the next middleware in the stack. + +This example overrides Medusa's default error handler with a handler that always returns a `400` status code with the same message. + + # HTTP Methods In this chapter, you'll learn about how to add new API routes for each HTTP method. @@ -6116,322 +6390,6 @@ This adds two API Routes: - A `POST` route at `http://localhost:9000/hello-world`. -# API Route Parameters - -In this chapter, you’ll learn about path, query, and request body parameters. - -## Path Parameters - -To create an API route that accepts a path parameter, create a directory within the route file's path whose name is of the format `[param]`. - -For example, to create an API Route at the path `/hello-world/:id`, where `:id` is a path parameter, create the file `src/api/hello-world/[id]/route.ts` with the following content: - -```ts title="src/api/hello-world/[id]/route.ts" highlights={singlePathHighlights} -import type { - MedusaRequest, - MedusaResponse, -} from "@medusajs/framework/http" - -export const GET = async ( - req: MedusaRequest, - res: MedusaResponse -) => { - res.json({ - message: `[GET] Hello ${req.params.id}!`, - }) -} -``` - -The `MedusaRequest` object has a `params` property. `params` holds the path parameters in key-value pairs. - -### Multiple Path Parameters - -To create an API route that accepts multiple path parameters, create within the file's path multiple directories whose names are of the format `[param]`. - -For example, to create an API route at `/hello-world/:id/name/:name`, create the file `src/api/hello-world/[id]/name/[name]/route.ts` with the following content: - -```ts title="src/api/hello-world/[id]/name/[name]/route.ts" highlights={multiplePathHighlights} -import type { - MedusaRequest, - MedusaResponse, -} from "@medusajs/framework/http" - -export const GET = async ( - req: MedusaRequest, - res: MedusaResponse -) => { - res.json({ - message: `[GET] Hello ${ - req.params.id - } - ${req.params.name}!`, - }) -} -``` - -You access the `id` and `name` path parameters using the `req.params` property. - -*** - -## Query Parameters - -You can access all query parameters in the `query` property of the `MedusaRequest` object. `query` is an object of key-value pairs, where the key is a query parameter's name, and the value is its value. - -For example: - -```ts title="src/api/hello-world/route.ts" highlights={queryHighlights} -import type { - MedusaRequest, - MedusaResponse, -} from "@medusajs/framework/http" - -export const GET = async ( - req: MedusaRequest, - res: MedusaResponse -) => { - res.json({ - message: `Hello ${req.query.name}`, - }) -} -``` - -The value of `req.query.name` is the value passed in `?name=John`, for example. - -### Validate Query Parameters - -You can apply validation rules on received query parameters to ensure they match specified rules and types. - -Learn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/validation#how-to-validate-request-query-paramters/index.html.md). - -*** - -## Request Body Parameters - -The Medusa application parses the body of any request having a JSON, URL-encoded, or text request content types. The request body parameters are set in the `MedusaRequest`'s `body` property. - -Learn more about configuring body parsing in [this guide](https://docs.medusajs.com/learn/fundamentals/api-routes/parse-body/index.html.md). - -For example: - -```ts title="src/api/hello-world/route.ts" highlights={bodyHighlights} -import type { - MedusaRequest, - MedusaResponse, -} from "@medusajs/framework/http" - -type HelloWorldReq = { - name: string -} - -export const POST = async ( - req: MedusaRequest, - res: MedusaResponse -) => { - res.json({ - message: `[POST] Hello ${req.body.name}!`, - }) -} -``` - -In this example, you use the `name` request body parameter to create the message in the returned response. - -The `MedusaRequest` type accepts a type argument that indicates the type of the request body. This is useful for auto-completion and to avoid typing errors. - -To test it out, send the following request to your Medusa application: - -```bash -curl -X POST 'http://localhost:9000/hello-world' \ --H 'Content-Type: application/json' \ ---data-raw '{ - "name": "John" -}' -``` - -This returns the following JSON object: - -```json -{ - "message": "[POST] Hello John!" -} -``` - -### Validate Body Parameters - -You can apply validation rules on received body parameters to ensure they match specified rules and types. - -Learn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/validation#how-to-validate-request-body/index.html.md). - - -# Configure Request Body Parser - -In this chapter, you'll learn how to configure the request body parser for your API routes. - -## Default Body Parser Configuration - -The Medusa application configures the body parser by default to parse JSON, URL-encoded, and text request content types. You can parse other data types by adding the relevant [Express middleware](https://expressjs.com/en/guide/using-middleware.html) or preserve the raw body data by configuring the body parser, which is useful for webhook requests. - -This chapter shares some examples of configuring the body parser for different data types or use cases. - -*** - -## Preserve Raw Body Data for Webhooks - -If your API route receives webhook requests, you might want to preserve the raw body data. To do this, you can configure the body parser to parse the raw body data and store it in the `req.rawBody` property. - -To do that, create the file `src/api/middlewares.ts` with the following content: - -```ts title="src/api/middlewares.ts" highlights={preserveHighlights} -import { defineMiddlewares } from "@medusajs/framework/http" - -export default defineMiddlewares({ - routes: [ - { - method: ["POST"], - bodyParser: { preserveRawBody: true }, - matcher: "/custom", - }, - ], -}) -``` - -The middleware route object passed to `routes` accepts a `bodyParser` property whose value is an object of configuration for the default body parser. By enabling the `preserveRawBody` property, the raw body data is preserved and stored in the `req.rawBody` property. - -Learn more about [middlewares](https://docs.medusajs.com/learn/fundamentals/api-routes/middlewares/index.html.md). - -You can then access the raw body data in your API route handler: - -```ts title="src/api/custom/route.ts" -import { MedusaRequest, MedusaResponse } from "@medusajs/framework/http" - -export async function POST( - req: MedusaRequest, - res: MedusaResponse -) { - console.log(req.rawBody) - - // TODO use raw body -} -``` - -*** - -## Configure Request Body Size Limit - -By default, the body parser limits the request body size to `100kb`. If a request body exceeds that size, the Medusa application throws an error. - -You can configure the body parser to accept larger request bodies by setting the `sizeLimit` property of the `bodyParser` object in a middleware route object. For example: - -```ts title="src/api/middlewares.ts" highlights={sizeLimitHighlights} -import { defineMiddlewares } from "@medusajs/framework/http" - -export default defineMiddlewares({ - routes: [ - { - method: ["POST"], - bodyParser: { sizeLimit: "2mb" }, - matcher: "/custom", - }, - ], -}) -``` - -The `sizeLimit` property accepts one of the following types of values: - -- A string representing the size limit in bytes (For example, `100kb`, `2mb`, `5gb`). It is passed to the [bytes](https://www.npmjs.com/package/bytes) library to parse the size. -- A number representing the size limit in bytes. For example, `1024` for 1kb. - -*** - -## Configure File Uploads - -To accept file uploads in your API routes, you can configure the [Express Multer middleware](https://expressjs.com/en/resources/middleware/multer.html) on your route. - -The `multer` package is available through the `@medusajs/medusa` package, so you don't need to install it. However, for better typing support, install the `@types/multer` package as a development dependency: - -```bash npm2yarn -npm install --save-dev @types/multer -``` - -Then, to configure file upload for your route, create the file `src/api/middlewares.ts` with the following content: - -```ts title="src/api/middlewares.ts" highlights={uploadHighlights} -import { defineMiddlewares } from "@medusajs/framework/http" -import multer from "multer" - -const upload = multer({ storage: multer.memoryStorage() }) - -export default defineMiddlewares({ - routes: [ - { - method: ["POST"], - matcher: "/custom", - middlewares: [ - // @ts-ignore - upload.array("files"), - ], - }, - ], -}) -``` - -In the example above, you configure the `multer` middleware to store the uploaded files in memory. Then, you apply the `upload.array("files")` middleware to the route to accept file uploads. By using the `array` method, you accept multiple file uploads with the same `files` field name. - -You can then access the uploaded files in your API route handler: - -```ts title="src/api/custom/route.ts" -import { MedusaRequest, MedusaResponse } from "@medusajs/framework/http" - -export async function POST( - req: MedusaRequest, - res: MedusaResponse -) { - const files = req.files as Express.Multer.File[] - - // TODO handle files -} -``` - -The uploaded files are stored in the `req.files` property as an array of Multer file objects that have properties like `filename` and `mimetype`. - -### Uploading Files using File Module Provider - -The recommended way to upload the files to storage using the configured [File Module Provider](https://docs.medusajs.com/resources/architectural-modules/file/index.html.md) is to use the [uploadFilesWorkflow](https://docs.medusajs.com/resources/references/medusa-workflows/uploadFilesWorkflow/index.html.md): - -```ts title="src/api/custom/route.ts" -import { MedusaRequest, MedusaResponse } from "@medusajs/framework/http" -import { MedusaError } from "@medusajs/framework/utils" -import { uploadFilesWorkflow } from "@medusajs/medusa/core-flows" - -export async function POST( - req: MedusaRequest, - res: MedusaResponse -) { - const files = req.files as Express.Multer.File[] - - if (!files?.length) { - throw new MedusaError( - MedusaError.Types.INVALID_DATA, - "No files were uploaded" - ) - } - - const { result } = await uploadFilesWorkflow(req.scope).run({ - input: { - files: files?.map((f) => ({ - filename: f.originalname, - mimeType: f.mimetype, - content: f.buffer.toString("binary"), - access: "public", - })), - }, - }) - - res.status(200).json({ files: result }) -} -``` - -Check out the [uploadFilesWorkflow reference](https://docs.medusajs.com/resources/references/medusa-workflows/uploadFilesWorkflow/index.html.md) for details on the expected input and output of the workflow. - - # Middlewares In this chapter, you’ll learn about middlewares and how to create them. @@ -6780,6 +6738,322 @@ A middleware can not override an existing middleware. Instead, middlewares are a For example, if you define a custom validation middleware, such as `validateAndTransformBody`, on an existing route, then both the original and the custom validation middleware will run. +# Configure Request Body Parser + +In this chapter, you'll learn how to configure the request body parser for your API routes. + +## Default Body Parser Configuration + +The Medusa application configures the body parser by default to parse JSON, URL-encoded, and text request content types. You can parse other data types by adding the relevant [Express middleware](https://expressjs.com/en/guide/using-middleware.html) or preserve the raw body data by configuring the body parser, which is useful for webhook requests. + +This chapter shares some examples of configuring the body parser for different data types or use cases. + +*** + +## Preserve Raw Body Data for Webhooks + +If your API route receives webhook requests, you might want to preserve the raw body data. To do this, you can configure the body parser to parse the raw body data and store it in the `req.rawBody` property. + +To do that, create the file `src/api/middlewares.ts` with the following content: + +```ts title="src/api/middlewares.ts" highlights={preserveHighlights} +import { defineMiddlewares } from "@medusajs/framework/http" + +export default defineMiddlewares({ + routes: [ + { + method: ["POST"], + bodyParser: { preserveRawBody: true }, + matcher: "/custom", + }, + ], +}) +``` + +The middleware route object passed to `routes` accepts a `bodyParser` property whose value is an object of configuration for the default body parser. By enabling the `preserveRawBody` property, the raw body data is preserved and stored in the `req.rawBody` property. + +Learn more about [middlewares](https://docs.medusajs.com/learn/fundamentals/api-routes/middlewares/index.html.md). + +You can then access the raw body data in your API route handler: + +```ts title="src/api/custom/route.ts" +import { MedusaRequest, MedusaResponse } from "@medusajs/framework/http" + +export async function POST( + req: MedusaRequest, + res: MedusaResponse +) { + console.log(req.rawBody) + + // TODO use raw body +} +``` + +*** + +## Configure Request Body Size Limit + +By default, the body parser limits the request body size to `100kb`. If a request body exceeds that size, the Medusa application throws an error. + +You can configure the body parser to accept larger request bodies by setting the `sizeLimit` property of the `bodyParser` object in a middleware route object. For example: + +```ts title="src/api/middlewares.ts" highlights={sizeLimitHighlights} +import { defineMiddlewares } from "@medusajs/framework/http" + +export default defineMiddlewares({ + routes: [ + { + method: ["POST"], + bodyParser: { sizeLimit: "2mb" }, + matcher: "/custom", + }, + ], +}) +``` + +The `sizeLimit` property accepts one of the following types of values: + +- A string representing the size limit in bytes (For example, `100kb`, `2mb`, `5gb`). It is passed to the [bytes](https://www.npmjs.com/package/bytes) library to parse the size. +- A number representing the size limit in bytes. For example, `1024` for 1kb. + +*** + +## Configure File Uploads + +To accept file uploads in your API routes, you can configure the [Express Multer middleware](https://expressjs.com/en/resources/middleware/multer.html) on your route. + +The `multer` package is available through the `@medusajs/medusa` package, so you don't need to install it. However, for better typing support, install the `@types/multer` package as a development dependency: + +```bash npm2yarn +npm install --save-dev @types/multer +``` + +Then, to configure file upload for your route, create the file `src/api/middlewares.ts` with the following content: + +```ts title="src/api/middlewares.ts" highlights={uploadHighlights} +import { defineMiddlewares } from "@medusajs/framework/http" +import multer from "multer" + +const upload = multer({ storage: multer.memoryStorage() }) + +export default defineMiddlewares({ + routes: [ + { + method: ["POST"], + matcher: "/custom", + middlewares: [ + // @ts-ignore + upload.array("files"), + ], + }, + ], +}) +``` + +In the example above, you configure the `multer` middleware to store the uploaded files in memory. Then, you apply the `upload.array("files")` middleware to the route to accept file uploads. By using the `array` method, you accept multiple file uploads with the same `files` field name. + +You can then access the uploaded files in your API route handler: + +```ts title="src/api/custom/route.ts" +import { MedusaRequest, MedusaResponse } from "@medusajs/framework/http" + +export async function POST( + req: MedusaRequest, + res: MedusaResponse +) { + const files = req.files as Express.Multer.File[] + + // TODO handle files +} +``` + +The uploaded files are stored in the `req.files` property as an array of Multer file objects that have properties like `filename` and `mimetype`. + +### Uploading Files using File Module Provider + +The recommended way to upload the files to storage using the configured [File Module Provider](https://docs.medusajs.com/resources/architectural-modules/file/index.html.md) is to use the [uploadFilesWorkflow](https://docs.medusajs.com/resources/references/medusa-workflows/uploadFilesWorkflow/index.html.md): + +```ts title="src/api/custom/route.ts" +import { MedusaRequest, MedusaResponse } from "@medusajs/framework/http" +import { MedusaError } from "@medusajs/framework/utils" +import { uploadFilesWorkflow } from "@medusajs/medusa/core-flows" + +export async function POST( + req: MedusaRequest, + res: MedusaResponse +) { + const files = req.files as Express.Multer.File[] + + if (!files?.length) { + throw new MedusaError( + MedusaError.Types.INVALID_DATA, + "No files were uploaded" + ) + } + + const { result } = await uploadFilesWorkflow(req.scope).run({ + input: { + files: files?.map((f) => ({ + filename: f.originalname, + mimeType: f.mimetype, + content: f.buffer.toString("binary"), + access: "public", + })), + }, + }) + + res.status(200).json({ files: result }) +} +``` + +Check out the [uploadFilesWorkflow reference](https://docs.medusajs.com/resources/references/medusa-workflows/uploadFilesWorkflow/index.html.md) for details on the expected input and output of the workflow. + + +# API Route Parameters + +In this chapter, you’ll learn about path, query, and request body parameters. + +## Path Parameters + +To create an API route that accepts a path parameter, create a directory within the route file's path whose name is of the format `[param]`. + +For example, to create an API Route at the path `/hello-world/:id`, where `:id` is a path parameter, create the file `src/api/hello-world/[id]/route.ts` with the following content: + +```ts title="src/api/hello-world/[id]/route.ts" highlights={singlePathHighlights} +import type { + MedusaRequest, + MedusaResponse, +} from "@medusajs/framework/http" + +export const GET = async ( + req: MedusaRequest, + res: MedusaResponse +) => { + res.json({ + message: `[GET] Hello ${req.params.id}!`, + }) +} +``` + +The `MedusaRequest` object has a `params` property. `params` holds the path parameters in key-value pairs. + +### Multiple Path Parameters + +To create an API route that accepts multiple path parameters, create within the file's path multiple directories whose names are of the format `[param]`. + +For example, to create an API route at `/hello-world/:id/name/:name`, create the file `src/api/hello-world/[id]/name/[name]/route.ts` with the following content: + +```ts title="src/api/hello-world/[id]/name/[name]/route.ts" highlights={multiplePathHighlights} +import type { + MedusaRequest, + MedusaResponse, +} from "@medusajs/framework/http" + +export const GET = async ( + req: MedusaRequest, + res: MedusaResponse +) => { + res.json({ + message: `[GET] Hello ${ + req.params.id + } - ${req.params.name}!`, + }) +} +``` + +You access the `id` and `name` path parameters using the `req.params` property. + +*** + +## Query Parameters + +You can access all query parameters in the `query` property of the `MedusaRequest` object. `query` is an object of key-value pairs, where the key is a query parameter's name, and the value is its value. + +For example: + +```ts title="src/api/hello-world/route.ts" highlights={queryHighlights} +import type { + MedusaRequest, + MedusaResponse, +} from "@medusajs/framework/http" + +export const GET = async ( + req: MedusaRequest, + res: MedusaResponse +) => { + res.json({ + message: `Hello ${req.query.name}`, + }) +} +``` + +The value of `req.query.name` is the value passed in `?name=John`, for example. + +### Validate Query Parameters + +You can apply validation rules on received query parameters to ensure they match specified rules and types. + +Learn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/validation#how-to-validate-request-query-paramters/index.html.md). + +*** + +## Request Body Parameters + +The Medusa application parses the body of any request having a JSON, URL-encoded, or text request content types. The request body parameters are set in the `MedusaRequest`'s `body` property. + +Learn more about configuring body parsing in [this guide](https://docs.medusajs.com/learn/fundamentals/api-routes/parse-body/index.html.md). + +For example: + +```ts title="src/api/hello-world/route.ts" highlights={bodyHighlights} +import type { + MedusaRequest, + MedusaResponse, +} from "@medusajs/framework/http" + +type HelloWorldReq = { + name: string +} + +export const POST = async ( + req: MedusaRequest, + res: MedusaResponse +) => { + res.json({ + message: `[POST] Hello ${req.body.name}!`, + }) +} +``` + +In this example, you use the `name` request body parameter to create the message in the returned response. + +The `MedusaRequest` type accepts a type argument that indicates the type of the request body. This is useful for auto-completion and to avoid typing errors. + +To test it out, send the following request to your Medusa application: + +```bash +curl -X POST 'http://localhost:9000/hello-world' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "name": "John" +}' +``` + +This returns the following JSON object: + +```json +{ + "message": "[POST] Hello John!" +} +``` + +### Validate Body Parameters + +You can apply validation rules on received body parameters to ensure they match specified rules and types. + +Learn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/api-routes/validation#how-to-validate-request-body/index.html.md). + + # Protected Routes In this chapter, you’ll learn how to create protected routes. @@ -6940,6 +7214,108 @@ export const GET = async ( In the route handler, you resolve the User Module's main service, then use it to retrieve the logged-in admin user. +# API Route Response + +In this chapter, you'll learn how to send a response in your API route. + +## Send a JSON Response + +To send a JSON response, use the `json` method of the `MedusaResponse` object passed as the second parameter of your API route handler. + +For example: + +```ts title="src/api/custom/route.ts" highlights={jsonHighlights} +import { MedusaRequest, MedusaResponse } from "@medusajs/framework/http" + +export const GET = async ( + req: MedusaRequest, + res: MedusaResponse +) => { + res.json({ + message: "Hello, World!", + }) +} +``` + +This API route returns the following JSON object: + +```json +{ + "message": "Hello, World!" +} +``` + +*** + +## Set Response Status Code + +By default, setting the JSON data using the `json` method returns a response with a `200` status code. + +To change the status code, use the `status` method of the `MedusaResponse` object. + +For example: + +```ts title="src/api/custom/route.ts" highlights={statusHighlight} +import { MedusaRequest, MedusaResponse } from "@medusajs/framework/http" + +export const GET = async ( + req: MedusaRequest, + res: MedusaResponse +) => { + res.status(201).json({ + message: "Hello, World!", + }) +} +``` + +The response of this API route has the status code `201`. + +*** + +## Change Response Content Type + +To return response data other than a JSON object, use the `writeHead` method of the `MedusaResponse` object. It allows you to set the response headers, including the content type. + +For example, to create an API route that returns an event stream: + +```ts highlights={streamHighlights} +import { MedusaRequest, MedusaResponse } from "@medusajs/framework/http" + +export const GET = async ( + req: MedusaRequest, + res: MedusaResponse +) => { + res.writeHead(200, { + "Content-Type": "text/event-stream", + "Cache-Control": "no-cache", + Connection: "keep-alive", + }) + + const interval = setInterval(() => { + res.write("Streaming data...\n") + }, 3000) + + req.on("end", () => { + clearInterval(interval) + res.end() + }) +} +``` + +The `writeHead` method accepts two parameters: + +1. The first one is the response's status code. +2. The second is an object of key-value pairs to set the headers of the response. + +This API route opens a stream by setting the `Content-Type` in the header to `text/event-stream`. It then simulates a stream by creating an interval that writes the stream data every three seconds. + +*** + +## Do More with Responses + +The `MedusaResponse` type is based on [Express's Response](https://expressjs.com/en/api.html#res). Refer to their API reference for other uses of responses. + + # Request Body and Query Parameter Validation In this chapter, you'll learn how to validate request body and query parameters in your custom API route. @@ -7189,467 +7565,1197 @@ For example, if you omit the `a` parameter, you'll receive a `400` response code To see different examples and learn more about creating a validation schema, refer to [Zod's documentation](https://zod.dev). -# Event Data Payload +# Configure Data Model Properties -In this chapter, you'll learn how subscribers receive an event's data payload. +In this chapter, you’ll learn how to configure data model properties. -## Access Event's Data Payload +## Property’s Default Value -When events are emitted, they’re emitted with a data payload. - -The object that the subscriber function receives as a parameter has an `event` property, which is an object holding the event payload in a `data` property with additional context. +Use the `default` method on a property's definition to specify the default value of a property. For example: -```ts title="src/subscribers/product-created.ts" highlights={highlights} collapsibleLines="1-5" expandButtonLabel="Show Imports" -import type { - SubscriberArgs, - SubscriberConfig, -} from "@medusajs/framework" +```ts highlights={defaultHighlights} +import { model } from "@medusajs/framework/utils" -export default async function productCreateHandler({ - event, -}: SubscriberArgs<{ id: string }>) { - const productId = event.data.id - console.log(`The product ${productId} was created`) -} +const MyCustom = model.define("my_custom", { + color: model + .enum(["black", "white"]) + .default("black"), + age: model + .number() + .default(0), + // ... +}) -export const config: SubscriberConfig = { - event: "product.created", -} +export default MyCustom ``` -The `event` object has the following properties: +In this example, you set the default value of the `color` enum property to `black`, and that of the `age` number property to `0`. -- data: (\`object\`) The data payload of the event. Its properties are different for each event. -- name: (string) The name of the triggered event. -- metadata: (\`object\`) Additional data and context of the emitted event. +*** -This logs the product ID received in the `product.created` event’s data payload to the console. +## Nullable Property -{/* --- - -## List of Events with Data Payload - -Refer to [this reference](!resources!/events-reference) for a full list of events emitted by Medusa and their data payloads. */} - - -# API Route Response - -In this chapter, you'll learn how to send a response in your API route. - -## Send a JSON Response - -To send a JSON response, use the `json` method of the `MedusaResponse` object passed as the second parameter of your API route handler. +Use the `nullable` method to indicate that a property’s value can be `null`. For example: -```ts title="src/api/custom/route.ts" highlights={jsonHighlights} -import { MedusaRequest, MedusaResponse } from "@medusajs/framework/http" +```ts highlights={nullableHighlights} +import { model } from "@medusajs/framework/utils" -export const GET = async ( - req: MedusaRequest, - res: MedusaResponse -) => { - res.json({ - message: "Hello, World!", - }) -} -``` +const MyCustom = model.define("my_custom", { + price: model.bigNumber().nullable(), + // ... +}) -This API route returns the following JSON object: - -```json -{ - "message": "Hello, World!" -} +export default MyCustom ``` *** -## Set Response Status Code +## Unique Property -By default, setting the JSON data using the `json` method returns a response with a `200` status code. - -To change the status code, use the `status` method of the `MedusaResponse` object. +The `unique` method indicates that a property’s value must be unique in the database through a unique index. For example: -```ts title="src/api/custom/route.ts" highlights={statusHighlight} -import { MedusaRequest, MedusaResponse } from "@medusajs/framework/http" +```ts highlights={uniqueHighlights} +import { model } from "@medusajs/framework/utils" -export const GET = async ( - req: MedusaRequest, - res: MedusaResponse -) => { - res.status(201).json({ - message: "Hello, World!", - }) -} +const User = model.define("user", { + email: model.text().unique(), + // ... +}) + +export default User ``` -The response of this API route has the status code `201`. +In this example, multiple users can’t have the same email. + + +# Add Data Model Check Constraints + +In this chapter, you'll learn how to add check constraints to your data model. + +## What is a Check Constraint? + +A check constraint is a condition that must be satisfied by records inserted into a database table, otherwise an error is thrown. + +For example, if you have a data model with a `price` property, you want to only allow positive number values. So, you add a check constraint that fails when inserting a record with a negative price value. *** -## Change Response Content Type +## How to Set a Check Constraint? -To return response data other than a JSON object, use the `writeHead` method of the `MedusaResponse` object. It allows you to set the response headers, including the content type. +To set check constraints on a data model, use the `checks` method. This method accepts an array of check constraints to apply on the data model. -For example, to create an API route that returns an event stream: +For example, to set a check constraint on a `price` property that ensures its value can only be a positive number: -```ts highlights={streamHighlights} -import { MedusaRequest, MedusaResponse } from "@medusajs/framework/http" +```ts highlights={checks1Highlights} +import { model } from "@medusajs/framework/utils" -export const GET = async ( - req: MedusaRequest, - res: MedusaResponse -) => { - res.writeHead(200, { - "Content-Type": "text/event-stream", - "Cache-Control": "no-cache", - Connection: "keep-alive", - }) - - const interval = setInterval(() => { - res.write("Streaming data...\n") - }, 3000) - - req.on("end", () => { - clearInterval(interval) - res.end() - }) -} +const CustomProduct = model.define("custom_product", { + // ... + price: model.bigNumber(), +}) +.checks([ + (columns) => `${columns.price} >= 0`, +]) ``` -The `writeHead` method accepts two parameters: +The item passed in the array parameter of `checks` can be a callback function that accepts as a parameter an object whose keys are the names of the properties in the data model schema, and values the respective column name in the database. -1. The first one is the response's status code. -2. The second is an object of key-value pairs to set the headers of the response. +The function returns a string indicating the [SQL check constraint expression](https://www.postgresql.org/docs/current/ddl-constraints.html#DDL-CONSTRAINTS-CHECK-CONSTRAINTS). In the expression, use the `columns` parameter to access a property's column name. -This API route opens a stream by setting the `Content-Type` in the header to `text/event-stream`. It then simulates a stream by creating an interval that writes the stream data every three seconds. +You can also pass an object to the `checks` method: -*** +```ts highlights={checks2Highlights} +import { model } from "@medusajs/framework/utils" -## Do More with Responses - -The `MedusaResponse` type is based on [Express's Response](https://expressjs.com/en/api.html#res). Refer to their API reference for other uses of responses. - - -# Add Columns to a Link - -In this chapter, you'll learn how to add custom columns to a link definition and manage them. - -## How to Add Custom Columns to a Link's Table? - -The `defineLink` function used to define a link accepts a third parameter, which is an object of options. - -To add custom columns to a link's table, pass in the third parameter of `defineLink` a `database` property: - -```ts highlights={linkHighlights} -import HelloModule from "../modules/hello" -import ProductModule from "@medusajs/medusa/product" -import { defineLink } from "@medusajs/framework/utils" - -export default defineLink( - ProductModule.linkable.product, - HelloModule.linkable.myCustom, +const CustomProduct = model.define("custom_product", { + // ... + price: model.bigNumber(), +}) +.checks([ { - database: { - extraColumns: { - metadata: { - type: "json", - }, - }, - }, - } -) + name: "custom_product_price_check", + expression: (columns) => `${columns.price} >= 0`, + }, +]) ``` -This adds to the table created for the link between `product` and `myCustom` a `metadata` column of type `json`. +The object accepts the following properties: -### Database Options - -The `database` property defines configuration for the table created in the database. - -Its `extraColumns` property defines custom columns to create in the link's table. - -`extraColumns`'s value is an object whose keys are the names of the columns, and values are the column's configurations as an object. - -### Column Configurations - -The column's configurations object accepts the following properties: - -- `type`: The column's type. Possible values are: - - `string` - - `text` - - `integer` - - `boolean` - - `date` - - `time` - - `datetime` - - `enum` - - `json` - - `array` - - `enumArray` - - `float` - - `double` - - `decimal` - - `bigint` - - `mediumint` - - `smallint` - - `tinyint` - - `blob` - - `uuid` - - `uint8array` -- `defaultValue`: The column's default value. -- `nullable`: Whether the column can have `null` values. +- `name`: The check constraint's name. +- `expression`: A function similar to the one that can be passed to the array. It accepts an object of columns and returns an [SQL check constraint expression](https://www.postgresql.org/docs/current/ddl-constraints.html#DDL-CONSTRAINTS-CHECK-CONSTRAINTS). *** -## Set Custom Column when Creating Link +## Apply in Migrations -The object you pass to Link's `create` method accepts a `data` property. Its value is an object whose keys are custom column names, and values are the value of the custom column for this link. +After adding the check constraint, make sure to generate and run migrations if you already have the table in the database. Otherwise, the check constraint won't be reflected. -For example: +To generate a migration for the data model's module then reflect it on the database, run the following command: -Learn more about Link, how to resolve it, and its methods in [this chapter](https://docs.medusajs.com/learn/fundamentals/module-links/link/index.html.md). - -```ts -await link.create({ - [Modules.PRODUCT]: { - product_id: "123", - }, - HELLO_MODULE: { - my_custom_id: "321", - }, - data: { - metadata: { - test: true, - }, - }, -}) +```bash +npx medusa db:generate custom_module +npx medusa db:migrate ``` -*** +The first command generates the migration under the `migrations` directory of your module's directory, and the second reflects it on the database. -## Retrieve Custom Column with Link -To retrieve linked records with their custom columns, use [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query/index.html.md). A module link's definition, exported by a file under `src/links`, has a special `entryPoint` property. Use this property when specifying the `entity` property in Query's `graph` method. +# Data Model Default Properties -For example: +In this chapter, you'll learn about the properties available by default in your data model. -```ts highlights={retrieveHighlights} -import productHelloLink from "../links/product-hello" +When you create a data model, the following properties are created for you by Medusa: -// ... +- `created_at`: A `dateTime` property that stores when a record of the data model was created. +- `updated_at`: A `dateTime` property that stores when a record of the data model was updated. +- `deleted_at`: A `dateTime` property that stores when a record of the data model was deleted. When you soft-delete a record, Medusa sets the `deleted_at` property to the current date. -const { data } = await query.graph({ - entity: productHelloLink.entryPoint, - fields: ["metadata", "product.*", "my_custom.*"], - filters: { - product_id: "prod_123", - }, -}) -``` -This retrieves the product of id `prod_123` and its linked `my_custom` records. +# Infer Type of Data Model -In the `fields` array you pass `metadata`, which is the custom column to retrieve of the link. +In this chapter, you'll learn how to infer the type of a data model. -*** +## How to Infer Type of Data Model? -## Update Custom Column's Value +Consider you have a `MyCustom` data model. You can't reference this data model in a type, such as a workflow input or service method output types, since it's a variable. -Link's `create` method updates a link's data if the link between the specified records already exists. - -So, to update the value of a custom column in a created link, use the `create` method again passing it a new value for the custom column. +Instead, Medusa provides `InferTypeOf` that transforms your data model to a type. For example: ```ts -await link.create({ - [Modules.PRODUCT]: { - product_id: "123", - }, - HELLO_MODULE: { - my_custom_id: "321", - }, - data: { - metadata: { - test: false, - }, - }, -}) +import { InferTypeOf } from "@medusajs/framework/types" +import { MyCustom } from "../models/my-custom" // relative path to the model + +export type MyCustom = InferTypeOf ``` +`InferTypeOf` accepts as a type argument the type of the data model. -# Emit Workflow and Service Events +Since the `MyCustom` data model is a variable, use the `typeof` operator to pass the data model as a type argument to `InferTypeOf`. -In this chapter, you'll learn about event types and how to emit an event in a service or workflow. +You can now use the `MyCustom` type to reference a data model in other types, such as in workflow inputs or service method outputs: -## Event Types +```ts title="Example Service" +// other imports... +import { InferTypeOf } from "@medusajs/framework/types" +import { MyCustom } from "../models/my-custom" -In your customization, you can emit an event, then listen to it in a subscriber and perform an asynchronus action, such as send a notification or data to a third-party system. +type MyCustom = InferTypeOf -There are two types of events in Medusa: - -1. Workflow event: an event that's emitted in a workflow after a commerce feature is performed. For example, Medusa emits the `order.placed` event after a cart is completed. -2. Service event: an event that's emitted to track, trace, or debug processes under the hood. For example, you can emit an event with an audit trail. - -### Which Event Type to Use? - -**Workflow events** are the most common event type in development, as most custom features and customizations are built around workflows. - -Some examples of workflow events: - -1. When a user creates a blog post and you're emitting an event to send a newsletter email. -2. When you finish syncing products to a third-party system and you want to notify the admin user of new products added. -3. When a customer purchases a digital product and you want to generate and send it to them. - -You should only go for a **service event** if you're emitting an event for processes under the hood that don't directly affect front-facing features. - -Some examples of service events: - -1. When you're tracing data manipulation and changes, and you want to track every time some custom data is changed. -2. When you're syncing data with a search engine. - -*** - -## Emit Event in a Workflow - -To emit a workflow event, use the `emitEventStep` helper step provided in the `@medusajs/medusa/core-flows` package. - -For example: - -```ts highlights={highlights} -import { - createWorkflow, -} from "@medusajs/framework/workflows-sdk" -import { - emitEventStep, -} from "@medusajs/medusa/core-flows" - -const helloWorldWorkflow = createWorkflow( - "hello-world", - () => { +class HelloModuleService extends MedusaService({ MyCustom }) { + async doSomething(): Promise { // ... - - emitEventStep({ - eventName: "custom.created", - data: { - id: "123", - // other data payload - }, - }) } -) +} ``` -The `emitEventStep` accepts an object having the following properties: -- `eventName`: The event's name. -- `data`: The data payload as an object. You can pass any properties in the object, and subscribers listening to the event will receive this data in the event's payload. +# Manage Relationships -In this example, you emit the event `custom.created` and pass in the data payload an ID property. +In this chapter, you'll learn how to manage relationships between data models when creating, updating, or retrieving records using the module's main service. -### Test it Out +## Manage One-to-One Relationship -If you execute the workflow, the event is emitted and you can see it in your application's logs. +### BelongsTo Side of One-to-One -Any subscribers listening to the event are executed. +When you create a record of a data model that belongs to another through a one-to-one relation, pass the ID of the other data model's record in the `{relation}_id` property, where `{relation}` is the name of the relation property. + +For example, assuming you have the [User and Email data models from the previous chapter](https://docs.medusajs.com/learn/fundamentals/data-models/relationships#one-to-one-relationship/index.html.md), set an email's user ID as follows: + +```ts highlights={belongsHighlights} +// when creating an email +const email = await helloModuleService.createEmails({ + // other properties... + user_id: "123", +}) + +// when updating an email +const email = await helloModuleService.updateEmails({ + id: "321", + // other properties... + user_id: "123", +}) +``` + +In the example above, you pass the `user_id` property when creating or updating an email to specify the user it belongs to. + +### HasOne Side + +When you create a record of a data model that has one of another, pass the ID of the other data model's record in the relation property. + +For example, assuming you have the [User and Email data models from the previous chapter](https://docs.medusajs.com/learn/fundamentals/data-models/relationships#one-to-one-relationship/index.html.md), set a user's email ID as follows: + +```ts highlights={hasOneHighlights} +// when creating a user +const user = await helloModuleService.createUsers({ + // other properties... + email: "123", +}) + +// when updating a user +const user = await helloModuleService.updateUsers({ + id: "321", + // other properties... + email: "123", +}) +``` + +In the example above, you pass the `email` property when creating or updating a user to specify the email it has. *** -## Emit Event in a Service +## Manage One-to-Many Relationship -To emit a service event: +In a one-to-many relationship, you can only manage the associations from the `belongsTo` side. -1. Resolve `event_bus` from the module's container in your service's constructor: +When you create a record of the data model on the `belongsTo` side, pass the ID of the other data model's record in the `{relation}_id` property, where `{relation}` is the name of the relation property. -### Extending Service Factory +For example, assuming you have the [Product and Store data models from the previous chapter](https://docs.medusajs.com/learn/fundamentals/data-models/relationships#one-to-many-relationship/index.html.md), set a product's store ID as follows: -```ts title="src/modules/hello/service.ts" highlights={["9"]} -import { IEventBusService } from "@medusajs/framework/types" -import { MedusaService } from "@medusajs/framework/utils" +```ts highlights={manyBelongsHighlights} +// when creating a product +const product = await helloModuleService.createProducts({ + // other properties... + store_id: "123", +}) -class HelloModuleService extends MedusaService({ - MyCustom, -}){ - protected eventBusService_: AbstractEventBusModuleService - - constructor({ event_bus }) { - super(...arguments) - this.eventBusService_ = event_bus - } -} +// when updating a product +const product = await helloModuleService.updateProducts({ + id: "321", + // other properties... + store_id: "123", +}) ``` -### Without Service Factory +In the example above, you pass the `store_id` property when creating or updating a product to specify the store it belongs to. -```ts title="src/modules/hello/service.ts" highlights={["6"]} -import { IEventBusService } from "@medusajs/framework/types" +*** -class HelloModuleService { - protected eventBusService_: AbstractEventBusModuleService +## Manage Many-to-Many Relationship - constructor({ event_bus }) { - this.eventBusService_ = event_bus - } -} +If your many-to-many relation is represented with a [pivotEntity](https://docs.medusajs.com/learn/fundamentals/data-models/relationships#many-to-many-with-custom-columns/index.html.md), refer to [this section](#manage-many-to-many-relationship-with-pivotentity) instead. + +### Create Associations + +When you create a record of a data model that has a many-to-many relationship to another data model, pass an array of IDs of the other data model's records in the relation property. + +For example, assuming you have the [Order and Product data models from the previous chapter](https://docs.medusajs.com/learn/fundamentals/data-models/relationships#many-to-many-relationship/index.html.md), set the association between products and orders as follows: + +```ts highlights={manyHighlights} +// when creating a product +const product = await helloModuleService.createProducts({ + // other properties... + orders: ["123", "321"], +}) + +// when creating an order +const order = await helloModuleService.createOrders({ + id: "321", + // other properties... + products: ["123", "321"], +}) ``` -2. Use the event bus service's `emit` method in the service's methods to emit an event: +In the example above, you pass the `orders` property when you create a product, and you pass the `products` property when you create an order. -```ts title="src/modules/hello/service.ts" highlights={serviceHighlights} -class HelloModuleService { - // ... - performAction() { - // TODO perform action +### Update Associations - this.eventBusService_.emit({ - name: "custom.event", - data: { - id: "123", - // other data payload - }, - }) - } -} +When you use the `update` methods generated by the service factory, you also pass an array of IDs as the relation property's value to add new associated records. + +However, this removes any existing associations to records whose IDs aren't included in the array. + +For example, assuming you have the [Order and Product data models from the previous chapter](https://docs.medusajs.com/learn/fundamentals/data-models/relationships#many-to-many-relationship/index.html.md), you update the product's related orders as so: + +```ts +const product = await helloModuleService.updateProducts({ + id: "123", + // other properties... + orders: ["321"], +}) ``` -The method accepts an object having the following properties: +If the product was associated with an order, and you don't include that order's ID in the `orders` array, the association between the product and order is removed. -- `name`: The event's name. -- `data`: The data payload as an object. You can pass any properties in the object, and subscribers listening to the event will receive this data in the event's payload. +So, to add a new association without removing existing ones, retrieve the product first to pass its associated orders when updating the product: -3. By default, the Event Module's service isn't injected into your module's container. To add it to the container, pass it in the module's registration object in `medusa-config.ts` in the `dependencies` property: +```ts highlights={updateAssociationHighlights} +const product = await helloModuleService.retrieveProduct( + "123", + { + relations: ["orders"], + } +) -```ts title="medusa-config.ts" highlights={depsHighlight} -import { Modules } from "@medusajs/framework/utils" - -module.exports = defineConfig({ - // ... - modules: [ - { - resolve: "./src/modules/hello", - dependencies: [ - Modules.EVENT_BUS, - ], - }, +const updatedProduct = await helloModuleService.updateProducts({ + id: product.id, + // other properties... + orders: [ + ...product.orders.map((order) => order.id), + "321", ], }) ``` -The `dependencies` property accepts an array of module registration keys. The specified modules' main services are injected into the module's container. +This keeps existing associations between the product and orders, and adds a new one. -That's how you can resolve it in your module's main service's constructor. +*** -### Test it Out +## Manage Many-to-Many Relationship with pivotEntity -If you execute the `performAction` method of your service, the event is emitted and you can see it in your application's logs. +If your many-to-many relation is represented without a [pivotEntity](https://docs.medusajs.com/learn/fundamentals/data-models/relationships#many-to-many-with-custom-columns/index.html.md), refer to [this section](#manage-many-to-many-relationship) instead. -Any subscribers listening to the event are also executed. +If you have a many-to-many relation with a `pivotEntity` specified, make sure to pass the data model representing the pivot table to [MedusaService](https://docs.medusajs.com/learn/fundamentals/modules/service-factory/index.html.md) that your module's service extends. + +For example, assuming you have the [Order, Product, and OrderProduct models from the previous chapter](https://docs.medusajs.com/learn/fundamentals/data-models/relationships#many-to-many-with-custom-columns/index.html.md), add `OrderProduct` to `MedusaService`'s object parameter: + +```ts highlights={["4"]} +class HelloModuleService extends MedusaService({ + Order, + Product, + OrderProduct, +}) {} +``` + +This will generate Create, Read, Update and Delete (CRUD) methods for the `OrderProduct` data model, which you can use to create relations between orders and products and manage the extra columns in the pivot table. + +For example: + +```ts +// create order-product association +const orderProduct = await helloModuleService.createOrderProducts({ + order_id: "123", + product_id: "123", + metadata: { + test: true, + }, +}) + +// update order-product association +const orderProduct = await helloModuleService.updateOrderProducts({ + id: "123", + metadata: { + test: false, + }, +}) + +// delete order-product association +await helloModuleService.deleteOrderProducts("123") +``` + +Since the `OrderProduct` data model belongs to the `Order` and `Product` data models, you can set its order and product as explained in the [one-to-many relationship section](#manage-one-to-many-relationship) using `order_id` and `product_id`. + +Refer to the [service factory reference](https://docs.medusajs.com/resources/service-factory-reference/index.html.md) for a full list of generated methods and their usages. + +*** + +## Retrieve Records of Relation + +The `list`, `listAndCount`, and `retrieve` methods of a module's main service accept as a second parameter an object of options. + +To retrieve the records associated with a data model's records through a relationship, pass in the second parameter object a `relations` property whose value is an array of relationship names. + +For example, assuming you have the [Order and Product data models from the previous chapter](https://docs.medusajs.com/learn/fundamentals/data-models/relationships#many-to-many-relationship/index.html.md), you retrieve a product's orders as follows: + +```ts highlights={retrieveHighlights} +const product = await helloModuleService.retrieveProducts( + "123", + { + relations: ["orders"], + } +) +``` + +In the example above, the retrieved product has an `orders` property, whose value is an array of orders associated with the product. + + +# Data Model Database Index + +In this chapter, you’ll learn how to define a database index on a data model. + +## Define Database Index on Property + +Use the `index` method on a property's definition to define a database index. + +For example: + +```ts highlights={highlights} +import { model } from "@medusajs/framework/utils" + +const MyCustom = model.define("my_custom", { + id: model.id().primaryKey(), + name: model.text().index( + "IDX_MY_CUSTOM_NAME" + ), +}) + +export default MyCustom +``` + +The `index` method optionally accepts the name of the index as a parameter. + +In this example, you define an index on the `name` property. + +*** + +## Define Database Index on Data Model + +A data model has an `indexes` method that defines database indices on its properties. + +The index can be on multiple columns (composite index). For example: + +```ts highlights={dataModelIndexHighlights} +import { model } from "@medusajs/framework/utils" + +const MyCustom = model.define("my_custom", { + id: model.id().primaryKey(), + name: model.text(), + age: model.number(), +}).indexes([ + { + on: ["name", "age"], + }, +]) + +export default MyCustom +``` + +The `indexes` method receives an array of indices as a parameter. Each index is an object with a required `on` property indicating the properties to apply the index on. + +In the above example, you define a composite index on the `name` and `age` properties. + +### Index Conditions + +An index can have conditions. For example: + +```ts highlights={conditionHighlights} +import { model } from "@medusajs/framework/utils" + +const MyCustom = model.define("my_custom", { + id: model.id().primaryKey(), + name: model.text(), + age: model.number(), +}).indexes([ + { + on: ["name", "age"], + where: { + age: 30, + }, + }, +]) + +export default MyCustom +``` + +The index object passed to `indexes` accepts a `where` property whose value is an object of conditions. The object's key is a property's name, and its value is the condition on that property. + +In the example above, the composite index is created on the `name` and `age` properties when the `age`'s value is `30`. + +A property's condition can be a negation. For example: + +```ts highlights={negationHighlights} +import { model } from "@medusajs/framework/utils" + +const MyCustom = model.define("my_custom", { + id: model.id().primaryKey(), + name: model.text(), + age: model.number().nullable(), +}).indexes([ + { + on: ["name", "age"], + where: { + age: { + $ne: null, + }, + }, + }, +]) + +export default MyCustom +``` + +A property's value in `where` can be an object having a `$ne` property. `$ne`'s value indicates what the specified property's value shouldn't be. + +In the example above, the composite index is created on the `name` and `age` properties when `age`'s value is not `null`. + +### Unique Database Index + +The object passed to `indexes` accepts a `unique` property indicating that the created index must be a unique index. + +For example: + +```ts highlights={uniqueHighlights} +import { model } from "@medusajs/framework/utils" + +const MyCustom = model.define("my_custom", { + id: model.id().primaryKey(), + name: model.text(), + age: model.number(), +}).indexes([ + { + on: ["name", "age"], + unique: true, + }, +]) + +export default MyCustom +``` + +This creates a unique composite index on the `name` and `age` properties. + + +# Data Model’s Primary Key + +In this chapter, you’ll learn how to configure the primary key of a data model. + +## primaryKey Method + +To set any `id`, `text`, or `number` property as a primary key, use the `primaryKey` method. + +For example: + +```ts highlights={highlights} +import { model } from "@medusajs/framework/utils" + +const MyCustom = model.define("my_custom", { + id: model.id().primaryKey(), + // ... +}) + +export default MyCustom +``` + +In the example above, the `id` property is defined as the data model's primary key. + + +# Data Model Property Types + +In this chapter, you’ll learn about the types of properties in a data model’s schema. + +## id + +The `id` method defines an automatically generated string ID property. The generated ID is a unique string that has a mix of letters and numbers. + +For example: + +```ts highlights={idHighlights} +import { model } from "@medusajs/framework/utils" + +const MyCustom = model.define("my_custom", { + id: model.id(), + // ... +}) + +export default MyCustom +``` + +*** + +## text + +The `text` method defines a string property. + +For example: + +```ts highlights={textHighlights} +import { model } from "@medusajs/framework/utils" + +const MyCustom = model.define("my_custom", { + name: model.text(), + // ... +}) + +export default MyCustom +``` + +*** + +## number + +The `number` method defines a number property. + +For example: + +```ts highlights={numberHighlights} +import { model } from "@medusajs/framework/utils" + +const MyCustom = model.define("my_custom", { + age: model.number(), + // ... +}) + +export default MyCustom +``` + +*** + +## float + +This property is only available after [Medusa v2.1.2](https://github.com/medusajs/medusa/releases/tag/v2.1.2). + +The `float` method defines a number property that allows for values with decimal places. + +Use this property type when it's less important to have high precision for numbers with large decimal places. Alternatively, for higher percision, use the [bigNumber property](#bignumber). + +For example: + +```ts highlights={floatHighlights} +import { model } from "@medusajs/framework/utils" + +const MyCustom = model.define("my_custom", { + rating: model.float(), + // ... +}) + +export default MyCustom +``` + +*** + +## bigNumber + +The `bigNumber` method defines a number property that expects large numbers, such as prices. + +Use this property type when it's important to have high precision for numbers with large decimal places. Alternatively, for less percision, use the [float property](#float). + +For example: + +```ts highlights={bigNumberHighlights} +import { model } from "@medusajs/framework/utils" + +const MyCustom = model.define("my_custom", { + price: model.bigNumber(), + // ... +}) + +export default MyCustom +``` + +*** + +## boolean + +The `boolean` method defines a boolean property. + +For example: + +```ts highlights={booleanHighlights} +import { model } from "@medusajs/framework/utils" + +const MyCustom = model.define("my_custom", { + hasAccount: model.boolean(), + // ... +}) + +export default MyCustom +``` + +*** + +### enum + +The `enum` method defines a property whose value can only be one of the specified values. + +For example: + +```ts highlights={enumHighlights} +import { model } from "@medusajs/framework/utils" + +const MyCustom = model.define("my_custom", { + color: model.enum(["black", "white"]), + // ... +}) + +export default MyCustom +``` + +The `enum` method accepts an array of possible string values. + +*** + +## dateTime + +The `dateTime` method defines a timestamp property. + +For example: + +```ts highlights={dateTimeHighlights} +import { model } from "@medusajs/framework/utils" + +const MyCustom = model.define("my_custom", { + date_of_birth: model.dateTime(), + // ... +}) + +export default MyCustom +``` + +*** + +## json + +The `json` method defines a property whose value is a stringified JSON object. + +For example: + +```ts highlights={jsonHighlights} +import { model } from "@medusajs/framework/utils" + +const MyCustom = model.define("my_custom", { + metadata: model.json(), + // ... +}) + +export default MyCustom +``` + +*** + +## array + +The `array` method defines an array of strings property. + +For example: + +```ts highlights={arrHightlights} +import { model } from "@medusajs/framework/utils" + +const MyCustom = model.define("my_custom", { + names: model.array(), + // ... +}) + +export default MyCustom +``` + +*** + +## Properties Reference + +Refer to the [Data Model API reference](https://docs.medusajs.com/resources/references/data-model/index.html.md) for a full reference of the properties. + + +# Data Model Relationships + +In this chapter, you’ll learn how to define relationships between data models in your module. + +## What is a Relationship Property? + +A relationship property defines an association in the database between two models. It's created using the Data Model Language (DML) methods, such as `hasOne` or `belongsTo`. + +When you generate a migration for these data models, the migrations include foreign key columns or pivot tables, based on the relationship's type. + +You want to create a relation between data models in the same module. + +You want to create a relationship between data models in different modules. Use module links instead. + +*** + +## One-to-One Relationship + +A one-to-one relationship indicates that one record of a data model belongs to or is associated with another. + +To define a one-to-one relationship, create relationship properties in the data models using the following methods: + +1. `hasOne`: indicates that the model has one record of the specified model. +2. `belongsTo`: indicates that the model belongs to one record of the specified model. + +For example: + +```ts highlights={oneToOneHighlights} +import { model } from "@medusajs/framework/utils" + +const User = model.define("user", { + id: model.id().primaryKey(), + email: model.hasOne(() => Email), +}) + +const Email = model.define("email", { + id: model.id().primaryKey(), + user: model.belongsTo(() => User, { + mappedBy: "email", + }), +}) +``` + +In the example above, a user has one email, and an email belongs to one user. + +The `hasOne` and `belongsTo` methods accept a function as the first parameter. The function returns the associated data model. + +The `belongsTo` method also requires passing as a second parameter an object with the property `mappedBy`. Its value is the name of the relationship property in the other data model. + +### Optional Relationship + +To make the relationship optional on the `hasOne` or `belongsTo` side, use the `nullable` method on either property as explained in [this chapter](https://docs.medusajs.com/learn/fundamentals/data-models/configure-properties#nullable-property/index.html.md). + +### One-sided One-to-One Relationship + +If the one-to-one relationship is only defined on one side, pass `undefined` to the `mappedBy` property in the `belongsTo` method. + +For example: + +```ts highlights={oneToOneUndefinedHighlights} +import { model } from "@medusajs/framework/utils" + +const User = model.define("user", { + id: model.id().primaryKey(), +}) + +const Email = model.define("email", { + id: model.id().primaryKey(), + user: model.belongsTo(() => User, { + mappedBy: undefined, + }), +}) +``` + +### One-to-One Relationship in the Database + +When you generate the migrations of data models that have a one-to-one relationship, the migration adds to the table of the data model that has the `belongsTo` property: + +1. A column of the format `{relation_name}_id` to store the ID of the record of the related data model. For example, the `email` table will have a `user_id` column. +2. A foreign key on the `{relation_name}_id` column to the table of the related data model. + +![Diagram illustrating the relation between user and email records in the database](https://res.cloudinary.com/dza7lstvk/image/upload/v1726733492/Medusa%20Book/one-to-one_cj5np3.jpg) + +*** + +## One-to-Many Relationship + +A one-to-many relationship indicates that one record of a data model has many records of another data model. + +To define a one-to-many relationship, create relationship properties in the data models using the following methods: + +1. `hasMany`: indicates that the model has more than one record of the specified model. +2. `belongsTo`: indicates that the model belongs to one record of the specified model. + +For example: + +```ts highlights={oneToManyHighlights} +import { model } from "@medusajs/framework/utils" + +const Store = model.define("store", { + id: model.id().primaryKey(), + products: model.hasMany(() => Product), +}) + +const Product = model.define("product", { + id: model.id().primaryKey(), + store: model.belongsTo(() => Store, { + mappedBy: "products", + }), +}) +``` + +In this example, a store has many products, but a product belongs to one store. + +### Optional Relationship + +To make the relationship optional on the `belongsTo` side, use the `nullable` method on the property as explained in [this chapter](https://docs.medusajs.com/learn/fundamentals/data-models/configure-properties#nullable-property/index.html.md). + +### One-to-Many Relationship in the Database + +When you generate the migrations of data models that have a one-to-many relationship, the migration adds to the table of the data model that has the `belongsTo` property: + +1. A column of the format `{relation_name}_id` to store the ID of the record of the related data model. For example, the `product` table will have a `store_id` column. +2. A foreign key on the `{relation_name}_id` column to the table of the related data model. + +![Diagram illustrating the relation between a store and product records in the database](https://res.cloudinary.com/dza7lstvk/image/upload/v1726733937/Medusa%20Book/one-to-many_d6wtcw.jpg) + +*** + +## Many-to-Many Relationship + +A many-to-many relationship indicates that many records of a data model can be associated with many records of another data model. + +To define a many-to-many relationship, create relationship properties in the data models using the `manyToMany` method. + +For example: + +```ts highlights={manyToManyHighlights} +import { model } from "@medusajs/framework/utils" + +const Order = model.define("order", { + id: model.id().primaryKey(), + products: model.manyToMany(() => Product, { + mappedBy: "orders", + pivotTable: "order_product", + joinColumn: "order_id", + inverseJoinColumn: "product_id", + }), +}) + +const Product = model.define("product", { + id: model.id().primaryKey(), + orders: model.manyToMany(() => Order, { + mappedBy: "products", + }), +}) +``` + +The `manyToMany` method accepts two parameters: + +1. A function that returns the associated data model. +2. An object of optional configuration. Only one of the data models in the relation can define the `pivotTable`, `joinColumn`, and `inverseJoinColumn` configurations, and it's considered the owner data model. The object can accept the following properties: + - `mappedBy`: The name of the relationship property in the other data model. If not set, the property's name is inferred from the associated data model's name. + - `pivotTable`: The name of the pivot table created in the database for the many-to-many relation. If not set, the pivot table is inferred by combining the names of the data models' tables in alphabetical order, separating them by `_`, and pluralizing the last name. For example, `order_products`. + - `joinColumn`: The name of the column in the pivot table that points to the owner model's primary key. + - `inverseJoinColumn`: The name of the column in the pivot table that points to the owned model's primary key. + +The `pivotTable`, `joinColumn`, and `inverseJoinColumn` properties are only available after [Medusa v2.0.7](https://github.com/medusajs/medusa/releases/tag/v2.0.7). + +Following [Medusa v2.1.0](https://github.com/medusajs/medusa/releases/tag/v2.1.0), if `pivotTable`, `joinColumn`, and `inverseJoinColumn` aren't specified on either model, the owner is decided based on alphabetical order. So, in the example above, the `Order` data model would be the owner. + +In this example, an order is associated with many products, and a product is associated with many orders. Since the `pivotTable`, `joinColumn`, and `inverseJoinColumn` configurations are defined on the order, it's considered the owner data model. + +### Many-to-Many Relationship in the Database + +When you generate the migrations of data models that have a many-to-many relationship, the migration adds a new pivot table. Its name is either the name you specify in the `pivotTable` configuration or the inferred name combining the names of the data models' tables in alphabetical order, separating them by `_`, and pluralizing the last name. For example, `order_products`. + +The pivot table has a column with the name `{data_model}_id` for each of the data model's tables. It also has foreign keys on each of these columns to their respective tables. + +The pivot table has columns with foreign keys pointing to the primary key of the associated tables. The column's name is either: + +- The value of the `joinColumn` configuration for the owner table, and the `inverseJoinColumn` configuration for the owned table; +- Or the inferred name `{table_name}_id`. + +![Diagram illustrating the relation between order and product records in the database](https://res.cloudinary.com/dza7lstvk/image/upload/v1726734269/Medusa%20Book/many-to-many_fzy5pq.jpg) + +### Many-To-Many with Custom Columns + +To add custom columns to the pivot table between two data models having a many-to-many relationship, you must define a new data model that represents the pivot table. + +For example: + +```ts highlights={manyToManyColumnHighlights} +import { model } from "@medusajs/framework/utils" + +export const Order = model.define("order_test", { + id: model.id().primaryKey(), + products: model.manyToMany(() => Product, { + pivotEntity: () => OrderProduct, + }), +}) + +export const Product = model.define("product_test", { + id: model.id().primaryKey(), + orders: model.manyToMany(() => Order), +}) + +export const OrderProduct = model.define("orders_products", { + id: model.id().primaryKey(), + order: model.belongsTo(() => Order, { + mappedBy: "products", + }), + product: model.belongsTo(() => Product, { + mappedBy: "orders", + }), + metadata: model.json().nullable(), +}) +``` + +The `Order` and `Product` data models have a many-to-many relationship. To add extra columns to the created pivot table, you pass a `pivotEntity` option to the `products` relation in `Order` (since `Order` is the owner). The value of `pivotEntity` is a function that returns the data model representing the pivot table. + +The `OrderProduct` model defines, aside from the ID, the following properties: + +- `order`: A relation that indicates this model belongs to the `Order` data model. You set the `mappedBy` option to the many-to-many relation's name in the `Order` data model. +- `product`: A relation that indicates this model belongs to the `Product` data model. You set the `mappedBy` option to the many-to-many relation's name in the `Product` data model. +- `metadata`: An extra column to add to the pivot table of type `json`. You can add other columns as well to the model. + +*** + +## Set Relationship Name in the Other Model + +The relationship property methods accept as a second parameter an object of options. The `mappedBy` property defines the name of the relationship in the other data model. + +This is useful if the relationship property’s name is different from that of the associated data model. + +As seen in previous examples, the `mappedBy` option is required for the `belongsTo` method. + +For example: + +```ts highlights={relationNameHighlights} +import { model } from "@medusajs/framework/utils" + +const User = model.define("user", { + id: model.id().primaryKey(), + email: model.hasOne(() => Email, { + mappedBy: "owner", + }), +}) + +const Email = model.define("email", { + id: model.id().primaryKey(), + owner: model.belongsTo(() => User, { + mappedBy: "email", + }), +}) +``` + +In this example, you specify in the `User` data model’s relationship property that the name of the relationship in the `Email` data model is `owner`. + +*** + +## Cascades + +When an operation is performed on a data model, such as record deletion, the relationship cascade specifies what related data model records should be affected by it. + +For example, if a store is deleted, its products should also be deleted. + +The `cascades` method used on a data model configures which child records an operation is cascaded to. + +For example: + +```ts highlights={highlights} +import { model } from "@medusajs/framework/utils" + +const Store = model.define("store", { + id: model.id().primaryKey(), + products: model.hasMany(() => Product), +}) +.cascades({ + delete: ["products"], +}) + +const Product = model.define("product", { + id: model.id().primaryKey(), + store: model.belongsTo(() => Store, { + mappedBy: "products", + }), +}) +``` + +The `cascades` method accepts an object. Its key is the operation’s name, such as `delete`. The value is an array of relationship property names that the operation is cascaded to. + +In the example above, when a store is deleted, its associated products are also deleted. + + +# Searchable Data Model Property + +In this chapter, you'll learn what a searchable property is and how to define it. + +## What is a Searchable Property? + +Methods generated by the [service factory](https://docs.medusajs.com/learn/fundamentals/modules/service-factory/index.html.md) that accept filters, such as `list{ModelName}s`, accept a `q` property as part of the filters. + +When the `q` filter is passed, the data model's searchable properties are queried to find matching records. + +*** + +## Define a Searchable Property + +Use the `searchable` method on a `text` property to indicate that it's searchable. + +For example: + +```ts highlights={searchableHighlights} +import { model } from "@medusajs/framework/utils" + +const MyCustom = model.define("my_custom", { + name: model.text().searchable(), + // ... +}) + +export default MyCustom +``` + +In this example, the `name` property is searchable. + +### Search Example + +If you pass a `q` filter to the `listMyCustoms` method: + +```ts +const myCustoms = await helloModuleService.listMyCustoms({ + q: "John", +}) +``` + +This retrieves records that include `John` in their `name` property. + + +# Write Migration + +In this chapter, you'll learn how to create a migration and write it manually. + +## What is a Migration? + +A migration is a class created in a TypeScript or JavaScript file under a module's `migrations` directory. It has two methods: + +- The `up` method reflects changes on the database. +- The `down` method reverts the changes made in the `up` method. + +*** + +## How to Write a Migration? + +The Medusa CLI tool provides a [db:generate](https://docs.medusajs.com/resources/medusa-cli/commands/db#dbgenerate/index.html.md) command to generate a migration for the specified modules' data models. + +Alternatively, you can manually create a migration file under the `migrations` directory of your module. + +For example: + +```ts title="src/modules/hello/migrations/Migration20240429.ts" +import { Migration } from "@mikro-orm/migrations" + +export class Migration20240702105919 extends Migration { + + async up(): Promise { + this.addSql("create table if not exists \"my_custom\" (\"id\" text not null, \"name\" text not null, \"created_at\" timestamptz not null default now(), \"updated_at\" timestamptz not null default now(), \"deleted_at\" timestamptz null, constraint \"my_custom_pkey\" primary key (\"id\"));") + } + + async down(): Promise { + this.addSql("drop table if exists \"my_custom\" cascade;") + } + +} +``` + +The migration's file name should be of the format `Migration{YEAR}{MONTH}{DAY}.ts`. The migration class in the file extends the `Migration` class imported from `@mikro-orm/migrations`. + +In the `up` and `down` method of the migration class, you use the `addSql` method provided by MikroORM's `Migration` class to run PostgreSQL syntax. + +In the example above, the `up` method creates the table `my_custom`, and the `down` method drops the table if the migration is reverted. + +Refer to [MikroORM's documentation](https://mikro-orm.io/docs/migrations#migration-class) for more details on writing migrations. + +*** + +## Run the Migration + +To run your migration, run the following command: + +This command also syncs module links. If you don't want that, use the `--skip-links` option. + +```bash +npx medusa db:migrate +``` + +This reflects the changes in the database as implemented in the migration's `up` method. + +*** + +## Rollback the Migration + +To rollback or revert the last migration you ran for a module, run the following command: + +```bash +npx medusa db:rollback helloModuleService +``` + +This rolls back the last ran migration on the Hello Module. + +*** + +## More Database Commands + +To learn more about the Medusa CLI's database commands, refer to [this CLI reference](https://docs.medusajs.com/resources/medusa-cli/commands/db/index.html.md). # Seed Data with Custom CLI Script @@ -7840,371 +8946,366 @@ npx medusa exec ./src/scripts/demo-products.ts This seeds the products to your database. If you run your Medusa application and view the products in the dashboard, you'll find fifty new products. -# Link +# Event Data Payload -In this chapter, you’ll learn what Link is and how to use it to manage links. +In this chapter, you'll learn how subscribers receive an event's data payload. -As of [Medusa v2.2.0](https://github.com/medusajs/medusa/releases/tag/v2.2.0), Remote Link has been deprecated in favor of Link. They have the same usage, so you only need to change the key used to resolve the tool from the Medusa container as explained below. +## Access Event's Data Payload -## What is Link? +When events are emitted, they’re emitted with a data payload. -Link is a class with utility methods to manage links between data models. It’s registered in the Medusa container under the `link` registration name. +The object that the subscriber function receives as a parameter has an `event` property, which is an object holding the event payload in a `data` property with additional context. For example: -```ts collapsibleLines="1-9" expandButtonLabel="Show Imports" -import { - MedusaRequest, - MedusaResponse, -} from "@medusajs/framework/http" -import { - ContainerRegistrationKeys, -} from "@medusajs/framework/utils" +```ts title="src/subscribers/product-created.ts" highlights={highlights} collapsibleLines="1-5" expandButtonLabel="Show Imports" +import type { + SubscriberArgs, + SubscriberConfig, +} from "@medusajs/framework" -export async function POST( - req: MedusaRequest, - res: MedusaResponse -): Promise { - const link = req.scope.resolve( - ContainerRegistrationKeys.LINK - ) - - // ... +export default async function productCreateHandler({ + event, +}: SubscriberArgs<{ id: string }>) { + const productId = event.data.id + console.log(`The product ${productId} was created`) +} + +export const config: SubscriberConfig = { + event: "product.created", } ``` -You can use its methods to manage links, such as create or delete links. +The `event` object has the following properties: + +- data: (\`object\`) The data payload of the event. Its properties are different for each event. +- name: (string) The name of the triggered event. +- metadata: (\`object\`) Additional data and context of the emitted event. + +This logs the product ID received in the `product.created` event’s data payload to the console. + +{/* --- + +## List of Events with Data Payload + +Refer to [this reference](!resources!/events-reference) for a full list of events emitted by Medusa and their data payloads. */} + + +# Emit Workflow and Service Events + +In this chapter, you'll learn about event types and how to emit an event in a service or workflow. + +## Event Types + +In your customization, you can emit an event, then listen to it in a subscriber and perform an asynchronus action, such as send a notification or data to a third-party system. + +There are two types of events in Medusa: + +1. Workflow event: an event that's emitted in a workflow after a commerce feature is performed. For example, Medusa emits the `order.placed` event after a cart is completed. +2. Service event: an event that's emitted to track, trace, or debug processes under the hood. For example, you can emit an event with an audit trail. + +### Which Event Type to Use? + +**Workflow events** are the most common event type in development, as most custom features and customizations are built around workflows. + +Some examples of workflow events: + +1. When a user creates a blog post and you're emitting an event to send a newsletter email. +2. When you finish syncing products to a third-party system and you want to notify the admin user of new products added. +3. When a customer purchases a digital product and you want to generate and send it to them. + +You should only go for a **service event** if you're emitting an event for processes under the hood that don't directly affect front-facing features. + +Some examples of service events: + +1. When you're tracing data manipulation and changes, and you want to track every time some custom data is changed. +2. When you're syncing data with a search engine. *** -## Create Link +## Emit Event in a Workflow -To create a link between records of two data models, use the `create` method of Link. +To emit a workflow event, use the `emitEventStep` helper step provided in the `@medusajs/medusa/core-flows` package. For example: -```ts +```ts highlights={highlights} +import { + createWorkflow, +} from "@medusajs/framework/workflows-sdk" +import { + emitEventStep, +} from "@medusajs/medusa/core-flows" + +const helloWorldWorkflow = createWorkflow( + "hello-world", + () => { + // ... + + emitEventStep({ + eventName: "custom.created", + data: { + id: "123", + // other data payload + }, + }) + } +) +``` + +The `emitEventStep` accepts an object having the following properties: + +- `eventName`: The event's name. +- `data`: The data payload as an object. You can pass any properties in the object, and subscribers listening to the event will receive this data in the event's payload. + +In this example, you emit the event `custom.created` and pass in the data payload an ID property. + +### Test it Out + +If you execute the workflow, the event is emitted and you can see it in your application's logs. + +Any subscribers listening to the event are executed. + +*** + +## Emit Event in a Service + +To emit a service event: + +1. Resolve `event_bus` from the module's container in your service's constructor: + +### Extending Service Factory + +```ts title="src/modules/hello/service.ts" highlights={["9"]} +import { IEventBusService } from "@medusajs/framework/types" +import { MedusaService } from "@medusajs/framework/utils" + +class HelloModuleService extends MedusaService({ + MyCustom, +}){ + protected eventBusService_: AbstractEventBusModuleService + + constructor({ event_bus }) { + super(...arguments) + this.eventBusService_ = event_bus + } +} +``` + +### Without Service Factory + +```ts title="src/modules/hello/service.ts" highlights={["6"]} +import { IEventBusService } from "@medusajs/framework/types" + +class HelloModuleService { + protected eventBusService_: AbstractEventBusModuleService + + constructor({ event_bus }) { + this.eventBusService_ = event_bus + } +} +``` + +2. Use the event bus service's `emit` method in the service's methods to emit an event: + +```ts title="src/modules/hello/service.ts" highlights={serviceHighlights} +class HelloModuleService { + // ... + performAction() { + // TODO perform action + + this.eventBusService_.emit({ + name: "custom.event", + data: { + id: "123", + // other data payload + }, + }) + } +} +``` + +The method accepts an object having the following properties: + +- `name`: The event's name. +- `data`: The data payload as an object. You can pass any properties in the object, and subscribers listening to the event will receive this data in the event's payload. + +3. By default, the Event Module's service isn't injected into your module's container. To add it to the container, pass it in the module's registration object in `medusa-config.ts` in the `dependencies` property: + +```ts title="medusa-config.ts" highlights={depsHighlight} import { Modules } from "@medusajs/framework/utils" -// ... +module.exports = defineConfig({ + // ... + modules: [ + { + resolve: "./src/modules/hello", + dependencies: [ + Modules.EVENT_BUS, + ], + }, + ], +}) +``` +The `dependencies` property accepts an array of module registration keys. The specified modules' main services are injected into the module's container. + +That's how you can resolve it in your module's main service's constructor. + +### Test it Out + +If you execute the `performAction` method of your service, the event is emitted and you can see it in your application's logs. + +Any subscribers listening to the event are also executed. + + +# Add Columns to a Link + +In this chapter, you'll learn how to add custom columns to a link definition and manage them. + +## How to Add Custom Columns to a Link's Table? + +The `defineLink` function used to define a link accepts a third parameter, which is an object of options. + +To add custom columns to a link's table, pass in the third parameter of `defineLink` a `database` property: + +```ts highlights={linkHighlights} +import HelloModule from "../modules/hello" +import ProductModule from "@medusajs/medusa/product" +import { defineLink } from "@medusajs/framework/utils" + +export default defineLink( + ProductModule.linkable.product, + HelloModule.linkable.myCustom, + { + database: { + extraColumns: { + metadata: { + type: "json", + }, + }, + }, + } +) +``` + +This adds to the table created for the link between `product` and `myCustom` a `metadata` column of type `json`. + +### Database Options + +The `database` property defines configuration for the table created in the database. + +Its `extraColumns` property defines custom columns to create in the link's table. + +`extraColumns`'s value is an object whose keys are the names of the columns, and values are the column's configurations as an object. + +### Column Configurations + +The column's configurations object accepts the following properties: + +- `type`: The column's type. Possible values are: + - `string` + - `text` + - `integer` + - `boolean` + - `date` + - `time` + - `datetime` + - `enum` + - `json` + - `array` + - `enumArray` + - `float` + - `double` + - `decimal` + - `bigint` + - `mediumint` + - `smallint` + - `tinyint` + - `blob` + - `uuid` + - `uint8array` +- `defaultValue`: The column's default value. +- `nullable`: Whether the column can have `null` values. + +*** + +## Set Custom Column when Creating Link + +The object you pass to Link's `create` method accepts a `data` property. Its value is an object whose keys are custom column names, and values are the value of the custom column for this link. + +For example: + +Learn more about Link, how to resolve it, and its methods in [this chapter](https://docs.medusajs.com/learn/fundamentals/module-links/link/index.html.md). + +```ts await link.create({ [Modules.PRODUCT]: { - product_id: "prod_123", + product_id: "123", }, - "helloModuleService": { - my_custom_id: "mc_123", + HELLO_MODULE: { + my_custom_id: "321", + }, + data: { + metadata: { + test: true, + }, }, }) ``` -The `create` method accepts as a parameter an object. The object’s keys are the names of the linked modules. +*** -The keys (names of linked modules) must be in the same [direction](https://docs.medusajs.com/learn/fundamentals/module-links/directions/index.html.md) of the link definition. +## Retrieve Custom Column with Link -The value of each module’s property is an object, whose keys are of the format `{data_model_snake_name}_id`, and values are the IDs of the linked record. +To retrieve linked records with their custom columns, use [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query/index.html.md). A module link's definition, exported by a file under `src/links`, has a special `entryPoint` property. Use this property when specifying the `entity` property in Query's `graph` method. -So, in the example above, you link a record of the `MyCustom` data model in a `hello` module to a `Product` record in the Product Module. +For example: + +```ts highlights={retrieveHighlights} +import productHelloLink from "../links/product-hello" + +// ... + +const { data } = await query.graph({ + entity: productHelloLink.entryPoint, + fields: ["metadata", "product.*", "my_custom.*"], + filters: { + product_id: "prod_123", + }, +}) +``` + +This retrieves the product of id `prod_123` and its linked `my_custom` records. + +In the `fields` array you pass `metadata`, which is the custom column to retrieve of the link. *** -## Dismiss Link +## Update Custom Column's Value -To remove a link between records of two data models, use the `dismiss` method of Link. +Link's `create` method updates a link's data if the link between the specified records already exists. + +So, to update the value of a custom column in a created link, use the `create` method again passing it a new value for the custom column. For example: ```ts -import { Modules } from "@medusajs/framework/utils" - -// ... - -await link.dismiss({ +await link.create({ [Modules.PRODUCT]: { - product_id: "prod_123", + product_id: "123", }, - "helloModuleService": { - my_custom_id: "mc_123", + HELLO_MODULE: { + my_custom_id: "321", + }, + data: { + metadata: { + test: false, + }, }, }) ``` -The `dismiss` method accepts the same parameter type as the [create method](#create-link). - -The keys (names of linked modules) must be in the same [direction](https://docs.medusajs.com/learn/fundamentals/module-links/directions/index.html.md) of the link definition. - -*** - -## Cascade Delete Linked Records - -If a record is deleted, use the `delete` method of Link to delete all linked records. - -For example: - -```ts -import { Modules } from "@medusajs/framework/utils" - -// ... - -await productModuleService.deleteVariants([variant.id]) - -await link.delete({ - [Modules.PRODUCT]: { - product_id: "prod_123", - }, -}) -``` - -This deletes all records linked to the deleted product. - -*** - -## Restore Linked Records - -If a record that was previously soft-deleted is now restored, use the `restore` method of Link to restore all linked records. - -For example: - -```ts -import { Modules } from "@medusajs/framework/utils" - -// ... - -await productModuleService.restoreProducts(["prod_123"]) - -await link.restore({ - [Modules.PRODUCT]: { - product_id: "prod_123", - }, -}) -``` - - -# Query Context - -In this chapter, you'll learn how to pass contexts when retrieving data with [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query/index.html.md). - -## What is Query Context? - -Query context is a way to pass additional information when retrieving data with Query. This data can be useful when applying custom transformations to the retrieved data based on the current context. - -For example, consider you have a Blog Module with posts and authors. You can accept the user's language as a context and return the posts in the user's language. Another example is how Medusa uses Query Context to [retrieve product variants' prices based on the customer's currency](https://docs.medusajs.com/resources/commerce-modules/product/guides/price/index.html.md). - -*** - -## How to Use Query Context - -The `query.graph` method accepts an optional `context` parameter that can be used to pass additional context either to the data model you're retrieving (for example, `post`), or its related and linked models (for example, `author`). - -You initialize a context using `QueryContext` from the Modules SDK. It accepts an object of contexts as an argument. - -For example, to retrieve posts using Query while passing the user's language as a context: - -```ts -const { data } = await query.graph({ - entity: "post", - fields: ["*"], - context: QueryContext({ - lang: "es", - }), -}) -``` - -In this example, you pass in the context a `lang` property whose value is `es`. - -Then, to handle the context while retrieving records of the data model, in the associated module's service you override the generated `list` method of the data model. - -For example, continuing the example above, you can override the `listPosts` method of the Blog Module's service to handle the context: - -```ts highlights={highlights2} -import { MedusaContext, MedusaService } from "@medusajs/framework/utils" -import { Context, FindConfig } from "@medusajs/framework/types" -import Post from "./models/post" -import Author from "./models/author" - -class BlogModuleService extends MedusaService({ - Post, - Author, -}){ - // @ts-ignore - async listPosts( - filters?: any, - config?: FindConfig | undefined, - @MedusaContext() sharedContext?: Context | undefined - ) { - const context = filters.context ?? {} - delete filters.context - - let posts = await super.listPosts(filters, config, sharedContext) - - if (context.lang === "es") { - posts = posts.map((post) => { - return { - ...post, - title: post.title + " en español", - } - }) - } - - return posts - } -} - -export default BlogModuleService -``` - -In the above example, you override the generated `listPosts` method. This method receives as a first parameter the filters passed to the query, but it also includes a `context` property that holds the context passed to the query. - -You extract the context from `filters`, then retrieve the posts using the parent's `listPosts` method. After that, if the language is set in the context, you transform the titles of the posts. - -All posts returned will now have their titles appended with "en español". - -Learn more about the generated `list` method in [this reference](https://docs.medusajs.com/resources/service-factory-reference/methods/list/index.html.md). - -### Using Pagination with Query - -If you pass pagination fields to `query.graph`, you must also override the `listAndCount` method in the service. - -For example, following along with the previous example, you must override the `listAndCountPosts` method of the Blog Module's service: - -```ts -import { MedusaContext, MedusaService } from "@medusajs/framework/utils" -import { Context, FindConfig } from "@medusajs/framework/types" -import Post from "./models/post" -import Author from "./models/author" - -class BlogModuleService extends MedusaService({ - Post, - Author, -}){ - // @ts-ignore - async listAndCountPosts( - filters?: any, - config?: FindConfig | undefined, - @MedusaContext() sharedContext?: Context | undefined - ) { - const context = filters.context ?? {} - delete filters.context - - const result = await super.listAndCountPosts( - filters, - config, - sharedContext - ) - - if (context.lang === "es") { - result.posts = posts.map((post) => { - return { - ...post, - title: post.title + " en español", - } - }) - } - - return result - } -} - -export default BlogModuleService -``` - -Now, the `listAndCountPosts` method will handle the context passed to `query.graph` when you pass pagination fields. You can also move the logic to transform the posts' titles to a separate method and call it from both `listPosts` and `listAndCountPosts`. - -*** - -## Passing Query Context to Related Data Models - -If you're retrieving a data model and you want to pass context to its associated model in the same module, you can pass them as part of `QueryContext`'s parameter, then handle them in the same `list` method. - -For linked data models, check out the [next section](#passing-query-context-to-linked-data-models). - -For example, to pass a context for the post's authors: - -```ts highlights={highlights3} -const { data } = await query.graph({ - entity: "post", - fields: ["*"], - context: QueryContext({ - lang: "es", - author: QueryContext({ - lang: "es", - }), - }), -}) -``` - -Then, in the `listPosts` method, you can handle the context for the post's authors: - -```ts highlights={highlights4} -import { MedusaContext, MedusaService } from "@medusajs/framework/utils" -import { Context, FindConfig } from "@medusajs/framework/types" -import Post from "./models/post" -import Author from "./models/author" - -class BlogModuleService extends MedusaService({ - Post, - Author, -}){ - // @ts-ignore - async listPosts( - filters?: any, - config?: FindConfig | undefined, - @MedusaContext() sharedContext?: Context | undefined - ) { - const context = filters.context ?? {} - delete filters.context - - let posts = await super.listPosts(filters, config, sharedContext) - - const isPostLangEs = context.lang === "es" - const isAuthorLangEs = context.author?.lang === "es" - - if (isPostLangEs || isAuthorLangEs) { - posts = posts.map((post) => { - return { - ...post, - title: isPostLangEs ? post.title + " en español" : post.title, - author: { - ...post.author, - name: isAuthorLangEs ? post.author.name + " en español" : post.author.name, - }, - } - }) - } - - return posts - } -} - -export default BlogModuleService -``` - -The context in `filters` will also have the context for `author`, which you can use to make transformations to the post's authors. - -*** - -## Passing Query Context to Linked Data Models - -If you're retrieving a data model and you want to pass context to a linked model in a different module, pass to the `context` property an object instead, where its keys are the linked model's name and the values are the context for that linked model. - -For example, consider the Product Module's `Product` data model is linked to the Blog Module's `Post` data model. You can pass context to the `Post` data model while retrieving products like so: - -```ts highlights={highlights5} -const { data } = await query.graph({ - entity: "product", - fields: ["*", "post.*"], - context: { - post: QueryContext({ - lang: "es", - }), - }, -}) -``` - -In this example, you retrieve products and their associated posts. You also pass a context for `post`, indicating the customer's language. - -To handle the context, you override the generated `listPosts` method of the Blog Module as explained [previously](#how-to-use-query-context). - # Module Link Direction @@ -8619,3548 +9720,371 @@ Try passing one of the Query configuration parameters, like `fields` or `limit`, Learn more about [specifing fields and relations](https://docs.medusajs.com/api/store#select-fields-and-relations) and [pagination](https://docs.medusajs.com/api/store#pagination) in the API reference. -# Add Data Model Check Constraints +# Link -In this chapter, you'll learn how to add check constraints to your data model. +In this chapter, you’ll learn what Link is and how to use it to manage links. -## What is a Check Constraint? +As of [Medusa v2.2.0](https://github.com/medusajs/medusa/releases/tag/v2.2.0), Remote Link has been deprecated in favor of Link. They have the same usage, so you only need to change the key used to resolve the tool from the Medusa container as explained below. -A check constraint is a condition that must be satisfied by records inserted into a database table, otherwise an error is thrown. +## What is Link? -For example, if you have a data model with a `price` property, you want to only allow positive number values. So, you add a check constraint that fails when inserting a record with a negative price value. - -*** - -## How to Set a Check Constraint? - -To set check constraints on a data model, use the `checks` method. This method accepts an array of check constraints to apply on the data model. - -For example, to set a check constraint on a `price` property that ensures its value can only be a positive number: - -```ts highlights={checks1Highlights} -import { model } from "@medusajs/framework/utils" - -const CustomProduct = model.define("custom_product", { - // ... - price: model.bigNumber(), -}) -.checks([ - (columns) => `${columns.price} >= 0`, -]) -``` - -The item passed in the array parameter of `checks` can be a callback function that accepts as a parameter an object whose keys are the names of the properties in the data model schema, and values the respective column name in the database. - -The function returns a string indicating the [SQL check constraint expression](https://www.postgresql.org/docs/current/ddl-constraints.html#DDL-CONSTRAINTS-CHECK-CONSTRAINTS). In the expression, use the `columns` parameter to access a property's column name. - -You can also pass an object to the `checks` method: - -```ts highlights={checks2Highlights} -import { model } from "@medusajs/framework/utils" - -const CustomProduct = model.define("custom_product", { - // ... - price: model.bigNumber(), -}) -.checks([ - { - name: "custom_product_price_check", - expression: (columns) => `${columns.price} >= 0`, - }, -]) -``` - -The object accepts the following properties: - -- `name`: The check constraint's name. -- `expression`: A function similar to the one that can be passed to the array. It accepts an object of columns and returns an [SQL check constraint expression](https://www.postgresql.org/docs/current/ddl-constraints.html#DDL-CONSTRAINTS-CHECK-CONSTRAINTS). - -*** - -## Apply in Migrations - -After adding the check constraint, make sure to generate and run migrations if you already have the table in the database. Otherwise, the check constraint won't be reflected. - -To generate a migration for the data model's module then reflect it on the database, run the following command: - -```bash -npx medusa db:generate custom_module -npx medusa db:migrate -``` - -The first command generates the migration under the `migrations` directory of your module's directory, and the second reflects it on the database. - - -# Configure Data Model Properties - -In this chapter, you’ll learn how to configure data model properties. - -## Property’s Default Value - -Use the `default` method on a property's definition to specify the default value of a property. +Link is a class with utility methods to manage links between data models. It’s registered in the Medusa container under the `link` registration name. For example: -```ts highlights={defaultHighlights} -import { model } from "@medusajs/framework/utils" - -const MyCustom = model.define("my_custom", { - color: model - .enum(["black", "white"]) - .default("black"), - age: model - .number() - .default(0), - // ... -}) - -export default MyCustom -``` - -In this example, you set the default value of the `color` enum property to `black`, and that of the `age` number property to `0`. - -*** - -## Nullable Property - -Use the `nullable` method to indicate that a property’s value can be `null`. - -For example: - -```ts highlights={nullableHighlights} -import { model } from "@medusajs/framework/utils" - -const MyCustom = model.define("my_custom", { - price: model.bigNumber().nullable(), - // ... -}) - -export default MyCustom -``` - -*** - -## Unique Property - -The `unique` method indicates that a property’s value must be unique in the database through a unique index. - -For example: - -```ts highlights={uniqueHighlights} -import { model } from "@medusajs/framework/utils" - -const User = model.define("user", { - email: model.text().unique(), - // ... -}) - -export default User -``` - -In this example, multiple users can’t have the same email. - - -# Data Model Default Properties - -In this chapter, you'll learn about the properties available by default in your data model. - -When you create a data model, the following properties are created for you by Medusa: - -- `created_at`: A `dateTime` property that stores when a record of the data model was created. -- `updated_at`: A `dateTime` property that stores when a record of the data model was updated. -- `deleted_at`: A `dateTime` property that stores when a record of the data model was deleted. When you soft-delete a record, Medusa sets the `deleted_at` property to the current date. - - -# Infer Type of Data Model - -In this chapter, you'll learn how to infer the type of a data model. - -## How to Infer Type of Data Model? - -Consider you have a `MyCustom` data model. You can't reference this data model in a type, such as a workflow input or service method output types, since it's a variable. - -Instead, Medusa provides `InferTypeOf` that transforms your data model to a type. - -For example: - -```ts -import { InferTypeOf } from "@medusajs/framework/types" -import { MyCustom } from "../models/my-custom" // relative path to the model - -export type MyCustom = InferTypeOf -``` - -`InferTypeOf` accepts as a type argument the type of the data model. - -Since the `MyCustom` data model is a variable, use the `typeof` operator to pass the data model as a type argument to `InferTypeOf`. - -You can now use the `MyCustom` type to reference a data model in other types, such as in workflow inputs or service method outputs: - -```ts title="Example Service" -// other imports... -import { InferTypeOf } from "@medusajs/framework/types" -import { MyCustom } from "../models/my-custom" - -type MyCustom = InferTypeOf - -class HelloModuleService extends MedusaService({ MyCustom }) { - async doSomething(): Promise { - // ... - } -} -``` - - -# Data Model Database Index - -In this chapter, you’ll learn how to define a database index on a data model. - -## Define Database Index on Property - -Use the `index` method on a property's definition to define a database index. - -For example: - -```ts highlights={highlights} -import { model } from "@medusajs/framework/utils" - -const MyCustom = model.define("my_custom", { - id: model.id().primaryKey(), - name: model.text().index( - "IDX_MY_CUSTOM_NAME" - ), -}) - -export default MyCustom -``` - -The `index` method optionally accepts the name of the index as a parameter. - -In this example, you define an index on the `name` property. - -*** - -## Define Database Index on Data Model - -A data model has an `indexes` method that defines database indices on its properties. - -The index can be on multiple columns (composite index). For example: - -```ts highlights={dataModelIndexHighlights} -import { model } from "@medusajs/framework/utils" - -const MyCustom = model.define("my_custom", { - id: model.id().primaryKey(), - name: model.text(), - age: model.number(), -}).indexes([ - { - on: ["name", "age"], - }, -]) - -export default MyCustom -``` - -The `indexes` method receives an array of indices as a parameter. Each index is an object with a required `on` property indicating the properties to apply the index on. - -In the above example, you define a composite index on the `name` and `age` properties. - -### Index Conditions - -An index can have conditions. For example: - -```ts highlights={conditionHighlights} -import { model } from "@medusajs/framework/utils" - -const MyCustom = model.define("my_custom", { - id: model.id().primaryKey(), - name: model.text(), - age: model.number(), -}).indexes([ - { - on: ["name", "age"], - where: { - age: 30, - }, - }, -]) - -export default MyCustom -``` - -The index object passed to `indexes` accepts a `where` property whose value is an object of conditions. The object's key is a property's name, and its value is the condition on that property. - -In the example above, the composite index is created on the `name` and `age` properties when the `age`'s value is `30`. - -A property's condition can be a negation. For example: - -```ts highlights={negationHighlights} -import { model } from "@medusajs/framework/utils" - -const MyCustom = model.define("my_custom", { - id: model.id().primaryKey(), - name: model.text(), - age: model.number().nullable(), -}).indexes([ - { - on: ["name", "age"], - where: { - age: { - $ne: null, - }, - }, - }, -]) - -export default MyCustom -``` - -A property's value in `where` can be an object having a `$ne` property. `$ne`'s value indicates what the specified property's value shouldn't be. - -In the example above, the composite index is created on the `name` and `age` properties when `age`'s value is not `null`. - -### Unique Database Index - -The object passed to `indexes` accepts a `unique` property indicating that the created index must be a unique index. - -For example: - -```ts highlights={uniqueHighlights} -import { model } from "@medusajs/framework/utils" - -const MyCustom = model.define("my_custom", { - id: model.id().primaryKey(), - name: model.text(), - age: model.number(), -}).indexes([ - { - on: ["name", "age"], - unique: true, - }, -]) - -export default MyCustom -``` - -This creates a unique composite index on the `name` and `age` properties. - - -# Manage Relationships - -In this chapter, you'll learn how to manage relationships between data models when creating, updating, or retrieving records using the module's main service. - -## Manage One-to-One Relationship - -### BelongsTo Side of One-to-One - -When you create a record of a data model that belongs to another through a one-to-one relation, pass the ID of the other data model's record in the `{relation}_id` property, where `{relation}` is the name of the relation property. - -For example, assuming you have the [User and Email data models from the previous chapter](https://docs.medusajs.com/learn/fundamentals/data-models/relationships#one-to-one-relationship/index.html.md), set an email's user ID as follows: - -```ts highlights={belongsHighlights} -// when creating an email -const email = await helloModuleService.createEmails({ - // other properties... - user_id: "123", -}) - -// when updating an email -const email = await helloModuleService.updateEmails({ - id: "321", - // other properties... - user_id: "123", -}) -``` - -In the example above, you pass the `user_id` property when creating or updating an email to specify the user it belongs to. - -### HasOne Side - -When you create a record of a data model that has one of another, pass the ID of the other data model's record in the relation property. - -For example, assuming you have the [User and Email data models from the previous chapter](https://docs.medusajs.com/learn/fundamentals/data-models/relationships#one-to-one-relationship/index.html.md), set a user's email ID as follows: - -```ts highlights={hasOneHighlights} -// when creating a user -const user = await helloModuleService.createUsers({ - // other properties... - email: "123", -}) - -// when updating a user -const user = await helloModuleService.updateUsers({ - id: "321", - // other properties... - email: "123", -}) -``` - -In the example above, you pass the `email` property when creating or updating a user to specify the email it has. - -*** - -## Manage One-to-Many Relationship - -In a one-to-many relationship, you can only manage the associations from the `belongsTo` side. - -When you create a record of the data model on the `belongsTo` side, pass the ID of the other data model's record in the `{relation}_id` property, where `{relation}` is the name of the relation property. - -For example, assuming you have the [Product and Store data models from the previous chapter](https://docs.medusajs.com/learn/fundamentals/data-models/relationships#one-to-many-relationship/index.html.md), set a product's store ID as follows: - -```ts highlights={manyBelongsHighlights} -// when creating a product -const product = await helloModuleService.createProducts({ - // other properties... - store_id: "123", -}) - -// when updating a product -const product = await helloModuleService.updateProducts({ - id: "321", - // other properties... - store_id: "123", -}) -``` - -In the example above, you pass the `store_id` property when creating or updating a product to specify the store it belongs to. - -*** - -## Manage Many-to-Many Relationship - -If your many-to-many relation is represented with a [pivotEntity](https://docs.medusajs.com/learn/fundamentals/data-models/relationships#many-to-many-with-custom-columns/index.html.md), refer to [this section](#manage-many-to-many-relationship-with-pivotentity) instead. - -### Create Associations - -When you create a record of a data model that has a many-to-many relationship to another data model, pass an array of IDs of the other data model's records in the relation property. - -For example, assuming you have the [Order and Product data models from the previous chapter](https://docs.medusajs.com/learn/fundamentals/data-models/relationships#many-to-many-relationship/index.html.md), set the association between products and orders as follows: - -```ts highlights={manyHighlights} -// when creating a product -const product = await helloModuleService.createProducts({ - // other properties... - orders: ["123", "321"], -}) - -// when creating an order -const order = await helloModuleService.createOrders({ - id: "321", - // other properties... - products: ["123", "321"], -}) -``` - -In the example above, you pass the `orders` property when you create a product, and you pass the `products` property when you create an order. - -### Update Associations - -When you use the `update` methods generated by the service factory, you also pass an array of IDs as the relation property's value to add new associated records. - -However, this removes any existing associations to records whose IDs aren't included in the array. - -For example, assuming you have the [Order and Product data models from the previous chapter](https://docs.medusajs.com/learn/fundamentals/data-models/relationships#many-to-many-relationship/index.html.md), you update the product's related orders as so: - -```ts -const product = await helloModuleService.updateProducts({ - id: "123", - // other properties... - orders: ["321"], -}) -``` - -If the product was associated with an order, and you don't include that order's ID in the `orders` array, the association between the product and order is removed. - -So, to add a new association without removing existing ones, retrieve the product first to pass its associated orders when updating the product: - -```ts highlights={updateAssociationHighlights} -const product = await helloModuleService.retrieveProduct( - "123", - { - relations: ["orders"], - } -) - -const updatedProduct = await helloModuleService.updateProducts({ - id: product.id, - // other properties... - orders: [ - ...product.orders.map((order) => order.id), - "321", - ], -}) -``` - -This keeps existing associations between the product and orders, and adds a new one. - -*** - -## Manage Many-to-Many Relationship with pivotEntity - -If your many-to-many relation is represented without a [pivotEntity](https://docs.medusajs.com/learn/fundamentals/data-models/relationships#many-to-many-with-custom-columns/index.html.md), refer to [this section](#manage-many-to-many-relationship) instead. - -If you have a many-to-many relation with a `pivotEntity` specified, make sure to pass the data model representing the pivot table to [MedusaService](https://docs.medusajs.com/learn/fundamentals/modules/service-factory/index.html.md) that your module's service extends. - -For example, assuming you have the [Order, Product, and OrderProduct models from the previous chapter](https://docs.medusajs.com/learn/fundamentals/data-models/relationships#many-to-many-with-custom-columns/index.html.md), add `OrderProduct` to `MedusaService`'s object parameter: - -```ts highlights={["4"]} -class HelloModuleService extends MedusaService({ - Order, - Product, - OrderProduct, -}) {} -``` - -This will generate Create, Read, Update and Delete (CRUD) methods for the `OrderProduct` data model, which you can use to create relations between orders and products and manage the extra columns in the pivot table. - -For example: - -```ts -// create order-product association -const orderProduct = await helloModuleService.createOrderProducts({ - order_id: "123", - product_id: "123", - metadata: { - test: true, - }, -}) - -// update order-product association -const orderProduct = await helloModuleService.updateOrderProducts({ - id: "123", - metadata: { - test: false, - }, -}) - -// delete order-product association -await helloModuleService.deleteOrderProducts("123") -``` - -Since the `OrderProduct` data model belongs to the `Order` and `Product` data models, you can set its order and product as explained in the [one-to-many relationship section](#manage-one-to-many-relationship) using `order_id` and `product_id`. - -Refer to the [service factory reference](https://docs.medusajs.com/resources/service-factory-reference/index.html.md) for a full list of generated methods and their usages. - -*** - -## Retrieve Records of Relation - -The `list`, `listAndCount`, and `retrieve` methods of a module's main service accept as a second parameter an object of options. - -To retrieve the records associated with a data model's records through a relationship, pass in the second parameter object a `relations` property whose value is an array of relationship names. - -For example, assuming you have the [Order and Product data models from the previous chapter](https://docs.medusajs.com/learn/fundamentals/data-models/relationships#many-to-many-relationship/index.html.md), you retrieve a product's orders as follows: - -```ts highlights={retrieveHighlights} -const product = await helloModuleService.retrieveProducts( - "123", - { - relations: ["orders"], - } -) -``` - -In the example above, the retrieved product has an `orders` property, whose value is an array of orders associated with the product. - - -# Data Model’s Primary Key - -In this chapter, you’ll learn how to configure the primary key of a data model. - -## primaryKey Method - -To set any `id`, `text`, or `number` property as a primary key, use the `primaryKey` method. - -For example: - -```ts highlights={highlights} -import { model } from "@medusajs/framework/utils" - -const MyCustom = model.define("my_custom", { - id: model.id().primaryKey(), - // ... -}) - -export default MyCustom -``` - -In the example above, the `id` property is defined as the data model's primary key. - - -# Data Model Property Types - -In this chapter, you’ll learn about the types of properties in a data model’s schema. - -## id - -The `id` method defines an automatically generated string ID property. The generated ID is a unique string that has a mix of letters and numbers. - -For example: - -```ts highlights={idHighlights} -import { model } from "@medusajs/framework/utils" - -const MyCustom = model.define("my_custom", { - id: model.id(), - // ... -}) - -export default MyCustom -``` - -*** - -## text - -The `text` method defines a string property. - -For example: - -```ts highlights={textHighlights} -import { model } from "@medusajs/framework/utils" - -const MyCustom = model.define("my_custom", { - name: model.text(), - // ... -}) - -export default MyCustom -``` - -*** - -## number - -The `number` method defines a number property. - -For example: - -```ts highlights={numberHighlights} -import { model } from "@medusajs/framework/utils" - -const MyCustom = model.define("my_custom", { - age: model.number(), - // ... -}) - -export default MyCustom -``` - -*** - -## float - -This property is only available after [Medusa v2.1.2](https://github.com/medusajs/medusa/releases/tag/v2.1.2). - -The `float` method defines a number property that allows for values with decimal places. - -Use this property type when it's less important to have high precision for numbers with large decimal places. Alternatively, for higher percision, use the [bigNumber property](#bignumber). - -For example: - -```ts highlights={floatHighlights} -import { model } from "@medusajs/framework/utils" - -const MyCustom = model.define("my_custom", { - rating: model.float(), - // ... -}) - -export default MyCustom -``` - -*** - -## bigNumber - -The `bigNumber` method defines a number property that expects large numbers, such as prices. - -Use this property type when it's important to have high precision for numbers with large decimal places. Alternatively, for less percision, use the [float property](#float). - -For example: - -```ts highlights={bigNumberHighlights} -import { model } from "@medusajs/framework/utils" - -const MyCustom = model.define("my_custom", { - price: model.bigNumber(), - // ... -}) - -export default MyCustom -``` - -*** - -## boolean - -The `boolean` method defines a boolean property. - -For example: - -```ts highlights={booleanHighlights} -import { model } from "@medusajs/framework/utils" - -const MyCustom = model.define("my_custom", { - hasAccount: model.boolean(), - // ... -}) - -export default MyCustom -``` - -*** - -### enum - -The `enum` method defines a property whose value can only be one of the specified values. - -For example: - -```ts highlights={enumHighlights} -import { model } from "@medusajs/framework/utils" - -const MyCustom = model.define("my_custom", { - color: model.enum(["black", "white"]), - // ... -}) - -export default MyCustom -``` - -The `enum` method accepts an array of possible string values. - -*** - -## dateTime - -The `dateTime` method defines a timestamp property. - -For example: - -```ts highlights={dateTimeHighlights} -import { model } from "@medusajs/framework/utils" - -const MyCustom = model.define("my_custom", { - date_of_birth: model.dateTime(), - // ... -}) - -export default MyCustom -``` - -*** - -## json - -The `json` method defines a property whose value is a stringified JSON object. - -For example: - -```ts highlights={jsonHighlights} -import { model } from "@medusajs/framework/utils" - -const MyCustom = model.define("my_custom", { - metadata: model.json(), - // ... -}) - -export default MyCustom -``` - -*** - -## array - -The `array` method defines an array of strings property. - -For example: - -```ts highlights={arrHightlights} -import { model } from "@medusajs/framework/utils" - -const MyCustom = model.define("my_custom", { - names: model.array(), - // ... -}) - -export default MyCustom -``` - -*** - -## Properties Reference - -Refer to the [Data Model API reference](https://docs.medusajs.com/resources/references/data-model/index.html.md) for a full reference of the properties. - - -# Searchable Data Model Property - -In this chapter, you'll learn what a searchable property is and how to define it. - -## What is a Searchable Property? - -Methods generated by the [service factory](https://docs.medusajs.com/learn/fundamentals/modules/service-factory/index.html.md) that accept filters, such as `list{ModelName}s`, accept a `q` property as part of the filters. - -When the `q` filter is passed, the data model's searchable properties are queried to find matching records. - -*** - -## Define a Searchable Property - -Use the `searchable` method on a `text` property to indicate that it's searchable. - -For example: - -```ts highlights={searchableHighlights} -import { model } from "@medusajs/framework/utils" - -const MyCustom = model.define("my_custom", { - name: model.text().searchable(), - // ... -}) - -export default MyCustom -``` - -In this example, the `name` property is searchable. - -### Search Example - -If you pass a `q` filter to the `listMyCustoms` method: - -```ts -const myCustoms = await helloModuleService.listMyCustoms({ - q: "John", -}) -``` - -This retrieves records that include `John` in their `name` property. - - -# Data Model Relationships - -In this chapter, you’ll learn how to define relationships between data models in your module. - -## What is a Relationship Property? - -A relationship property defines an association in the database between two models. It's created using the Data Model Language (DML) methods, such as `hasOne` or `belongsTo`. - -When you generate a migration for these data models, the migrations include foreign key columns or pivot tables, based on the relationship's type. - -You want to create a relation between data models in the same module. - -You want to create a relationship between data models in different modules. Use module links instead. - -*** - -## One-to-One Relationship - -A one-to-one relationship indicates that one record of a data model belongs to or is associated with another. - -To define a one-to-one relationship, create relationship properties in the data models using the following methods: - -1. `hasOne`: indicates that the model has one record of the specified model. -2. `belongsTo`: indicates that the model belongs to one record of the specified model. - -For example: - -```ts highlights={oneToOneHighlights} -import { model } from "@medusajs/framework/utils" - -const User = model.define("user", { - id: model.id().primaryKey(), - email: model.hasOne(() => Email), -}) - -const Email = model.define("email", { - id: model.id().primaryKey(), - user: model.belongsTo(() => User, { - mappedBy: "email", - }), -}) -``` - -In the example above, a user has one email, and an email belongs to one user. - -The `hasOne` and `belongsTo` methods accept a function as the first parameter. The function returns the associated data model. - -The `belongsTo` method also requires passing as a second parameter an object with the property `mappedBy`. Its value is the name of the relationship property in the other data model. - -### Optional Relationship - -To make the relationship optional on the `hasOne` or `belongsTo` side, use the `nullable` method on either property as explained in [this chapter](https://docs.medusajs.com/learn/fundamentals/data-models/configure-properties#nullable-property/index.html.md). - -### One-sided One-to-One Relationship - -If the one-to-one relationship is only defined on one side, pass `undefined` to the `mappedBy` property in the `belongsTo` method. - -For example: - -```ts highlights={oneToOneUndefinedHighlights} -import { model } from "@medusajs/framework/utils" - -const User = model.define("user", { - id: model.id().primaryKey(), -}) - -const Email = model.define("email", { - id: model.id().primaryKey(), - user: model.belongsTo(() => User, { - mappedBy: undefined, - }), -}) -``` - -### One-to-One Relationship in the Database - -When you generate the migrations of data models that have a one-to-one relationship, the migration adds to the table of the data model that has the `belongsTo` property: - -1. A column of the format `{relation_name}_id` to store the ID of the record of the related data model. For example, the `email` table will have a `user_id` column. -2. A foreign key on the `{relation_name}_id` column to the table of the related data model. - -![Diagram illustrating the relation between user and email records in the database](https://res.cloudinary.com/dza7lstvk/image/upload/v1726733492/Medusa%20Book/one-to-one_cj5np3.jpg) - -*** - -## One-to-Many Relationship - -A one-to-many relationship indicates that one record of a data model has many records of another data model. - -To define a one-to-many relationship, create relationship properties in the data models using the following methods: - -1. `hasMany`: indicates that the model has more than one record of the specified model. -2. `belongsTo`: indicates that the model belongs to one record of the specified model. - -For example: - -```ts highlights={oneToManyHighlights} -import { model } from "@medusajs/framework/utils" - -const Store = model.define("store", { - id: model.id().primaryKey(), - products: model.hasMany(() => Product), -}) - -const Product = model.define("product", { - id: model.id().primaryKey(), - store: model.belongsTo(() => Store, { - mappedBy: "products", - }), -}) -``` - -In this example, a store has many products, but a product belongs to one store. - -### Optional Relationship - -To make the relationship optional on the `belongsTo` side, use the `nullable` method on the property as explained in [this chapter](https://docs.medusajs.com/learn/fundamentals/data-models/configure-properties#nullable-property/index.html.md). - -### One-to-Many Relationship in the Database - -When you generate the migrations of data models that have a one-to-many relationship, the migration adds to the table of the data model that has the `belongsTo` property: - -1. A column of the format `{relation_name}_id` to store the ID of the record of the related data model. For example, the `product` table will have a `store_id` column. -2. A foreign key on the `{relation_name}_id` column to the table of the related data model. - -![Diagram illustrating the relation between a store and product records in the database](https://res.cloudinary.com/dza7lstvk/image/upload/v1726733937/Medusa%20Book/one-to-many_d6wtcw.jpg) - -*** - -## Many-to-Many Relationship - -A many-to-many relationship indicates that many records of a data model can be associated with many records of another data model. - -To define a many-to-many relationship, create relationship properties in the data models using the `manyToMany` method. - -For example: - -```ts highlights={manyToManyHighlights} -import { model } from "@medusajs/framework/utils" - -const Order = model.define("order", { - id: model.id().primaryKey(), - products: model.manyToMany(() => Product, { - mappedBy: "orders", - pivotTable: "order_product", - joinColumn: "order_id", - inverseJoinColumn: "product_id", - }), -}) - -const Product = model.define("product", { - id: model.id().primaryKey(), - orders: model.manyToMany(() => Order, { - mappedBy: "products", - }), -}) -``` - -The `manyToMany` method accepts two parameters: - -1. A function that returns the associated data model. -2. An object of optional configuration. Only one of the data models in the relation can define the `pivotTable`, `joinColumn`, and `inverseJoinColumn` configurations, and it's considered the owner data model. The object can accept the following properties: - - `mappedBy`: The name of the relationship property in the other data model. If not set, the property's name is inferred from the associated data model's name. - - `pivotTable`: The name of the pivot table created in the database for the many-to-many relation. If not set, the pivot table is inferred by combining the names of the data models' tables in alphabetical order, separating them by `_`, and pluralizing the last name. For example, `order_products`. - - `joinColumn`: The name of the column in the pivot table that points to the owner model's primary key. - - `inverseJoinColumn`: The name of the column in the pivot table that points to the owned model's primary key. - -The `pivotTable`, `joinColumn`, and `inverseJoinColumn` properties are only available after [Medusa v2.0.7](https://github.com/medusajs/medusa/releases/tag/v2.0.7). - -Following [Medusa v2.1.0](https://github.com/medusajs/medusa/releases/tag/v2.1.0), if `pivotTable`, `joinColumn`, and `inverseJoinColumn` aren't specified on either model, the owner is decided based on alphabetical order. So, in the example above, the `Order` data model would be the owner. - -In this example, an order is associated with many products, and a product is associated with many orders. Since the `pivotTable`, `joinColumn`, and `inverseJoinColumn` configurations are defined on the order, it's considered the owner data model. - -### Many-to-Many Relationship in the Database - -When you generate the migrations of data models that have a many-to-many relationship, the migration adds a new pivot table. Its name is either the name you specify in the `pivotTable` configuration or the inferred name combining the names of the data models' tables in alphabetical order, separating them by `_`, and pluralizing the last name. For example, `order_products`. - -The pivot table has a column with the name `{data_model}_id` for each of the data model's tables. It also has foreign keys on each of these columns to their respective tables. - -The pivot table has columns with foreign keys pointing to the primary key of the associated tables. The column's name is either: - -- The value of the `joinColumn` configuration for the owner table, and the `inverseJoinColumn` configuration for the owned table; -- Or the inferred name `{table_name}_id`. - -![Diagram illustrating the relation between order and product records in the database](https://res.cloudinary.com/dza7lstvk/image/upload/v1726734269/Medusa%20Book/many-to-many_fzy5pq.jpg) - -### Many-To-Many with Custom Columns - -To add custom columns to the pivot table between two data models having a many-to-many relationship, you must define a new data model that represents the pivot table. - -For example: - -```ts highlights={manyToManyColumnHighlights} -import { model } from "@medusajs/framework/utils" - -export const Order = model.define("order_test", { - id: model.id().primaryKey(), - products: model.manyToMany(() => Product, { - pivotEntity: () => OrderProduct, - }), -}) - -export const Product = model.define("product_test", { - id: model.id().primaryKey(), - orders: model.manyToMany(() => Order), -}) - -export const OrderProduct = model.define("orders_products", { - id: model.id().primaryKey(), - order: model.belongsTo(() => Order, { - mappedBy: "products", - }), - product: model.belongsTo(() => Product, { - mappedBy: "orders", - }), - metadata: model.json().nullable(), -}) -``` - -The `Order` and `Product` data models have a many-to-many relationship. To add extra columns to the created pivot table, you pass a `pivotEntity` option to the `products` relation in `Order` (since `Order` is the owner). The value of `pivotEntity` is a function that returns the data model representing the pivot table. - -The `OrderProduct` model defines, aside from the ID, the following properties: - -- `order`: A relation that indicates this model belongs to the `Order` data model. You set the `mappedBy` option to the many-to-many relation's name in the `Order` data model. -- `product`: A relation that indicates this model belongs to the `Product` data model. You set the `mappedBy` option to the many-to-many relation's name in the `Product` data model. -- `metadata`: An extra column to add to the pivot table of type `json`. You can add other columns as well to the model. - -*** - -## Set Relationship Name in the Other Model - -The relationship property methods accept as a second parameter an object of options. The `mappedBy` property defines the name of the relationship in the other data model. - -This is useful if the relationship property’s name is different from that of the associated data model. - -As seen in previous examples, the `mappedBy` option is required for the `belongsTo` method. - -For example: - -```ts highlights={relationNameHighlights} -import { model } from "@medusajs/framework/utils" - -const User = model.define("user", { - id: model.id().primaryKey(), - email: model.hasOne(() => Email, { - mappedBy: "owner", - }), -}) - -const Email = model.define("email", { - id: model.id().primaryKey(), - owner: model.belongsTo(() => User, { - mappedBy: "email", - }), -}) -``` - -In this example, you specify in the `User` data model’s relationship property that the name of the relationship in the `Email` data model is `owner`. - -*** - -## Cascades - -When an operation is performed on a data model, such as record deletion, the relationship cascade specifies what related data model records should be affected by it. - -For example, if a store is deleted, its products should also be deleted. - -The `cascades` method used on a data model configures which child records an operation is cascaded to. - -For example: - -```ts highlights={highlights} -import { model } from "@medusajs/framework/utils" - -const Store = model.define("store", { - id: model.id().primaryKey(), - products: model.hasMany(() => Product), -}) -.cascades({ - delete: ["products"], -}) - -const Product = model.define("product", { - id: model.id().primaryKey(), - store: model.belongsTo(() => Store, { - mappedBy: "products", - }), -}) -``` - -The `cascades` method accepts an object. Its key is the operation’s name, such as `delete`. The value is an array of relationship property names that the operation is cascaded to. - -In the example above, when a store is deleted, its associated products are also deleted. - - -# Write Migration - -In this chapter, you'll learn how to create a migration and write it manually. - -## What is a Migration? - -A migration is a class created in a TypeScript or JavaScript file under a module's `migrations` directory. It has two methods: - -- The `up` method reflects changes on the database. -- The `down` method reverts the changes made in the `up` method. - -*** - -## How to Write a Migration? - -The Medusa CLI tool provides a [db:generate](https://docs.medusajs.com/resources/medusa-cli/commands/db#dbgenerate/index.html.md) command to generate a migration for the specified modules' data models. - -Alternatively, you can manually create a migration file under the `migrations` directory of your module. - -For example: - -```ts title="src/modules/hello/migrations/Migration20240429.ts" -import { Migration } from "@mikro-orm/migrations" - -export class Migration20240702105919 extends Migration { - - async up(): Promise { - this.addSql("create table if not exists \"my_custom\" (\"id\" text not null, \"name\" text not null, \"created_at\" timestamptz not null default now(), \"updated_at\" timestamptz not null default now(), \"deleted_at\" timestamptz null, constraint \"my_custom_pkey\" primary key (\"id\"));") - } - - async down(): Promise { - this.addSql("drop table if exists \"my_custom\" cascade;") - } - -} -``` - -The migration's file name should be of the format `Migration{YEAR}{MONTH}{DAY}.ts`. The migration class in the file extends the `Migration` class imported from `@mikro-orm/migrations`. - -In the `up` and `down` method of the migration class, you use the `addSql` method provided by MikroORM's `Migration` class to run PostgreSQL syntax. - -In the example above, the `up` method creates the table `my_custom`, and the `down` method drops the table if the migration is reverted. - -Refer to [MikroORM's documentation](https://mikro-orm.io/docs/migrations#migration-class) for more details on writing migrations. - -*** - -## Run the Migration - -To run your migration, run the following command: - -This command also syncs module links. If you don't want that, use the `--skip-links` option. - -```bash -npx medusa db:migrate -``` - -This reflects the changes in the database as implemented in the migration's `up` method. - -*** - -## Rollback the Migration - -To rollback or revert the last migration you ran for a module, run the following command: - -```bash -npx medusa db:rollback helloModuleService -``` - -This rolls back the last ran migration on the Hello Module. - -*** - -## More Database Commands - -To learn more about the Medusa CLI's database commands, refer to [this CLI reference](https://docs.medusajs.com/resources/medusa-cli/commands/db/index.html.md). - - -# Create a Plugin - -In this chapter, you'll learn how to create a Medusa plugin and publish it. - -A [plugin](https://docs.medusajs.com/learn/fundamentals/plugins/index.html.md) is a package of reusable Medusa customizations that you can install in any Medusa application. By creating and publishing a plugin, you can reuse your Medusa customizations across multiple projects or share them with the community. - -Plugins are available starting from [Medusa v2.3.0](https://github.com/medusajs/medusa/releases/tag/v2.3.0). - -## 1. Create a Plugin Project - -Plugins are created in a separate Medusa project. This makes the development and publishing of the plugin easier. Later, you'll install that plugin in your Medusa application to test it out and use it. - -Medusa's `create-medusa-app` CLI tool provides the option to create a plugin project. Run the following command to create a new plugin project: - -```bash -npx create-medusa-app my-plugin --plugin -``` - -This will create a new Medusa plugin project in the `my-plugin` directory. - -### Plugin Directory Structure - -After the installation is done, the plugin structure will look like this: - -![Directory structure of a plugin project](https://res.cloudinary.com/dza7lstvk/image/upload/v1737019441/Medusa%20Book/project-dir_q4xtri.jpg) - -- `src/`: Contains the Medusa customizations. -- `src/admin`: Contains [admin extensions](https://docs.medusajs.com/learn/fundamentals/admin/index.html.md). -- `src/api`: Contains [API routes](https://docs.medusajs.com/learn/fundamentals/api-routes/index.html.md) and [middlewares](https://docs.medusajs.com/learn/fundamentals/api-routes/middlewares/index.html.md). You can add store, admin, or any custom API routes. -- `src/jobs`: Contains [scheduled jobs](https://docs.medusajs.com/learn/fundamentals/scheduled-jobs/index.html.md). -- `src/links`: Contains [module links](https://docs.medusajs.com/learn/fundamentals/module-links/index.html.md). -- `src/modules`: Contains [modules](https://docs.medusajs.com/learn/fundamentals/modules/index.html.md). -- `src/provider`: Contains [module providers](#create-module-providers). -- `src/subscribers`: Contains [subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers/index.html.md). -- `src/workflows`: Contains [workflows](https://docs.medusajs.com/learn/fundamentals/workflows/index.html.md). You can also add [hooks](https://docs.medusajs.com/learn/fundamentals/workflows/add-workflow-hook/index.html.md) under `src/workflows/hooks`. -- `package.json`: Contains the plugin's package information, including general information and dependencies. -- `tsconfig.json`: Contains the TypeScript configuration for the plugin. - -*** - -## 2. Prepare Plugin - -### Package Name - -Before developing, testing, and publishing your plugin, make sure its name in `package.json` is correct. This is the name you'll use to install the plugin in your Medusa application. - -For example: - -```json title="package.json" -{ - "name": "@myorg/plugin-name", - // ... -} -``` - -### Package Keywords - -In addition, make sure that the `keywords` field in `package.json` includes the keyword `medusa-plugin` and `medusa-v2`. This helps Medusa list community plugins on the Medusa website: - -```json title="package.json" -{ - "keywords": [ - "medusa-plugin", - "medusa-v2" - ], - // ... -} -``` - -### Package Dependencies - -Your plugin project will already have the dependencies mentioned in this section. If you haven't made any changes to the dependencies, you can skip this section. - -In the `package.json` file you must have the Medusa dependencies as `devDependencies` and `peerDependencies`. In addition, you must have `@swc/core` as a `devDependency`, as it's used by the plugin CLI tools. - -For example, assuming `2.5.0` is the latest Medusa version: - -```json title="package.json" -{ - "devDependencies": { - "@medusajs/admin-sdk": "2.5.0", - "@medusajs/cli": "2.5.0", - "@medusajs/framework": "2.5.0", - "@medusajs/medusa": "2.5.0", - "@medusajs/test-utils": "2.5.0", - "@medusajs/ui": "4.0.4", - "@medusajs/icons": "2.5.0", - "@swc/core": "1.5.7", - }, - "peerDependencies": { - "@medusajs/admin-sdk": "2.5.0", - "@medusajs/cli": "2.5.0", - "@medusajs/framework": "2.5.0", - "@medusajs/test-utils": "2.5.0", - "@medusajs/medusa": "2.5.0", - "@medusajs/ui": "4.0.3", - "@medusajs/icons": "2.5.0", - } -} -``` - -*** - -## 3. Publish Plugin Locally for Development and Testing - -Medusa's CLI tool provides commands to simplify developing and testing your plugin in a local Medusa application. You start by publishing your plugin in the local package registry, then install it in your Medusa application. You can then watch for changes in the plugin as you develop it. - -### Publish and Install Local Package - -### Prerequisites - -- [Medusa application installed.](https://docs.medusajs.com/learn/installation/index.html.md) - -The first time you create your plugin, you need to publish the package into a local package registry, then install it in your Medusa application. This is a one-time only process. - -To publish the plugin to the local registry, run the following command in your plugin project: - -```bash title="Plugin project" -npx medusa plugin:publish -``` - -This command uses [Yalc](https://github.com/wclr/yalc) under the hood to publish the plugin to a local package registry. The plugin is published locally under the name you specified in `package.json`. - -Next, navigate to your Medusa application: - -```bash title="Medusa application" -cd ~/path/to/medusa-app -``` - -Make sure to replace `~/path/to/medusa-app` with the path to your Medusa application. - -Then, if your project was created before v2.3.1 of Medusa, make sure to install `yalc` as a development dependency: - -```bash npm2yarn title="Medusa application" -npm install --save-dev yalc -``` - -After that, run the following Medusa CLI command to install the plugin: - -```bash title="Medusa application" -npx medusa plugin:add @myorg/plugin-name -``` - -Make sure to replace `@myorg/plugin-name` with the name of your plugin as specified in `package.json`. Your plugin will be installed from the local package registry into your Medusa application. - -### Register Plugin in Medusa Application - -After installing the plugin, you need to register it in your Medusa application in the configurations defined in `medusa-config.ts`. - -Add the plugin to the `plugins` array in the `medusa-config.ts` file: - -```ts title="medusa-config.ts" highlights={pluginHighlights} -module.exports = defineConfig({ - // ... - plugins: [ - { - resolve: "@myorg/plugin-name", - options: {}, - }, - ], -}) -``` - -The `plugins` configuration is an array of objects where each object has a `resolve` key whose value is the name of the plugin package. - -#### Pass Module Options through Plugin - -Each plugin configuration also accepts an `options` property, whose value is an object of options to pass to the plugin's modules. - -For example: - -```ts title="medusa-config.ts" highlights={pluginOptionsHighlight} -module.exports = defineConfig({ - // ... - plugins: [ - { - resolve: "@myorg/plugin-name", - options: { - apiKey: true, - }, - }, - ], -}) -``` - -The `options` property in the plugin configuration is passed to all modules in the plugin. Learn more about module options in [this chapter](https://docs.medusajs.com/learn/fundamentals/modules/options/index.html.md). - -### Watch Plugin Changes During Development - -While developing your plugin, you can watch for changes in the plugin and automatically update the plugin in the Medusa application using it. This is the only command you'll continuously need during your plugin development. - -To do that, run the following command in your plugin project: - -```bash title="Plugin project" -npx medusa plugin:develop -``` - -This command will: - -- Watch for changes in the plugin. Whenever a file is changed, the plugin is automatically built. -- Publish the plugin changes to the local package registry. This will automatically update the plugin in the Medusa application using it. You can also benefit from real-time HMR updates of admin extensions. - -### Start Medusa Application - -You can start your Medusa application's development server to test out your plugin: - -```bash npm2yarn title="Medusa application" -npm run dev -``` - -While your Medusa application is running and the plugin is being watched, you can test your plugin while developing it in the Medusa application. - -*** - -## 4. Create Customizations in the Plugin - -You can now build your plugin's customizations. The following guide explains how to build different customizations in your plugin. - -- [Create a module](https://docs.medusajs.com/learn/fundamentals/modules/index.html.md) -- [Create a module link](https://docs.medusajs.com/learn/fundamentals/module-links/index.html.md) -- [Create a workflow](https://docs.medusajs.com/learn/fundamentals/workflows/index.html.md) -- [Add a workflow hook](https://docs.medusajs.com/learn/fundamentals/workflows/add-workflow-hook/index.html.md) -- [Create an API route](https://docs.medusajs.com/learn/fundamentals/api-routes/index.html.md) -- [Add a subscriber](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers/index.html.md) -- [Add a scheduled job](https://docs.medusajs.com/learn/fundamentals/scheduled-jobs/index.html.md) -- [Add an admin widget](https://docs.medusajs.com/learn/fundamentals/admin/widgets/index.html.md) -- [Add an admin UI route](https://docs.medusajs.com/learn/fundamentals/admin/ui-routes/index.html.md) - -While building those customizations, you can test them in your Medusa application by [watching the plugin changes](#watch-plugin-changes-during-development) and [starting the Medusa application](#start-medusa-application). - -### Generating Migrations for Modules - -During your development, you may need to generate migrations for modules in your plugin. To do that, use the `plugin:db:generate` command: - -```bash title="Plugin project" -npx medusa plugin:db:generate -``` - -This command generates migrations for all modules in the plugin. You can then run these migrations on the Medusa application that the plugin is installed in using the `db:migrate` command: - -```bash title="Medusa application" -npx medusa db:migrate -``` - -### Importing Module Resources - -Your plugin project should have the following exports in `package.json`: - -```json title="package.json" -{ - "exports": { - "./package.json": "./package.json", - "./workflows": "./.medusa/server/src/workflows/index.js", - "./.medusa/server/src/modules/*": "./.medusa/server/src/modules/*/index.js", - "./providers/*": "./.medusa/server/src/providers/*/index.js", - "./*": "./.medusa/server/src/*.js" - } -} -``` - -Aside from the `./package.json` and `./providers`, these exports are only a recommendation. You can cherry-pick the files and directories you want to export. - -The plugin exports the following files and directories: - -- `./package.json`: The package.json file. Medusa needs to access the `package.json` when registering the plugin. -- `./workflows`: The workflows exported in `./src/workflows/index.ts`. -- `./.medusa/server/src/modules/*`: The definition file of modules. This is useful if you create links to the plugin's modules in the Medusa application. -- `./providers/*`: The definition file of module providers. This allows you to register the plugin's providers in the Medusa application. -- `./*`: Any other files in the plugin's `src` directory. - -With these exports, you can import the plugin's resources in the Medusa application's code like this: - -`@myorg/plugin-name` is the plugin package's name. - -```ts -import { Workflow1, Workflow2 } from "@myorg/plugin-name/workflows" -import BlogModule from "@myorg/plugin-name/modules/blog" -// import other files created in plugin like ./src/types/blog.ts -import BlogType from "@myorg/plugin-name/types/blog" -``` - -And you can register a module provider in the Medusa application's `medusa-config.ts` like this: - -```ts highlights={[["9"]]} title="medusa-config.ts" -module.exports = defineConfig({ - // ... - modules: [ - { - resolve: "@medusajs/medusa/notification", - options: { - providers: [ - { - resolve: "@myorg/plugin-name/providers/my-notification", - id: "my-notification", - options: { - channels: ["email"], - // provider options... - }, - }, - ], - }, - }, - ], -}) -``` - -You pass to `resolve` the path to the provider relative to the plugin package. So, in this example, the `my-notification` provider is located in `./src/providers/my-notification/index.ts` of the plugin. - -### Create Module Providers - -To learn how to create module providers, refer to the following guides: - -- [File Module Provider](https://docs.medusajs.com/resources/references/file-provider-module/index.html.md) -- [Notification Module Provider](https://docs.medusajs.com/resources/references/notification-provider-module/index.html.md) -- [Auth Module Provider](https://docs.medusajs.com/resources/references/auth/provider/index.html.md) -- [Payment Module Provider](https://docs.medusajs.com/resources/references/payment/provider/index.html.md) -- [Fulfillment Module Provider](https://docs.medusajs.com/resources/references/fulfillment/provider/index.html.md) -- [Tax Module Provider](https://docs.medusajs.com/resources/references/tax/provider/index.html.md) - -*** - -## 5. Publish Plugin to NPM - -Medusa's CLI tool provides a command that bundles your plugin to be published to npm. Once you're ready to publish your plugin publicly, run the following command in your plugin project: - -```bash -npx medusa plugin:build -``` - -The command will compile an output in the `.medusa/server` directory. - -You can now publish the plugin to npm using the [NPM CLI tool](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm). Run the following command to publish the plugin to npm: - -```bash -npm publish -``` - -If you haven't logged in before with your NPM account, you'll be asked to log in first. Then, your package is published publicly to be used in any Medusa application. - -### Install Public Plugin in Medusa Application - -You install a plugin that's published publicly using your package manager. For example: - -```bash npm2yarn -npm install @myorg/plugin-name -``` - -Where `@myorg/plugin-name` is the name of your plugin as published on NPM. - -Then, register the plugin in your Medusa application's configurations as explained in [this section](#register-plugin-in-medusa-application). - -*** - -## Update a Published Plugin - -To update the Medusa dependencies in a plugin, refer to [this documentation](https://docs.medusajs.com/learn/update#update-plugin-project/index.html.md). - -If you've published a plugin and you've made changes to it, you'll have to publish the update to NPM again. - -First, run the following command to change the version of the plugin: - -```bash -npm version -``` - -Where `` indicates the type of version update you’re publishing. For example, it can be `major` or `minor`. Refer to the [npm version documentation](https://docs.npmjs.com/cli/v10/commands/npm-version) for more information. - -Then, re-run the same commands for publishing a plugin: - -```bash -npx medusa plugin:build -npm publish -``` - -This will publish an updated version of your plugin under a new version. - - -# Access Workflow Errors - -In this chapter, you’ll learn how to access errors that occur during a workflow’s execution. - -## How to Access Workflow Errors? - -By default, when an error occurs in a workflow, it throws that error, and the execution stops. - -You can configure the workflow to return the errors instead so that you can access and handle them differently. - -For example: - -```ts title="src/api/workflows/route.ts" highlights={highlights} collapsibleLines="1-6" expandButtonLabel="Show Imports" -import type { - MedusaRequest, +```ts collapsibleLines="1-9" expandButtonLabel="Show Imports" +import { + MedusaRequest, MedusaResponse, } from "@medusajs/framework/http" -import myWorkflow from "../../../workflows/hello-world" +import { + ContainerRegistrationKeys, +} from "@medusajs/framework/utils" -export async function GET( +export async function POST( req: MedusaRequest, res: MedusaResponse -) { - const { result, errors } = await myWorkflow(req.scope) - .run({ - // ... - throwOnError: false, - }) - - if (errors.length) { - return res.send({ - errors: errors.map((error) => error.error), - }) - } - - res.send(result) -} - -``` - -The object passed to the `run` method accepts a `throwOnError` property. When disabled, the errors are returned in the `errors` property of `run`'s output. - -The value of `errors` is an array of error objects. Each object has an `error` property, whose value is the name or text of the thrown error. - - -# Scheduled Jobs Number of Executions - -In this chapter, you'll learn how to set a limit on the number of times a scheduled job is executed. - -## numberOfExecutions Option - -The export configuration object of the scheduled job accepts an optional property `numberOfExecutions`. Its value is a number indicating how many times the scheduled job can be executed during the Medusa application's runtime. - -For example: - -```ts highlights={highlights} -export default async function myCustomJob() { - console.log("I'll be executed three times only.") -} - -export const config = { - name: "hello-world", - // execute every minute - schedule: "* * * * *", - numberOfExecutions: 3, -} -``` - -The above scheduled job has the `numberOfExecutions` configuration set to `3`. - -So, it'll only execute 3 times, each every minute, then it won't be executed anymore. - -If you restart the Medusa application, the scheduled job will be executed again until reaching the number of executions specified. - - -# Expose a Workflow Hook - -In this chapter, you'll learn how to expose a hook in your workflow. - -## When to Expose a Hook - -Your workflow is reusable in other applications, and you allow performing an external action at some point in your workflow. - -Your workflow isn't reusable by other applications. Use a step that performs what a hook handler would instead. - -*** - -## How to Expose a Hook in a Workflow? - -To expose a hook in your workflow, use `createHook` from the Workflows SDK. - -For example: - -```ts title="src/workflows/my-workflow/index.ts" highlights={hookHighlights} -import { - createStep, - createHook, - createWorkflow, - WorkflowResponse, -} from "@medusajs/framework/workflows-sdk" -import { createProductStep } from "./steps/create-product" - -export const myWorkflow = createWorkflow( - "my-workflow", - function (input) { - const product = createProductStep(input) - const productCreatedHook = createHook( - "productCreated", - { productId: product.id } - ) - - return new WorkflowResponse(product, { - hooks: [productCreatedHook], - }) - } -) -``` - -The `createHook` function accepts two parameters: - -1. The first is a string indicating the hook's name. You use this to consume the hook later. -2. The second is the input to pass to the hook handler. - -The workflow must also pass an object having a `hooks` property as a second parameter to the `WorkflowResponse` constructor. Its value is an array of the workflow's hooks. - -### How to Consume the Hook? - -To consume the hook of the workflow, create the file `src/workflows/hooks/my-workflow.ts` with the following content: - -```ts title="src/workflows/hooks/my-workflow.ts" highlights={handlerHighlights} -import { myWorkflow } from "../my-workflow" - -myWorkflow.hooks.productCreated( - async ({ productId }, { container }) => { - // TODO perform an action - } -) -``` - -The hook is available on the workflow's `hooks` property using its name `productCreated`. - -You invoke the hook, passing a step function (the hook handler) as a parameter. - - -# Workflow Constraints - -This chapter lists constraints of defining a workflow or its steps. - -Medusa creates an internal representation of the workflow definition you pass to `createWorkflow` to track and store its steps. At that point, variables in the workflow don't have any values. They only do when you execute the workflow. - -This creates restrictions related to variable manipulations, using if-conditions, and other constraints. This chapter lists these constraints and provides their alternatives. - -## Workflow Constraints - -### No Async Functions - -The function passed to `createWorkflow` can’t be an async function: - -```ts highlights={[["4", "async", "Function can't be async."], ["11", "", "Correct way of defining the function."]]} -// Don't -const myWorkflow = createWorkflow( - "hello-world", - async function (input: WorkflowInput) { - // ... -}) - -// Do -const myWorkflow = createWorkflow( - "hello-world", - function (input: WorkflowInput) { - // ... -}) -``` - -### No Direct Variable Manipulation - -You can’t directly manipulate variables within the workflow's constructor function. - -Learn more about why you can't manipulate variables [in this chapter](https://docs.medusajs.com/learn/fundamentals/workflows/variable-manipulation/index.html.md) - -Instead, use `transform` from the Workflows SDK: - -```ts highlights={highlights} -// Don't -const myWorkflow = createWorkflow( - "hello-world", - function (input: WorkflowInput) { - const str1 = step1(input) - const str2 = step2(input) - - return new WorkflowResponse({ - message: `${str1}${str2}`, - }) -}) - -// Do -const myWorkflow = createWorkflow( - "hello-world", - function (input: WorkflowInput) { - const str1 = step1(input) - const str2 = step2(input) - - const result = transform( - { - str1, - str2, - }, - (input) => ({ - message: `${input.str1}${input.str2}`, - }) +): Promise { + const link = req.scope.resolve( + ContainerRegistrationKeys.LINK ) - - return new WorkflowResponse(result) -}) -``` - -### Create Dates in transform - -When you use `new Date()` in a workflow's constructor function, the date is evaluated when Medusa creates the internal representation of the workflow, not during execution. - -Instead, create the date using `transform`. - -Learn more about how Medusa creates an internal representation of a workflow [in this chapter](https://docs.medusajs.com/learn/fundamentals/workflows/variable-manipulation/index.html.md). - -For example: - -```ts highlights={dateHighlights} -// Don't -const myWorkflow = createWorkflow( - "hello-world", - function (input: WorkflowInput) { - const today = new Date() - - return new WorkflowResponse({ - today, - }) -}) - -// Do -const myWorkflow = createWorkflow( - "hello-world", - function (input: WorkflowInput) { - const today = transform({}, () => new Date()) - - return new WorkflowResponse({ - today, - }) -}) -``` - -### No If Conditions - -You can't use if-conditions in a workflow. - -Learn more about why you can't use if-conditions [in this chapter](https://docs.medusajs.com/learn/fundamentals/workflows/conditions#why-if-conditions-arent-allowed-in-workflows/index.html.md) - -Instead, use when-then from the Workflows SDK: - -```ts -// Don't -const myWorkflow = createWorkflow( - "hello-world", - function (input: WorkflowInput) { - if (input.is_active) { - // perform an action - } -}) - -// Do (explained in the next chapter) -const myWorkflow = createWorkflow( - "hello-world", - function (input: WorkflowInput) { - when(input, (input) => { - return input.is_active - }) - .then(() => { - // perform an action - }) -}) -``` - -You can also pair multiple `when-then` blocks to implement an `if-else` condition as explained in [this chapter](https://docs.medusajs.com/learn/fundamentals/workflows/conditions/index.html.md). - -### No Conditional Operators - -You can't use conditional operators in a workflow, such as `??` or `||`. - -Learn more about why you can't use conditional operators [in this chapter](https://docs.medusajs.com/learn/fundamentals/workflows/conditions#why-if-conditions-arent-allowed-in-workflows/index.html.md) - -Instead, use `transform` to store the desired value in a variable. - -### Logical Or (||) Alternative - -```ts -// Don't -const myWorkflow = createWorkflow( - "hello-world", - function (input: WorkflowInput) { - const message = input.message || "Hello" -}) - -// Do -// other imports... -import { transform } from "@medusajs/framework/workflows-sdk" - -const myWorkflow = createWorkflow( - "hello-world", - function (input: WorkflowInput) { - const message = transform( - { - input, - }, - (data) => data.input.message || "hello" - ) -}) -``` - -### Nullish Coalescing (??) Alternative - -```ts -// Don't -const myWorkflow = createWorkflow( - "hello-world", - function (input: WorkflowInput) { - const message = input.message ?? "Hello" -}) - -// Do -// other imports... -import { transform } from "@medusajs/framework/workflows-sdk" - -const myWorkflow = createWorkflow( - "hello-world", - function (input: WorkflowInput) { - const message = transform( - { - input, - }, - (data) => data.input.message ?? "hello" - ) -}) -``` - -### Double Not (!!) Alternative - -```ts -// Don't -const myWorkflow = createWorkflow( - "hello-world", - function (input: WorkflowInput) { - step1({ - isActive: !!input.is_active, - }) -}) - -// Do -// other imports... -import { transform } from "@medusajs/framework/workflows-sdk" - -const myWorkflow = createWorkflow( - "hello-world", - function (input: WorkflowInput) { - const isActive = transform( - { - input, - }, - (data) => !!data.input.is_active - ) - step1({ - isActive, - }) -}) -``` - -### Ternary Alternative - -```ts -// Don't -const myWorkflow = createWorkflow( - "hello-world", - function (input: WorkflowInput) { - step1({ - message: input.is_active ? "active" : "inactive", - }) -}) - -// Do -// other imports... -import { transform } from "@medusajs/framework/workflows-sdk" - -const myWorkflow = createWorkflow( - "hello-world", - function (input: WorkflowInput) { - const message = transform( - { - input, - }, - (data) => { - return data.input.is_active ? "active" : "inactive" - } - ) - - step1({ - message, - }) -}) -``` - -### Optional Chaining (?.) Alternative - -```ts -// Don't -const myWorkflow = createWorkflow( - "hello-world", - function (input: WorkflowInput) { - step1({ - name: input.customer?.name, - }) -}) - -// Do -// other imports... -import { transform } from "@medusajs/framework/workflows-sdk" - -const myWorkflow = createWorkflow( - "hello-world", - function (input: WorkflowInput) { - const name = transform( - { - input, - }, - (data) => data.input.customer?.name - ) - - step1({ - name, - }) -}) -``` - -*** - -## Step Constraints - -### Returned Values - -A step must only return serializable values, such as [primitive values](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#primitive_values) or an object. - -Values of other types, such as Maps, aren't allowed. - -```ts -// Don't -import { - createStep, - StepResponse, -} from "@medusajs/framework/workflows-sdk" - -const step1 = createStep( - "step-1", - (input, { container }) => { - const myMap = new Map() - - // ... - - return new StepResponse({ - myMap, - }) - } -) - -// Do -import { - createStep, - StepResponse, -} from "@medusajs/framework/workflows-sdk" - -const step1 = createStep( - "step-1", - (input, { container }) => { - const myObj: Record = {} - - // ... - - return new StepResponse({ - myObj, - }) - } -) -``` - - -# Conditions in Workflows with When-Then - -In this chapter, you'll learn how to execute an action based on a condition in a workflow using when-then from the Workflows SDK. - -## Why If-Conditions Aren't Allowed in Workflows? - -Medusa creates an internal representation of the workflow definition you pass to `createWorkflow` to track and store its steps. At that point, variables in the workflow don't have any values. They only do when you execute the workflow. - -So, you can't use an if-condition that checks a variable's value, as the condition will be evaluated when Medusa creates the internal representation of the workflow, rather than during execution. - -Instead, use when-then from the Workflows SDK. It allows you to perform steps in a workflow only if a condition that you specify is satisfied. - -Restrictions for conditions is only applicable in a workflow's definition. You can still use if-conditions in your step's code. - -*** - -## How to use When-Then? - -The Workflows SDK provides a `when` function that is used to check whether a condition is true. You chain a `then` function to `when` that specifies the steps to execute if the condition in `when` is satisfied. - -For example: - -```ts highlights={highlights} -import { - createWorkflow, - WorkflowResponse, - when, -} from "@medusajs/framework/workflows-sdk" -// step imports... - -const workflow = createWorkflow( - "workflow", - function (input: { - is_active: boolean - }) { - - const result = when( - input, - (input) => { - return input.is_active - } - ).then(() => { - const stepResult = isActiveStep() - return stepResult - }) - - // executed without condition - const anotherStepResult = anotherStep(result) - - return new WorkflowResponse( - anotherStepResult - ) - } -) -``` - -In this code snippet, you execute the `isActiveStep` only if the `input.is_active`'s value is `true`. - -### When Parameters - -`when` accepts the following parameters: - -1. The first parameter is either an object or the workflow's input. This data is passed as a parameter to the function in `when`'s second parameter. -2. The second parameter is a function that returns a boolean indicating whether to execute the action in `then`. - -### Then Parameters - -To specify the action to perform if the condition is satisfied, chain a `then` function to `when` and pass it a callback function. - -The callback function is only executed if `when`'s second parameter function returns a `true` value. - -*** - -## Implementing If-Else with When-Then - -when-then doesn't support if-else conditions. Instead, use two `when-then` conditions in your workflow. - -For example: - -```ts highlights={ifElseHighlights} -const workflow = createWorkflow( - "workflow", - function (input: { - is_active: boolean - }) { - - const isActiveResult = when( - input, - (input) => { - return input.is_active - } - ).then(() => { - return isActiveStep() - }) - - const notIsActiveResult = when( - input, - (input) => { - return !input.is_active - } - ).then(() => { - return notIsActiveStep() - }) - - // ... - } -) -``` - -In the above workflow, you use two `when-then` blocks. The first one performs a step if `input.is_active` is `true`, and the second performs a step if `input.is_active` is `false`, acting as an else condition. - -*** - -## Specify Name for When-Then - -Internally, `when-then` blocks have a unique name similar to a step. When you return a step's result in a `when-then` block, the block's name is derived from the step's name. For example: - -```ts -const isActiveResult = when( - input, - (input) => { - return input.is_active - } -).then(() => { - return isActiveStep() -}) -``` - -This `when-then` block's internal name will be `when-then-is-active`, where `is-active` is the step's name. - -However, if you need to return in your `when-then` block something other than a step's result, you need to specify a unique step name for that block. Otherwise, Medusa will generate a random name for it which can cause unexpected errors in production. - -You pass a name for `when-then` as a first parameter of `when`, whose signature can accept three parameters in this case. For example: - -```ts highlights={nameHighlights} -const { isActive } = when( - "check-is-active", - input, - (input) => { - return input.is_active - } -).then(() => { - const isActive = isActiveStep() - - return { - isActive, - } -}) -``` - -Since `then` returns a value different than the step's result, you pass to the `when` function the following parameters: - -1. A unique name to be assigned to the `when-then` block. -2. Either an object or the workflow's input. This data is passed as a parameter to the function in `when`'s second parameter. -3. A function that returns a boolean indicating whether to execute the action in `then`. - -The second and third parameters are the same as the parameters you previously passed to `when`. - - -# Compensation Function - -In this chapter, you'll learn what a compensation function is and how to add it to a step. - -## What is a Compensation Function - -A compensation function rolls back or undoes changes made by a step when an error occurs in the workflow. - -For example, if a step creates a record, the compensation function deletes the record when an error occurs later in the workflow. - -By using compensation functions, you provide a mechanism that guarantees data consistency in your application and across systems. - -*** - -## How to add a Compensation Function? - -A compensation function is passed as a second parameter to the `createStep` function. - -For example, create the file `src/workflows/hello-world.ts` with the following content: - -```ts title="src/workflows/hello-world.ts" highlights={[["15"], ["16"], ["17"]]} collapsibleLines="1-5" expandButtonLabel="Show Imports" -import { - createStep, - StepResponse, -} from "@medusajs/framework/workflows-sdk" - -const step1 = createStep( - "step-1", - async () => { - const message = `Hello from step one!` - - console.log(message) - - return new StepResponse(message) - }, - async () => { - console.log("Oops! Rolling back my changes...") - } -) -``` - -Each step can have a compensation function. The compensation function only runs if an error occurs throughout the workflow. - -*** - -## Test the Compensation Function - -Create a step in the same `src/workflows/hello-world.ts` file that throws an error: - -```ts title="src/workflows/hello-world.ts" -const step2 = createStep( - "step-2", - async () => { - throw new Error("Throwing an error...") - } -) -``` - -Then, create a workflow that uses the steps: - -```ts title="src/workflows/hello-world.ts" collapsibleLines="1-8" expandButtonLabel="Show Imports" -import { - createWorkflow, - WorkflowResponse, -} from "@medusajs/framework/workflows-sdk" -// other imports... - -// steps... - -const myWorkflow = createWorkflow( - "hello-world", - function (input) { - const str1 = step1() - step2() - - return new WorkflowResponse({ - message: str1, - }) -}) - -export default myWorkflow -``` - -Finally, execute the workflow from an API route: - -```ts title="src/api/workflow/route.ts" collapsibleLines="1-6" expandButtonLabel="Show Imports" -import type { - MedusaRequest, - MedusaResponse, -} from "@medusajs/framework/http" -import myWorkflow from "../../../workflows/hello-world" - -export async function GET( - req: MedusaRequest, - res: MedusaResponse -) { - const { result } = await myWorkflow(req.scope) - .run() - - res.send(result) -} -``` - -Run the Medusa application and send a `GET` request to `/workflow`: - -```bash -curl http://localhost:9000/workflow -``` - -In the console, you'll see: - -- `Hello from step one!` logged in the terminal, indicating that the first step ran successfully. -- `Oops! Rolling back my changes...` logged in the terminal, indicating that the second step failed and the compensation function of the first step ran consequently. - -*** - -## Pass Input to Compensation Function - -If a step creates a record, the compensation function must receive the ID of the record to remove it. - -To pass input to the compensation function, pass a second parameter in the `StepResponse` returned by the step. - -For example: - -```ts highlights={inputHighlights} -import { - createStep, - StepResponse, -} from "@medusajs/framework/workflows-sdk" - -const step1 = createStep( - "step-1", - async () => { - return new StepResponse( - `Hello from step one!`, - { message: "Oops! Rolling back my changes..." } - ) - }, - async ({ message }) => { - console.log(message) - } -) -``` - -In this example, the step passes an object as a second parameter to `StepResponse`. - -The compensation function receives the object and uses its `message` property to log a message. - -*** - -## Resolve Resources from the Medusa Container - -The compensation function receives an object second parameter. The object has a `container` property that you use to resolve resources from the Medusa container. - -For example: - -```ts -import { - createStep, - StepResponse, -} from "@medusajs/framework/workflows-sdk" -import { ContainerRegistrationKeys } from "@medusajs/framework/utils" - -const step1 = createStep( - "step-1", - async () => { - return new StepResponse( - `Hello from step one!`, - { message: "Oops! Rolling back my changes..." } - ) - }, - async ({ message }, { container }) => { - const logger = container.resolve( - ContainerRegistrationKeys.LOGGER - ) - - logger.info(message) - } -) -``` - -In this example, you use the `container` property in the second object parameter of the compensation function to resolve the logger. - -You then use the logger to log a message. - -*** - -## Handle Errors in Loops - -This feature is only available after [Medusa v2.0.5](https://github.com/medusajs/medusa/releases/tag/v2.0.5). - -Consider you have a module that integrates a third-party ERP system, and you're creating a workflow that deletes items in that ERP. You may have the following step: - -```ts -// other imports... -import { promiseAll } from "@medusajs/framework/utils" - -type StepInput = { - ids: string[] -} - -const step1 = createStep( - "step-1", - async ({ ids }: StepInput, { container }) => { - const erpModuleService = container.resolve( - ERP_MODULE - ) - const prevData: unknown[] = [] - - await promiseAll( - ids.map(async (id) => { - const data = await erpModuleService.retrieve(id) - - await erpModuleService.delete(id) - - prevData.push(id) - }) - ) - - return new StepResponse(ids, prevData) - } -) -``` - -In the step, you loop over the IDs to retrieve the item's data, store them in a `prevData` variable, then delete them using the ERP Module's service. You then pass the `prevData` variable to the compensation function. - -However, if an error occurs in the loop, the `prevData` variable won't be passed to the compensation function as the execution never reached the return statement. - -To handle errors in the loop so that the compensation function receives the last version of `prevData` before the error occurred, you wrap the loop in a try-catch block. Then, in the catch block, you invoke and return the `StepResponse.permanentFailure` function: - -```ts highlights={highlights} -try { - await promiseAll( - ids.map(async (id) => { - const data = await erpModuleService.retrieve(id) - - await erpModuleService.delete(id) - - prevData.push(id) - }) - ) -} catch (e) { - return StepResponse.permanentFailure( - `An error occurred: ${e}`, - prevData - ) -} -``` - -The `StepResponse.permanentFailure` fails the step and its workflow, triggering current and previous steps' compensation functions. The `permanentFailure` function accepts as a first parameter the error message, which is saved in the workflow's error details, and as a second parameter the data to pass to the compensation function. - -So, if an error occurs during the loop, the compensation function will still receive the `prevData` variable to undo the changes made before the step failed. - - -# Execute Another Workflow - -In this chapter, you'll learn how to execute a workflow in another. - -## Execute in a Workflow - -To execute a workflow in another, use the `runAsStep` method that every workflow has. - -For example: - -```ts highlights={workflowsHighlights} collapsibleLines="1-7" expandMoreButton="Show Imports" -import { - createWorkflow, -} from "@medusajs/framework/workflows-sdk" -import { - createProductsWorkflow, -} from "@medusajs/medusa/core-flows" - -const workflow = createWorkflow( - "hello-world", - async (input) => { - const products = createProductsWorkflow.runAsStep({ - input: { - products: [ - // ... - ], - }, - }) - - // ... - } -) -``` - -Instead of invoking the workflow and passing it the container, you use its `runAsStep` method and pass it an object as a parameter. - -The object has an `input` property to pass input to the workflow. - -*** - -## Preparing Input Data - -If you need to perform some data manipulation to prepare the other workflow's input data, use `transform` from the Workflows SDK. - -Learn about transform in [this chapter](https://docs.medusajs.com/learn/fundamentals/workflows/variable-manipulation/index.html.md). - -For example: - -```ts highlights={transformHighlights} collapsibleLines="1-12" -import { - createWorkflow, - transform, -} from "@medusajs/framework/workflows-sdk" -import { - createProductsWorkflow, -} from "@medusajs/medusa/core-flows" - -type WorkflowInput = { - title: string -} - -const workflow = createWorkflow( - "hello-product", - async (input: WorkflowInput) => { - const createProductsData = transform({ - input, - }, (data) => [ - { - title: `Hello ${data.input.title}`, - }, - ]) - - const products = createProductsWorkflow.runAsStep({ - input: { - products: createProductsData, - }, - }) - - // ... - } -) -``` - -In this example, you use the `transform` function to prepend `Hello` to the title of the product. Then, you pass the result as an input to the `createProductsWorkflow`. - -*** - -## Run Workflow Conditionally - -To run a workflow in another based on a condition, use when-then from the Workflows SDK. - -Learn about when-then in [this chapter](https://docs.medusajs.com/learn/fundamentals/workflows/conditions/index.html.md). - -For example: - -```ts highlights={whenHighlights} collapsibleLines="1-16" -import { - createWorkflow, - when, -} from "@medusajs/framework/workflows-sdk" -import { - createProductsWorkflow, -} from "@medusajs/medusa/core-flows" -import { - CreateProductWorkflowInputDTO, -} from "@medusajs/framework/types" - -type WorkflowInput = { - product?: CreateProductWorkflowInputDTO - should_create?: boolean -} - -const workflow = createWorkflow( - "hello-product", - async (input: WorkflowInput) => { - const product = when(input, ({ should_create }) => should_create) - .then(() => { - return createProductsWorkflow.runAsStep({ - input: { - products: [input.product], - }, - }) - }) - } -) -``` - -In this example, you use when-then to run the `createProductsWorkflow` only if `should_create` (passed in the `input`) is enabled. - - -# Run Workflow Steps in Parallel - -In this chapter, you’ll learn how to run workflow steps in parallel. - -## parallelize Utility Function - -If your workflow has steps that don’t rely on one another’s results, run them in parallel using `parallelize` from the Workflows SDK. - -The workflow waits until all steps passed to the `parallelize` function finish executing before continuing to the next step. - -For example: - -```ts highlights={highlights} collapsibleLines="1-12" expandButtonLabel="Show Imports" -import { - createWorkflow, - WorkflowResponse, - parallelize, -} from "@medusajs/framework/workflows-sdk" -import { - createProductStep, - getProductStep, - createPricesStep, - attachProductToSalesChannelStep, -} from "./steps" - -interface WorkflowInput { - title: string -} - -const myWorkflow = createWorkflow( - "my-workflow", - (input: WorkflowInput) => { - const product = createProductStep(input) - - const [prices, productSalesChannel] = parallelize( - createPricesStep(product), - attachProductToSalesChannelStep(product) - ) - - const id = product.id - const refetchedProduct = getProductStep(product.id) - - return new WorkflowResponse(refetchedProduct) - } -) -``` - -The `parallelize` function accepts the steps to run in parallel as a parameter. - -It returns an array of the steps' results in the same order they're passed to the `parallelize` function. - -So, `prices` is the result of `createPricesStep`, and `productSalesChannel` is the result of `attachProductToSalesChannelStep`. - - -# Multiple Step Usage in Workflow - -In this chapter, you'll learn how to use a step multiple times in a workflow. - -## Problem Reusing a Step in a Workflow - -In some cases, you may need to use a step multiple times in the same workflow. - -The most common example is using the `useQueryGraphStep` multiple times in a workflow to retrieve multiple unrelated data, such as customers and products. - -Each workflow step must have a unique ID, which is the ID passed as a first parameter when creating the step: - -```ts -const useQueryGraphStep = createStep( - "use-query-graph" // ... -) +} ``` -This causes an error when you use the same step multiple times in a workflow, as it's registered in the workflow as two steps having the same ID: - -```ts -const helloWorkflow = createWorkflow( - "hello", - () => { - const { data: products } = useQueryGraphStep({ - entity: "product", - fields: ["id"], - }) - - // ERROR OCCURS HERE: A STEP HAS THE SAME ID AS ANOTHER IN THE WORKFLOW - const { data: customers } = useQueryGraphStep({ - entity: "customer", - fields: ["id"], - }) - } -) -``` - -The next section explains how to fix this issue to use the same step multiple times in a workflow. +You can use its methods to manage links, such as create or delete links. *** -## How to Use a Step Multiple Times in a Workflow? +## Create Link -When you execute a step in a workflow, you can chain a `config` method to it to change the step's config. - -Use the `config` method to change a step's ID for a single execution. - -So, this is the correct way to write the example above: - -```ts highlights={highlights} -const helloWorkflow = createWorkflow( - "hello", - () => { - const { data: products } = useQueryGraphStep({ - entity: "product", - fields: ["id"], - }) - - // ✓ No error occurs, the step has a different ID. - const { data: customers } = useQueryGraphStep({ - entity: "customer", - fields: ["id"], - }).config({ name: "fetch-customers" }) - } -) -``` - -The `config` method accepts an object with a `name` property. Its value is a new ID of the step to use for this execution only. - -The first `useQueryGraphStep` usage has the ID `use-query-graph`, and the second `useQueryGraphStep` usage has the ID `fetch-customers`. - - -# Long-Running Workflows - -In this chapter, you’ll learn what a long-running workflow is and how to configure it. - -## What is a Long-Running Workflow? - -When you execute a workflow, you wait until the workflow finishes execution to receive the output. - -A long-running workflow is a workflow that continues its execution in the background. You don’t receive its output immediately. Instead, you subscribe to the workflow execution to listen to status changes and receive its result once the execution is finished. - -### Why use Long-Running Workflows? - -Long-running workflows are useful if: - -- A task takes too long. For example, you're importing data from a CSV file. -- The workflow's steps wait for an external action to finish before resuming execution. For example, before you import the data from the CSV file, you wait until the import is confirmed by the user. - -*** - -## Configure Long-Running Workflows - -A workflow is considered long-running if at least one step has its `async` configuration set to `true` and doesn't return a step response. - -For example, consider the following workflow and steps: - -```ts title="src/workflows/hello-world.ts" highlights={[["15"]]} collapsibleLines="1-11" expandButtonLabel="Show More" -import { - createStep, - createWorkflow, - WorkflowResponse, - StepResponse, -} from "@medusajs/framework/workflows-sdk" - -const step1 = createStep("step-1", async () => { - return new StepResponse({}) -}) - -const step2 = createStep( - { - name: "step-2", - async: true, - }, - async () => { - console.log("Waiting to be successful...") - } -) - -const step3 = createStep("step-3", async () => { - return new StepResponse("Finished three steps") -}) - -const myWorkflow = createWorkflow( - "hello-world", - function () { - step1() - step2() - const message = step3() - - return new WorkflowResponse({ - message, - }) -}) - -export default myWorkflow -``` - -The second step has in its configuration object `async` set to `true` and it doesn't return a step response. This indicates that this step is an asynchronous step. - -So, when you execute the `hello-world` workflow, it continues its execution in the background once it reaches the second step. - -A workflow is also considered long-running if one of its steps has their `retryInterval` option set as explained in [this chapter](https://docs.medusajs.com/learn/fundamentals/workflows/retry-failed-steps/index.html.md). - -*** - -## Change Step Status - -Once the workflow's execution reaches an async step, it'll wait in the background for the step to succeed or fail before it moves to the next step. - -To fail or succeed a step, use the Workflow Engine Module's main service that is registered in the Medusa Container under the `Modules.WORKFLOW_ENGINE` (or `workflowsModuleService`) key. - -### Retrieve Transaction ID - -Before changing the status of a workflow execution's async step, you must have the execution's transaction ID. - -When you execute the workflow, the object returned has a `transaction` property, which is an object that holds the details of the workflow execution's transaction. Use its `transactionId` to later change async steps' statuses: - -```ts -const { transaction } = await myWorkflow(req.scope) - .run() - -// use transaction.transactionId later -``` - -### Change Step Status to Successful - -The Workflow Engine Module's main service has a `setStepSuccess` method to set a step's status to successful. If you use it on a workflow execution's async step, the workflow continues execution to the next step. - -For example, consider the following step: - -```ts highlights={successStatusHighlights} collapsibleLines="1-9" expandButtonLabel="Show Imports" -import { - Modules, - TransactionHandlerType, -} from "@medusajs/framework/utils" -import { - StepResponse, - createStep, -} from "@medusajs/framework/workflows-sdk" - -type SetStepSuccessStepInput = { - transactionId: string -}; - -export const setStepSuccessStep = createStep( - "set-step-success-step", - async function ( - { transactionId }: SetStepSuccessStepInput, - { container } - ) { - const workflowEngineService = container.resolve( - Modules.WORKFLOW_ENGINE - ) - - await workflowEngineService.setStepSuccess({ - idempotencyKey: { - action: TransactionHandlerType.INVOKE, - transactionId, - stepId: "step-2", - workflowId: "hello-world", - }, - stepResponse: new StepResponse("Done!"), - options: { - container, - }, - }) - } -) -``` - -In this step (which you use in a workflow other than the long-running workflow), you resolve the Workflow Engine Module's main service and set `step-2` of the previous workflow as successful. - -The `setStepSuccess` method of the workflow engine's main service accepts as a parameter an object having the following properties: - -- idempotencyKey: (\`object\`) The details of the workflow execution. - - - action: (\`invoke\` | \`compensate\`) If the step's compensation function is running, use \`compensate\`. Otherwise, use \`invoke\`. - - - transactionId: (\`string\`) The ID of the workflow execution's transaction. - - - stepId: (\`string\`) The ID of the step to change its status. This is the first parameter passed to \`createStep\` when creating the step. - - - workflowId: (\`string\`) The ID of the workflow. This is the first parameter passed to \`createWorkflow\` when creating the workflow. -- stepResponse: (\`StepResponse\`) Set the response of the step. This is similar to the response you return in a step's definition, but since the \`async\` step doesn't have a response, you set its response when changing its status. -- options: (\`Record\\`) Options to pass to the step. - - - container: (\`MedusaContainer\`) An instance of the Medusa Container - -### Change Step Status to Failed - -The Workflow Engine Module's main service also has a `setStepFailure` method that changes a step's status to failed. It accepts the same parameter as `setStepSuccess`. - -After changing the async step's status to failed, the workflow execution fails and the compensation functions of previous steps are executed. +To create a link between records of two data models, use the `create` method of Link. For example: -```ts highlights={failureStatusHighlights} collapsibleLines="1-9" expandButtonLabel="Show Imports" -import { - Modules, - TransactionHandlerType, -} from "@medusajs/framework/utils" -import { - StepResponse, - createStep, -} from "@medusajs/framework/workflows-sdk" - -type SetStepFailureStepInput = { - transactionId: string -}; - -export const setStepFailureStep = createStep( - "set-step-success-step", - async function ( - { transactionId }: SetStepFailureStepInput, - { container } - ) { - const workflowEngineService = container.resolve( - Modules.WORKFLOW_ENGINE - ) - - await workflowEngineService.setStepFailure({ - idempotencyKey: { - action: TransactionHandlerType.INVOKE, - transactionId, - stepId: "step-2", - workflowId: "hello-world", - }, - stepResponse: new StepResponse("Failed!"), - options: { - container, - }, - }) - } -) -``` - -You use this step in another workflow that changes the status of an async step in a long-running workflow's execution to failed. - -*** - -## Access Long-Running Workflow Status and Result - -To access the status and result of a long-running workflow execution, use the `subscribe` and `unsubscribe` methods of the Workflow Engine Module's main service. - -To retrieve the workflow execution's details at a later point, you must enable [storing the workflow's executions](https://docs.medusajs.com/learn/fundamentals/workflows/store-executions/index.html.md). - -For example: - -```ts title="src/api/workflows/route.ts" highlights={highlights} collapsibleLines="1-11" expandButtonLabel="Show Imports" -import type { MedusaRequest, MedusaResponse } from "@medusajs/framework/http" -import myWorkflow from "../../../workflows/hello-world" -import { - IWorkflowEngineService, -} from "@medusajs/framework/types" +```ts import { Modules } from "@medusajs/framework/utils" -export async function GET(req: MedusaRequest, res: MedusaResponse) { - const { transaction, result } = await myWorkflow(req.scope).run() +// ... - const workflowEngineService = req.scope.resolve< - IWorkflowEngineService - >( - Modules.WORKFLOW_ENGINE - ) - - const subscriptionOptions = { - workflowId: "hello-world", - transactionId: transaction.transactionId, - subscriberId: "hello-world-subscriber", - } - - await workflowEngineService.subscribe({ - ...subscriptionOptions, - subscriber: async (data) => { - if (data.eventType === "onFinish") { - console.log("Finished execution", data.result) - // unsubscribe - await workflowEngineService.unsubscribe({ - ...subscriptionOptions, - subscriberOrId: subscriptionOptions.subscriberId, - }) - } else if (data.eventType === "onStepFailure") { - console.log("Workflow failed", data.step) - } - }, - }) - - res.send(result) -} -``` - -In the above example, you execute the long-running workflow `hello-world` and resolve the Workflow Engine Module's main service from the Medusa container. - -### subscribe Method - -The main service's `subscribe` method allows you to listen to changes in the workflow execution’s status. It accepts an object having three properties: - -- workflowId: (\`string\`) The name of the workflow. -- transactionId: (\`string\`) The ID of the workflow exection's transaction. The transaction's details are returned in the response of the workflow execution. -- subscriberId: (\`string\`) The ID of the subscriber. -- subscriber: (\`(data: \{ eventType: string, result?: any }) => Promise\\`) The function executed when the workflow execution's status changes. The function receives a data object. It has an \`eventType\` property, which you use to check the status of the workflow execution. - -If the value of `eventType` in the `subscriber` function's first parameter is `onFinish`, the workflow finished executing. The first parameter then also has a `result` property holding the workflow's output. - -### unsubscribe Method - -You can unsubscribe from the workflow using the workflow engine's `unsubscribe` method, which requires the same object parameter as the `subscribe` method. - -However, instead of the `subscriber` property, it requires a `subscriberOrId` property whose value is the same `subscriberId` passed to the `subscribe` method. - -*** - -## Example: Restaurant-Delivery Recipe - -To find a full example of a long-running workflow, refer to the [restaurant-delivery recipe](https://docs.medusajs.com/resources/recipes/marketplace/examples/restaurant-delivery/index.html.md). - -In the recipe, you use a long-running workflow that moves an order from placed to completed. The workflow waits for the restaurant to accept the order, the driver to pick up the order, and other external actions. - - -# Retry Failed Steps - -In this chapter, you’ll learn how to configure steps to allow retrial on failure. - -## Configure a Step’s Retrial - -By default, when an error occurs in a step, the step and the workflow fail, and the execution stops. - -You can configure the step to retry on failure. The `createStep` function can accept a configuration object instead of the step’s name as a first parameter. - -For example: - -```ts title="src/workflows/hello-world.ts" highlights={[["10"]]} collapsibleLines="1-6" expandButtonLabel="Show Imports" -import { - createStep, - createWorkflow, - WorkflowResponse, -} from "@medusajs/framework/workflows-sdk" - -const step1 = createStep( - { - name: "step-1", - maxRetries: 2, +await link.create({ + [Modules.PRODUCT]: { + product_id: "prod_123", + }, + "helloModuleService": { + my_custom_id: "mc_123", }, - async () => { - console.log("Executing step 1") - - throw new Error("Oops! Something happened.") - } -) - -const myWorkflow = createWorkflow( - "hello-world", - function () { - const str1 = step1() - - return new WorkflowResponse({ - message: str1, - }) }) - -export default myWorkflow ``` -The step’s configuration object accepts a `maxRetries` property, which is a number indicating the number of times a step can be retried when it fails. +The `create` method accepts as a parameter an object. The object’s keys are the names of the linked modules. -When you execute the above workflow, you’ll see the following result in the terminal: +The keys (names of linked modules) must be in the same [direction](https://docs.medusajs.com/learn/fundamentals/module-links/directions/index.html.md) of the link definition. -```bash -Executing step 1 -Executing step 1 -Executing step 1 -error: Oops! Something happened. -Error: Oops! Something happened. -``` +The value of each module’s property is an object, whose keys are of the format `{data_model_snake_name}_id`, and values are the IDs of the linked record. -The first line indicates the first time the step was executed, and the next two lines indicate the times the step was retried. After that, the step and workflow fail. +So, in the example above, you link a record of the `MyCustom` data model in a `hello` module to a `Product` record in the Product Module. *** -## Step Retry Intervals +## Dismiss Link -By default, a step is retried immediately after it fails. To specify a wait time before a step is retried, pass a `retryInterval` property to the step's configuration object. Its value is a number of seconds to wait before retrying the step. +To remove a link between records of two data models, use the `dismiss` method of Link. For example: -```ts title="src/workflows/hello-world.ts" highlights={[["5"]]} -const step1 = createStep( - { - name: "step-1", - maxRetries: 2, - retryInterval: 2, // 2 seconds - }, - async () => { - // ... - } -) -``` - -### Interval Changes Workflow to Long-Running - -By setting `retryInterval` on a step, a workflow becomes a [long-running workflow](https://docs.medusajs.com/learn/fundamentals/workflows/long-running-workflow/index.html.md) that runs asynchronously in the background. So, you won't receive its result or errors immediately when you execute the workflow. - -Instead, you must subscribe to the workflow's execution using the Workflow Engine Module Service. Learn more about it in [this chapter](https://docs.medusajs.com/learn/fundamentals/workflows/long-running-workflow#access-long-running-workflow-status-and-result/index.html.md). - - -# Store Workflow Executions - -In this chapter, you'll learn how to store workflow executions in the database and access them later. - -## Workflow Execution Retention - -Medusa doesn't store your workflow's execution details by default. However, you can configure a workflow to keep its execution details stored in the database. - -This is useful for auditing and debugging purposes. When you store a workflow's execution, you can view details around its steps, their states and their output. You can also check whether the workflow or any of its steps failed. - -You can view stored workflow executions from the Medusa Admin dashboard by going to Settings -> Workflows. - -*** - -## How to Store Workflow's Executions? - -### Prerequisites - -- [Redis Workflow Engine must be installed and configured.](https://docs.medusajs.com/resources/architectural-modules/workflow-engine/redis/index.html.md) - -`createWorkflow` from the Workflows SDK can accept an object as a first parameter to set the workflow's configuration. To enable storing a workflow's executions: - -- Enable the `store` option. If your workflow is a [Long-Running Workflow](https://docs.medusajs.com/learn/fundamentals/workflows/long-running-workflow/index.html.md), this option is enabled by default. -- Set the `retentionTime` option to the number of seconds that the workflow execution should be stored in the database. - -For example: - -```ts highlights={highlights} -import { createStep, createWorkflow } from "@medusajs/framework/workflows-sdk" - -const step1 = createStep( - { - name: "step-1", - }, - async () => { - console.log("Hello from step 1") - } -) - -export const helloWorkflow = createWorkflow( - { - name: "hello-workflow", - retentionTime: 99999, - store: true, - }, - () => { - step1() - } -) -``` - -Whenever you execute the `helloWorkflow` now, its execution details will be stored in the database. - -*** - -## Retrieve Workflow Executions - -You can view stored workflow executions from the Medusa Admin dashboard by going to Settings -> Workflows. - -When you execute a workflow, the returned object has a `transaction` property containing the workflow execution's transaction details: - ```ts -const { transaction } = await helloWorkflow(container).run() -``` - -To retrieve a workflow's execution details from the database, resolve the Workflow Engine Module from the container and use its `listWorkflowExecutions` method. - -For example, you can create a `GET` API Route at `src/workflows/[id]/route.ts` that retrieves a workflow execution for the specified transaction ID: - -```ts title="src/workflows/[id]/route.ts" highlights={retrieveHighlights} -import { MedusaRequest, MedusaResponse } from "@medusajs/framework" import { Modules } from "@medusajs/framework/utils" -export async function GET( - req: MedusaRequest, - res: MedusaResponse -) { - const { transaction_id } = req.params - - const workflowEngineService = req.scope.resolve( - Modules.WORKFLOW_ENGINE - ) +// ... - const [workflowExecution] = await workflowEngineService.listWorkflowExecutions({ - transaction_id: transaction_id, - }) - - res.json({ - workflowExecution, - }) -} -``` - -In the above example, you resolve the Workflow Engine Module from the container and use its `listWorkflowExecutions` method, passing the `transaction_id` as a filter to retrieve its workflow execution details. - -A workflow execution object will be similar to the following: - -```json -{ - "workflow_id": "hello-workflow", - "transaction_id": "01JJC2T6AVJCQ3N4BRD1EB88SP", - "id": "wf_exec_01JJC2T6B3P76JD35F12QTTA78", - "execution": { - "state": "done", - "steps": {}, - "modelId": "hello-workflow", - "options": {}, - "metadata": {}, - "startedAt": 1737719880027, - "definition": {}, - "timedOutAt": null, - "hasAsyncSteps": false, - "transactionId": "01JJC2T6AVJCQ3N4BRD1EB88SP", - "hasFailedSteps": false, - "hasSkippedSteps": false, - "hasWaitingSteps": false, - "hasRevertedSteps": false, - "hasSkippedOnFailureSteps": false +await link.dismiss({ + [Modules.PRODUCT]: { + product_id: "prod_123", }, - "context": { - "data": {}, - "errors": [] + "helloModuleService": { + my_custom_id: "mc_123", }, - "state": "done", - "created_at": "2025-01-24T09:58:00.036Z", - "updated_at": "2025-01-24T09:58:00.046Z", - "deleted_at": null -} -``` - -### Example: Check if Stored Workflow Execution Failed - -To check if a stored workflow execution failed, you can check its `state` property: - -```ts -if (workflowExecution.state === "failed") { - return res.status(500).json({ - error: "Workflow failed", - }) -} -``` - -Other state values include `done`, `invoking`, and `compensating`. - - -# Workflow Timeout - -In this chapter, you’ll learn how to set a timeout for workflows and steps. - -## What is a Workflow Timeout? - -By default, a workflow doesn’t have a timeout. It continues execution until it’s finished or an error occurs. - -You can configure a workflow’s timeout to indicate how long the workflow can execute. If a workflow's execution time passes the configured timeout, it is failed and an error is thrown. - -### Timeout Doesn't Stop Step Execution - -Configuring a timeout doesn't stop the execution of a step in progress. The timeout only affects the status of the workflow and its result. - -*** - -## Configure Workflow Timeout - -The `createWorkflow` function can accept a configuration object instead of the workflow’s name. - -In the configuration object, you pass a `timeout` property, whose value is a number indicating the timeout in seconds. - -For example: - -```ts title="src/workflows/hello-world.ts" highlights={[["16"]]} collapsibleLines="1-13" expandButtonLabel="Show More" -import { - createStep, - createWorkflow, - WorkflowResponse, -} from "@medusajs/framework/workflows-sdk" - -const step1 = createStep( - "step-1", - async () => { - // ... - } -) - -const myWorkflow = createWorkflow({ - name: "hello-world", - timeout: 2, // 2 seconds -}, function () { - const str1 = step1() - - return new WorkflowResponse({ - message: str1, - }) }) - -export default myWorkflow - ``` -This workflow's executions fail if they run longer than two seconds. +The `dismiss` method accepts the same parameter type as the [create method](#create-link). -A workflow’s timeout error is returned in the `errors` property of the workflow’s execution, as explained in [this chapter](https://docs.medusajs.com/learn/fundamentals/workflows/access-workflow-errors/index.html.md). The error’s name is `TransactionTimeoutError`. +The keys (names of linked modules) must be in the same [direction](https://docs.medusajs.com/learn/fundamentals/module-links/directions/index.html.md) of the link definition. *** -## Configure Step Timeout +## Cascade Delete Linked Records -Alternatively, you can configure the timeout for a step rather than the entire workflow. - -As mentioned in the previous section, the timeout doesn't stop the execution of the step. It only affects the step's status and output. - -The step’s configuration object accepts a `timeout` property, whose value is a number indicating the timeout in seconds. +If a record is deleted, use the `delete` method of Link to delete all linked records. For example: -```tsx -const step1 = createStep( - { - name: "step-1", - timeout: 2, // 2 seconds +```ts +import { Modules } from "@medusajs/framework/utils" + +// ... + +await productModuleService.deleteVariants([variant.id]) + +await link.delete({ + [Modules.PRODUCT]: { + product_id: "prod_123", }, - async () => { - // ... - } -) +}) ``` -This step's executions fail if they run longer than two seconds. - -A step’s timeout error is returned in the `errors` property of the workflow’s execution, as explained in [this chapter](https://docs.medusajs.com/learn/fundamentals/workflows/access-workflow-errors/index.html.md). The error’s name is `TransactionStepTimeoutError`. - - -# Variable Manipulation in Workflows with transform - -In this chapter, you'll learn how to use `transform` from the Workflows SDK to manipulate variables in a workflow. - -## Why Variable Manipulation isn't Allowed in Workflows - -Medusa creates an internal representation of the workflow definition you pass to `createWorkflow` to track and store its steps. - -At that point, variables in the workflow don't have any values. They only do when you execute the workflow. - -So, you can only pass variables as parameters to steps. But, in a workflow, you can't change a variable's value or, if the variable is an array, loop over its items. - -Instead, use `transform` from the Workflows SDK. - -Restrictions for variable manipulation is only applicable in a workflow's definition. You can still manipulate variables in your step's code. +This deletes all records linked to the deleted product. *** -## What is the transform Utility? +## Restore Linked Records -`transform` creates a new variable as the result of manipulating other variables. - -For example, consider you have two strings as the output of two steps: - -```ts -const str1 = step1() -const str2 = step2() -``` - -To concatenate the strings, you create a new variable `str3` using the `transform` function: - -```ts highlights={highlights} -import { - createWorkflow, - WorkflowResponse, - transform, -} from "@medusajs/framework/workflows-sdk" -// step imports... - -const myWorkflow = createWorkflow( - "hello-world", - function (input) { - const str1 = step1(input) - const str2 = step2(input) - - const str3 = transform( - { str1, str2 }, - (data) => `${data.str1}${data.str2}` - ) - - return new WorkflowResponse(str3) - } -) -``` - -`transform` accepts two parameters: - -1. The first parameter is an object of variables to manipulate. The object is passed as a parameter to `transform`'s second parameter function. -2. The second parameter is the function performing the variable manipulation. - -The value returned by the second parameter function is returned by `transform`. So, the `str3` variable holds the concatenated string. - -You can use the returned value in the rest of the workflow, either to pass it as an input to other steps or to return it in the workflow's response. - -*** - -## Example: Looping Over Array - -Use `transform` to loop over arrays to create another variable from the array's items. - -For example: - -```ts collapsibleLines="1-7" expandButtonLabel="Show Imports" -import { - createWorkflow, - WorkflowResponse, - transform, -} from "@medusajs/framework/workflows-sdk" -// step imports... - -type WorkflowInput = { - items: { - id: string - name: string - }[] -} - -const myWorkflow = createWorkflow( - "hello-world", - function ({ items }: WorkflowInput) { - const ids = transform( - { items }, - (data) => data.items.map((item) => item.id) - ) - - doSomethingStep(ids) - - // ... - } -) -``` - -This workflow receives an `items` array in its input. - -You use `transform` to create an `ids` variable, which is an array of strings holding the `id` of each item in the `items` array. - -You then pass the `ids` variable as a parameter to the `doSomethingStep`. - -*** - -## Example: Creating a Date - -If you create a date with `new Date()` in a workflow's constructor function, Medusa evaluates the date's value when it creates the internal representation of the workflow, not when the workflow is executed. - -So, use `transform` instead to create a date variable with `new Date()`. +If a record that was previously soft-deleted is now restored, use the `restore` method of Link to restore all linked records. For example: ```ts -const myWorkflow = createWorkflow( - "hello-world", - () => { - const today = transform({}, () => new Date()) +import { Modules } from "@medusajs/framework/utils" - doSomethingStep(today) - } -) +// ... + +await productModuleService.restoreProducts(["prod_123"]) + +await link.restore({ + [Modules.PRODUCT]: { + product_id: "prod_123", + }, +}) ``` -In this workflow, `today` is only evaluated when the workflow is executed. + +# Query Context + +In this chapter, you'll learn how to pass contexts when retrieving data with [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query/index.html.md). + +## What is Query Context? + +Query context is a way to pass additional information when retrieving data with Query. This data can be useful when applying custom transformations to the retrieved data based on the current context. + +For example, consider you have a Blog Module with posts and authors. You can accept the user's language as a context and return the posts in the user's language. Another example is how Medusa uses Query Context to [retrieve product variants' prices based on the customer's currency](https://docs.medusajs.com/resources/commerce-modules/product/guides/price/index.html.md). *** -## Caveats +## How to Use Query Context -### Transform Evaluation +The `query.graph` method accepts an optional `context` parameter that can be used to pass additional context either to the data model you're retrieving (for example, `post`), or its related and linked models (for example, `author`). -`transform`'s value is only evaluated if you pass its output to a step or in the workflow response. +You initialize a context using `QueryContext` from the Modules SDK. It accepts an object of contexts as an argument. -For example, if you have the following workflow: +For example, to retrieve posts using Query while passing the user's language as a context: ```ts -const myWorkflow = createWorkflow( - "hello-world", - function (input) { - const str = transform( - { input }, - (data) => `${data.input.str1}${data.input.str2}` - ) - - return new WorkflowResponse("done") - } -) +const { data } = await query.graph({ + entity: "post", + fields: ["*"], + context: QueryContext({ + lang: "es", + }), +}) ``` -Since `str`'s value isn't used as a step's input or passed to `WorkflowResponse`, its value is never evaluated. +In this example, you pass in the context a `lang` property whose value is `es`. -### Data Validation +Then, to handle the context while retrieving records of the data model, in the associated module's service you override the generated `list` method of the data model. -`transform` should only be used to perform variable or data manipulation. +For example, continuing the example above, you can override the `listPosts` method of the Blog Module's service to handle the context: -If you want to perform some validation on the data, use a step or [when-then](https://docs.medusajs.com/learn/fundamentals/workflows/conditions/index.html.md) instead. +```ts highlights={highlights2} +import { MedusaContext, MedusaService } from "@medusajs/framework/utils" +import { Context, FindConfig } from "@medusajs/framework/types" +import Post from "./models/post" +import Author from "./models/author" -For example: +class BlogModuleService extends MedusaService({ + Post, + Author, +}){ + // @ts-ignore + async listPosts( + filters?: any, + config?: FindConfig | undefined, + @MedusaContext() sharedContext?: Context | undefined + ) { + const context = filters.context ?? {} + delete filters.context -```ts -// DON'T -const myWorkflow = createWorkflow( - "hello-world", - function (input) { - const str = transform( - { input }, - (data) => { - if (!input.str1) { - throw new Error("Not allowed!") + let posts = await super.listPosts(filters, config, sharedContext) + + if (context.lang === "es") { + posts = posts.map((post) => { + return { + ...post, + title: post.title + " en español", } - } - ) - } -) - -// DO -const validateHasStr1Step = createStep( - "validate-has-str1", - ({ input }) => { - if (!input.str1) { - throw new Error("Not allowed!") + }) } - } -) -const myWorkflow = createWorkflow( - "hello-world", - function (input) { - validateHasStr1({ - input, - }) - - // workflow continues its execution only if - // the step doesn't throw the error. + return posts } -) +} + +export default BlogModuleService ``` +In the above example, you override the generated `listPosts` method. This method receives as a first parameter the filters passed to the query, but it also includes a `context` property that holds the context passed to the query. + +You extract the context from `filters`, then retrieve the posts using the parent's `listPosts` method. After that, if the language is set in the context, you transform the titles of the posts. + +All posts returned will now have their titles appended with "en español". + +Learn more about the generated `list` method in [this reference](https://docs.medusajs.com/resources/service-factory-reference/methods/list/index.html.md). + +### Using Pagination with Query + +If you pass pagination fields to `query.graph`, you must also override the `listAndCount` method in the service. + +For example, following along with the previous example, you must override the `listAndCountPosts` method of the Blog Module's service: + +```ts +import { MedusaContext, MedusaService } from "@medusajs/framework/utils" +import { Context, FindConfig } from "@medusajs/framework/types" +import Post from "./models/post" +import Author from "./models/author" + +class BlogModuleService extends MedusaService({ + Post, + Author, +}){ + // @ts-ignore + async listAndCountPosts( + filters?: any, + config?: FindConfig | undefined, + @MedusaContext() sharedContext?: Context | undefined + ) { + const context = filters.context ?? {} + delete filters.context + + const result = await super.listAndCountPosts( + filters, + config, + sharedContext + ) + + if (context.lang === "es") { + result.posts = posts.map((post) => { + return { + ...post, + title: post.title + " en español", + } + }) + } + + return result + } +} + +export default BlogModuleService +``` + +Now, the `listAndCountPosts` method will handle the context passed to `query.graph` when you pass pagination fields. You can also move the logic to transform the posts' titles to a separate method and call it from both `listPosts` and `listAndCountPosts`. + +*** + +## Passing Query Context to Related Data Models + +If you're retrieving a data model and you want to pass context to its associated model in the same module, you can pass them as part of `QueryContext`'s parameter, then handle them in the same `list` method. + +For linked data models, check out the [next section](#passing-query-context-to-linked-data-models). + +For example, to pass a context for the post's authors: + +```ts highlights={highlights3} +const { data } = await query.graph({ + entity: "post", + fields: ["*"], + context: QueryContext({ + lang: "es", + author: QueryContext({ + lang: "es", + }), + }), +}) +``` + +Then, in the `listPosts` method, you can handle the context for the post's authors: + +```ts highlights={highlights4} +import { MedusaContext, MedusaService } from "@medusajs/framework/utils" +import { Context, FindConfig } from "@medusajs/framework/types" +import Post from "./models/post" +import Author from "./models/author" + +class BlogModuleService extends MedusaService({ + Post, + Author, +}){ + // @ts-ignore + async listPosts( + filters?: any, + config?: FindConfig | undefined, + @MedusaContext() sharedContext?: Context | undefined + ) { + const context = filters.context ?? {} + delete filters.context + + let posts = await super.listPosts(filters, config, sharedContext) + + const isPostLangEs = context.lang === "es" + const isAuthorLangEs = context.author?.lang === "es" + + if (isPostLangEs || isAuthorLangEs) { + posts = posts.map((post) => { + return { + ...post, + title: isPostLangEs ? post.title + " en español" : post.title, + author: { + ...post.author, + name: isAuthorLangEs ? post.author.name + " en español" : post.author.name, + }, + } + }) + } + + return posts + } +} + +export default BlogModuleService +``` + +The context in `filters` will also have the context for `author`, which you can use to make transformations to the post's authors. + +*** + +## Passing Query Context to Linked Data Models + +If you're retrieving a data model and you want to pass context to a linked model in a different module, pass to the `context` property an object instead, where its keys are the linked model's name and the values are the context for that linked model. + +For example, consider the Product Module's `Product` data model is linked to the Blog Module's `Post` data model. You can pass context to the `Post` data model while retrieving products like so: + +```ts highlights={highlights5} +const { data } = await query.graph({ + entity: "product", + fields: ["*", "post.*"], + context: { + post: QueryContext({ + lang: "es", + }), + }, +}) +``` + +In this example, you retrieve products and their associated posts. You also pass a context for `post`, indicating the customer's language. + +To handle the context, you override the generated `listPosts` method of the Blog Module as explained [previously](#how-to-use-query-context). + # Architectural Modules @@ -12193,130 +10117,6 @@ There are different architectural module types including: Refer to the [Architectural Modules reference](https://docs.medusajs.com/resources/architectural-modules/index.html.md) for a list of Medusa’s architectural modules, available modules to install, and how to create an architectural module. -# Workflow Hooks - -In this chapter, you'll learn what a workflow hook is and how to consume them. - -## What is a Workflow Hook? - -A workflow hook is a point in a workflow where you can inject custom functionality as a step function, called a hook handler. - -Medusa exposes hooks in many of its workflows that are used in its API routes. You can consume those hooks to add your custom logic. - -Refer to the [Workflows Reference](https://docs.medusajs.com/resources/medusa-workflows-reference/index.html.md) to view all workflows and their hooks. - -You want to perform a custom action during a workflow's execution, such as when a product is created. - -*** - -## How to Consume a Hook? - -A workflow has a special `hooks` property which is an object that holds its hooks. - -So, in a TypeScript or JavaScript file created under the `src/workflows/hooks` directory: - -- Import the workflow. -- Access its hook using the `hooks` property. -- Pass the hook a step function as a parameter to consume it. - -For example, to consume the `productsCreated` hook of Medusa's `createProductsWorkflow`, create the file `src/workflows/hooks/product-created.ts` with the following content: - -```ts title="src/workflows/hooks/product-created.ts" highlights={handlerHighlights} -import { createProductsWorkflow } from "@medusajs/medusa/core-flows" - -createProductsWorkflow.hooks.productsCreated( - async ({ products }, { container }) => { - // TODO perform an action - } -) -``` - -The `productsCreated` hook is available on the workflow's `hooks` property by its name. - -You invoke the hook, passing a step function (the hook handler) as a parameter. - -Now, when a product is created using the [Create Product API route](https://docs.medusajs.com/api/admin#products_postproducts), your hook handler is executed after the product is created. - -A hook can have only one handler. - -Refer to the [createProductsWorkflow reference](https://docs.medusajs.com/resources/references/medusa-workflows/createProductsWorkflow/index.html.md) to see at which point the hook handler is executed. - -### Hook Handler Parameter - -Since a hook handler is essentially a step function, it receives the hook's input as a first parameter, and an object holding a `container` property as a second parameter. - -Each hook has different input. For example, the `productsCreated` hook receives an object having a `products` property holding the created product. - -### Hook Handler Compensation - -Since the hook handler is a step function, you can set its compensation function as a second parameter of the hook. - -For example: - -```ts title="src/workflows/hooks/product-created.ts" -import { createProductsWorkflow } from "@medusajs/medusa/core-flows" - -createProductsWorkflow.hooks.productsCreated( - async ({ products }, { container }) => { - // TODO perform an action - - return new StepResponse(undefined, { ids }) - }, - async ({ ids }, { container }) => { - // undo the performed action - } -) -``` - -The compensation function is executed if an error occurs in the workflow to undo the actions performed by the hook handler. - -The compensation function receives as an input the second parameter passed to the `StepResponse` returned by the step function. - -It also accepts as a second parameter an object holding a `container` property to resolve resources from the Medusa container. - -### Additional Data Property - -Medusa's workflows pass in the hook's input an `additional_data` property: - -```ts title="src/workflows/hooks/product-created.ts" highlights={[["4", "additional_data"]]} -import { createProductsWorkflow } from "@medusajs/medusa/core-flows" - -createProductsWorkflow.hooks.productsCreated( - async ({ products, additional_data }, { container }) => { - // TODO perform an action - } -) -``` - -This property is an object that holds additional data passed to the workflow through the request sent to the API route using the workflow. - -Learn how to pass `additional_data` in requests to API routes in [this chapter](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data/index.html.md). - -### Pass Additional Data to Workflow - -You can also pass that additional data when executing the workflow. Pass it as a parameter to the `.run` method of the workflow: - -```ts title="src/workflows/hooks/product-created.ts" highlights={[["10", "additional_data"]]} -import type { MedusaRequest, MedusaResponse } from "@medusajs/framework/http" -import { createProductsWorkflow } from "@medusajs/medusa/core-flows" - -export async function POST(req: MedusaRequest, res: MedusaResponse) { - await createProductsWorkflow(req.scope).run({ - input: { - products: [ - // ... - ], - additional_data: { - custom_field: "test", - }, - }, - }) -} -``` - -Your hook handler then receives that passed data in the `additional_data` object. - - # Commerce Modules In this chapter, you'll learn about Medusa's commerce modules. @@ -12848,6 +10648,33 @@ class HelloModuleService { ``` +# Modules Directory Structure + +In this document, you'll learn about the expected files and directories in your module. + +![Module Directory Structure Example](https://res.cloudinary.com/dza7lstvk/image/upload/v1714379976/Medusa%20Book/modules-dir-overview_nqq7ne.jpg) + +## index.ts + +The `index.ts` file in the root of your module's directory is the only required file. It must export the module's definition as explained in a [previous chapter](https://docs.medusajs.com/learn/fundamentals/modules/index.html.md). + +*** + +## service.ts + +A module must have a main service. It's created in the `service.ts` file at the root of your module directory as explained in a [previous chapter](https://docs.medusajs.com/learn/fundamentals/modules/index.html.md). + +*** + +## Other Directories + +The following directories are optional and their content are explained more in the following chapters: + +- `models`: Holds the data models representing tables in the database. +- `migrations`: Holds the migration files used to reflect changes on the database. +- `loaders`: Holds the scripts to run on the Medusa application's start-up. + + # Loaders In this chapter, you’ll learn about loaders and how to use them. @@ -13192,33 +11019,6 @@ export const syncBrandsWorkflow = createWorkflow( You can then use this workflow in an API route, scheduled job, or other resources that use this functionality. -# Modules Directory Structure - -In this document, you'll learn about the expected files and directories in your module. - -![Module Directory Structure Example](https://res.cloudinary.com/dza7lstvk/image/upload/v1714379976/Medusa%20Book/modules-dir-overview_nqq7ne.jpg) - -## index.ts - -The `index.ts` file in the root of your module's directory is the only required file. It must export the module's definition as explained in a [previous chapter](https://docs.medusajs.com/learn/fundamentals/modules/index.html.md). - -*** - -## service.ts - -A module must have a main service. It's created in the `service.ts` file at the root of your module directory as explained in a [previous chapter](https://docs.medusajs.com/learn/fundamentals/modules/index.html.md). - -*** - -## Other Directories - -The following directories are optional and their content are explained more in the following chapters: - -- `models`: Holds the data models representing tables in the database. -- `migrations`: Holds the migration files used to reflect changes on the database. -- `loaders`: Holds the scripts to run on the Medusa application's start-up. - - # Multiple Services in a Module In this chapter, you'll learn how to use multiple services in a module. @@ -13723,205 +11523,2739 @@ export default HelloModuleService ``` -# Write Integration Tests +# Create a Plugin -In this chapter, you'll learn about `medusaIntegrationTestRunner` from Medusa's Testing Framework and how to use it to write integration tests. +In this chapter, you'll learn how to create a Medusa plugin and publish it. -### Prerequisites +A [plugin](https://docs.medusajs.com/learn/fundamentals/plugins/index.html.md) is a package of reusable Medusa customizations that you can install in any Medusa application. By creating and publishing a plugin, you can reuse your Medusa customizations across multiple projects or share them with the community. -- [Testing Tools Setup](https://docs.medusajs.com/learn/debugging-and-testing/testing-tools/index.html.md) +Plugins are available starting from [Medusa v2.3.0](https://github.com/medusajs/medusa/releases/tag/v2.3.0). -## medusaIntegrationTestRunner Utility +## 1. Create a Plugin Project -The `medusaIntegrationTestRunner` is from Medusa's Testing Framework and it's used to create integration tests in your Medusa project. It runs a full Medusa application, allowing you test API routes, workflows, or other customizations. +Plugins are created in a separate Medusa project. This makes the development and publishing of the plugin easier. Later, you'll install that plugin in your Medusa application to test it out and use it. + +Medusa's `create-medusa-app` CLI tool provides the option to create a plugin project. Run the following command to create a new plugin project: + +```bash +npx create-medusa-app my-plugin --plugin +``` + +This will create a new Medusa plugin project in the `my-plugin` directory. + +### Plugin Directory Structure + +After the installation is done, the plugin structure will look like this: + +![Directory structure of a plugin project](https://res.cloudinary.com/dza7lstvk/image/upload/v1737019441/Medusa%20Book/project-dir_q4xtri.jpg) + +- `src/`: Contains the Medusa customizations. +- `src/admin`: Contains [admin extensions](https://docs.medusajs.com/learn/fundamentals/admin/index.html.md). +- `src/api`: Contains [API routes](https://docs.medusajs.com/learn/fundamentals/api-routes/index.html.md) and [middlewares](https://docs.medusajs.com/learn/fundamentals/api-routes/middlewares/index.html.md). You can add store, admin, or any custom API routes. +- `src/jobs`: Contains [scheduled jobs](https://docs.medusajs.com/learn/fundamentals/scheduled-jobs/index.html.md). +- `src/links`: Contains [module links](https://docs.medusajs.com/learn/fundamentals/module-links/index.html.md). +- `src/modules`: Contains [modules](https://docs.medusajs.com/learn/fundamentals/modules/index.html.md). +- `src/provider`: Contains [module providers](#create-module-providers). +- `src/subscribers`: Contains [subscribers](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers/index.html.md). +- `src/workflows`: Contains [workflows](https://docs.medusajs.com/learn/fundamentals/workflows/index.html.md). You can also add [hooks](https://docs.medusajs.com/learn/fundamentals/workflows/add-workflow-hook/index.html.md) under `src/workflows/hooks`. +- `package.json`: Contains the plugin's package information, including general information and dependencies. +- `tsconfig.json`: Contains the TypeScript configuration for the plugin. + +*** + +## 2. Prepare Plugin + +### Package Name + +Before developing, testing, and publishing your plugin, make sure its name in `package.json` is correct. This is the name you'll use to install the plugin in your Medusa application. For example: -```ts title="integration-tests/http/test.spec.ts" highlights={highlights} -import { medusaIntegrationTestRunner } from "@medusajs/test-utils" +```json title="package.json" +{ + "name": "@myorg/plugin-name", + // ... +} +``` -medusaIntegrationTestRunner({ - testSuite: ({ api, getContainer }) => { - // TODO write tests... +### Package Keywords + +In addition, make sure that the `keywords` field in `package.json` includes the keyword `medusa-plugin` and `medusa-v2`. This helps Medusa list community plugins on the Medusa website: + +```json title="package.json" +{ + "keywords": [ + "medusa-plugin", + "medusa-v2" + ], + // ... +} +``` + +### Package Dependencies + +Your plugin project will already have the dependencies mentioned in this section. If you haven't made any changes to the dependencies, you can skip this section. + +In the `package.json` file you must have the Medusa dependencies as `devDependencies` and `peerDependencies`. In addition, you must have `@swc/core` as a `devDependency`, as it's used by the plugin CLI tools. + +For example, assuming `2.5.0` is the latest Medusa version: + +```json title="package.json" +{ + "devDependencies": { + "@medusajs/admin-sdk": "2.5.0", + "@medusajs/cli": "2.5.0", + "@medusajs/framework": "2.5.0", + "@medusajs/medusa": "2.5.0", + "@medusajs/test-utils": "2.5.0", + "@medusajs/ui": "4.0.4", + "@medusajs/icons": "2.5.0", + "@swc/core": "1.5.7", }, -}) - -jest.setTimeout(60 * 1000) -``` - -The `medusaIntegrationTestRunner` function accepts an object as a parameter. The object has a required property `testSuite`. - -`testSuite`'s value is a function that defines the tests to run. The function accepts as a parameter an object that has the following properties: - -- `api`: a set of utility methods used to send requests to the Medusa application. It has the following methods: - - `get`: Send a `GET` request to an API route. - - `post`: Send a `POST` request to an API route. - - `delete`: Send a `DELETE` request to an API route. -- `getContainer`: a function that retrieves the Medusa Container. Use the `getContainer().resolve` method to resolve resources from the Medusa Container. - -The tests in the `testSuite` function are written using [Jest](https://jestjs.io/). - -### Jest Timeout - -Since your tests connect to the database and perform actions that require more time than the typical tests, make sure to increase the timeout in your test: - -```ts title="integration-tests/http/test.spec.ts" -// in your test's file -jest.setTimeout(60 * 1000) + "peerDependencies": { + "@medusajs/admin-sdk": "2.5.0", + "@medusajs/cli": "2.5.0", + "@medusajs/framework": "2.5.0", + "@medusajs/test-utils": "2.5.0", + "@medusajs/medusa": "2.5.0", + "@medusajs/ui": "4.0.3", + "@medusajs/icons": "2.5.0", + } +} ``` *** -### Run Tests +## 3. Publish Plugin Locally for Development and Testing -Run the following command to run your tests: +Medusa's CLI tool provides commands to simplify developing and testing your plugin in a local Medusa application. You start by publishing your plugin in the local package registry, then install it in your Medusa application. You can then watch for changes in the plugin as you develop it. -```bash npm2yarn -npm run test:integration -``` - -If you don't have a `test:integration` script in `package.json`, refer to the [Medusa Testing Tools chapter](https://docs.medusajs.com/learn/debugging-and-testing/testing-tools#add-test-commands/index.html.md). - -This runs your Medusa application and runs the tests available under the `src/integrations/http` directory. - -*** - -## Other Options and Inputs - -Refer to [this reference in the Development Resources documentation](https://docs.medusajs.com/resources/test-tools-reference/medusaIntegrationTestRunner/index.html.md) for other available parameter options and inputs of the `testSuite` function. - -*** - -## Database Used in Tests - -The `medusaIntegrationTestRunner` function creates a database with a random name before running the tests. Then, it drops that database after all the tests end. - -To manage that database, such as changing its name or perform operations on it in your tests, refer to the [references in the Development Resources documentation](https://docs.medusajs.com/resources/test-tools-reference/medusaIntegrationTestRunner/index.html.md). - -*** - -## Example Integration Tests - -The next chapters provide examples of writing integration tests for API routes and workflows. - - -# Write Tests for Modules - -In this chapter, you'll learn about `moduleIntegrationTestRunner` from Medusa's Testing Framework and how to use it to write integration tests for a module's main service. +### Publish and Install Local Package ### Prerequisites -- [Testing Tools Setup](https://docs.medusajs.com/learn/debugging-and-testing/testing-tools/index.html.md) +- [Medusa application installed.](https://docs.medusajs.com/learn/installation/index.html.md) -## moduleIntegrationTestRunner Utility +The first time you create your plugin, you need to publish the package into a local package registry, then install it in your Medusa application. This is a one-time only process. -`moduleIntegrationTestRunner` creates integration tests for a module. The integration tests run on a test Medusa application with only the specified module enabled. +To publish the plugin to the local registry, run the following command in your plugin project: -For example, assuming you have a `hello` module, create a test file at `src/modules/hello/__tests__/service.spec.ts`: - -```ts title="src/modules/hello/__tests__/service.spec.ts" -import { moduleIntegrationTestRunner } from "@medusajs/test-utils" -import { HELLO_MODULE } from ".." -import HelloModuleService from "../service" -import MyCustom from "../models/my-custom" - -moduleIntegrationTestRunner({ - moduleName: HELLO_MODULE, - moduleModels: [MyCustom], - resolve: "./src/modules/hello", - testSuite: ({ service }) => { - // TODO write tests - }, -}) - -jest.setTimeout(60 * 1000) +```bash title="Plugin project" +npx medusa plugin:publish ``` -The `moduleIntegrationTestRunner` function accepts as a parameter an object with the following properties: +This command uses [Yalc](https://github.com/wclr/yalc) under the hood to publish the plugin to a local package registry. The plugin is published locally under the name you specified in `package.json`. -- `moduleName`: The name of the module. -- `moduleModels`: An array of models in the module. Refer to [this section](#write-tests-for-modules-without-data-models) if your module doesn't have data models. -- `resolve`: The path to the model. -- `testSuite`: A function that defines the tests to run. +Next, navigate to your Medusa application: -The `testSuite` function accepts as a parameter an object having the `service` property, which is an instance of the module's main service. +```bash title="Medusa application" +cd ~/path/to/medusa-app +``` -The type argument provided to the `moduleIntegrationTestRunner` function is used as the type of the `service` property. +Make sure to replace `~/path/to/medusa-app` with the path to your Medusa application. -The tests in the `testSuite` function are written using [Jest](https://jestjs.io/). +Then, if your project was created before v2.3.1 of Medusa, make sure to install `yalc` as a development dependency: + +```bash npm2yarn title="Medusa application" +npm install --save-dev yalc +``` + +After that, run the following Medusa CLI command to install the plugin: + +```bash title="Medusa application" +npx medusa plugin:add @myorg/plugin-name +``` + +Make sure to replace `@myorg/plugin-name` with the name of your plugin as specified in `package.json`. Your plugin will be installed from the local package registry into your Medusa application. + +### Register Plugin in Medusa Application + +After installing the plugin, you need to register it in your Medusa application in the configurations defined in `medusa-config.ts`. + +Add the plugin to the `plugins` array in the `medusa-config.ts` file: + +```ts title="medusa-config.ts" highlights={pluginHighlights} +module.exports = defineConfig({ + // ... + plugins: [ + { + resolve: "@myorg/plugin-name", + options: {}, + }, + ], +}) +``` + +The `plugins` configuration is an array of objects where each object has a `resolve` key whose value is the name of the plugin package. + +#### Pass Module Options through Plugin + +Each plugin configuration also accepts an `options` property, whose value is an object of options to pass to the plugin's modules. + +For example: + +```ts title="medusa-config.ts" highlights={pluginOptionsHighlight} +module.exports = defineConfig({ + // ... + plugins: [ + { + resolve: "@myorg/plugin-name", + options: { + apiKey: true, + }, + }, + ], +}) +``` + +The `options` property in the plugin configuration is passed to all modules in the plugin. Learn more about module options in [this chapter](https://docs.medusajs.com/learn/fundamentals/modules/options/index.html.md). + +### Watch Plugin Changes During Development + +While developing your plugin, you can watch for changes in the plugin and automatically update the plugin in the Medusa application using it. This is the only command you'll continuously need during your plugin development. + +To do that, run the following command in your plugin project: + +```bash title="Plugin project" +npx medusa plugin:develop +``` + +This command will: + +- Watch for changes in the plugin. Whenever a file is changed, the plugin is automatically built. +- Publish the plugin changes to the local package registry. This will automatically update the plugin in the Medusa application using it. You can also benefit from real-time HMR updates of admin extensions. + +### Start Medusa Application + +You can start your Medusa application's development server to test out your plugin: + +```bash npm2yarn title="Medusa application" +npm run dev +``` + +While your Medusa application is running and the plugin is being watched, you can test your plugin while developing it in the Medusa application. *** -## Run Tests +## 4. Create Customizations in the Plugin -Run the following command to run your module integration tests: +You can now build your plugin's customizations. The following guide explains how to build different customizations in your plugin. + +- [Create a module](https://docs.medusajs.com/learn/fundamentals/modules/index.html.md) +- [Create a module link](https://docs.medusajs.com/learn/fundamentals/module-links/index.html.md) +- [Create a workflow](https://docs.medusajs.com/learn/fundamentals/workflows/index.html.md) +- [Add a workflow hook](https://docs.medusajs.com/learn/fundamentals/workflows/add-workflow-hook/index.html.md) +- [Create an API route](https://docs.medusajs.com/learn/fundamentals/api-routes/index.html.md) +- [Add a subscriber](https://docs.medusajs.com/learn/fundamentals/events-and-subscribers/index.html.md) +- [Add a scheduled job](https://docs.medusajs.com/learn/fundamentals/scheduled-jobs/index.html.md) +- [Add an admin widget](https://docs.medusajs.com/learn/fundamentals/admin/widgets/index.html.md) +- [Add an admin UI route](https://docs.medusajs.com/learn/fundamentals/admin/ui-routes/index.html.md) + +While building those customizations, you can test them in your Medusa application by [watching the plugin changes](#watch-plugin-changes-during-development) and [starting the Medusa application](#start-medusa-application). + +### Generating Migrations for Modules + +During your development, you may need to generate migrations for modules in your plugin. To do that, use the `plugin:db:generate` command: + +```bash title="Plugin project" +npx medusa plugin:db:generate +``` + +This command generates migrations for all modules in the plugin. You can then run these migrations on the Medusa application that the plugin is installed in using the `db:migrate` command: + +```bash title="Medusa application" +npx medusa db:migrate +``` + +### Importing Module Resources + +Your plugin project should have the following exports in `package.json`: + +```json title="package.json" +{ + "exports": { + "./package.json": "./package.json", + "./workflows": "./.medusa/server/src/workflows/index.js", + "./.medusa/server/src/modules/*": "./.medusa/server/src/modules/*/index.js", + "./providers/*": "./.medusa/server/src/providers/*/index.js", + "./*": "./.medusa/server/src/*.js" + } +} +``` + +Aside from the `./package.json` and `./providers`, these exports are only a recommendation. You can cherry-pick the files and directories you want to export. + +The plugin exports the following files and directories: + +- `./package.json`: The package.json file. Medusa needs to access the `package.json` when registering the plugin. +- `./workflows`: The workflows exported in `./src/workflows/index.ts`. +- `./.medusa/server/src/modules/*`: The definition file of modules. This is useful if you create links to the plugin's modules in the Medusa application. +- `./providers/*`: The definition file of module providers. This allows you to register the plugin's providers in the Medusa application. +- `./*`: Any other files in the plugin's `src` directory. + +With these exports, you can import the plugin's resources in the Medusa application's code like this: + +`@myorg/plugin-name` is the plugin package's name. + +```ts +import { Workflow1, Workflow2 } from "@myorg/plugin-name/workflows" +import BlogModule from "@myorg/plugin-name/modules/blog" +// import other files created in plugin like ./src/types/blog.ts +import BlogType from "@myorg/plugin-name/types/blog" +``` + +And you can register a module provider in the Medusa application's `medusa-config.ts` like this: + +```ts highlights={[["9"]]} title="medusa-config.ts" +module.exports = defineConfig({ + // ... + modules: [ + { + resolve: "@medusajs/medusa/notification", + options: { + providers: [ + { + resolve: "@myorg/plugin-name/providers/my-notification", + id: "my-notification", + options: { + channels: ["email"], + // provider options... + }, + }, + ], + }, + }, + ], +}) +``` + +You pass to `resolve` the path to the provider relative to the plugin package. So, in this example, the `my-notification` provider is located in `./src/providers/my-notification/index.ts` of the plugin. + +### Create Module Providers + +To learn how to create module providers, refer to the following guides: + +- [File Module Provider](https://docs.medusajs.com/resources/references/file-provider-module/index.html.md) +- [Notification Module Provider](https://docs.medusajs.com/resources/references/notification-provider-module/index.html.md) +- [Auth Module Provider](https://docs.medusajs.com/resources/references/auth/provider/index.html.md) +- [Payment Module Provider](https://docs.medusajs.com/resources/references/payment/provider/index.html.md) +- [Fulfillment Module Provider](https://docs.medusajs.com/resources/references/fulfillment/provider/index.html.md) +- [Tax Module Provider](https://docs.medusajs.com/resources/references/tax/provider/index.html.md) + +*** + +## 5. Publish Plugin to NPM + +Medusa's CLI tool provides a command that bundles your plugin to be published to npm. Once you're ready to publish your plugin publicly, run the following command in your plugin project: + +```bash +npx medusa plugin:build +``` + +The command will compile an output in the `.medusa/server` directory. + +You can now publish the plugin to npm using the [NPM CLI tool](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm). Run the following command to publish the plugin to npm: + +```bash +npm publish +``` + +If you haven't logged in before with your NPM account, you'll be asked to log in first. Then, your package is published publicly to be used in any Medusa application. + +### Install Public Plugin in Medusa Application + +You install a plugin that's published publicly using your package manager. For example: ```bash npm2yarn -npm run test:integration:modules +npm install @myorg/plugin-name ``` -If you don't have a `test:integration:modules` script in `package.json`, refer to the [Medusa Testing Tools chapter](https://docs.medusajs.com/learn/debugging-and-testing/testing-tools#add-test-commands/index.html.md). +Where `@myorg/plugin-name` is the name of your plugin as published on NPM. -This runs your Medusa application and runs the tests available in any `__tests__` directory under the `src/modules` directory. +Then, register the plugin in your Medusa application's configurations as explained in [this section](#register-plugin-in-medusa-application). *** -## Pass Module Options +## Update a Published Plugin -If your module accepts options, you can set them using the `moduleOptions` property of the `moduleIntegrationTestRunner`'s parameter. +To update the Medusa dependencies in a plugin, refer to [this documentation](https://docs.medusajs.com/learn/update#update-plugin-project/index.html.md). + +If you've published a plugin and you've made changes to it, you'll have to publish the update to NPM again. + +First, run the following command to change the version of the plugin: + +```bash +npm version +``` + +Where `` indicates the type of version update you’re publishing. For example, it can be `major` or `minor`. Refer to the [npm version documentation](https://docs.npmjs.com/cli/v10/commands/npm-version) for more information. + +Then, re-run the same commands for publishing a plugin: + +```bash +npx medusa plugin:build +npm publish +``` + +This will publish an updated version of your plugin under a new version. + + +# Scheduled Jobs Number of Executions + +In this chapter, you'll learn how to set a limit on the number of times a scheduled job is executed. + +## numberOfExecutions Option + +The export configuration object of the scheduled job accepts an optional property `numberOfExecutions`. Its value is a number indicating how many times the scheduled job can be executed during the Medusa application's runtime. + +For example: + +```ts highlights={highlights} +export default async function myCustomJob() { + console.log("I'll be executed three times only.") +} + +export const config = { + name: "hello-world", + // execute every minute + schedule: "* * * * *", + numberOfExecutions: 3, +} +``` + +The above scheduled job has the `numberOfExecutions` configuration set to `3`. + +So, it'll only execute 3 times, each every minute, then it won't be executed anymore. + +If you restart the Medusa application, the scheduled job will be executed again until reaching the number of executions specified. + + +# Docs Contribution Guidelines + +Thank you for your interest in contributing to the documentation! You will be helping the open source community and other developers interested in learning more about Medusa and using it. + +This guide is specific to contributing to the documentation. If you’re interested in contributing to Medusa’s codebase, check out the [contributing guidelines in the Medusa GitHub repository](https://github.com/medusajs/medusa/blob/develop/CONTRIBUTING.md). + +## Documentation Workspace + +Medusa's documentation projects are all part of the documentation yarn workspace, which you can find in the [medusa repository](https://github.com/medusajs/medusa) under the `www` directory. + +The workspace has the following two directories: + +- `apps`: this directory holds the different documentation websites and projects. + - `book`: includes the codebase for the [main Medusa documentation](https://docs.medusajs.com//index.html.md). It's built with [Next.js 15](https://nextjs.org/). + - `resources`: includes the codebase for the Medusa Development Resources documentation. It's built with [Next.js 15](https://nextjs.org/). + - `api-reference`: includes the codebase for the API reference website. It's built with [Next.js 15](https://nextjs.org/). + - `ui`: includes the codebase for the Medusa UI documentation website. It's built with [Next.js 15](https://nextjs.org/). +- `packages`: this directory holds the shared packages and components necessary for the development of the projects in the `apps` directory. + - `docs-ui` includes the shared React components between the different apps. + - `remark-rehype-plugins` includes Remark and Rehype plugins used by the documentation projects. + +*** + +## Documentation Content + +All documentation projects are built with Next.js. The content is writtin in MDX files. + +### Medusa Main Docs Content + +The content of the Medusa main docs are under the `www/apps/book/app` directory. + +### Medusa Development Resources Content + +The content of the Medusa Resources documentation are under the `www/apps/resources/app` directory. + +Documentation pages under the `www/apps/resources/references` directory are generated automatically from the source code under the `packages/medusa` directory. So, you can't directly make changes to them. Instead, you'll have to make changes to the comments in the original source code. + +### API Reference + +The API reference's content is split into two types: + +1. Static content, which are the content related to getting started, expanding fields, and more. These are located in the `www/apps/api-reference/markdown` directory. They are MDX files. +2. OpenAPI specs that are shown to developers when checking the reference of an API Route. These are generated from OpenApi Spec comments, which are under the `www/utils/generated/oas-output` directory. + +### Medusa UI Documentation + +The content of the Medusa UI documentation are located under the `www/apps/ui/src/content/docs` directory. They are MDX files. + +The UI documentation also shows code examples, which are under the `www/apps/ui/src/examples` directory. + +The UI component props are generated from the source code and placed into the `www/apps/ui/src/specs` directory. To contribute to these props and their comments, check the comments in the source code under the `packages/design-system/ui` directory. + +*** + +## Style Guide + +When you contribute to the documentation content, make sure to follow the [documentation style guide](https://www.notion.so/Style-Guide-Docs-fad86dd1c5f84b48b145e959f36628e0). + +*** + +## How to Contribute + +If you’re fixing errors in an existing documentation page, you can scroll down to the end of the page and click on the “Edit this page” link. You’ll be redirected to the GitHub edit form of that page and you can make edits directly and submit a pull request (PR). + +If you’re adding a new page or contributing to the codebase, fork the repository, create a new branch, and make all changes necessary in your repository. Then, once you’re done, create a PR in the Medusa repository. + +### Base Branch + +When you make an edit to an existing documentation page or fork the repository to make changes to the documentation, create a new branch. + +Documentation contributions always use `develop` as the base branch. Make sure to also open your PR against the `develop` branch. + +### Branch Name + +Make sure that the branch name starts with `docs/`. For example, `docs/fix-services`. Vercel deployed previews are only triggered for branches starting with `docs/`. + +### Pull Request Conventions + +When you create a pull request, prefix the title with `docs:` or `docs(PROJECT_NAME):`, where `PROJECT_NAME` is the name of the documentation project this pull request pertains to. For example, `docs(ui): fix titles`. + +In the body of the PR, explain clearly what the PR does. If the PR solves an issue, use [closing keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) with the issue number. For example, “Closes #1333”. + +*** + +## Images + +If you are adding images to a documentation page, you can host the image on [Imgur](https://imgur.com) for free to include it in the PR. Our team will later upload it to our image hosting. + +*** + +## NPM and Yarn Code Blocks + +If you’re adding code blocks that use NPM and Yarn, you must add the `npm2yarn` meta field. + +For example: + +````md +```bash npm2yarn +npm run start +``` +```` + +The code snippet must be written using NPM. + +### Global Option + +When a command uses the global option `-g`, add it at the end of the NPM command to ensure that it’s transformed to a Yarn command properly. For example: + +```bash npm2yarn +npm install @medusajs/cli -g +``` + +*** + +## Linting with Vale + +Medusa uses [Vale](https://vale.sh/) to lint documentation pages and perform checks on incoming PRs into the repository. + +### Result of Vale PR Checks + +You can check the result of running the "lint" action on your PR by clicking the Details link next to it. You can find there all errors that you need to fix. + +### Run Vale Locally + +If you want to check your work locally, you can do that by: + +1. [Installing Vale](https://vale.sh/docs/vale-cli/installation/) on your machine. +2. Changing to the `www/vale` directory: + +```bash +cd www/vale +``` + +3\. Running the `run-vale` script: + +```bash +# to lint content for the main documentation +./run-vale.sh book/app/learn error resources +# to lint content for the resources documentation +./run-vale.sh resources/app error +# to lint content for the API reference +./run-vale.sh api-reference/markdown error +# to lint content for the Medusa UI documentation +./run-vale.sh ui/src/content/docs error +# to lint content for the user guide +./run-vale.sh user-guide/app error +``` + +{/* TODO need to enable MDX v1 comments first. */} + +{/* ### Linter Exceptions + +If it's needed to break some style guide rules in a document, you can wrap the parts that the linter shouldn't scan with the following comments in the `md` or `mdx` files: + +```md + + +content that shouldn't be scanned for errors here... + + +``` + +You can also disable specific rules. For example: + +```md + + +Medusa supports Node versions 14 and 16. + + +``` + +If you use this in your PR, you must justify its usage. */} + +*** + +## Linting with ESLint + +Medusa uses ESlint to lint code blocks both in the content and the code base of the documentation apps. + +### Linting Content with ESLint + +Each PR runs through a check that lints the code in the content files using ESLint. The action's name is `content-eslint`. + +If you want to check content ESLint errors locally and fix them, you can do that by: + +1\. Install the dependencies in the `www` directory: + +```bash +yarn install +``` + +2\. Run the turbo command in the `www` directory: + +```bash +turbo run lint:content +``` + +This will fix any fixable errors, and show errors that require your action. + +### Linting Code with ESLint + +Each PR runs through a check that lints the code in the content files using ESLint. The action's name is `code-docs-eslint`. + +If you want to check code ESLint errors locally and fix them, you can do that by: + +1\. Install the dependencies in the `www` directory: + +```bash +yarn install +``` + +2\. Run the turbo command in the `www` directory: + +```bash +yarn lint +``` + +This will fix any fixable errors, and show errors that require your action. + +{/* TODO need to enable MDX v1 comments first. */} + +{/* ### ESLint Exceptions + +If some code blocks have errors that can't or shouldn't be fixed, you can add the following command before the code block: + +~~~md + + +```js +console.log("This block isn't linted") +``` + +```js +console.log("This block is linted") +``` +~~~ + +You can also disable specific rules. For example: + +~~~md + + +```js +console.log("This block can use semicolons"); +``` + +```js +console.log("This block can't use semi colons") +``` +~~~ */} + + +# Translate Medusa Admin + +The Medusa Admin supports multiple languages, with the default being English. In this documentation, you'll learn how to contribute to the community by translating the Medusa Admin to a language you're fluent in. + +{/* vale docs.We = NO */} + +You can contribute either by translating the admin to a new language, or fixing translations for existing languages. As we can't validate every language's translations, some translations may be incorrect. Your contribution is welcome to fix any translation errors you find. + +{/* vale docs.We = YES */} + +Check out the translated languages either in the admin dashboard's settings or on [GitHub](https://github.com/medusajs/medusa/blob/develop/packages/admin/dashboard/src/i18n/languages.ts). + +*** + +## How to Contribute Translation + +1. Clone the [Medusa monorepository](https://github.com/medusajs/medusa) to your local machine: + +```bash +git clone https://github.com/medusajs/medusa.git +``` + +If you already have it cloned, make sure to pull the latest changes from the `develop` branch. + +2. Install the monorepository's dependencies. Since it's a Yarn workspace, it's highly recommended to use yarn: + +```bash +yarn install +``` + +3. Create a branch that you'll use to open the pull request later: + +```bash +git checkout -b feat/translate- +``` + +Where `` is your language name. For example, `feat/translate-da`. + +4. Translation files are under `packages/admin/dashboard/src/i18n/translations` as JSON files whose names are the ISO-2 name of the language. + - If you're adding a new language, copy the file `packages/admin/dashboard/src/i18n/translations/en.json` and paste it with the ISO-2 name for your language. For example, if you're adding Danish translations, copy the `en.json` file and paste it as `packages/admin/dashboard/src/i18n/translations/de.json`. + - If you're fixing a translation, find the JSON file of the language under `packages/admin/dashboard/src/i18n/translations`. + +5. Start translating the keys in the JSON file (or updating the targeted ones). All keys in the JSON file must be translated, and your PR tests will fail otherwise. + - You can check whether the JSON file is valid by running the following command in `packages/admin/dashboard`, replacing `da.json` with the JSON file's name: + +```bash title="packages/admin/dashboard" +yarn i18n:validate da.json +``` + +6. After finishing the translation, if you're adding a new language, import its JSON file in `packages/admin/dashboard/src/i18n/translations/index.ts` and add it to the exported object: + +```ts title="packages/admin/dashboard/src/i18n/translations/index.ts" highlights={[["2"], ["6"], ["7"], ["8"]]} +// other imports... +import da from "./da.json" + +export default { + // other languages... + da: { + translation: da, + }, +} +``` + +The language's key in the object is the ISO-2 name of the language. + +7. If you're adding a new language, add it to the file `packages/admin/dashboard/src/i18n/languages.ts`: + +```ts title="packages/admin/dashboard/src/i18n/languages.ts" highlights={languageHighlights} +import { da } from "date-fns/locale" +// other imports... + +export const languages: Language[] = [ + // other languages... + { + code: "da", + display_name: "Danish", + ltr: true, + date_locale: da, + }, +] +``` + +`languages` is an array having the following properties: + +- `code`: The ISO-2 name of the language. For example, `da` for Danish. +- `display_name`: The language's name to be displayed in the admin. +- `ltr`: Whether the language supports a left-to-right layout. For example, set this to `false` for languages like Arabic. +- `date_locale`: An instance of the locale imported from the [date-fns/locale](https://date-fns.org/) package. + +8. Once you're done, push the changes into your branch and open a pull request on GitHub. + +Our team will perform a general review on your PR and merge it if no issues are found. The translation will be available in the admin after the next release. + + +# Access Workflow Errors + +In this chapter, you’ll learn how to access errors that occur during a workflow’s execution. + +## How to Access Workflow Errors? + +By default, when an error occurs in a workflow, it throws that error, and the execution stops. + +You can configure the workflow to return the errors instead so that you can access and handle them differently. + +For example: + +```ts title="src/api/workflows/route.ts" highlights={highlights} collapsibleLines="1-6" expandButtonLabel="Show Imports" +import type { + MedusaRequest, + MedusaResponse, +} from "@medusajs/framework/http" +import myWorkflow from "../../../workflows/hello-world" + +export async function GET( + req: MedusaRequest, + res: MedusaResponse +) { + const { result, errors } = await myWorkflow(req.scope) + .run({ + // ... + throwOnError: false, + }) + + if (errors.length) { + return res.send({ + errors: errors.map((error) => error.error), + }) + } + + res.send(result) +} + +``` + +The object passed to the `run` method accepts a `throwOnError` property. When disabled, the errors are returned in the `errors` property of `run`'s output. + +The value of `errors` is an array of error objects. Each object has an `error` property, whose value is the name or text of the thrown error. + + +# Expose a Workflow Hook + +In this chapter, you'll learn how to expose a hook in your workflow. + +## When to Expose a Hook + +Your workflow is reusable in other applications, and you allow performing an external action at some point in your workflow. + +Your workflow isn't reusable by other applications. Use a step that performs what a hook handler would instead. + +*** + +## How to Expose a Hook in a Workflow? + +To expose a hook in your workflow, use `createHook` from the Workflows SDK. + +For example: + +```ts title="src/workflows/my-workflow/index.ts" highlights={hookHighlights} +import { + createStep, + createHook, + createWorkflow, + WorkflowResponse, +} from "@medusajs/framework/workflows-sdk" +import { createProductStep } from "./steps/create-product" + +export const myWorkflow = createWorkflow( + "my-workflow", + function (input) { + const product = createProductStep(input) + const productCreatedHook = createHook( + "productCreated", + { productId: product.id } + ) + + return new WorkflowResponse(product, { + hooks: [productCreatedHook], + }) + } +) +``` + +The `createHook` function accepts two parameters: + +1. The first is a string indicating the hook's name. You use this to consume the hook later. +2. The second is the input to pass to the hook handler. + +The workflow must also pass an object having a `hooks` property as a second parameter to the `WorkflowResponse` constructor. Its value is an array of the workflow's hooks. + +### How to Consume the Hook? + +To consume the hook of the workflow, create the file `src/workflows/hooks/my-workflow.ts` with the following content: + +```ts title="src/workflows/hooks/my-workflow.ts" highlights={handlerHighlights} +import { myWorkflow } from "../my-workflow" + +myWorkflow.hooks.productCreated( + async ({ productId }, { container }) => { + // TODO perform an action + } +) +``` + +The hook is available on the workflow's `hooks` property using its name `productCreated`. + +You invoke the hook, passing a step function (the hook handler) as a parameter. + + +# Compensation Function + +In this chapter, you'll learn what a compensation function is and how to add it to a step. + +## What is a Compensation Function + +A compensation function rolls back or undoes changes made by a step when an error occurs in the workflow. + +For example, if a step creates a record, the compensation function deletes the record when an error occurs later in the workflow. + +By using compensation functions, you provide a mechanism that guarantees data consistency in your application and across systems. + +*** + +## How to add a Compensation Function? + +A compensation function is passed as a second parameter to the `createStep` function. + +For example, create the file `src/workflows/hello-world.ts` with the following content: + +```ts title="src/workflows/hello-world.ts" highlights={[["15"], ["16"], ["17"]]} collapsibleLines="1-5" expandButtonLabel="Show Imports" +import { + createStep, + StepResponse, +} from "@medusajs/framework/workflows-sdk" + +const step1 = createStep( + "step-1", + async () => { + const message = `Hello from step one!` + + console.log(message) + + return new StepResponse(message) + }, + async () => { + console.log("Oops! Rolling back my changes...") + } +) +``` + +Each step can have a compensation function. The compensation function only runs if an error occurs throughout the workflow. + +*** + +## Test the Compensation Function + +Create a step in the same `src/workflows/hello-world.ts` file that throws an error: + +```ts title="src/workflows/hello-world.ts" +const step2 = createStep( + "step-2", + async () => { + throw new Error("Throwing an error...") + } +) +``` + +Then, create a workflow that uses the steps: + +```ts title="src/workflows/hello-world.ts" collapsibleLines="1-8" expandButtonLabel="Show Imports" +import { + createWorkflow, + WorkflowResponse, +} from "@medusajs/framework/workflows-sdk" +// other imports... + +// steps... + +const myWorkflow = createWorkflow( + "hello-world", + function (input) { + const str1 = step1() + step2() + + return new WorkflowResponse({ + message: str1, + }) +}) + +export default myWorkflow +``` + +Finally, execute the workflow from an API route: + +```ts title="src/api/workflow/route.ts" collapsibleLines="1-6" expandButtonLabel="Show Imports" +import type { + MedusaRequest, + MedusaResponse, +} from "@medusajs/framework/http" +import myWorkflow from "../../../workflows/hello-world" + +export async function GET( + req: MedusaRequest, + res: MedusaResponse +) { + const { result } = await myWorkflow(req.scope) + .run() + + res.send(result) +} +``` + +Run the Medusa application and send a `GET` request to `/workflow`: + +```bash +curl http://localhost:9000/workflow +``` + +In the console, you'll see: + +- `Hello from step one!` logged in the terminal, indicating that the first step ran successfully. +- `Oops! Rolling back my changes...` logged in the terminal, indicating that the second step failed and the compensation function of the first step ran consequently. + +*** + +## Pass Input to Compensation Function + +If a step creates a record, the compensation function must receive the ID of the record to remove it. + +To pass input to the compensation function, pass a second parameter in the `StepResponse` returned by the step. + +For example: + +```ts highlights={inputHighlights} +import { + createStep, + StepResponse, +} from "@medusajs/framework/workflows-sdk" + +const step1 = createStep( + "step-1", + async () => { + return new StepResponse( + `Hello from step one!`, + { message: "Oops! Rolling back my changes..." } + ) + }, + async ({ message }) => { + console.log(message) + } +) +``` + +In this example, the step passes an object as a second parameter to `StepResponse`. + +The compensation function receives the object and uses its `message` property to log a message. + +*** + +## Resolve Resources from the Medusa Container + +The compensation function receives an object second parameter. The object has a `container` property that you use to resolve resources from the Medusa container. For example: ```ts -import { moduleIntegrationTestRunner } from "@medusajs/test-utils" -import HelloModuleService from "../service" +import { + createStep, + StepResponse, +} from "@medusajs/framework/workflows-sdk" +import { ContainerRegistrationKeys } from "@medusajs/framework/utils" -moduleIntegrationTestRunner({ - moduleOptions: { - apiKey: "123", +const step1 = createStep( + "step-1", + async () => { + return new StepResponse( + `Hello from step one!`, + { message: "Oops! Rolling back my changes..." } + ) }, + async ({ message }, { container }) => { + const logger = container.resolve( + ContainerRegistrationKeys.LOGGER + ) + + logger.info(message) + } +) +``` + +In this example, you use the `container` property in the second object parameter of the compensation function to resolve the logger. + +You then use the logger to log a message. + +*** + +## Handle Errors in Loops + +This feature is only available after [Medusa v2.0.5](https://github.com/medusajs/medusa/releases/tag/v2.0.5). + +Consider you have a module that integrates a third-party ERP system, and you're creating a workflow that deletes items in that ERP. You may have the following step: + +```ts +// other imports... +import { promiseAll } from "@medusajs/framework/utils" + +type StepInput = { + ids: string[] +} + +const step1 = createStep( + "step-1", + async ({ ids }: StepInput, { container }) => { + const erpModuleService = container.resolve( + ERP_MODULE + ) + const prevData: unknown[] = [] + + await promiseAll( + ids.map(async (id) => { + const data = await erpModuleService.retrieve(id) + + await erpModuleService.delete(id) + + prevData.push(id) + }) + ) + + return new StepResponse(ids, prevData) + } +) +``` + +In the step, you loop over the IDs to retrieve the item's data, store them in a `prevData` variable, then delete them using the ERP Module's service. You then pass the `prevData` variable to the compensation function. + +However, if an error occurs in the loop, the `prevData` variable won't be passed to the compensation function as the execution never reached the return statement. + +To handle errors in the loop so that the compensation function receives the last version of `prevData` before the error occurred, you wrap the loop in a try-catch block. Then, in the catch block, you invoke and return the `StepResponse.permanentFailure` function: + +```ts highlights={highlights} +try { + await promiseAll( + ids.map(async (id) => { + const data = await erpModuleService.retrieve(id) + + await erpModuleService.delete(id) + + prevData.push(id) + }) + ) +} catch (e) { + return StepResponse.permanentFailure( + `An error occurred: ${e}`, + prevData + ) +} +``` + +The `StepResponse.permanentFailure` fails the step and its workflow, triggering current and previous steps' compensation functions. The `permanentFailure` function accepts as a first parameter the error message, which is saved in the workflow's error details, and as a second parameter the data to pass to the compensation function. + +So, if an error occurs during the loop, the compensation function will still receive the `prevData` variable to undo the changes made before the step failed. + + +# Conditions in Workflows with When-Then + +In this chapter, you'll learn how to execute an action based on a condition in a workflow using when-then from the Workflows SDK. + +## Why If-Conditions Aren't Allowed in Workflows? + +Medusa creates an internal representation of the workflow definition you pass to `createWorkflow` to track and store its steps. At that point, variables in the workflow don't have any values. They only do when you execute the workflow. + +So, you can't use an if-condition that checks a variable's value, as the condition will be evaluated when Medusa creates the internal representation of the workflow, rather than during execution. + +Instead, use when-then from the Workflows SDK. It allows you to perform steps in a workflow only if a condition that you specify is satisfied. + +Restrictions for conditions is only applicable in a workflow's definition. You can still use if-conditions in your step's code. + +*** + +## How to use When-Then? + +The Workflows SDK provides a `when` function that is used to check whether a condition is true. You chain a `then` function to `when` that specifies the steps to execute if the condition in `when` is satisfied. + +For example: + +```ts highlights={highlights} +import { + createWorkflow, + WorkflowResponse, + when, +} from "@medusajs/framework/workflows-sdk" +// step imports... + +const workflow = createWorkflow( + "workflow", + function (input: { + is_active: boolean + }) { + + const result = when( + input, + (input) => { + return input.is_active + } + ).then(() => { + const stepResult = isActiveStep() + return stepResult + }) + + // executed without condition + const anotherStepResult = anotherStep(result) + + return new WorkflowResponse( + anotherStepResult + ) + } +) +``` + +In this code snippet, you execute the `isActiveStep` only if the `input.is_active`'s value is `true`. + +### When Parameters + +`when` accepts the following parameters: + +1. The first parameter is either an object or the workflow's input. This data is passed as a parameter to the function in `when`'s second parameter. +2. The second parameter is a function that returns a boolean indicating whether to execute the action in `then`. + +### Then Parameters + +To specify the action to perform if the condition is satisfied, chain a `then` function to `when` and pass it a callback function. + +The callback function is only executed if `when`'s second parameter function returns a `true` value. + +*** + +## Implementing If-Else with When-Then + +when-then doesn't support if-else conditions. Instead, use two `when-then` conditions in your workflow. + +For example: + +```ts highlights={ifElseHighlights} +const workflow = createWorkflow( + "workflow", + function (input: { + is_active: boolean + }) { + + const isActiveResult = when( + input, + (input) => { + return input.is_active + } + ).then(() => { + return isActiveStep() + }) + + const notIsActiveResult = when( + input, + (input) => { + return !input.is_active + } + ).then(() => { + return notIsActiveStep() + }) + + // ... + } +) +``` + +In the above workflow, you use two `when-then` blocks. The first one performs a step if `input.is_active` is `true`, and the second performs a step if `input.is_active` is `false`, acting as an else condition. + +*** + +## Specify Name for When-Then + +Internally, `when-then` blocks have a unique name similar to a step. When you return a step's result in a `when-then` block, the block's name is derived from the step's name. For example: + +```ts +const isActiveResult = when( + input, + (input) => { + return input.is_active + } +).then(() => { + return isActiveStep() +}) +``` + +This `when-then` block's internal name will be `when-then-is-active`, where `is-active` is the step's name. + +However, if you need to return in your `when-then` block something other than a step's result, you need to specify a unique step name for that block. Otherwise, Medusa will generate a random name for it which can cause unexpected errors in production. + +You pass a name for `when-then` as a first parameter of `when`, whose signature can accept three parameters in this case. For example: + +```ts highlights={nameHighlights} +const { isActive } = when( + "check-is-active", + input, + (input) => { + return input.is_active + } +).then(() => { + const isActive = isActiveStep() + + return { + isActive, + } +}) +``` + +Since `then` returns a value different than the step's result, you pass to the `when` function the following parameters: + +1. A unique name to be assigned to the `when-then` block. +2. Either an object or the workflow's input. This data is passed as a parameter to the function in `when`'s second parameter. +3. A function that returns a boolean indicating whether to execute the action in `then`. + +The second and third parameters are the same as the parameters you previously passed to `when`. + + +# Workflow Constraints + +This chapter lists constraints of defining a workflow or its steps. + +Medusa creates an internal representation of the workflow definition you pass to `createWorkflow` to track and store its steps. At that point, variables in the workflow don't have any values. They only do when you execute the workflow. + +This creates restrictions related to variable manipulations, using if-conditions, and other constraints. This chapter lists these constraints and provides their alternatives. + +## Workflow Constraints + +### No Async Functions + +The function passed to `createWorkflow` can’t be an async function: + +```ts highlights={[["4", "async", "Function can't be async."], ["11", "", "Correct way of defining the function."]]} +// Don't +const myWorkflow = createWorkflow( + "hello-world", + async function (input: WorkflowInput) { // ... }) + +// Do +const myWorkflow = createWorkflow( + "hello-world", + function (input: WorkflowInput) { + // ... +}) +``` + +### No Direct Variable Manipulation + +You can’t directly manipulate variables within the workflow's constructor function. + +Learn more about why you can't manipulate variables [in this chapter](https://docs.medusajs.com/learn/fundamentals/workflows/variable-manipulation/index.html.md) + +Instead, use `transform` from the Workflows SDK: + +```ts highlights={highlights} +// Don't +const myWorkflow = createWorkflow( + "hello-world", + function (input: WorkflowInput) { + const str1 = step1(input) + const str2 = step2(input) + + return new WorkflowResponse({ + message: `${str1}${str2}`, + }) +}) + +// Do +const myWorkflow = createWorkflow( + "hello-world", + function (input: WorkflowInput) { + const str1 = step1(input) + const str2 = step2(input) + + const result = transform( + { + str1, + str2, + }, + (input) => ({ + message: `${input.str1}${input.str2}`, + }) + ) + + return new WorkflowResponse(result) +}) +``` + +### Create Dates in transform + +When you use `new Date()` in a workflow's constructor function, the date is evaluated when Medusa creates the internal representation of the workflow, not during execution. + +Instead, create the date using `transform`. + +Learn more about how Medusa creates an internal representation of a workflow [in this chapter](https://docs.medusajs.com/learn/fundamentals/workflows/variable-manipulation/index.html.md). + +For example: + +```ts highlights={dateHighlights} +// Don't +const myWorkflow = createWorkflow( + "hello-world", + function (input: WorkflowInput) { + const today = new Date() + + return new WorkflowResponse({ + today, + }) +}) + +// Do +const myWorkflow = createWorkflow( + "hello-world", + function (input: WorkflowInput) { + const today = transform({}, () => new Date()) + + return new WorkflowResponse({ + today, + }) +}) +``` + +### No If Conditions + +You can't use if-conditions in a workflow. + +Learn more about why you can't use if-conditions [in this chapter](https://docs.medusajs.com/learn/fundamentals/workflows/conditions#why-if-conditions-arent-allowed-in-workflows/index.html.md) + +Instead, use when-then from the Workflows SDK: + +```ts +// Don't +const myWorkflow = createWorkflow( + "hello-world", + function (input: WorkflowInput) { + if (input.is_active) { + // perform an action + } +}) + +// Do (explained in the next chapter) +const myWorkflow = createWorkflow( + "hello-world", + function (input: WorkflowInput) { + when(input, (input) => { + return input.is_active + }) + .then(() => { + // perform an action + }) +}) +``` + +You can also pair multiple `when-then` blocks to implement an `if-else` condition as explained in [this chapter](https://docs.medusajs.com/learn/fundamentals/workflows/conditions/index.html.md). + +### No Conditional Operators + +You can't use conditional operators in a workflow, such as `??` or `||`. + +Learn more about why you can't use conditional operators [in this chapter](https://docs.medusajs.com/learn/fundamentals/workflows/conditions#why-if-conditions-arent-allowed-in-workflows/index.html.md) + +Instead, use `transform` to store the desired value in a variable. + +### Logical Or (||) Alternative + +```ts +// Don't +const myWorkflow = createWorkflow( + "hello-world", + function (input: WorkflowInput) { + const message = input.message || "Hello" +}) + +// Do +// other imports... +import { transform } from "@medusajs/framework/workflows-sdk" + +const myWorkflow = createWorkflow( + "hello-world", + function (input: WorkflowInput) { + const message = transform( + { + input, + }, + (data) => data.input.message || "hello" + ) +}) +``` + +### Nullish Coalescing (??) Alternative + +```ts +// Don't +const myWorkflow = createWorkflow( + "hello-world", + function (input: WorkflowInput) { + const message = input.message ?? "Hello" +}) + +// Do +// other imports... +import { transform } from "@medusajs/framework/workflows-sdk" + +const myWorkflow = createWorkflow( + "hello-world", + function (input: WorkflowInput) { + const message = transform( + { + input, + }, + (data) => data.input.message ?? "hello" + ) +}) +``` + +### Double Not (!!) Alternative + +```ts +// Don't +const myWorkflow = createWorkflow( + "hello-world", + function (input: WorkflowInput) { + step1({ + isActive: !!input.is_active, + }) +}) + +// Do +// other imports... +import { transform } from "@medusajs/framework/workflows-sdk" + +const myWorkflow = createWorkflow( + "hello-world", + function (input: WorkflowInput) { + const isActive = transform( + { + input, + }, + (data) => !!data.input.is_active + ) + + step1({ + isActive, + }) +}) +``` + +### Ternary Alternative + +```ts +// Don't +const myWorkflow = createWorkflow( + "hello-world", + function (input: WorkflowInput) { + step1({ + message: input.is_active ? "active" : "inactive", + }) +}) + +// Do +// other imports... +import { transform } from "@medusajs/framework/workflows-sdk" + +const myWorkflow = createWorkflow( + "hello-world", + function (input: WorkflowInput) { + const message = transform( + { + input, + }, + (data) => { + return data.input.is_active ? "active" : "inactive" + } + ) + + step1({ + message, + }) +}) +``` + +### Optional Chaining (?.) Alternative + +```ts +// Don't +const myWorkflow = createWorkflow( + "hello-world", + function (input: WorkflowInput) { + step1({ + name: input.customer?.name, + }) +}) + +// Do +// other imports... +import { transform } from "@medusajs/framework/workflows-sdk" + +const myWorkflow = createWorkflow( + "hello-world", + function (input: WorkflowInput) { + const name = transform( + { + input, + }, + (data) => data.input.customer?.name + ) + + step1({ + name, + }) +}) ``` *** -## Write Tests for Modules without Data Models +## Step Constraints -If your module doesn't have a data model, pass a dummy model in the `moduleModels` property. +### Returned Values + +A step must only return serializable values, such as [primitive values](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#primitive_values) or an object. + +Values of other types, such as Maps, aren't allowed. + +```ts +// Don't +import { + createStep, + StepResponse, +} from "@medusajs/framework/workflows-sdk" + +const step1 = createStep( + "step-1", + (input, { container }) => { + const myMap = new Map() + + // ... + + return new StepResponse({ + myMap, + }) + } +) + +// Do +import { + createStep, + StepResponse, +} from "@medusajs/framework/workflows-sdk" + +const step1 = createStep( + "step-1", + (input, { container }) => { + const myObj: Record = {} + + // ... + + return new StepResponse({ + myObj, + }) + } +) +``` + + +# Execute Another Workflow + +In this chapter, you'll learn how to execute a workflow in another. + +## Execute in a Workflow + +To execute a workflow in another, use the `runAsStep` method that every workflow has. + +For example: + +```ts highlights={workflowsHighlights} collapsibleLines="1-7" expandMoreButton="Show Imports" +import { + createWorkflow, +} from "@medusajs/framework/workflows-sdk" +import { + createProductsWorkflow, +} from "@medusajs/medusa/core-flows" + +const workflow = createWorkflow( + "hello-world", + async (input) => { + const products = createProductsWorkflow.runAsStep({ + input: { + products: [ + // ... + ], + }, + }) + + // ... + } +) +``` + +Instead of invoking the workflow and passing it the container, you use its `runAsStep` method and pass it an object as a parameter. + +The object has an `input` property to pass input to the workflow. + +*** + +## Preparing Input Data + +If you need to perform some data manipulation to prepare the other workflow's input data, use `transform` from the Workflows SDK. + +Learn about transform in [this chapter](https://docs.medusajs.com/learn/fundamentals/workflows/variable-manipulation/index.html.md). + +For example: + +```ts highlights={transformHighlights} collapsibleLines="1-12" +import { + createWorkflow, + transform, +} from "@medusajs/framework/workflows-sdk" +import { + createProductsWorkflow, +} from "@medusajs/medusa/core-flows" + +type WorkflowInput = { + title: string +} + +const workflow = createWorkflow( + "hello-product", + async (input: WorkflowInput) => { + const createProductsData = transform({ + input, + }, (data) => [ + { + title: `Hello ${data.input.title}`, + }, + ]) + + const products = createProductsWorkflow.runAsStep({ + input: { + products: createProductsData, + }, + }) + + // ... + } +) +``` + +In this example, you use the `transform` function to prepend `Hello` to the title of the product. Then, you pass the result as an input to the `createProductsWorkflow`. + +*** + +## Run Workflow Conditionally + +To run a workflow in another based on a condition, use when-then from the Workflows SDK. + +Learn about when-then in [this chapter](https://docs.medusajs.com/learn/fundamentals/workflows/conditions/index.html.md). + +For example: + +```ts highlights={whenHighlights} collapsibleLines="1-16" +import { + createWorkflow, + when, +} from "@medusajs/framework/workflows-sdk" +import { + createProductsWorkflow, +} from "@medusajs/medusa/core-flows" +import { + CreateProductWorkflowInputDTO, +} from "@medusajs/framework/types" + +type WorkflowInput = { + product?: CreateProductWorkflowInputDTO + should_create?: boolean +} + +const workflow = createWorkflow( + "hello-product", + async (input: WorkflowInput) => { + const product = when(input, ({ should_create }) => should_create) + .then(() => { + return createProductsWorkflow.runAsStep({ + input: { + products: [input.product], + }, + }) + }) + } +) +``` + +In this example, you use when-then to run the `createProductsWorkflow` only if `should_create` (passed in the `input`) is enabled. + + +# Long-Running Workflows + +In this chapter, you’ll learn what a long-running workflow is and how to configure it. + +## What is a Long-Running Workflow? + +When you execute a workflow, you wait until the workflow finishes execution to receive the output. + +A long-running workflow is a workflow that continues its execution in the background. You don’t receive its output immediately. Instead, you subscribe to the workflow execution to listen to status changes and receive its result once the execution is finished. + +### Why use Long-Running Workflows? + +Long-running workflows are useful if: + +- A task takes too long. For example, you're importing data from a CSV file. +- The workflow's steps wait for an external action to finish before resuming execution. For example, before you import the data from the CSV file, you wait until the import is confirmed by the user. + +*** + +## Configure Long-Running Workflows + +A workflow is considered long-running if at least one step has its `async` configuration set to `true` and doesn't return a step response. + +For example, consider the following workflow and steps: + +```ts title="src/workflows/hello-world.ts" highlights={[["15"]]} collapsibleLines="1-11" expandButtonLabel="Show More" +import { + createStep, + createWorkflow, + WorkflowResponse, + StepResponse, +} from "@medusajs/framework/workflows-sdk" + +const step1 = createStep("step-1", async () => { + return new StepResponse({}) +}) + +const step2 = createStep( + { + name: "step-2", + async: true, + }, + async () => { + console.log("Waiting to be successful...") + } +) + +const step3 = createStep("step-3", async () => { + return new StepResponse("Finished three steps") +}) + +const myWorkflow = createWorkflow( + "hello-world", + function () { + step1() + step2() + const message = step3() + + return new WorkflowResponse({ + message, + }) +}) + +export default myWorkflow +``` + +The second step has in its configuration object `async` set to `true` and it doesn't return a step response. This indicates that this step is an asynchronous step. + +So, when you execute the `hello-world` workflow, it continues its execution in the background once it reaches the second step. + +A workflow is also considered long-running if one of its steps has their `retryInterval` option set as explained in [this chapter](https://docs.medusajs.com/learn/fundamentals/workflows/retry-failed-steps/index.html.md). + +*** + +## Change Step Status + +Once the workflow's execution reaches an async step, it'll wait in the background for the step to succeed or fail before it moves to the next step. + +To fail or succeed a step, use the Workflow Engine Module's main service that is registered in the Medusa Container under the `Modules.WORKFLOW_ENGINE` (or `workflowsModuleService`) key. + +### Retrieve Transaction ID + +Before changing the status of a workflow execution's async step, you must have the execution's transaction ID. + +When you execute the workflow, the object returned has a `transaction` property, which is an object that holds the details of the workflow execution's transaction. Use its `transactionId` to later change async steps' statuses: + +```ts +const { transaction } = await myWorkflow(req.scope) + .run() + +// use transaction.transactionId later +``` + +### Change Step Status to Successful + +The Workflow Engine Module's main service has a `setStepSuccess` method to set a step's status to successful. If you use it on a workflow execution's async step, the workflow continues execution to the next step. + +For example, consider the following step: + +```ts highlights={successStatusHighlights} collapsibleLines="1-9" expandButtonLabel="Show Imports" +import { + Modules, + TransactionHandlerType, +} from "@medusajs/framework/utils" +import { + StepResponse, + createStep, +} from "@medusajs/framework/workflows-sdk" + +type SetStepSuccessStepInput = { + transactionId: string +}; + +export const setStepSuccessStep = createStep( + "set-step-success-step", + async function ( + { transactionId }: SetStepSuccessStepInput, + { container } + ) { + const workflowEngineService = container.resolve( + Modules.WORKFLOW_ENGINE + ) + + await workflowEngineService.setStepSuccess({ + idempotencyKey: { + action: TransactionHandlerType.INVOKE, + transactionId, + stepId: "step-2", + workflowId: "hello-world", + }, + stepResponse: new StepResponse("Done!"), + options: { + container, + }, + }) + } +) +``` + +In this step (which you use in a workflow other than the long-running workflow), you resolve the Workflow Engine Module's main service and set `step-2` of the previous workflow as successful. + +The `setStepSuccess` method of the workflow engine's main service accepts as a parameter an object having the following properties: + +- idempotencyKey: (\`object\`) The details of the workflow execution. + + - action: (\`invoke\` | \`compensate\`) If the step's compensation function is running, use \`compensate\`. Otherwise, use \`invoke\`. + + - transactionId: (\`string\`) The ID of the workflow execution's transaction. + + - stepId: (\`string\`) The ID of the step to change its status. This is the first parameter passed to \`createStep\` when creating the step. + + - workflowId: (\`string\`) The ID of the workflow. This is the first parameter passed to \`createWorkflow\` when creating the workflow. +- stepResponse: (\`StepResponse\`) Set the response of the step. This is similar to the response you return in a step's definition, but since the \`async\` step doesn't have a response, you set its response when changing its status. +- options: (\`Record\\`) Options to pass to the step. + + - container: (\`MedusaContainer\`) An instance of the Medusa Container + +### Change Step Status to Failed + +The Workflow Engine Module's main service also has a `setStepFailure` method that changes a step's status to failed. It accepts the same parameter as `setStepSuccess`. + +After changing the async step's status to failed, the workflow execution fails and the compensation functions of previous steps are executed. + +For example: + +```ts highlights={failureStatusHighlights} collapsibleLines="1-9" expandButtonLabel="Show Imports" +import { + Modules, + TransactionHandlerType, +} from "@medusajs/framework/utils" +import { + StepResponse, + createStep, +} from "@medusajs/framework/workflows-sdk" + +type SetStepFailureStepInput = { + transactionId: string +}; + +export const setStepFailureStep = createStep( + "set-step-success-step", + async function ( + { transactionId }: SetStepFailureStepInput, + { container } + ) { + const workflowEngineService = container.resolve( + Modules.WORKFLOW_ENGINE + ) + + await workflowEngineService.setStepFailure({ + idempotencyKey: { + action: TransactionHandlerType.INVOKE, + transactionId, + stepId: "step-2", + workflowId: "hello-world", + }, + stepResponse: new StepResponse("Failed!"), + options: { + container, + }, + }) + } +) +``` + +You use this step in another workflow that changes the status of an async step in a long-running workflow's execution to failed. + +*** + +## Access Long-Running Workflow Status and Result + +To access the status and result of a long-running workflow execution, use the `subscribe` and `unsubscribe` methods of the Workflow Engine Module's main service. + +To retrieve the workflow execution's details at a later point, you must enable [storing the workflow's executions](https://docs.medusajs.com/learn/fundamentals/workflows/store-executions/index.html.md). + +For example: + +```ts title="src/api/workflows/route.ts" highlights={highlights} collapsibleLines="1-11" expandButtonLabel="Show Imports" +import type { MedusaRequest, MedusaResponse } from "@medusajs/framework/http" +import myWorkflow from "../../../workflows/hello-world" +import { + IWorkflowEngineService, +} from "@medusajs/framework/types" +import { Modules } from "@medusajs/framework/utils" + +export async function GET(req: MedusaRequest, res: MedusaResponse) { + const { transaction, result } = await myWorkflow(req.scope).run() + + const workflowEngineService = req.scope.resolve< + IWorkflowEngineService + >( + Modules.WORKFLOW_ENGINE + ) + + const subscriptionOptions = { + workflowId: "hello-world", + transactionId: transaction.transactionId, + subscriberId: "hello-world-subscriber", + } + + await workflowEngineService.subscribe({ + ...subscriptionOptions, + subscriber: async (data) => { + if (data.eventType === "onFinish") { + console.log("Finished execution", data.result) + // unsubscribe + await workflowEngineService.unsubscribe({ + ...subscriptionOptions, + subscriberOrId: subscriptionOptions.subscriberId, + }) + } else if (data.eventType === "onStepFailure") { + console.log("Workflow failed", data.step) + } + }, + }) + + res.send(result) +} +``` + +In the above example, you execute the long-running workflow `hello-world` and resolve the Workflow Engine Module's main service from the Medusa container. + +### subscribe Method + +The main service's `subscribe` method allows you to listen to changes in the workflow execution’s status. It accepts an object having three properties: + +- workflowId: (\`string\`) The name of the workflow. +- transactionId: (\`string\`) The ID of the workflow exection's transaction. The transaction's details are returned in the response of the workflow execution. +- subscriberId: (\`string\`) The ID of the subscriber. +- subscriber: (\`(data: \{ eventType: string, result?: any }) => Promise\\`) The function executed when the workflow execution's status changes. The function receives a data object. It has an \`eventType\` property, which you use to check the status of the workflow execution. + +If the value of `eventType` in the `subscriber` function's first parameter is `onFinish`, the workflow finished executing. The first parameter then also has a `result` property holding the workflow's output. + +### unsubscribe Method + +You can unsubscribe from the workflow using the workflow engine's `unsubscribe` method, which requires the same object parameter as the `subscribe` method. + +However, instead of the `subscriber` property, it requires a `subscriberOrId` property whose value is the same `subscriberId` passed to the `subscribe` method. + +*** + +## Example: Restaurant-Delivery Recipe + +To find a full example of a long-running workflow, refer to the [restaurant-delivery recipe](https://docs.medusajs.com/resources/recipes/marketplace/examples/restaurant-delivery/index.html.md). + +In the recipe, you use a long-running workflow that moves an order from placed to completed. The workflow waits for the restaurant to accept the order, the driver to pick up the order, and other external actions. + + +# Multiple Step Usage in Workflow + +In this chapter, you'll learn how to use a step multiple times in a workflow. + +## Problem Reusing a Step in a Workflow + +In some cases, you may need to use a step multiple times in the same workflow. + +The most common example is using the `useQueryGraphStep` multiple times in a workflow to retrieve multiple unrelated data, such as customers and products. + +Each workflow step must have a unique ID, which is the ID passed as a first parameter when creating the step: + +```ts +const useQueryGraphStep = createStep( + "use-query-graph" + // ... +) +``` + +This causes an error when you use the same step multiple times in a workflow, as it's registered in the workflow as two steps having the same ID: + +```ts +const helloWorkflow = createWorkflow( + "hello", + () => { + const { data: products } = useQueryGraphStep({ + entity: "product", + fields: ["id"], + }) + + // ERROR OCCURS HERE: A STEP HAS THE SAME ID AS ANOTHER IN THE WORKFLOW + const { data: customers } = useQueryGraphStep({ + entity: "customer", + fields: ["id"], + }) + } +) +``` + +The next section explains how to fix this issue to use the same step multiple times in a workflow. + +*** + +## How to Use a Step Multiple Times in a Workflow? + +When you execute a step in a workflow, you can chain a `config` method to it to change the step's config. + +Use the `config` method to change a step's ID for a single execution. + +So, this is the correct way to write the example above: + +```ts highlights={highlights} +const helloWorkflow = createWorkflow( + "hello", + () => { + const { data: products } = useQueryGraphStep({ + entity: "product", + fields: ["id"], + }) + + // ✓ No error occurs, the step has a different ID. + const { data: customers } = useQueryGraphStep({ + entity: "customer", + fields: ["id"], + }).config({ name: "fetch-customers" }) + } +) +``` + +The `config` method accepts an object with a `name` property. Its value is a new ID of the step to use for this execution only. + +The first `useQueryGraphStep` usage has the ID `use-query-graph`, and the second `useQueryGraphStep` usage has the ID `fetch-customers`. + + +# Run Workflow Steps in Parallel + +In this chapter, you’ll learn how to run workflow steps in parallel. + +## parallelize Utility Function + +If your workflow has steps that don’t rely on one another’s results, run them in parallel using `parallelize` from the Workflows SDK. + +The workflow waits until all steps passed to the `parallelize` function finish executing before continuing to the next step. + +For example: + +```ts highlights={highlights} collapsibleLines="1-12" expandButtonLabel="Show Imports" +import { + createWorkflow, + WorkflowResponse, + parallelize, +} from "@medusajs/framework/workflows-sdk" +import { + createProductStep, + getProductStep, + createPricesStep, + attachProductToSalesChannelStep, +} from "./steps" + +interface WorkflowInput { + title: string +} + +const myWorkflow = createWorkflow( + "my-workflow", + (input: WorkflowInput) => { + const product = createProductStep(input) + + const [prices, productSalesChannel] = parallelize( + createPricesStep(product), + attachProductToSalesChannelStep(product) + ) + + const id = product.id + const refetchedProduct = getProductStep(product.id) + + return new WorkflowResponse(refetchedProduct) + } +) +``` + +The `parallelize` function accepts the steps to run in parallel as a parameter. + +It returns an array of the steps' results in the same order they're passed to the `parallelize` function. + +So, `prices` is the result of `createPricesStep`, and `productSalesChannel` is the result of `attachProductToSalesChannelStep`. + + +# Store Workflow Executions + +In this chapter, you'll learn how to store workflow executions in the database and access them later. + +## Workflow Execution Retention + +Medusa doesn't store your workflow's execution details by default. However, you can configure a workflow to keep its execution details stored in the database. + +This is useful for auditing and debugging purposes. When you store a workflow's execution, you can view details around its steps, their states and their output. You can also check whether the workflow or any of its steps failed. + +You can view stored workflow executions from the Medusa Admin dashboard by going to Settings -> Workflows. + +*** + +## How to Store Workflow's Executions? + +### Prerequisites + +- [Redis Workflow Engine must be installed and configured.](https://docs.medusajs.com/resources/architectural-modules/workflow-engine/redis/index.html.md) + +`createWorkflow` from the Workflows SDK can accept an object as a first parameter to set the workflow's configuration. To enable storing a workflow's executions: + +- Enable the `store` option. If your workflow is a [Long-Running Workflow](https://docs.medusajs.com/learn/fundamentals/workflows/long-running-workflow/index.html.md), this option is enabled by default. +- Set the `retentionTime` option to the number of seconds that the workflow execution should be stored in the database. + +For example: + +```ts highlights={highlights} +import { createStep, createWorkflow } from "@medusajs/framework/workflows-sdk" + +const step1 = createStep( + { + name: "step-1", + }, + async () => { + console.log("Hello from step 1") + } +) + +export const helloWorkflow = createWorkflow( + { + name: "hello-workflow", + retentionTime: 99999, + store: true, + }, + () => { + step1() + } +) +``` + +Whenever you execute the `helloWorkflow` now, its execution details will be stored in the database. + +*** + +## Retrieve Workflow Executions + +You can view stored workflow executions from the Medusa Admin dashboard by going to Settings -> Workflows. + +When you execute a workflow, the returned object has a `transaction` property containing the workflow execution's transaction details: + +```ts +const { transaction } = await helloWorkflow(container).run() +``` + +To retrieve a workflow's execution details from the database, resolve the Workflow Engine Module from the container and use its `listWorkflowExecutions` method. + +For example, you can create a `GET` API Route at `src/workflows/[id]/route.ts` that retrieves a workflow execution for the specified transaction ID: + +```ts title="src/workflows/[id]/route.ts" highlights={retrieveHighlights} +import { MedusaRequest, MedusaResponse } from "@medusajs/framework" +import { Modules } from "@medusajs/framework/utils" + +export async function GET( + req: MedusaRequest, + res: MedusaResponse +) { + const { transaction_id } = req.params + + const workflowEngineService = req.scope.resolve( + Modules.WORKFLOW_ENGINE + ) + + const [workflowExecution] = await workflowEngineService.listWorkflowExecutions({ + transaction_id: transaction_id, + }) + + res.json({ + workflowExecution, + }) +} +``` + +In the above example, you resolve the Workflow Engine Module from the container and use its `listWorkflowExecutions` method, passing the `transaction_id` as a filter to retrieve its workflow execution details. + +A workflow execution object will be similar to the following: + +```json +{ + "workflow_id": "hello-workflow", + "transaction_id": "01JJC2T6AVJCQ3N4BRD1EB88SP", + "id": "wf_exec_01JJC2T6B3P76JD35F12QTTA78", + "execution": { + "state": "done", + "steps": {}, + "modelId": "hello-workflow", + "options": {}, + "metadata": {}, + "startedAt": 1737719880027, + "definition": {}, + "timedOutAt": null, + "hasAsyncSteps": false, + "transactionId": "01JJC2T6AVJCQ3N4BRD1EB88SP", + "hasFailedSteps": false, + "hasSkippedSteps": false, + "hasWaitingSteps": false, + "hasRevertedSteps": false, + "hasSkippedOnFailureSteps": false + }, + "context": { + "data": {}, + "errors": [] + }, + "state": "done", + "created_at": "2025-01-24T09:58:00.036Z", + "updated_at": "2025-01-24T09:58:00.046Z", + "deleted_at": null +} +``` + +### Example: Check if Stored Workflow Execution Failed + +To check if a stored workflow execution failed, you can check its `state` property: + +```ts +if (workflowExecution.state === "failed") { + return res.status(500).json({ + error: "Workflow failed", + }) +} +``` + +Other state values include `done`, `invoking`, and `compensating`. + + +# Retry Failed Steps + +In this chapter, you’ll learn how to configure steps to allow retrial on failure. + +## Configure a Step’s Retrial + +By default, when an error occurs in a step, the step and the workflow fail, and the execution stops. + +You can configure the step to retry on failure. The `createStep` function can accept a configuration object instead of the step’s name as a first parameter. + +For example: + +```ts title="src/workflows/hello-world.ts" highlights={[["10"]]} collapsibleLines="1-6" expandButtonLabel="Show Imports" +import { + createStep, + createWorkflow, + WorkflowResponse, +} from "@medusajs/framework/workflows-sdk" + +const step1 = createStep( + { + name: "step-1", + maxRetries: 2, + }, + async () => { + console.log("Executing step 1") + + throw new Error("Oops! Something happened.") + } +) + +const myWorkflow = createWorkflow( + "hello-world", + function () { + const str1 = step1() + + return new WorkflowResponse({ + message: str1, + }) +}) + +export default myWorkflow +``` + +The step’s configuration object accepts a `maxRetries` property, which is a number indicating the number of times a step can be retried when it fails. + +When you execute the above workflow, you’ll see the following result in the terminal: + +```bash +Executing step 1 +Executing step 1 +Executing step 1 +error: Oops! Something happened. +Error: Oops! Something happened. +``` + +The first line indicates the first time the step was executed, and the next two lines indicate the times the step was retried. After that, the step and workflow fail. + +*** + +## Step Retry Intervals + +By default, a step is retried immediately after it fails. To specify a wait time before a step is retried, pass a `retryInterval` property to the step's configuration object. Its value is a number of seconds to wait before retrying the step. + +For example: + +```ts title="src/workflows/hello-world.ts" highlights={[["5"]]} +const step1 = createStep( + { + name: "step-1", + maxRetries: 2, + retryInterval: 2, // 2 seconds + }, + async () => { + // ... + } +) +``` + +### Interval Changes Workflow to Long-Running + +By setting `retryInterval` on a step, a workflow becomes a [long-running workflow](https://docs.medusajs.com/learn/fundamentals/workflows/long-running-workflow/index.html.md) that runs asynchronously in the background. So, you won't receive its result or errors immediately when you execute the workflow. + +Instead, you must subscribe to the workflow's execution using the Workflow Engine Module Service. Learn more about it in [this chapter](https://docs.medusajs.com/learn/fundamentals/workflows/long-running-workflow#access-long-running-workflow-status-and-result/index.html.md). + + +# Variable Manipulation in Workflows with transform + +In this chapter, you'll learn how to use `transform` from the Workflows SDK to manipulate variables in a workflow. + +## Why Variable Manipulation isn't Allowed in Workflows + +Medusa creates an internal representation of the workflow definition you pass to `createWorkflow` to track and store its steps. + +At that point, variables in the workflow don't have any values. They only do when you execute the workflow. + +So, you can only pass variables as parameters to steps. But, in a workflow, you can't change a variable's value or, if the variable is an array, loop over its items. + +Instead, use `transform` from the Workflows SDK. + +Restrictions for variable manipulation is only applicable in a workflow's definition. You can still manipulate variables in your step's code. + +*** + +## What is the transform Utility? + +`transform` creates a new variable as the result of manipulating other variables. + +For example, consider you have two strings as the output of two steps: + +```ts +const str1 = step1() +const str2 = step2() +``` + +To concatenate the strings, you create a new variable `str3` using the `transform` function: + +```ts highlights={highlights} +import { + createWorkflow, + WorkflowResponse, + transform, +} from "@medusajs/framework/workflows-sdk" +// step imports... + +const myWorkflow = createWorkflow( + "hello-world", + function (input) { + const str1 = step1(input) + const str2 = step2(input) + + const str3 = transform( + { str1, str2 }, + (data) => `${data.str1}${data.str2}` + ) + + return new WorkflowResponse(str3) + } +) +``` + +`transform` accepts two parameters: + +1. The first parameter is an object of variables to manipulate. The object is passed as a parameter to `transform`'s second parameter function. +2. The second parameter is the function performing the variable manipulation. + +The value returned by the second parameter function is returned by `transform`. So, the `str3` variable holds the concatenated string. + +You can use the returned value in the rest of the workflow, either to pass it as an input to other steps or to return it in the workflow's response. + +*** + +## Example: Looping Over Array + +Use `transform` to loop over arrays to create another variable from the array's items. + +For example: + +```ts collapsibleLines="1-7" expandButtonLabel="Show Imports" +import { + createWorkflow, + WorkflowResponse, + transform, +} from "@medusajs/framework/workflows-sdk" +// step imports... + +type WorkflowInput = { + items: { + id: string + name: string + }[] +} + +const myWorkflow = createWorkflow( + "hello-world", + function ({ items }: WorkflowInput) { + const ids = transform( + { items }, + (data) => data.items.map((item) => item.id) + ) + + doSomethingStep(ids) + + // ... + } +) +``` + +This workflow receives an `items` array in its input. + +You use `transform` to create an `ids` variable, which is an array of strings holding the `id` of each item in the `items` array. + +You then pass the `ids` variable as a parameter to the `doSomethingStep`. + +*** + +## Example: Creating a Date + +If you create a date with `new Date()` in a workflow's constructor function, Medusa evaluates the date's value when it creates the internal representation of the workflow, not when the workflow is executed. + +So, use `transform` instead to create a date variable with `new Date()`. For example: ```ts -import { moduleIntegrationTestRunner } from "@medusajs/test-utils" -import HelloModuleService from "../service" -import { model } from "@medusajs/framework/utils" +const myWorkflow = createWorkflow( + "hello-world", + () => { + const today = transform({}, () => new Date()) -const DummyModel = model.define("dummy_model", { - id: model.id().primaryKey(), -}) - -moduleIntegrationTestRunner({ - moduleModels: [DummyModel], - // ... -}) - -jest.setTimeout(60 * 1000) + doSomethingStep(today) + } +) ``` -*** - -### Other Options and Inputs - -Refer to [this reference in the Development Resources documentation](https://docs.medusajs.com/resources/test-tools-reference/moduleIntegrationTestRunner/index.html.md) for other available parameter options and inputs of the `testSuite` function. +In this workflow, `today` is only evaluated when the workflow is executed. *** -## Database Used in Tests +## Caveats -The `moduleIntegrationTestRunner` function creates a database with a random name before running the tests. Then, it drops that database after all the tests end. +### Transform Evaluation -To manage that database, such as changing its name or perform operations on it in your tests, refer to the [references in the Development Resources documentation](https://docs.medusajs.com/resources/test-tools-reference/moduleIntegrationTestRunner/index.html.md). +`transform`'s value is only evaluated if you pass its output to a step or in the workflow response. + +For example, if you have the following workflow: + +```ts +const myWorkflow = createWorkflow( + "hello-world", + function (input) { + const str = transform( + { input }, + (data) => `${data.input.str1}${data.input.str2}` + ) + + return new WorkflowResponse("done") + } +) +``` + +Since `str`'s value isn't used as a step's input or passed to `WorkflowResponse`, its value is never evaluated. + +### Data Validation + +`transform` should only be used to perform variable or data manipulation. + +If you want to perform some validation on the data, use a step or [when-then](https://docs.medusajs.com/learn/fundamentals/workflows/conditions/index.html.md) instead. + +For example: + +```ts +// DON'T +const myWorkflow = createWorkflow( + "hello-world", + function (input) { + const str = transform( + { input }, + (data) => { + if (!input.str1) { + throw new Error("Not allowed!") + } + } + ) + } +) + +// DO +const validateHasStr1Step = createStep( + "validate-has-str1", + ({ input }) => { + if (!input.str1) { + throw new Error("Not allowed!") + } + } +) + +const myWorkflow = createWorkflow( + "hello-world", + function (input) { + validateHasStr1({ + input, + }) + + // workflow continues its execution only if + // the step doesn't throw the error. + } +) +``` + + +# Workflow Hooks + +In this chapter, you'll learn what a workflow hook is and how to consume them. + +## What is a Workflow Hook? + +A workflow hook is a point in a workflow where you can inject custom functionality as a step function, called a hook handler. + +Medusa exposes hooks in many of its workflows that are used in its API routes. You can consume those hooks to add your custom logic. + +Refer to the [Workflows Reference](https://docs.medusajs.com/resources/medusa-workflows-reference/index.html.md) to view all workflows and their hooks. + +You want to perform a custom action during a workflow's execution, such as when a product is created. + +*** + +## How to Consume a Hook? + +A workflow has a special `hooks` property which is an object that holds its hooks. + +So, in a TypeScript or JavaScript file created under the `src/workflows/hooks` directory: + +- Import the workflow. +- Access its hook using the `hooks` property. +- Pass the hook a step function as a parameter to consume it. + +For example, to consume the `productsCreated` hook of Medusa's `createProductsWorkflow`, create the file `src/workflows/hooks/product-created.ts` with the following content: + +```ts title="src/workflows/hooks/product-created.ts" highlights={handlerHighlights} +import { createProductsWorkflow } from "@medusajs/medusa/core-flows" + +createProductsWorkflow.hooks.productsCreated( + async ({ products }, { container }) => { + // TODO perform an action + } +) +``` + +The `productsCreated` hook is available on the workflow's `hooks` property by its name. + +You invoke the hook, passing a step function (the hook handler) as a parameter. + +Now, when a product is created using the [Create Product API route](https://docs.medusajs.com/api/admin#products_postproducts), your hook handler is executed after the product is created. + +A hook can have only one handler. + +Refer to the [createProductsWorkflow reference](https://docs.medusajs.com/resources/references/medusa-workflows/createProductsWorkflow/index.html.md) to see at which point the hook handler is executed. + +### Hook Handler Parameter + +Since a hook handler is essentially a step function, it receives the hook's input as a first parameter, and an object holding a `container` property as a second parameter. + +Each hook has different input. For example, the `productsCreated` hook receives an object having a `products` property holding the created product. + +### Hook Handler Compensation + +Since the hook handler is a step function, you can set its compensation function as a second parameter of the hook. + +For example: + +```ts title="src/workflows/hooks/product-created.ts" +import { createProductsWorkflow } from "@medusajs/medusa/core-flows" + +createProductsWorkflow.hooks.productsCreated( + async ({ products }, { container }) => { + // TODO perform an action + + return new StepResponse(undefined, { ids }) + }, + async ({ ids }, { container }) => { + // undo the performed action + } +) +``` + +The compensation function is executed if an error occurs in the workflow to undo the actions performed by the hook handler. + +The compensation function receives as an input the second parameter passed to the `StepResponse` returned by the step function. + +It also accepts as a second parameter an object holding a `container` property to resolve resources from the Medusa container. + +### Additional Data Property + +Medusa's workflows pass in the hook's input an `additional_data` property: + +```ts title="src/workflows/hooks/product-created.ts" highlights={[["4", "additional_data"]]} +import { createProductsWorkflow } from "@medusajs/medusa/core-flows" + +createProductsWorkflow.hooks.productsCreated( + async ({ products, additional_data }, { container }) => { + // TODO perform an action + } +) +``` + +This property is an object that holds additional data passed to the workflow through the request sent to the API route using the workflow. + +Learn how to pass `additional_data` in requests to API routes in [this chapter](https://docs.medusajs.com/learn/fundamentals/api-routes/additional-data/index.html.md). + +### Pass Additional Data to Workflow + +You can also pass that additional data when executing the workflow. Pass it as a parameter to the `.run` method of the workflow: + +```ts title="src/workflows/hooks/product-created.ts" highlights={[["10", "additional_data"]]} +import type { MedusaRequest, MedusaResponse } from "@medusajs/framework/http" +import { createProductsWorkflow } from "@medusajs/medusa/core-flows" + +export async function POST(req: MedusaRequest, res: MedusaResponse) { + await createProductsWorkflow(req.scope).run({ + input: { + products: [ + // ... + ], + additional_data: { + custom_field: "test", + }, + }, + }) +} +``` + +Your hook handler then receives that passed data in the `additional_data` object. # Example: Write Integration Tests for API Routes @@ -14490,6 +14824,162 @@ const response = await api.post(`/custom`, form, { ``` +# Workflow Timeout + +In this chapter, you’ll learn how to set a timeout for workflows and steps. + +## What is a Workflow Timeout? + +By default, a workflow doesn’t have a timeout. It continues execution until it’s finished or an error occurs. + +You can configure a workflow’s timeout to indicate how long the workflow can execute. If a workflow's execution time passes the configured timeout, it is failed and an error is thrown. + +### Timeout Doesn't Stop Step Execution + +Configuring a timeout doesn't stop the execution of a step in progress. The timeout only affects the status of the workflow and its result. + +*** + +## Configure Workflow Timeout + +The `createWorkflow` function can accept a configuration object instead of the workflow’s name. + +In the configuration object, you pass a `timeout` property, whose value is a number indicating the timeout in seconds. + +For example: + +```ts title="src/workflows/hello-world.ts" highlights={[["16"]]} collapsibleLines="1-13" expandButtonLabel="Show More" +import { + createStep, + createWorkflow, + WorkflowResponse, +} from "@medusajs/framework/workflows-sdk" + +const step1 = createStep( + "step-1", + async () => { + // ... + } +) + +const myWorkflow = createWorkflow({ + name: "hello-world", + timeout: 2, // 2 seconds +}, function () { + const str1 = step1() + + return new WorkflowResponse({ + message: str1, + }) +}) + +export default myWorkflow + +``` + +This workflow's executions fail if they run longer than two seconds. + +A workflow’s timeout error is returned in the `errors` property of the workflow’s execution, as explained in [this chapter](https://docs.medusajs.com/learn/fundamentals/workflows/access-workflow-errors/index.html.md). The error’s name is `TransactionTimeoutError`. + +*** + +## Configure Step Timeout + +Alternatively, you can configure the timeout for a step rather than the entire workflow. + +As mentioned in the previous section, the timeout doesn't stop the execution of the step. It only affects the step's status and output. + +The step’s configuration object accepts a `timeout` property, whose value is a number indicating the timeout in seconds. + +For example: + +```tsx +const step1 = createStep( + { + name: "step-1", + timeout: 2, // 2 seconds + }, + async () => { + // ... + } +) +``` + +This step's executions fail if they run longer than two seconds. + +A step’s timeout error is returned in the `errors` property of the workflow’s execution, as explained in [this chapter](https://docs.medusajs.com/learn/fundamentals/workflows/access-workflow-errors/index.html.md). The error’s name is `TransactionStepTimeoutError`. + + +# Example: Integration Tests for a Module + +In this chapter, find an example of writing an integration test for a module using [moduleIntegrationTestRunner](https://docs.medusajs.com/learn/debugging-and-testing/testing-tools/modules-tests/index.html.md) from Medusa's Testing Framework. + +### Prerequisites + +- [Testing Tools Setup](https://docs.medusajs.com/learn/debugging-and-testing/testing-tools/index.html.md) + +## Write Integration Test for Module + +Consider a `hello` module with a `HelloModuleService` that has a `getMessage` method: + +```ts title="src/modules/hello/service.ts" +import { MedusaService } from "@medusajs/framework/utils" +import MyCustom from "./models/my-custom" + +class HelloModuleService extends MedusaService({ + MyCustom, +}){ + getMessage(): string { + return "Hello, World!" + } +} + +export default HelloModuleService +``` + +To create an integration test for the method, create the file `src/modules/hello/__tests__/service.spec.ts` with the following content: + +```ts title="src/modules/hello/__tests__/service.spec.ts" +import { moduleIntegrationTestRunner } from "@medusajs/test-utils" +import { HELLO_MODULE } from ".." +import HelloModuleService from "../service" +import MyCustom from "../models/my-custom" + +moduleIntegrationTestRunner({ + moduleName: HELLO_MODULE, + moduleModels: [MyCustom], + resolve: "./src/modules/hello", + testSuite: ({ service }) => { + describe("HelloModuleService", () => { + it("says hello world", () => { + const message = service.getMessage() + + expect(message).toEqual("Hello, World!") + }) + }) + }, +}) + +jest.setTimeout(60 * 1000) +``` + +You use the `moduleIntegrationTestRunner` function to add tests for the `hello` module. You have one test that passes if the `getMessage` method returns the `"Hello, World!"` string. + +*** + +## Run Test + +Run the following command to run your module integration tests: + +```bash npm2yarn +npm run test:integration:modules +``` + +If you don't have a `test:integration:modules` script in `package.json`, refer to the [Medusa Testing Tools chapter](https://docs.medusajs.com/learn/debugging-and-testing/testing-tools#add-test-commands/index.html.md). + +This runs your Medusa application and runs the tests available in any `__tests__` directory under the `src/modules` directory. + + # Example: Write Integration Tests for Workflows In this chapter, you'll learn how to write integration tests for workflows using [medusaIntegrationTestRunner](https://docs.medusajs.com/learn/debugging-and-testing/testing-tools/integration-tests/index.html.md) from Medusa's Testing Framwork. @@ -14621,76 +15111,6 @@ The `errors` property contains an array of errors thrown during the execution of If you threw a `MedusaError`, then you can check the error message in `errors[0].error.message`. -# Example: Integration Tests for a Module - -In this chapter, find an example of writing an integration test for a module using [moduleIntegrationTestRunner](https://docs.medusajs.com/learn/debugging-and-testing/testing-tools/modules-tests/index.html.md) from Medusa's Testing Framework. - -### Prerequisites - -- [Testing Tools Setup](https://docs.medusajs.com/learn/debugging-and-testing/testing-tools/index.html.md) - -## Write Integration Test for Module - -Consider a `hello` module with a `HelloModuleService` that has a `getMessage` method: - -```ts title="src/modules/hello/service.ts" -import { MedusaService } from "@medusajs/framework/utils" -import MyCustom from "./models/my-custom" - -class HelloModuleService extends MedusaService({ - MyCustom, -}){ - getMessage(): string { - return "Hello, World!" - } -} - -export default HelloModuleService -``` - -To create an integration test for the method, create the file `src/modules/hello/__tests__/service.spec.ts` with the following content: - -```ts title="src/modules/hello/__tests__/service.spec.ts" -import { moduleIntegrationTestRunner } from "@medusajs/test-utils" -import { HELLO_MODULE } from ".." -import HelloModuleService from "../service" -import MyCustom from "../models/my-custom" - -moduleIntegrationTestRunner({ - moduleName: HELLO_MODULE, - moduleModels: [MyCustom], - resolve: "./src/modules/hello", - testSuite: ({ service }) => { - describe("HelloModuleService", () => { - it("says hello world", () => { - const message = service.getMessage() - - expect(message).toEqual("Hello, World!") - }) - }) - }, -}) - -jest.setTimeout(60 * 1000) -``` - -You use the `moduleIntegrationTestRunner` function to add tests for the `hello` module. You have one test that passes if the `getMessage` method returns the `"Hello, World!"` string. - -*** - -## Run Test - -Run the following command to run your module integration tests: - -```bash npm2yarn -npm run test:integration:modules -``` - -If you don't have a `test:integration:modules` script in `package.json`, refer to the [Medusa Testing Tools chapter](https://docs.medusajs.com/learn/debugging-and-testing/testing-tools#add-test-commands/index.html.md). - -This runs your Medusa application and runs the tests available in any `__tests__` directory under the `src/modules` directory. - - # Commerce Modules In this section of the documentation, you'll find guides and references related to Medusa's commerce modules. @@ -15000,136 +15420,6 @@ Learn more about workflows in [this documentation](https://docs.medusajs.com/doc *** -# Auth Module - -In this section of the documentation, you will find resources to learn more about the Auth Module and how to use it in your application. - -Medusa has auth related features available out-of-the-box through the Auth Module. A [module](https://docs.medusajs.com/docs/learn/fundamentals/modules/index.html.md) is a standalone package that provides features for a single domain. Each of Medusa's commerce features are placed in commerce modules, such as this Auth Module. - -Learn more about why modules are isolated in [this documentation](https://docs.medusajs.com/docs/learn/fundamentals/modules/isolation/index.html.md). - -## Auth Features - -- [Basic User Authentication](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/auth/authentication-route#1-basic-authentication-flow/index.html.md): Authenticate users using their email and password credentials. -- [Third-Party and Social Authentication](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/auth/authentication-route#2-third-party-service-authenticate-flow/index.html.md): Authenticate users using third-party services and social platforms, such as [Google](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/auth/auth-providers/google/index.html.md) and [GitHub](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/auth/auth-providers/github/index.html.md). -- [Authenticate Custom Actor Types](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/auth/create-actor-type/index.html.md): Create custom user or actor types, such as managers, authenticate them in your application, and guard routes based on the custom user types. -- [Custom Authentication Providers](https://docs.medusajs.com/references/auth/provider/index.html.md): Integrate third-party services with custom authentication providors. - -*** - -## How to Use the Auth Module - -In your Medusa application, you build flows around commerce modules. A flow is built as a [Workflow](https://docs.medusajs.com/docs/learn/fundamentals/workflows/index.html.md), which is a special function composed of a series of steps that guarantees data consistency and reliable roll-back mechanism. - -You can build custom workflows and steps. You can also re-use Medusa's workflows and steps, which are provided by the `@medusajs/medusa/core-flows` package. - -For example: - -```ts title="src/workflows/authenticate-user.ts" highlights={highlights} -import { - createWorkflow, - WorkflowResponse, - createStep, - StepResponse, -} from "@medusajs/framework/workflows-sdk" -import { Modules, MedusaError } from "@medusajs/framework/utils" -import { MedusaRequest } from "@medusajs/framework/http" -import { AuthenticationInput } from "@medusajs/framework/types" - -type Input = { - req: MedusaRequest -} - -const authenticateUserStep = createStep( - "authenticate-user", - async ({ req }: Input, { container }) => { - const authModuleService = container.resolve(Modules.AUTH) - - const { success, authIdentity, error } = await authModuleService - .authenticate( - "emailpass", - { - url: req.url, - headers: req.headers, - query: req.query, - body: req.body, - authScope: "admin", // or custom actor type - protocol: req.protocol, - } as AuthenticationInput - ) - - if (!success) { - // incorrect authentication details - throw new MedusaError( - MedusaError.Types.UNAUTHORIZED, - error || "Incorrect authentication details" - ) - } - - return new StepResponse({ authIdentity }, authIdentity?.id) - }, - async (authIdentityId, { container }) => { - if (!authIdentityId) { - return - } - - const authModuleService = container.resolve(Modules.AUTH) - - await authModuleService.deleteAuthIdentities([authIdentityId]) - } -) - -export const authenticateUserWorkflow = createWorkflow( - "authenticate-user", - (input: Input) => { - const { authIdentity } = authenticateUserStep(input) - - return new WorkflowResponse({ - authIdentity, - }) - } -) -``` - -You can then execute the workflow in your custom API routes, scheduled jobs, or subscribers: - -```ts title="API Route" highlights={[["11"], ["12"]]} collapsibleLines="1-6" expandButtonLabel="Show Imports" -import type { - MedusaRequest, - MedusaResponse, -} from "@medusajs/framework/http" -import { authenticateUserWorkflow } from "../../workflows/authenticate-user" - -export async function GET( - req: MedusaRequest, - res: MedusaResponse -) { - const { result } = await authenticateUserWorkflow(req.scope) - .run({ - req, - }) - - res.send(result) -} -``` - -Learn more about workflows in [this documentation](https://docs.medusajs.com/docs/learn/fundamentals/workflows/index.html.md). - -*** - -## Configure Auth Module - -The Auth Module accepts options for further configurations. Refer to [this documentation](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/auth/module-options/index.html.md) for details on the module's options. - -*** - -## Providers - -Medusa provides the following authentication providers out-of-the-box. You can use them to authenticate admin users, customers, or custom actor types. - -*** - - # Cart Module In this section of the documentation, you will find resources to learn more about the Cart Module and how to use it in your application. @@ -15280,6 +15570,277 @@ Learn more about workflows in [this documentation](https://docs.medusajs.com/doc *** +# Auth Module + +In this section of the documentation, you will find resources to learn more about the Auth Module and how to use it in your application. + +Medusa has auth related features available out-of-the-box through the Auth Module. A [module](https://docs.medusajs.com/docs/learn/fundamentals/modules/index.html.md) is a standalone package that provides features for a single domain. Each of Medusa's commerce features are placed in commerce modules, such as this Auth Module. + +Learn more about why modules are isolated in [this documentation](https://docs.medusajs.com/docs/learn/fundamentals/modules/isolation/index.html.md). + +## Auth Features + +- [Basic User Authentication](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/auth/authentication-route#1-basic-authentication-flow/index.html.md): Authenticate users using their email and password credentials. +- [Third-Party and Social Authentication](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/auth/authentication-route#2-third-party-service-authenticate-flow/index.html.md): Authenticate users using third-party services and social platforms, such as [Google](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/auth/auth-providers/google/index.html.md) and [GitHub](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/auth/auth-providers/github/index.html.md). +- [Authenticate Custom Actor Types](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/auth/create-actor-type/index.html.md): Create custom user or actor types, such as managers, authenticate them in your application, and guard routes based on the custom user types. +- [Custom Authentication Providers](https://docs.medusajs.com/references/auth/provider/index.html.md): Integrate third-party services with custom authentication providors. + +*** + +## How to Use the Auth Module + +In your Medusa application, you build flows around commerce modules. A flow is built as a [Workflow](https://docs.medusajs.com/docs/learn/fundamentals/workflows/index.html.md), which is a special function composed of a series of steps that guarantees data consistency and reliable roll-back mechanism. + +You can build custom workflows and steps. You can also re-use Medusa's workflows and steps, which are provided by the `@medusajs/medusa/core-flows` package. + +For example: + +```ts title="src/workflows/authenticate-user.ts" highlights={highlights} +import { + createWorkflow, + WorkflowResponse, + createStep, + StepResponse, +} from "@medusajs/framework/workflows-sdk" +import { Modules, MedusaError } from "@medusajs/framework/utils" +import { MedusaRequest } from "@medusajs/framework/http" +import { AuthenticationInput } from "@medusajs/framework/types" + +type Input = { + req: MedusaRequest +} + +const authenticateUserStep = createStep( + "authenticate-user", + async ({ req }: Input, { container }) => { + const authModuleService = container.resolve(Modules.AUTH) + + const { success, authIdentity, error } = await authModuleService + .authenticate( + "emailpass", + { + url: req.url, + headers: req.headers, + query: req.query, + body: req.body, + authScope: "admin", // or custom actor type + protocol: req.protocol, + } as AuthenticationInput + ) + + if (!success) { + // incorrect authentication details + throw new MedusaError( + MedusaError.Types.UNAUTHORIZED, + error || "Incorrect authentication details" + ) + } + + return new StepResponse({ authIdentity }, authIdentity?.id) + }, + async (authIdentityId, { container }) => { + if (!authIdentityId) { + return + } + + const authModuleService = container.resolve(Modules.AUTH) + + await authModuleService.deleteAuthIdentities([authIdentityId]) + } +) + +export const authenticateUserWorkflow = createWorkflow( + "authenticate-user", + (input: Input) => { + const { authIdentity } = authenticateUserStep(input) + + return new WorkflowResponse({ + authIdentity, + }) + } +) +``` + +You can then execute the workflow in your custom API routes, scheduled jobs, or subscribers: + +```ts title="API Route" highlights={[["11"], ["12"]]} collapsibleLines="1-6" expandButtonLabel="Show Imports" +import type { + MedusaRequest, + MedusaResponse, +} from "@medusajs/framework/http" +import { authenticateUserWorkflow } from "../../workflows/authenticate-user" + +export async function GET( + req: MedusaRequest, + res: MedusaResponse +) { + const { result } = await authenticateUserWorkflow(req.scope) + .run({ + req, + }) + + res.send(result) +} +``` + +Learn more about workflows in [this documentation](https://docs.medusajs.com/docs/learn/fundamentals/workflows/index.html.md). + +*** + +## Configure Auth Module + +The Auth Module accepts options for further configurations. Refer to [this documentation](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/auth/module-options/index.html.md) for details on the module's options. + +*** + +## Providers + +Medusa provides the following authentication providers out-of-the-box. You can use them to authenticate admin users, customers, or custom actor types. + +*** + + +# Customer Module + +In this section of the documentation, you will find resources to learn more about the Customer Module and how to use it in your application. + +Refer to the [Medusa Admin User Guide](https://docs.medusajs.com/user-guide/customers/index.html.md) to learn how to manage customers and groups using the dashboard. + +Medusa has customer related features available out-of-the-box through the Customer Module. A [module](https://docs.medusajs.com/docs/learn/fundamentals/modules/index.html.md) is a standalone package that provides features for a single domain. Each of Medusa's commerce features are placed in commerce modules, such as this Customer Module. + +Learn more about why modules are isolated in [this documentation](https://docs.medusajs.com/docs/learn/fundamentals/modules/isolation/index.html.md). + +## Customer Features + +- [Customer Management](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/customer/customer-accounts/index.html.md): Store and manage guest and registered customers in your store. +- [Customer Organization](https://docs.medusajs.com/references/customer/models/index.html.md): Organize customers into groups. This has a lot of benefits and supports many use cases, such as provide discounts for specific customer groups using the [Promotion Module](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/promotion/index.html.md). + +*** + +## How to Use the Customer Module + +In your Medusa application, you build flows around commerce modules. A flow is built as a [Workflow](https://docs.medusajs.com/docs/learn/fundamentals/workflows/index.html.md), which is a special function composed of a series of steps that guarantees data consistency and reliable roll-back mechanism. + +You can build custom workflows and steps. You can also re-use Medusa's workflows and steps, which are provided by the `@medusajs/medusa/core-flows` package. + +For example: + +```ts title="src/workflows/create-customer.ts" highlights={highlights} +import { + createWorkflow, + WorkflowResponse, + createStep, + StepResponse, +} from "@medusajs/framework/workflows-sdk" +import { Modules } from "@medusajs/framework/utils" + +const createCustomerStep = createStep( + "create-customer", + async ({}, { container }) => { + const customerModuleService = container.resolve(Modules.CUSTOMER) + + const customer = await customerModuleService.createCustomers({ + first_name: "Peter", + last_name: "Hayes", + email: "peter.hayes@example.com", + }) + + return new StepResponse({ customer }, customer.id) + }, + async (customerId, { container }) => { + if (!customerId) { + return + } + const customerModuleService = container.resolve(Modules.CUSTOMER) + + await customerModuleService.deleteCustomers([customerId]) + } +) + +export const createCustomerWorkflow = createWorkflow( + "create-customer", + () => { + const { customer } = createCustomerStep() + + return new WorkflowResponse({ + customer, + }) + } +) +``` + +You can then execute the workflow in your custom API routes, scheduled jobs, or subscribers: + +### API Route + +```ts title="src/api/workflow/route.ts" highlights={[["11"], ["12"]]} collapsibleLines="1-6" expandButtonLabel="Show Imports" +import type { + MedusaRequest, + MedusaResponse, +} from "@medusajs/framework/http" +import { createCustomerWorkflow } from "../../workflows/create-customer" + +export async function GET( + req: MedusaRequest, + res: MedusaResponse +) { + const { result } = await createCustomerWorkflow(req.scope) + .run() + + res.send(result) +} +``` + +### Subscriber + +```ts title="src/subscribers/user-created.ts" highlights={[["11"], ["12"]]} collapsibleLines="1-6" expandButtonLabel="Show Imports" +import { + type SubscriberConfig, + type SubscriberArgs, +} from "@medusajs/framework" +import { createCustomerWorkflow } from "../workflows/create-customer" + +export default async function handleUserCreated({ + event: { data }, + container, +}: SubscriberArgs<{ id: string }>) { + const { result } = await createCustomerWorkflow(container) + .run() + + console.log(result) +} + +export const config: SubscriberConfig = { + event: "user.created", +} +``` + +### Scheduled Job + +```ts title="src/jobs/run-daily.ts" highlights={[["7"], ["8"]]} +import { MedusaContainer } from "@medusajs/framework/types" +import { createCustomerWorkflow } from "../workflows/create-customer" + +export default async function myCustomJob( + container: MedusaContainer +) { + const { result } = await createCustomerWorkflow(container) + .run() + + console.log(result) +} + +export const config = { + name: "run-once-a-day", + schedule: `0 0 * * *`, +} +``` + +Learn more about workflows in [this documentation](https://docs.medusajs.com/docs/learn/fundamentals/workflows/index.html.md). + +*** + + # Fulfillment Module In this section of the documentation, you will find resources to learn more about the Fulfillment Module and how to use it in your application. @@ -15746,160 +16307,6 @@ Learn more about workflows in [this documentation](https://docs.medusajs.com/doc *** -# Pricing Module - -In this section of the documentation, you will find resources to learn more about the Pricing Module and how to use it in your application. - -Refer to the [Medusa Admin User Guide](https://docs.medusajs.com/user-guide/price-lists/index.html.md) to learn how to manage price lists using the dashboard. - -Medusa has pricing related features available out-of-the-box through the Pricing Module. A [module](https://docs.medusajs.com/docs/learn/fundamentals/modules/index.html.md) is a standalone package that provides features for a single domain. Each of Medusa's commerce features are placed in commerce modules, such as this Pricing Module. - -Learn more about why modules are isolated in [this documentation](https://docs.medusajs.com/docs/learn/fundamentals/modules/isolation/index.html.md). - -## Pricing Features - -- [Price Management](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/pricing/concepts/index.html.md): Store and manage prices of a resource, such as a product or a variant. -- [Advanced Rule Engine](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/pricing/price-rules/index.html.md): Create prices with custom rules to condition prices based on different contexts. -- [Price Lists](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/pricing/concepts#price-list/index.html.md): Group prices and apply them only in specific conditions with price lists. -- [Price Calculation Strategy](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/pricing/price-calculation/index.html.md): Retrieve the best price in a given context and for the specified rule values. -- [Tax-Inclusive Pricing](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/pricing/tax-inclusive-pricing/index.html.md): Calculate prices with taxes included in the price, and Medusa will handle calculating the taxes automatically. - -*** - -## How to Use the Pricing Module - -In your Medusa application, you build flows around commerce modules. A flow is built as a [Workflow](https://docs.medusajs.com/docs/learn/fundamentals/workflows/index.html.md), which is a special function composed of a series of steps that guarantees data consistency and reliable roll-back mechanism. - -You can build custom workflows and steps. You can also re-use Medusa's workflows and steps, which are provided by the `@medusajs/medusa/core-flows` package. - -For example: - -```ts title="src/workflows/create-price-set.ts" highlights={highlights} -import { - createWorkflow, - WorkflowResponse, - createStep, - StepResponse, -} from "@medusajs/framework/workflows-sdk" -import { Modules } from "@medusajs/framework/utils" - -const createPriceSetStep = createStep( - "create-price-set", - async ({}, { container }) => { - const pricingModuleService = container.resolve(Modules.PRICING) - - const priceSet = await pricingModuleService.createPriceSets({ - prices: [ - { - amount: 500, - currency_code: "USD", - }, - { - amount: 400, - currency_code: "EUR", - min_quantity: 0, - max_quantity: 4, - rules: {}, - }, - ], - }) - - return new StepResponse({ priceSet }, priceSet.id) - }, - async (priceSetId, { container }) => { - if (!priceSetId) { - return - } - const pricingModuleService = container.resolve(Modules.PRICING) - - await pricingModuleService.deletePriceSets([priceSetId]) - } -) - -export const createPriceSetWorkflow = createWorkflow( - "create-price-set", - () => { - const { priceSet } = createPriceSetStep() - - return new WorkflowResponse({ - priceSet, - }) - } -) -``` - -You can then execute the workflow in your custom API routes, scheduled jobs, or subscribers: - -### API Route - -```ts title="src/api/workflow/route.ts" highlights={[["11"], ["12"]]} collapsibleLines="1-6" expandButtonLabel="Show Imports" -import type { - MedusaRequest, - MedusaResponse, -} from "@medusajs/framework/http" -import { createPriceSetWorkflow } from "../../workflows/create-price-set" - -export async function GET( - req: MedusaRequest, - res: MedusaResponse -) { - const { result } = await createPriceSetWorkflow(req.scope) - .run() - - res.send(result) -} -``` - -### Subscriber - -```ts title="src/subscribers/user-created.ts" highlights={[["11"], ["12"]]} collapsibleLines="1-6" expandButtonLabel="Show Imports" -import { - type SubscriberConfig, - type SubscriberArgs, -} from "@medusajs/framework" -import { createPriceSetWorkflow } from "../workflows/create-price-set" - -export default async function handleUserCreated({ - event: { data }, - container, -}: SubscriberArgs<{ id: string }>) { - const { result } = await createPriceSetWorkflow(container) - .run() - - console.log(result) -} - -export const config: SubscriberConfig = { - event: "user.created", -} -``` - -### Scheduled Job - -```ts title="src/jobs/run-daily.ts" highlights={[["7"], ["8"]]} -import { MedusaContainer } from "@medusajs/framework/types" -import { createPriceSetWorkflow } from "../workflows/create-price-set" - -export default async function myCustomJob( - container: MedusaContainer -) { - const { result } = await createPriceSetWorkflow(container) - .run() - - console.log(result) -} - -export const config = { - name: "run-once-a-day", - schedule: `0 0 * * *`, -} -``` - -Learn more about workflows in [this documentation](https://docs.medusajs.com/docs/learn/fundamentals/workflows/index.html.md). - -*** - - # Payment Module In this section of the documentation, you will find resources to learn more about the Payment Module and how to use it in your application. @@ -16209,24 +16616,27 @@ Learn more about workflows in [this documentation](https://docs.medusajs.com/doc *** -# Customer Module +# Pricing Module -In this section of the documentation, you will find resources to learn more about the Customer Module and how to use it in your application. +In this section of the documentation, you will find resources to learn more about the Pricing Module and how to use it in your application. -Refer to the [Medusa Admin User Guide](https://docs.medusajs.com/user-guide/customers/index.html.md) to learn how to manage customers and groups using the dashboard. +Refer to the [Medusa Admin User Guide](https://docs.medusajs.com/user-guide/price-lists/index.html.md) to learn how to manage price lists using the dashboard. -Medusa has customer related features available out-of-the-box through the Customer Module. A [module](https://docs.medusajs.com/docs/learn/fundamentals/modules/index.html.md) is a standalone package that provides features for a single domain. Each of Medusa's commerce features are placed in commerce modules, such as this Customer Module. +Medusa has pricing related features available out-of-the-box through the Pricing Module. A [module](https://docs.medusajs.com/docs/learn/fundamentals/modules/index.html.md) is a standalone package that provides features for a single domain. Each of Medusa's commerce features are placed in commerce modules, such as this Pricing Module. Learn more about why modules are isolated in [this documentation](https://docs.medusajs.com/docs/learn/fundamentals/modules/isolation/index.html.md). -## Customer Features +## Pricing Features -- [Customer Management](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/customer/customer-accounts/index.html.md): Store and manage guest and registered customers in your store. -- [Customer Organization](https://docs.medusajs.com/references/customer/models/index.html.md): Organize customers into groups. This has a lot of benefits and supports many use cases, such as provide discounts for specific customer groups using the [Promotion Module](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/promotion/index.html.md). +- [Price Management](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/pricing/concepts/index.html.md): Store and manage prices of a resource, such as a product or a variant. +- [Advanced Rule Engine](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/pricing/price-rules/index.html.md): Create prices with custom rules to condition prices based on different contexts. +- [Price Lists](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/pricing/concepts#price-list/index.html.md): Group prices and apply them only in specific conditions with price lists. +- [Price Calculation Strategy](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/pricing/price-calculation/index.html.md): Retrieve the best price in a given context and for the specified rule values. +- [Tax-Inclusive Pricing](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/pricing/tax-inclusive-pricing/index.html.md): Calculate prices with taxes included in the price, and Medusa will handle calculating the taxes automatically. *** -## How to Use the Customer Module +## How to Use the Pricing Module In your Medusa application, you build flows around commerce modules. A flow is built as a [Workflow](https://docs.medusajs.com/docs/learn/fundamentals/workflows/index.html.md), which is a special function composed of a series of steps that guarantees data consistency and reliable roll-back mechanism. @@ -16234,7 +16644,7 @@ You can build custom workflows and steps. You can also re-use Medusa's workflows For example: -```ts title="src/workflows/create-customer.ts" highlights={highlights} +```ts title="src/workflows/create-price-set.ts" highlights={highlights} import { createWorkflow, WorkflowResponse, @@ -16243,36 +16653,46 @@ import { } from "@medusajs/framework/workflows-sdk" import { Modules } from "@medusajs/framework/utils" -const createCustomerStep = createStep( - "create-customer", +const createPriceSetStep = createStep( + "create-price-set", async ({}, { container }) => { - const customerModuleService = container.resolve(Modules.CUSTOMER) + const pricingModuleService = container.resolve(Modules.PRICING) - const customer = await customerModuleService.createCustomers({ - first_name: "Peter", - last_name: "Hayes", - email: "peter.hayes@example.com", + const priceSet = await pricingModuleService.createPriceSets({ + prices: [ + { + amount: 500, + currency_code: "USD", + }, + { + amount: 400, + currency_code: "EUR", + min_quantity: 0, + max_quantity: 4, + rules: {}, + }, + ], }) - return new StepResponse({ customer }, customer.id) + return new StepResponse({ priceSet }, priceSet.id) }, - async (customerId, { container }) => { - if (!customerId) { + async (priceSetId, { container }) => { + if (!priceSetId) { return } - const customerModuleService = container.resolve(Modules.CUSTOMER) + const pricingModuleService = container.resolve(Modules.PRICING) - await customerModuleService.deleteCustomers([customerId]) + await pricingModuleService.deletePriceSets([priceSetId]) } ) -export const createCustomerWorkflow = createWorkflow( - "create-customer", +export const createPriceSetWorkflow = createWorkflow( + "create-price-set", () => { - const { customer } = createCustomerStep() + const { priceSet } = createPriceSetStep() return new WorkflowResponse({ - customer, + priceSet, }) } ) @@ -16287,13 +16707,13 @@ import type { MedusaRequest, MedusaResponse, } from "@medusajs/framework/http" -import { createCustomerWorkflow } from "../../workflows/create-customer" +import { createPriceSetWorkflow } from "../../workflows/create-price-set" export async function GET( req: MedusaRequest, res: MedusaResponse ) { - const { result } = await createCustomerWorkflow(req.scope) + const { result } = await createPriceSetWorkflow(req.scope) .run() res.send(result) @@ -16307,13 +16727,13 @@ import { type SubscriberConfig, type SubscriberArgs, } from "@medusajs/framework" -import { createCustomerWorkflow } from "../workflows/create-customer" +import { createPriceSetWorkflow } from "../workflows/create-price-set" export default async function handleUserCreated({ event: { data }, container, }: SubscriberArgs<{ id: string }>) { - const { result } = await createCustomerWorkflow(container) + const { result } = await createPriceSetWorkflow(container) .run() console.log(result) @@ -16328,12 +16748,12 @@ export const config: SubscriberConfig = { ```ts title="src/jobs/run-daily.ts" highlights={[["7"], ["8"]]} import { MedusaContainer } from "@medusajs/framework/types" -import { createCustomerWorkflow } from "../workflows/create-customer" +import { createPriceSetWorkflow } from "../workflows/create-price-set" export default async function myCustomJob( container: MedusaContainer ) { - const { result } = await createCustomerWorkflow(container) + const { result } = await createPriceSetWorkflow(container) .run() console.log(result) @@ -16493,154 +16913,6 @@ Learn more about workflows in [this documentation](https://docs.medusajs.com/doc *** -# Promotion Module - -In this section of the documentation, you will find resources to learn more about the Promotion Module and how to use it in your application. - -Refer to the [Medusa Admin User Guide](https://docs.medusajs.com/user-guide/promotions/index.html.md) to learn how to manage promotions using the dashboard. - -Medusa has promotion related features available out-of-the-box through the Promotion Module. A [module](https://docs.medusajs.com/docs/learn/fundamentals/modules/index.html.md) is a standalone package that provides features for a single domain. Each of Medusa's commerce features are placed in commerce modules, such as this Promotion Module. - -Learn more about why modules are isolated in [this documentation](https://docs.medusajs.com/docs/learn/fundamentals/modules/isolation/index.html.md). - -## Promotion Features - -- [Discount Functionalities](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/promotion/concepts/index.html.md): A promotion discounts an amount or percentage of a cart's items, shipping methods, or the entire order. -- [Flexible Promotion Rules](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/promotion/concepts#flexible-rules/index.html.md): A promotion has rules that restricts when the promotion is applied. -- [Campaign Management](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/promotion/campaign/index.html.md): A campaign combines promotions under the same conditions, such as start and end dates, and budget configurations. -- [Apply Promotion on Carts and Orders](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/promotion/actions/index.html.md): Apply promotions on carts and orders to discount items, shipping methods, or the entire order. - -*** - -## How to Use the Promotion Module - -In your Medusa application, you build flows around commerce modules. A flow is built as a [Workflow](https://docs.medusajs.com/docs/learn/fundamentals/workflows/index.html.md), which is a special function composed of a series of steps that guarantees data consistency and reliable roll-back mechanism. - -You can build custom workflows and steps. You can also re-use Medusa's workflows and steps, which are provided by the `@medusajs/medusa/core-flows` package. - -For example: - -```ts title="src/workflows/create-promotion.ts" highlights={highlights} -import { - createWorkflow, - WorkflowResponse, - createStep, - StepResponse, -} from "@medusajs/framework/workflows-sdk" -import { Modules } from "@medusajs/framework/utils" - -const createPromotionStep = createStep( - "create-promotion", - async ({}, { container }) => { - const promotionModuleService = container.resolve(Modules.PROMOTION) - - const promotion = await promotionModuleService.createPromotions({ - code: "10%OFF", - type: "standard", - application_method: { - type: "percentage", - target_type: "order", - value: 10, - currency_code: "usd", - }, - }) - - return new StepResponse({ promotion }, promotion.id) - }, - async (promotionId, { container }) => { - if (!promotionId) { - return - } - const promotionModuleService = container.resolve(Modules.PROMOTION) - - await promotionModuleService.deletePromotions(promotionId) - } -) - -export const createPromotionWorkflow = createWorkflow( - "create-promotion", - () => { - const { promotion } = createPromotionStep() - - return new WorkflowResponse({ - promotion, - }) - } -) -``` - -You can then execute the workflow in your custom API routes, scheduled jobs, or subscribers: - -### API Route - -```ts title="src/api/workflow/route.ts" highlights={[["11"], ["12"]]} collapsibleLines="1-6" expandButtonLabel="Show Imports" -import type { - MedusaRequest, - MedusaResponse, -} from "@medusajs/framework/http" -import { createPromotionWorkflow } from "../../workflows/create-cart" - -export async function GET( - req: MedusaRequest, - res: MedusaResponse -) { - const { result } = await createPromotionWorkflow(req.scope) - .run() - - res.send(result) -} -``` - -### Subscriber - -```ts title="src/subscribers/user-created.ts" highlights={[["11"], ["12"]]} collapsibleLines="1-6" expandButtonLabel="Show Imports" -import { - type SubscriberConfig, - type SubscriberArgs, -} from "@medusajs/framework" -import { createPromotionWorkflow } from "../workflows/create-cart" - -export default async function handleUserCreated({ - event: { data }, - container, -}: SubscriberArgs<{ id: string }>) { - const { result } = await createPromotionWorkflow(container) - .run() - - console.log(result) -} - -export const config: SubscriberConfig = { - event: "user.created", -} -``` - -### Scheduled Job - -```ts title="src/jobs/run-daily.ts" highlights={[["7"], ["8"]]} -import { MedusaContainer } from "@medusajs/framework/types" -import { createPromotionWorkflow } from "../workflows/create-cart" - -export default async function myCustomJob( - container: MedusaContainer -) { - const { result } = await createPromotionWorkflow(container) - .run() - - console.log(result) -} - -export const config = { - name: "run-once-a-day", - schedule: `0 0 * * *`, -} -``` - -Learn more about workflows in [this documentation](https://docs.medusajs.com/docs/learn/fundamentals/workflows/index.html.md). - -*** - - # Sales Channel Module In this section of the documentation, you will find resources to learn more about the Sales Channel Module and how to use it in your application. @@ -16938,6 +17210,147 @@ Learn more about workflows in [this documentation](https://docs.medusajs.com/doc *** +# Store Module + +In this section of the documentation, you will find resources to learn more about the Store Module and how to use it in your application. + +Refer to the [Medusa Admin User Guide](https://docs.medusajs.com/user-guide/settings/store/index.html.md) to learn how to manage your store using the dashboard. + +Medusa has store related features available out-of-the-box through the Store Module. A [module](https://docs.medusajs.com/docs/learn/fundamentals/modules/index.html.md) is a standalone package that provides features for a single domain. Each of Medusa's commerce features are placed in commerce modules, such as this Store Module. + +Learn more about why modules are isolated in [this documentation](https://docs.medusajs.com/docs/learn/fundamentals/modules/isolation/index.html.md). + +## Store Features + +- [Store Management](https://docs.medusajs.com/references/store/models/Store/index.html.md): Create and manage stores in your application. +- [Multi-Tenancy Support](https://docs.medusajs.com/references/store/models/Store/index.html.md): Create multiple stores, each having its own configurations. + +*** + +## How to Use Store Module's Service + +In your Medusa application, you build flows around commerce modules. A flow is built as a [Workflow](https://docs.medusajs.com/docs/learn/fundamentals/workflows/index.html.md), which is a special function composed of a series of steps that guarantees data consistency and reliable roll-back mechanism. + +You can build custom workflows and steps. You can also re-use Medusa's workflows and steps, which are provided by the `@medusajs/medusa/core-flows` package. + +For example: + +```ts title="src/workflows/create-store.ts" highlights={highlights} +import { + createWorkflow, + WorkflowResponse, + createStep, + StepResponse, +} from "@medusajs/framework/workflows-sdk" +import { Modules } from "@medusajs/framework/utils" + +const createStoreStep = createStep( + "create-store", + async ({}, { container }) => { + const storeModuleService = container.resolve(Modules.STORE) + + const store = await storeModuleService.createStores({ + name: "My Store", + supported_currencies: [{ + currency_code: "usd", + is_default: true, + }], + }) + + return new StepResponse({ store }, store.id) + }, + async (storeId, { container }) => { + if(!storeId) { + return + } + const storeModuleService = container.resolve(Modules.STORE) + + await storeModuleService.deleteStores([storeId]) + } +) + +export const createStoreWorkflow = createWorkflow( + "create-store", + () => { + const { store } = createStoreStep() + + return new WorkflowResponse({ store }) + } +) +``` + +You can then execute the workflow in your custom API routes, scheduled jobs, or subscribers: + +### API Route + +```ts title="src/api/workflow/route.ts" highlights={[["11"], ["12"]]} collapsibleLines="1-6" expandButtonLabel="Show Imports" +import type { + MedusaRequest, + MedusaResponse, +} from "@medusajs/framework/http" +import { createStoreWorkflow } from "../../workflows/create-store" + +export async function GET( + req: MedusaRequest, + res: MedusaResponse +) { + const { result } = await createStoreWorkflow(req.scope) + .run() + + res.send(result) +} +``` + +### Subscriber + +```ts title="src/subscribers/user-created.ts" highlights={[["11"], ["12"]]} collapsibleLines="1-6" expandButtonLabel="Show Imports" +import { + type SubscriberConfig, + type SubscriberArgs, +} from "@medusajs/framework" +import { createStoreWorkflow } from "../workflows/create-store" + +export default async function handleUserCreated({ + event: { data }, + container, +}: SubscriberArgs<{ id: string }>) { + const { result } = await createStoreWorkflow(container) + .run() + + console.log(result) +} + +export const config: SubscriberConfig = { + event: "user.created", +} +``` + +### Scheduled Job + +```ts title="src/jobs/run-daily.ts" highlights={[["7"], ["8"]]} +import { MedusaContainer } from "@medusajs/framework/types" +import { createStoreWorkflow } from "../workflows/create-store" + +export default async function myCustomJob( + container: MedusaContainer +) { + const { result } = await createStoreWorkflow(container) + .run() + + console.log(result) +} + +export const config = { + name: "run-once-a-day", + schedule: `0 0 * * *`, +} +``` + +Learn more about workflows in [this documentation](https://docs.medusajs.com/docs/learn/fundamentals/workflows/index.html.md). + +*** + + # User Module In this section of the documentation, you will find resources to learn more about the User Module and how to use it in your application. @@ -17229,24 +17642,26 @@ The Tax Module accepts options for further configurations. Refer to [this docume *** -# Store Module +# Promotion Module -In this section of the documentation, you will find resources to learn more about the Store Module and how to use it in your application. +In this section of the documentation, you will find resources to learn more about the Promotion Module and how to use it in your application. -Refer to the [Medusa Admin User Guide](https://docs.medusajs.com/user-guide/settings/store/index.html.md) to learn how to manage your store using the dashboard. +Refer to the [Medusa Admin User Guide](https://docs.medusajs.com/user-guide/promotions/index.html.md) to learn how to manage promotions using the dashboard. -Medusa has store related features available out-of-the-box through the Store Module. A [module](https://docs.medusajs.com/docs/learn/fundamentals/modules/index.html.md) is a standalone package that provides features for a single domain. Each of Medusa's commerce features are placed in commerce modules, such as this Store Module. +Medusa has promotion related features available out-of-the-box through the Promotion Module. A [module](https://docs.medusajs.com/docs/learn/fundamentals/modules/index.html.md) is a standalone package that provides features for a single domain. Each of Medusa's commerce features are placed in commerce modules, such as this Promotion Module. Learn more about why modules are isolated in [this documentation](https://docs.medusajs.com/docs/learn/fundamentals/modules/isolation/index.html.md). -## Store Features +## Promotion Features -- [Store Management](https://docs.medusajs.com/references/store/models/Store/index.html.md): Create and manage stores in your application. -- [Multi-Tenancy Support](https://docs.medusajs.com/references/store/models/Store/index.html.md): Create multiple stores, each having its own configurations. +- [Discount Functionalities](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/promotion/concepts/index.html.md): A promotion discounts an amount or percentage of a cart's items, shipping methods, or the entire order. +- [Flexible Promotion Rules](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/promotion/concepts#flexible-rules/index.html.md): A promotion has rules that restricts when the promotion is applied. +- [Campaign Management](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/promotion/campaign/index.html.md): A campaign combines promotions under the same conditions, such as start and end dates, and budget configurations. +- [Apply Promotion on Carts and Orders](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/promotion/actions/index.html.md): Apply promotions on carts and orders to discount items, shipping methods, or the entire order. *** -## How to Use Store Module's Service +## How to Use the Promotion Module In your Medusa application, you build flows around commerce modules. A flow is built as a [Workflow](https://docs.medusajs.com/docs/learn/fundamentals/workflows/index.html.md), which is a special function composed of a series of steps that guarantees data consistency and reliable roll-back mechanism. @@ -17254,7 +17669,7 @@ You can build custom workflows and steps. You can also re-use Medusa's workflows For example: -```ts title="src/workflows/create-store.ts" highlights={highlights} +```ts title="src/workflows/create-promotion.ts" highlights={highlights} import { createWorkflow, WorkflowResponse, @@ -17263,37 +17678,42 @@ import { } from "@medusajs/framework/workflows-sdk" import { Modules } from "@medusajs/framework/utils" -const createStoreStep = createStep( - "create-store", +const createPromotionStep = createStep( + "create-promotion", async ({}, { container }) => { - const storeModuleService = container.resolve(Modules.STORE) + const promotionModuleService = container.resolve(Modules.PROMOTION) - const store = await storeModuleService.createStores({ - name: "My Store", - supported_currencies: [{ + const promotion = await promotionModuleService.createPromotions({ + code: "10%OFF", + type: "standard", + application_method: { + type: "percentage", + target_type: "order", + value: 10, currency_code: "usd", - is_default: true, - }], + }, }) - return new StepResponse({ store }, store.id) + return new StepResponse({ promotion }, promotion.id) }, - async (storeId, { container }) => { - if(!storeId) { + async (promotionId, { container }) => { + if (!promotionId) { return } - const storeModuleService = container.resolve(Modules.STORE) - - await storeModuleService.deleteStores([storeId]) + const promotionModuleService = container.resolve(Modules.PROMOTION) + + await promotionModuleService.deletePromotions(promotionId) } ) -export const createStoreWorkflow = createWorkflow( - "create-store", +export const createPromotionWorkflow = createWorkflow( + "create-promotion", () => { - const { store } = createStoreStep() + const { promotion } = createPromotionStep() - return new WorkflowResponse({ store }) + return new WorkflowResponse({ + promotion, + }) } ) ``` @@ -17307,13 +17727,13 @@ import type { MedusaRequest, MedusaResponse, } from "@medusajs/framework/http" -import { createStoreWorkflow } from "../../workflows/create-store" +import { createPromotionWorkflow } from "../../workflows/create-cart" export async function GET( req: MedusaRequest, res: MedusaResponse ) { - const { result } = await createStoreWorkflow(req.scope) + const { result } = await createPromotionWorkflow(req.scope) .run() res.send(result) @@ -17327,13 +17747,13 @@ import { type SubscriberConfig, type SubscriberArgs, } from "@medusajs/framework" -import { createStoreWorkflow } from "../workflows/create-store" +import { createPromotionWorkflow } from "../workflows/create-cart" export default async function handleUserCreated({ event: { data }, container, }: SubscriberArgs<{ id: string }>) { - const { result } = await createStoreWorkflow(container) + const { result } = await createPromotionWorkflow(container) .run() console.log(result) @@ -17348,12 +17768,12 @@ export const config: SubscriberConfig = { ```ts title="src/jobs/run-daily.ts" highlights={[["7"], ["8"]]} import { MedusaContainer } from "@medusajs/framework/types" -import { createStoreWorkflow } from "../workflows/create-store" +import { createPromotionWorkflow } from "../workflows/create-cart" export default async function myCustomJob( container: MedusaContainer ) { - const { result } = await createStoreWorkflow(container) + const { result } = await createPromotionWorkflow(container) .run() console.log(result) @@ -17549,1242 +17969,6 @@ const { data: stores } = useQueryGraphStep({ ``` -# Auth Identity and Actor Types - -In this document, you’ll learn about concepts related to identity and actors in the Auth Module. - -## What is an Auth Identity? - -The [AuthIdentity data model](https://docs.medusajs.com/references/auth/models/AuthIdentity/index.html.md) represents a user registered by an [authentication provider](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/auth/auth-providers/index.html.md). When a user is registered using an authentication provider, the provider creates a record of `AuthIdentity`. - -Then, when the user logs-in in the future with the same authentication provider, the associated auth identity is used to validate their credentials. - -*** - -## Actor Types - -An actor type is a type of user that can be authenticated. The Auth Module doesn't store or manage any user-like models, such as for customers or users. Instead, the user types are created and managed by other modules. For example, a customer is managed by the [Customer Module](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/customer/index.html.md). - -Then, when an auth identity is created for the actor type, the ID of the user is stored in the `app_metadata` property of the auth identity. - -For example, an auth identity of a customer has the following `app_metadata` property: - -```json -{ - "app_metadata": { - "customer_id": "cus_123" - } -} -``` - -The ID of the user is stored in the key `{actor_type}_id` of the `app_metadata` property. - -*** - -## Protect Routes by Actor Type - -When you protect routes with the `authenticate` middleware, you specify in its first parameter the actor type that must be authenticated to access the specified API routes. - -For example: - -```ts title="src/api/middlewares.ts" highlights={highlights} -import { - defineMiddlewares, - authenticate, -} from "@medusajs/framework/http" - -export default defineMiddlewares({ - routes: [ - { - matcher: "/custom/admin*", - middlewares: [ - authenticate("user", ["session", "bearer", "api-key"]), - ], - }, - ], -}) -``` - -By specifying `user` as the first parameter of `authenticate`, only authenticated users of actor type `user` (admin users) can access API routes starting with `/custom/admin`. - -*** - -## Custom Actor Types - -You can define custom actor types that allows a custom user, managed by your custom module, to authenticate into Medusa. - -For example, if you have a custom module with a `Manager` data model, you can authenticate managers with the `manager` actor type. - -Learn how to create a custom actor type in [this guide](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/auth/create-actor-type/index.html.md). - - -# How to Use Authentication Routes - -In this document, you'll learn about the authentication routes and how to use them to create and log-in users, and reset their password. - -These routes are added by Medusa's HTTP layer, not the Auth Module. - -## Types of Authentication Flows - -### 1. Basic Authentication Flow - -This authentication flow doesn't require validation with third-party services. - -[How to register customer in storefront using basic authentication flow](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/storefront-development/customers/register/index.html.md). - -The steps are: - -![Diagram showcasing the basic authentication flow between the frontend and the Medusa application](https://res.cloudinary.com/dza7lstvk/image/upload/v1725539370/Medusa%20Resources/basic-auth-routes_pgpjch.jpg) - -1. Register the user with the [Register Route](#register-route). -2. Use the authentication token to create the user with their respective API route. - - For example, for customers you would use the [Create Customer API route](https://docs.medusajs.com/api/store#customers_postcustomers). - - For admin users, you accept an invite using the [Accept Invite API route](https://docs.medusajs.com/api/admin#invites_postinvitesaccept) -3. Authenticate the user with the [Auth Route](#login-route). - -After registration, you only use the [Auth Route](#login-route) for subsequent authentication. - -To handle errors related to existing identities, refer to [this section](#handling-existing-identities). - -### 2. Third-Party Service Authenticate Flow - -This authentication flow authenticates the user with a third-party service, such as Google. - -[How to authenticate customer with a third-party provider in the storefront.](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/storefront-development/customers/third-party-login/index.html.md). - -It requires the following steps: - -![Diagram showcasing the authentication flow between the frontend, Medusa application, and third-party service](https://res.cloudinary.com/dza7lstvk/image/upload/v1725528159/Medusa%20Resources/Third_Party_Auth_tvf4ng.jpg) - -1. Authenticate the user with the [Auth Route](#login-route). -2. The auth route returns a URL to authenticate with third-party service, such as login with Google. The frontend (such as a storefront), when it receives a `location` property in the response, must redirect to the returned location. -3. Once the authentication with the third-party service finishes, it redirects back to the frontend with a `code` query parameter. So, make sure your third-party service is configured to redirect to your frontend page after successful authentication. -4. The frontend sends a request to the [Validate Callback Route](#validate-callback-route) passing it the query parameters received from the third-party service, such as the `code` and `state` query parameters. -5. If the callback validation is successful, the frontend receives the authentication token. -6. Decode the received token in the frontend using tools like [react-jwt](https://www.npmjs.com/package/react-jwt). - - If the decoded data has an `actor_id` property, then the user is already registered. So, use this token for subsequent authenticated requests. - - If not, follow the rest of the steps. -7. The frontend uses the authentication token to create the user with their respective API route. - - For example, for customers you would use the [Create Customer API route](https://docs.medusajs.com/api/store#customers_postcustomers). - - For admin users, you accept an invite using the [Accept Invite API route](https://docs.medusajs.com/api/admin#invites_postinvitesaccept) -8. The frontend sends a request to the [Refresh Token Route](#refresh-token-route) to retrieve a new token with the user information populated. - -*** - -## Register Route - -The Medusa application defines an API route at `/auth/{actor_type}/{provider}/register` that creates an auth identity for an actor type, such as a `customer`. It returns a JWT token that you pass to an API route that creates the user. - -```bash -curl -X POST http://localhost:9000/auth/{actor_type}/{providers}/register --H 'Content-Type: application/json' \ ---data-raw '{ - "email": "Whitney_Schultz@gmail.com" - // ... -}' -``` - -This API route is useful for providers like `emailpass` that uses custom logic to authenticate a user. For authentication providers that authenticate with third-party services, such as Google, use the [Auth Route](#login-route) instead. - -For example, if you're registering a customer, you: - -1. Send a request to `/auth/customer/emailpass/register` to retrieve the registration JWT token. -2. Send a request to the [Create Customer API route](https://docs.medusajs.com/api/store#customers_postcustomers) to create the customer, passing the [JWT token in the header](https://docs.medusajs.com/api/store#authentication). - -### Path Parameters - -Its path parameters are: - -- `{actor_type}`: the actor type of the user you're authenticating. For example, `customer`. -- `{provider}`: the auth provider to handle the authentication. For example, `emailpass`. - -### Request Body Parameters - -This route accepts in the request body the data that the specified authentication provider requires to handle authentication. - -For example, the EmailPass provider requires an `email` and `password` fields in the request body. - -### Response Fields - -If the authentication is successful, you'll receive a `token` field in the response body object: - -```json -{ - "token": "..." -} -``` - -Use that token in the header of subsequent requests to send authenticated requests. - -### Handling Existing Identities - -An auth identity with the same email may already exist in Medusa. This can happen if: - -- Another actor type is using that email. For example, an admin user is trying to register as a customer. -- The same email belongs to a record of the same actor type. For example, another customer has the same email. - -In these scenarios, the Register Route will return an error instead of a token: - -```json -{ - "type": "unauthorized", - "message": "Identity with email already exists" -} -``` - -To handle these scenarios, you can use the [Login Route](#login-route) to validate that the email and password match the existing identity. If so, you can allow the admin user, for example, to register as a customer. - -Otherwise, if the email and password don't match the existing identity, such as when the email belongs to another customer, the [Login Route](#login-route) returns an error: - -```json -{ - "type": "unauthorized", - "message": "Invalid email or password" -} -``` - -You can show that error message to the customer. - -*** - -## Login Route - -The Medusa application defines an API route at `/auth/{actor_type}/{provider}` that authenticates a user of an actor type. It returns a JWT token that can be passed in [the header of subsequent requests](https://docs.medusajs.com/api/store#authentication) to send authenticated requests. - -```bash -curl -X POST http://localhost:9000/auth/{actor_type}/{providers} --H 'Content-Type: application/json' \ ---data-raw '{ - "email": "Whitney_Schultz@gmail.com" - // ... -}' -``` - -For example, if you're authenticating a customer, you send a request to `/auth/customer/emailpass`. - -### Path Parameters - -Its path parameters are: - -- `{actor_type}`: the actor type of the user you're authenticating. For example, `customer`. -- `{provider}`: the auth provider to handle the authentication. For example, `emailpass`. - -### Request Body Parameters - -This route accepts in the request body the data that the specified authentication provider requires to handle authentication. - -For example, the EmailPass provider requires an `email` and `password` fields in the request body. - -#### Overriding Callback URL - -For the [GitHub](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/auth/auth-providers/github/index.html.md) and [Google](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/auth/auth-providers/google/index.html.md) providers, you can pass a `callback_url` body parameter that overrides the `callbackUrl` set in the provider's configurations. - -This is useful if you want to redirect the user to a different URL after authentication based on their actor type. For example, you can set different `callback_url` for admin users and customers. - -### Response Fields - -If the authentication is successful, you'll receive a `token` field in the response body object: - -```json -{ - "token": "..." -} -``` - -Use that token in the header of subsequent requests to send authenticated requests. - -If the authentication requires more action with a third-party service, you'll receive a `location` property: - -```json -{ - "location": "https://..." -} -``` - -Redirect to that URL in the frontend to continue the authentication process with the third-party service. - -[How to login Customers using the authentication route](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/storefront-development/customers/login/index.html.md). - -*** - -## Validate Callback Route - -The Medusa application defines an API route at `/auth/{actor_type}/{provider}/callback` that's useful for validating the authentication callback or redirect from third-party services like Google. - -```bash -curl -X POST http://localhost:9000/auth/{actor_type}/{providers}/callback?code=123&state=456 -``` - -Refer to the [third-party authentication flow](#2-third-party-service-authenticate-flow) section to see how this route fits into the authentication flow. - -### Path Parameters - -Its path parameters are: - -- `{actor_type}`: the actor type of the user you're authenticating. For example, `customer`. -- `{provider}`: the auth provider to handle the authentication. For example, `google`. - -### Query Parameters - -This route accepts all the query parameters that the third-party service sends to the frontend after the user completes the authentication process, such as the `code` and `state` query parameters. - -### Response Fields - -If the authentication is successful, you'll receive a `token` field in the response body object: - -```json -{ - "token": "..." -} -``` - -In your frontend, decode the token using tools like [react-jwt](https://www.npmjs.com/package/react-jwt): - -- If the decoded data has an `actor_id` property, the user is already registered. So, use this token for subsequent authenticated requests. -- If not, use the token in the header of a request that creates the user, such as the [Create Customer API route](https://docs.medusajs.com/api/store#customers_postcustomers). - -*** - -## Refresh Token Route - -The Medusa application defines an API route at `/auth/token/refresh` that's useful after authenticating a user with a third-party service to populate the user's token with their new information. - -It requires the user's JWT token that they received from the authentication or callback routes. - -```bash -curl -X POST http://localhost:9000/auth/token/refresh \ --H 'Authorization: Bearer {token}' -``` - -### Response Fields - -If the token was refreshed successfully, you'll receive a `token` field in the response body object: - -```json -{ - "token": "..." -} -``` - -Use that token in the header of subsequent requests to send authenticated requests. - -*** - -## Reset Password Routes - -To reset a user's password: - -1. Generate a token using the [Generate Reset Password Token API route](#generate-reset-password-token-route). - - The API route emits the `auth.password_reset` event, passing the token in the payload. - - You can create a subscriber, as seen in [this guide](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/auth/reset-password/index.html.md), that listens to the event and send a notification to the user. -2. Pass the token to the [Reset Password API route](#reset-password-route) to reset the password. - - The URL in the user's notification should direct them to a frontend URL, which sends a request to this route. - -[Storefront Development: How to Reset a Customer's Password.](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/storefront-development/customers/reset-password/index.html.md) - -### Generate Reset Password Token Route - -The Medusa application defines an API route at `/auth/{actor_type}/{auth_provider}/reset-password` that emits the `auth.password_reset` event, passing the token in the payload. - -```bash -curl -X POST http://localhost:9000/auth/{actor_type}/{providers}/reset-password --H 'Content-Type: application/json' \ ---data-raw '{ - "identifier": "Whitney_Schultz@gmail.com" -}' -``` - -This API route is useful for providers like `emailpass` that store a user's password and use it for authentication. - -#### Path Parameters - -Its path parameters are: - -- `{actor_type}`: the actor type of the user you're authenticating. For example, `customer`. -- `{provider}`: the auth provider to handle the authentication. For example, `emailpass`. - -#### Request Body Parameters - -This route accepts in the request body an object having the following property: - -- `identifier`: The user's identifier in the specified auth provider. For example, for the `emailpass` auth provider, you pass the user's email. - -#### Response Fields - -If the authentication is successful, the request returns a `201` response code. - -### Reset Password Route - -The Medusa application defines an API route at `/auth/{actor_type}/{auth_provider}/update` that accepts a token and, if valid, updates the user's password. - -```bash -curl -X POST http://localhost:9000/auth/{actor_type}/{providers}/update --H 'Content-Type: application/json' \ --H 'Authorization: Bearer {token}' \ ---data-raw '{ - "email": "Whitney_Schultz@gmail.com", - "password": "supersecret" -}' -``` - -This API route is useful for providers like `emailpass` that store a user's password and use it for logging them in. - -#### Path Parameters - -Its path parameters are: - -- `{actor_type}`: the actor type of the user you're authenticating. For example, `customer`. -- `{provider}`: the auth provider to handle the authentication. For example, `emailpass`. - -#### Pass Token in Authorization Header - -Before [Medusa v2.6](https://github.com/medusajs/medusa/releases/tag/v2.6), you passed the token as a query parameter. Now, you must pass it in the `Authorization` header. - -In the request's authorization header, you must pass the token generated using the [Generate Reset Password Token route](#generate-reset-password-token-route). You pass it as a bearer token. - -### Request Body Parameters - -This route accepts in the request body an object that has the data necessary for the provider to update the user's password. - -For the `emailpass` provider, you must pass the following properties: - -- `email`: The user's email. -- `password`: The new password. - -### Response Fields - -If the authentication is successful, the request returns an object with a `success` property set to `true`: - -```json -{ - "success": "true" -} -``` - - -# How to Create an Actor Type - -In this document, learn how to create an actor type and authenticate its associated data model. - -## 0. Create Module with Data Model - -Before creating an actor type, you must have a module with a data model representing the actor type. - -Learn how to create a module in [this guide](https://docs.medusajs.com/docs/learn/fundamentals/modules/index.html.md). - -The rest of this guide uses this `Manager` data model as an example: - -```ts title="src/modules/manager/models/manager.ts" -import { model } from "@medusajs/framework/utils" - -const Manager = model.define("manager", { - id: model.id().primaryKey(), - firstName: model.text(), - lastName: model.text(), - email: model.text(), -}) - -export default Manager -``` - -*** - -## 1. Create Workflow - -Start by creating a workflow that does two things: - -- Creates a record of the `Manager` data model. -- Sets the `app_metadata` property of the associated `AuthIdentity` record based on the new actor type. - -For example, create the file `src/workflows/create-manager.ts`. with the following content: - -```ts title="src/workflows/create-manager.ts" highlights={workflowHighlights} -import { - createWorkflow, - createStep, - StepResponse, - WorkflowResponse, -} from "@medusajs/framework/workflows-sdk" -import { - setAuthAppMetadataStep, -} from "@medusajs/medusa/core-flows" -import ManagerModuleService from "../modules/manager/service" - -type CreateManagerWorkflowInput = { - manager: { - first_name: string - last_name: string - email: string - } - authIdentityId: string -} - -const createManagerStep = createStep( - "create-manager-step", - async ({ - manager: managerData, - }: Pick, - { container }) => { - const managerModuleService: ManagerModuleService = - container.resolve("managerModuleService") - - const manager = await managerModuleService.createManager( - managerData - ) - - return new StepResponse(manager) - } -) - -const createManagerWorkflow = createWorkflow( - "create-manager", - function (input: CreateManagerWorkflowInput) { - const manager = createManagerStep({ - manager: input.manager, - }) - - setAuthAppMetadataStep({ - authIdentityId: input.authIdentityId, - actorType: "manager", - value: manager.id, - }) - - return new WorkflowResponse(manager) - } -) - -export default createManagerWorkflow -``` - -This workflow accepts the manager’s data and the associated auth identity’s ID as inputs. The next sections explain how the auth identity ID is retrieved. - -The workflow has two steps: - -1. Create the manager using the `createManagerStep`. -2. Set the `app_metadata` property of the associated auth identity using the `setAuthAppMetadataStep` from Medusa's core workflows. You specify the actor type `manager` in the `actorType` property of the step’s input. - -*** - -## 2. Define the Create API Route - -Next, you’ll use the workflow defined in the previous section in an API route that creates a manager. - -So, create the file `src/api/manager/route.ts` with the following content: - -```ts title="src/api/manager/route.ts" highlights={createRouteHighlights} -import type { - AuthenticatedMedusaRequest, - MedusaResponse, -} from "@medusajs/framework/http" -import { MedusaError } from "@medusajs/framework/utils" -import createManagerWorkflow from "../../workflows/create-manager" - -type RequestBody = { - first_name: string - last_name: string - email: string -} - -export async function POST( - req: AuthenticatedMedusaRequest, - res: MedusaResponse -) { - // If `actor_id` is present, the request carries - // authentication for an existing manager - if (req.auth_context.actor_id) { - throw new MedusaError( - MedusaError.Types.INVALID_DATA, - "Request already authenticated as a manager." - ) - } - - const { result } = await createManagerWorkflow(req.scope) - .run({ - input: { - manager: req.body, - authIdentityId: req.auth_context.auth_identity_id, - }, - }) - - res.status(200).json({ manager: result }) -} -``` - -Since the manager must be associated with an `AuthIdentity` record, the request is expected to be authenticated, even if the manager isn’t created yet. This can be achieved by: - -1. Obtaining a token usng the [/auth route](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/auth/authentication-route/index.html.md). -2. Passing the token in the bearer header of the request to this route. - -In the API route, you create the manager using the workflow from the previous section and return it in the response. - -*** - -## 3. Apply the `authenticate` Middleware - -The last step is to apply the `authenticate` middleware on the API routes that require a manager’s authentication. - -To do that, create the file `src/api/middlewares.ts` with the following content: - -```ts title="src/api/middlewares.ts" highlights={middlewareHighlights} -import { - defineMiddlewares, - authenticate, -} from "@medusajs/framework/http" - -export default defineMiddlewares({ - routes: [ - { - matcher: "/manager", - method: "POST", - middlewares: [ - authenticate("manager", ["session", "bearer"], { - allowUnregistered: true, - }), - ], - }, - { - matcher: "/manager/me*", - middlewares: [ - authenticate("manager", ["session", "bearer"]), - ], - }, - ], -}) -``` - -This applies middlewares on two route patterns: - -1. The `authenticate` middleware is applied on the `/manager` API route for `POST` requests while allowing unregistered managers. This requires that a bearer token be passed in the request to access the manager’s auth identity but doesn’t require the manager to be registered. -2. The `authenticate` middleware is applied on all routes starting with `/manager/me`, restricting these routes to authenticated managers only. - -### Retrieve Manager API Route - -For example, create the file `src/api/manager/me/route.ts` with the following content: - -```ts title="src/api/manager/me/route.ts" -import { - AuthenticatedMedusaRequest, - MedusaResponse, -} from "@medusajs/framework/http" -import ManagerModuleService from "../../../modules/manager/service" - -export async function GET( - req: AuthenticatedMedusaRequest, - res: MedusaResponse -): Promise { - const managerModuleService: ManagerModuleService = - req.scope.resolve("managerModuleService") - - const manager = await managerModuleService.retrieveManager( - req.auth_context.actor_id - ) - - res.json({ manager }) -} -``` - -This route is only accessible by authenticated managers. You access the manager’s ID using `req.auth_context.actor_id`. - -*** - -## Test Custom Actor Type Authentication Flow - -To authenticate managers: - -1. Send a `POST` request to `/auth/manager/emailpass/register` to create an auth identity for the manager: - -```bash -curl -X POST 'http://localhost:9000/auth/manager/emailpass/register' \ --H 'Content-Type: application/json' \ ---data-raw '{ - "email": "manager@gmail.com", - "password": "supersecret" -}' -``` - -Copy the returned token to use it in the next request. - -2. Send a `POST` request to `/manager` to create a manager: - -```bash -curl -X POST 'http://localhost:9000/manager' \ --H 'Content-Type: application/json' \ --H 'Authorization: Bearer {token}' \ ---data-raw '{ - "first_name": "John", - "last_name": "Doe", - "email": "manager@gmail.com" -}' -``` - -Replace `{token}` with the token returned in the previous step. - -3. Send a `POST` request to `/auth/manager/emailpass` again to retrieve an authenticated token for the manager: - -```bash -curl -X POST 'http://localhost:9000/auth/manager/emailpass' \ --H 'Content-Type: application/json' \ ---data-raw '{ - "email": "manager@gmail.com", - "password": "supersecret" -}' -``` - -4. You can now send authenticated requests as a manager. For example, send a `GET` request to `/manager/me` to retrieve the authenticated manager’s details: - -```bash -curl 'http://localhost:9000/manager/me' \ --H 'Authorization: Bearer {token}' -``` - -Whenever you want to log in as a manager, use the `/auth/manager/emailpass` API route, as explained in step 3. - -*** - -## Delete User of Actor Type - -When you delete a user of the actor type, you must update its auth identity to remove the association to the user. - -For example, create the following workflow that deletes a manager and updates its auth identity, create the file `src/workflows/delete-manager.ts` with the following content: - -```ts title="src/workflows/delete-manager.ts" collapsibleLines="1-6" expandButtonLabel="Show Imports" -import { - createStep, - StepResponse, -} from "@medusajs/framework/workflows-sdk" -import ManagerModuleService from "../modules/manager/service" - -export type DeleteManagerWorkflow = { - id: string -} - -const deleteManagerStep = createStep( - "delete-manager-step", - async ( - { id }: DeleteManagerWorkflow, - { container }) => { - const managerModuleService: ManagerModuleService = - container.resolve("managerModuleService") - - const manager = await managerModuleService.retrieve(id) - - await managerModuleService.deleteManagers(id) - - return new StepResponse(undefined, { manager }) - }, - async ({ manager }, { container }) => { - const managerModuleService: ManagerModuleService = - container.resolve("managerModuleService") - - await managerModuleService.createManagers(manager) - } - ) -``` - -You add a step that deletes the manager using the `deleteManagers` method of the module's main service. In the compensation function, you create the manager again. - -Next, in the same file, add the workflow that deletes a manager: - -```ts title="src/workflows/delete-manager.ts" collapsibleLines="1-15" expandButtonLabel="Show Imports" highlights={deleteHighlights} -// other imports -import { MedusaError } from "@medusajs/framework/utils" -import { - WorkflowData, - WorkflowResponse, - createWorkflow, - transform, -} from "@medusajs/framework/workflows-sdk" -import { - setAuthAppMetadataStep, - useQueryGraphStep, -} from "@medusajs/medusa/core-flows" - -// ... - -export const deleteManagerWorkflow = createWorkflow( - "delete-manager", - ( - input: WorkflowData - ): WorkflowResponse => { - deleteManagerStep(input) - - const { data: authIdentities } = useQueryGraphStep({ - entity: "auth_identity", - fields: ["id"], - filters: { - app_metadata: { - // the ID is of the format `{actor_type}_id`. - manager_id: input.id, - }, - }, - }) - - const authIdentity = transform( - { authIdentities }, - ({ authIdentities }) => { - const authIdentity = authIdentities[0] - - if (!authIdentity) { - throw new MedusaError( - MedusaError.Types.NOT_FOUND, - "Auth identity not found" - ) - } - - return authIdentity - } - ) - - setAuthAppMetadataStep({ - authIdentityId: authIdentity.id, - actorType: "manager", - value: null, - }) - - return new WorkflowResponse(input.id) - } -) -``` - -In the workflow, you: - -1. Use the `deleteManagerStep` defined earlier to delete the manager. -2. Retrieve the auth identity of the manager using Query. To do that, you filter the `app_metadata` property of an auth identity, which holds the user's ID under `{actor_type_name}_id`. So, in this case, it's `manager_id`. -3. Check that the auth identity exist, then, update the auth identity to remove the ID of the manager from it. - -You can use this workflow when deleting a manager, such as in an API route. - - -# Authentication Flows with the Auth Main Service - -In this document, you'll learn how to use the Auth Module's main service's methods to implement authentication flows and reset a user's password. - -## Authentication Methods - -### Register - -The [register method of the Auth Module's main service](https://docs.medusajs.com/references/auth/register/index.html.md) creates an auth identity that can be authenticated later. - -For example: - -```ts -const data = await authModuleService.register( - "emailpass", - // passed to auth provider - { - // ... - } -) -``` - -This method calls the `register` method of the provider specified in the first parameter and returns its data. - -### Authenticate - -To authenticate a user, you use the [authenticate method of the Auth Module's main service](https://docs.medusajs.com/references/auth/authenticate/index.html.md). For example: - -```ts -const data = await authModuleService.authenticate( - "emailpass", - // passed to auth provider - { - // ... - } -) -``` - -This method calls the `authenticate` method of the provider specified in the first parameter and returns its data. - -*** - -## Auth Flow 1: Basic Authentication - -The basic authentication flow requires first using the `register` method, then the `authenticate` method: - -```ts -const { success, authIdentity, error } = await authModuleService.register( - "emailpass", - // passed to auth provider - { - // ... - } -) - -if (error) { - // registration failed - // TODO return an error - return -} - -// later (can be another route for log-in) -const { success, authIdentity, location } = await authModuleService.authenticate( - "emailpass", - // passed to auth provider - { - // ... - } -) - -if (success && !location) { - // user is authenticated -} -``` - -If `success` is true and `location` isn't set, the user is authenticated successfully, and their authentication details are available within the `authIdentity` object. - -The next section explains the flow if `location` is set. - -Check out the [AuthIdentity](https://docs.medusajs.com/references/auth/models/AuthIdentity/index.html.md) reference for the received properties in `authIdentity`. - -![Diagram showcasing the basic authentication flow](https://res.cloudinary.com/dza7lstvk/image/upload/v1711373749/Medusa%20Resources/basic-auth_lgpqsj.jpg) - -### Auth Identity with Same Identifier - -If an auth identity, such as a `customer`, tries to register with an email of another auth identity, the `register` method returns an error. This can happen either if another customer is using the same email, or an admin user has the same email. - -There are two ways to handle this: - -- Consider the customer authenticated if the `authenticate` method validates that the email and password are correct. This allows admin users, for example, to authenticate as customers. -- Return an error message to the customer, informing them that the email is already in use. - -*** - -## Auth Flow 2: Third-Party Service Authentication - -The third-party service authentication method requires using the `authenticate` method first: - -```ts -const { success, authIdentity, location } = await authModuleService.authenticate( - "google", - // passed to auth provider - { - // ... - } -) - -if (location) { - // return the location for the front-end to redirect to -} - -if (!success) { - // authentication failed -} - -// authentication successful -``` - -If the `authenticate` method returns a `location` property, the authentication process requires the user to perform an action with a third-party service. So, you return the `location` to the front-end or client to redirect to that URL. - -For example, when using the `google` provider, the `location` is the URL that the user is navigated to login. - -![Diagram showcasing the first part of the third-party authentication flow](https://res.cloudinary.com/dza7lstvk/image/upload/v1711374847/Medusa%20Resources/third-party-auth-1_enyedy.jpg) - -### Overriding Callback URL - -The Google and GitHub providers allow you to override their `callbackUrl` option during authentication. This is useful when you redirect the user after authentication to a URL based on its actor type. For example, you redirect admin users and customers to different pages. - -```ts -const { success, authIdentity, location } = await authModuleService.authenticate( - "google", - // passed to auth provider - { - // ... - callback_url: "example.com", - } -) -``` - -### validateCallback - -Providers handling this authentication flow must implement the `validateCallback` method. It implements the logic to validate the authentication with the third-party service. - -So, once the user performs the required action with the third-party service (for example, log-in with Google), the frontend must redirect to an API route that uses the [validateCallback method of the Auth Module's main service](https://docs.medusajs.com/references/auth/validateCallback/index.html.md). - -The method calls the specified provider’s `validateCallback` method passing it the authentication details it received in the second parameter: - -```ts -const { success, authIdentity } = await authModuleService.validateCallback( - "google", - // passed to auth provider - { - // request data, such as - url, - headers, - query, - body, - protocol, - } -) - -if (success) { - // authentication succeeded -} -``` - -For providers like Google, the `query` object contains the query parameters from the original callback URL, such as the `code` and `state` parameters. - -If the returned `success` property is `true`, the authentication with the third-party provider was successful. - -![Diagram showcasing the second part of the third-party authentication flow](https://res.cloudinary.com/dza7lstvk/image/upload/v1711375123/Medusa%20Resources/third-party-auth-2_kmjxju.jpg) - -*** - -## Reset Password - -To update a user's password or other authentication details, use the `updateProvider` method of the Auth Module's main service. It calls the `update` method of the specified authentication provider. - -For example: - -```ts -const { success } = await authModuleService.updateProvider( - "emailpass", - // passed to the auth provider - { - entity_id: "user@example.com", - password: "supersecret", - } -) - -if (success) { - // password reset successfully -} -``` - -The method accepts as a first parameter the ID of the provider, and as a second parameter the data necessary to reset the password. - -In the example above, you use the `emailpass` provider, so you have to pass an object having an `email` and `password` properties. - -If the returned `success` property is `true`, the password has reset successfully. - - -# Auth Providers - -In this document, you’ll learn how the Auth Module handles authentication using providers. - -## What's an Auth Module Provider? - -An auth module provider handles authenticating customers and users, either using custom logic or by integrating a third-party service. - -For example, the EmailPass Auth Module Provider authenticates a user using their email and password, whereas the Google Auth Module Provider authenticates users using their Google account. - -### Auth Providers List - -- [Emailpass](https://docs.medusajs.com/commerce-modules/auth/auth-providers/emailpass/index.html.md) -- [Google](https://docs.medusajs.com/commerce-modules/auth/auth-providers/google/index.html.md) -- [GitHub](https://docs.medusajs.com/commerce-modules/auth/auth-providers/github/index.html.md) - -*** - -## Configure Allowed Auth Providers of Actor Types - -By default, users of all actor types can authenticate with all installed auth module providers. - -To restrict the auth providers used for actor types, use the [authMethodsPerActor option](https://docs.medusajs.com/references/medusa-config#http-authMethodsPerActor-1-3/index.html.md) in Medusa's configurations: - -```ts title="medusa-config.ts" -module.exports = defineConfig({ - projectConfig: { - http: { - authMethodsPerActor: { - user: ["google"], - customer: ["emailpass"], - }, - // ... - }, - // ... - }, -}) -``` - -When you specify the `authMethodsPerActor` configuration, it overrides the default. So, if you don't specify any providers for an actor type, users of that actor type can't authenticate with any provider. - -*** - -## How to Create an Auth Module Provider - -Refer to [this guide](https://docs.medusajs.com/references/auth/provider/index.html.md) to learn how to create an auth module provider. - - -# Auth Module Options - -In this document, you'll learn about the options of the Auth Module. - -## providers - -The `providers` option is an array of auth module providers. - -When the Medusa application starts, these providers are registered and can be used to handle authentication. - -By default, the `emailpass` provider is registered to authenticate customers and admin users. - -For example: - -```ts title="medusa-config.ts" -import { Modules, ContainerRegistrationKeys } from "@medusajs/framework/utils" - -// ... - -module.exports = defineConfig({ - // ... - modules: [ - { - resolve: "@medusajs/medusa/auth", - dependencies: [Modules.CACHE, ContainerRegistrationKeys.LOGGER], - options: { - providers: [ - { - resolve: "@medusajs/medusa/auth-emailpass", - id: "emailpass", - options: { - // provider options... - }, - }, - ], - }, - }, - ], -}) -``` - -The `providers` option is an array of objects that accept the following properties: - -- `resolve`: A string indicating the package name of the module provider or the path to it relative to the `src` directory. -- `id`: A string indicating the provider's unique name or ID. -- `options`: An optional object of the module provider's options. - -*** - -## Auth CORS - -The Medusa application's authentication API routes are defined under the `/auth` prefix that requires setting the `authCors` property of the `http` configuration. - -By default, the Medusa application you created will have an `AUTH_CORS` environment variable, which is used as the value of `authCors`. - -Refer to [Medusa's configuration guide](https://docs.medusajs.com/references/medusa-config#authCors/index.html.md) to learn more about the `authCors` configuration. - -*** - -## authMethodsPerActor Configuration - -The Medusa application's configuration accept an `authMethodsPerActor` configuration which restricts the allowed auth providers used with an actor type. - -Learn more about the `authMethodsPerActor` configuration in [this guide](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/auth/auth-providers#configure-allowed-auth-providers-of-actor-types/index.html.md). - - -# How to Handle Password Reset Token Event - -In this guide, you'll learn how to handle the `auth.password_reset` event, which is emitted when a request is sent to the [Generate Reset Password Token API route](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/auth/authentication-route#generate-reset-password-token-route/index.html.md). - -Refer to this [Medusa Admin User Guide](https://docs.medusajs.com/user-guide/reset-password/index.html.md) to learn how to reset your user admin password using the dashboard. - -You'll create a subscriber that listens to the event. When the event is emitted, the subscriber sends an email notification to the user. - -### Prerequisites - -- [A notification provider module, such as SendGrid](https://docs.medusajs.com/architectural-modules/notification/sendgrid/index.html.md) - -## 1. Create Subscriber - -The first step is to create a subscriber that listens to the `auth.password_reset` and sends the user a notification with instructions to reset their password. - -Create the file `src/subscribers/handle-reset.ts` with the following content: - -```ts title="src/subscribers/handle-reset.ts" highlights={highlights} collapsibleLines="1-6" expandMoreLabel="Show Imports" -import { - SubscriberArgs, - type SubscriberConfig, -} from "@medusajs/medusa" -import { Modules } from "@medusajs/framework/utils" - -export default async function resetPasswordTokenHandler({ - event: { data: { - entity_id: email, - token, - actor_type, - } }, - container, -}: SubscriberArgs<{ entity_id: string, token: string, actor_type: string }>) { - const notificationModuleService = container.resolve( - Modules.NOTIFICATION - ) - - const urlPrefix = actor_type === "customer" ? - "https://storefront.com" : - "https://admin.com/app" - - await notificationModuleService.createNotifications({ - to: email, - channel: "email", - template: "reset-password-template", - data: { - // a URL to a frontend application - url: `${urlPrefix}/reset-password?token=${token}&email=${email}`, - }, - }) -} - -export const config: SubscriberConfig = { - event: "auth.password_reset", -} -``` - -You subscribe to the `auth.password_reset` event. The event has a data payload object with the following properties: - -- `entity_id`: The identifier of the user. When using the `emailpass` provider, it's the user's email. -- `token`: The token to reset the user's password. -- `actor_type`: The user's actor type. For example, if the user is a customer, the `actor_type` is `customer`. If it's an admin user, the `actor_type` is `user`. - -This event's payload previously had an `actorType` field. It was renamed to `actor_type` after [Medusa v2.0.7](https://github.com/medusajs/medusa/releases/tag/v2.0.7). - -In the subscriber, you: - -- Decide the frontend URL based on whether the user is a customer or admin user by checking the value of `actor_type`. -- Resolve the Notification Module and use its `createNotifications` method to send the notification. -- You pass to the `createNotifications` method an object having the following properties: - - `to`: The identifier to send the notification to, which in this case is the email. - - `channel`: The channel to send the notification through, which in this case is email. - - `template`: The template ID in the third-party service. - - `data`: The data payload to pass to the template. You pass the URL to redirect the user to. You must pass the token and email in the URL so that the frontend can send them later to the Medusa application when reseting the password. - -*** - -## 2. Test it Out: Generate Reset Password Token - -To test the subscriber out, send a request to the `/auth/{actor_type}/{auth_provider}/reset-password` API route, replacing `{actor_type}` and `{auth_provider}` with the user's actor type and provider used for authentication respectively. - -For example, to generate a reset password token for an admin user using the `emailpass` provider, send the following request: - -```bash -curl --location 'http://localhost:9000/auth/user/emailpass/reset-password' \ ---header 'Content-Type: application/json' \ ---data-raw '{ - "identifier": "admin-test@gmail.com" -}' -``` - -In the request body, you must pass an `identifier` parameter. Its value is the user's identifier, which is the email in this case. - -If the token is generated successfully, the request returns a response with `201` status code. In the terminal, you'll find the following message indicating that the `auth.password_reset` event was emitted and your subscriber ran: - -```plain -info: Processing auth.password_reset which has 1 subscribers -``` - -The notification is sent to the user with the frontend URL to enter a new password. - -*** - -## Next Steps: Implementing Frontend - -In your frontend, you must have a page that accepts `token` and `email` query parameters. - -The page shows the user password fields to enter their new password, then submits the new password, token, and email to the [Reset Password Route](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/auth/authentication-route#reset-password-route/index.html.md). - -### Examples - -- [Storefront Guide: Reset Customer Password](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/storefront-development/customers/reset-password/index.html.md) - - # Cart Concepts In this document, you’ll get an overview of the main concepts of a cart. @@ -18822,124 +18006,6 @@ If the fulfillment provider requires additional custom data to be passed along f The `data` property is an object used to store custom data relevant later for fulfillment. -# Promotions Adjustments in Carts - -In this document, you’ll learn how a promotion is applied to a cart’s line items and shipping methods using adjustment lines. - -## What are Adjustment Lines? - -An adjustment line indicates a change to an item or a shipping method’s amount. It’s used to apply promotions or discounts on a cart. - -The [LineItemAdjustment](https://docs.medusajs.com/references/cart/models/LineItemAdjustment/index.html.md) data model represents changes on a line item, and the [ShippingMethodAdjustment](https://docs.medusajs.com/references/cart/models/ShippingMethodAdjustment/index.html.md) data model represents changes on a shipping method. - -![A diagram showcasing the relations between other data models and adjustment line models](https://res.cloudinary.com/dza7lstvk/image/upload/v1711534248/Medusa%20Resources/cart-adjustments_k4sttb.jpg) - -The `amount` property of the adjustment line indicates the amount to be discounted from the original amount. Also, the ID of the applied promotion is stored in the `promotion_id` property of the adjustment line. - -*** - -## Discountable Option - -The [LineItem](https://docs.medusajs.com/references/cart/models/LineItem/index.html.md) data model has an `is_discountable` property that indicates whether promotions can be applied to the line item. It’s enabled by default. - -When disabled, a promotion can’t be applied to a line item. In the context of the Promotion Module, the promotion isn’t applied to the line item even if it matches its rules. - -*** - -## Promotion Actions - -When using the Cart and Promotion modules together, such as in the Medusa application, use the [computeActions method of the Promotion Module’s main service](https://docs.medusajs.com/references/promotion/computeActions/index.html.md). It retrieves the actions of line items and shipping methods. - -Learn more about actions in the [Promotion Module’s documentation](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/promotion/actions/index.html.md). - -For example: - -```ts collapsibleLines="1-8" expandButtonLabel="Show Imports" -import { - ComputeActionAdjustmentLine, - ComputeActionItemLine, - ComputeActionShippingLine, - // ... -} from "@medusajs/framework/types" - -// retrieve the cart -const cart = await cartModuleService.retrieveCart("cart_123", { - relations: [ - "items.adjustments", - "shipping_methods.adjustments", - ], -}) - -// retrieve line item adjustments -const lineItemAdjustments: ComputeActionItemLine[] = [] -cart.items.forEach((item) => { - const filteredAdjustments = item.adjustments?.filter( - (adjustment) => adjustment.code !== undefined - ) as unknown as ComputeActionAdjustmentLine[] - if (filteredAdjustments.length) { - lineItemAdjustments.push({ - ...item, - adjustments: filteredAdjustments, - }) - } -}) - -// retrieve shipping method adjustments -const shippingMethodAdjustments: ComputeActionShippingLine[] = - [] -cart.shipping_methods.forEach((shippingMethod) => { - const filteredAdjustments = - shippingMethod.adjustments?.filter( - (adjustment) => adjustment.code !== undefined - ) as unknown as ComputeActionAdjustmentLine[] - if (filteredAdjustments.length) { - shippingMethodAdjustments.push({ - ...shippingMethod, - adjustments: filteredAdjustments, - }) - } -}) - -// compute actions -const actions = await promotionModuleService.computeActions( - ["promo_123"], - { - items: lineItemAdjustments, - shipping_methods: shippingMethodAdjustments, - } -) -``` - -The `computeActions` method accepts the existing adjustments of line items and shipping methods to compute the actions accurately. - -Then, use the returned `addItemAdjustment` and `addShippingMethodAdjustment` actions to set the cart’s line item and the shipping method’s adjustments. - -```ts collapsibleLines="1-8" expandButtonLabel="Show Imports" -import { - AddItemAdjustmentAction, - AddShippingMethodAdjustment, - // ... -} from "@medusajs/framework/types" - -// ... - -await cartModuleService.setLineItemAdjustments( - cart.id, - actions.filter( - (action) => action.action === "addItemAdjustment" - ) as AddItemAdjustmentAction[] -) - -await cartModuleService.setShippingMethodAdjustments( - cart.id, - actions.filter( - (action) => - action.action === "addShippingMethodAdjustment" - ) as AddShippingMethodAdjustment[] -) -``` - - # Links between Cart Module and Other Modules This document showcases the module links defined between the Cart Module and other commerce modules. @@ -19377,6 +18443,124 @@ const { data: carts } = useQueryGraphStep({ ``` +# Promotions Adjustments in Carts + +In this document, you’ll learn how a promotion is applied to a cart’s line items and shipping methods using adjustment lines. + +## What are Adjustment Lines? + +An adjustment line indicates a change to an item or a shipping method’s amount. It’s used to apply promotions or discounts on a cart. + +The [LineItemAdjustment](https://docs.medusajs.com/references/cart/models/LineItemAdjustment/index.html.md) data model represents changes on a line item, and the [ShippingMethodAdjustment](https://docs.medusajs.com/references/cart/models/ShippingMethodAdjustment/index.html.md) data model represents changes on a shipping method. + +![A diagram showcasing the relations between other data models and adjustment line models](https://res.cloudinary.com/dza7lstvk/image/upload/v1711534248/Medusa%20Resources/cart-adjustments_k4sttb.jpg) + +The `amount` property of the adjustment line indicates the amount to be discounted from the original amount. Also, the ID of the applied promotion is stored in the `promotion_id` property of the adjustment line. + +*** + +## Discountable Option + +The [LineItem](https://docs.medusajs.com/references/cart/models/LineItem/index.html.md) data model has an `is_discountable` property that indicates whether promotions can be applied to the line item. It’s enabled by default. + +When disabled, a promotion can’t be applied to a line item. In the context of the Promotion Module, the promotion isn’t applied to the line item even if it matches its rules. + +*** + +## Promotion Actions + +When using the Cart and Promotion modules together, such as in the Medusa application, use the [computeActions method of the Promotion Module’s main service](https://docs.medusajs.com/references/promotion/computeActions/index.html.md). It retrieves the actions of line items and shipping methods. + +Learn more about actions in the [Promotion Module’s documentation](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/promotion/actions/index.html.md). + +For example: + +```ts collapsibleLines="1-8" expandButtonLabel="Show Imports" +import { + ComputeActionAdjustmentLine, + ComputeActionItemLine, + ComputeActionShippingLine, + // ... +} from "@medusajs/framework/types" + +// retrieve the cart +const cart = await cartModuleService.retrieveCart("cart_123", { + relations: [ + "items.adjustments", + "shipping_methods.adjustments", + ], +}) + +// retrieve line item adjustments +const lineItemAdjustments: ComputeActionItemLine[] = [] +cart.items.forEach((item) => { + const filteredAdjustments = item.adjustments?.filter( + (adjustment) => adjustment.code !== undefined + ) as unknown as ComputeActionAdjustmentLine[] + if (filteredAdjustments.length) { + lineItemAdjustments.push({ + ...item, + adjustments: filteredAdjustments, + }) + } +}) + +// retrieve shipping method adjustments +const shippingMethodAdjustments: ComputeActionShippingLine[] = + [] +cart.shipping_methods.forEach((shippingMethod) => { + const filteredAdjustments = + shippingMethod.adjustments?.filter( + (adjustment) => adjustment.code !== undefined + ) as unknown as ComputeActionAdjustmentLine[] + if (filteredAdjustments.length) { + shippingMethodAdjustments.push({ + ...shippingMethod, + adjustments: filteredAdjustments, + }) + } +}) + +// compute actions +const actions = await promotionModuleService.computeActions( + ["promo_123"], + { + items: lineItemAdjustments, + shipping_methods: shippingMethodAdjustments, + } +) +``` + +The `computeActions` method accepts the existing adjustments of line items and shipping methods to compute the actions accurately. + +Then, use the returned `addItemAdjustment` and `addShippingMethodAdjustment` actions to set the cart’s line item and the shipping method’s adjustments. + +```ts collapsibleLines="1-8" expandButtonLabel="Show Imports" +import { + AddItemAdjustmentAction, + AddShippingMethodAdjustment, + // ... +} from "@medusajs/framework/types" + +// ... + +await cartModuleService.setLineItemAdjustments( + cart.id, + actions.filter( + (action) => action.action === "addItemAdjustment" + ) as AddItemAdjustmentAction[] +) + +await cartModuleService.setShippingMethodAdjustments( + cart.id, + actions.filter( + (action) => + action.action === "addShippingMethodAdjustment" + ) as AddShippingMethodAdjustment[] +) +``` + + # Tax Lines in Cart Module In this document, you’ll learn about tax lines in a cart and how to retrieve tax lines with the Tax Module. @@ -19452,6 +18636,1467 @@ await cartModuleService.setLineItemTaxLines( ``` +# Authentication Flows with the Auth Main Service + +In this document, you'll learn how to use the Auth Module's main service's methods to implement authentication flows and reset a user's password. + +## Authentication Methods + +### Register + +The [register method of the Auth Module's main service](https://docs.medusajs.com/references/auth/register/index.html.md) creates an auth identity that can be authenticated later. + +For example: + +```ts +const data = await authModuleService.register( + "emailpass", + // passed to auth provider + { + // ... + } +) +``` + +This method calls the `register` method of the provider specified in the first parameter and returns its data. + +### Authenticate + +To authenticate a user, you use the [authenticate method of the Auth Module's main service](https://docs.medusajs.com/references/auth/authenticate/index.html.md). For example: + +```ts +const data = await authModuleService.authenticate( + "emailpass", + // passed to auth provider + { + // ... + } +) +``` + +This method calls the `authenticate` method of the provider specified in the first parameter and returns its data. + +*** + +## Auth Flow 1: Basic Authentication + +The basic authentication flow requires first using the `register` method, then the `authenticate` method: + +```ts +const { success, authIdentity, error } = await authModuleService.register( + "emailpass", + // passed to auth provider + { + // ... + } +) + +if (error) { + // registration failed + // TODO return an error + return +} + +// later (can be another route for log-in) +const { success, authIdentity, location } = await authModuleService.authenticate( + "emailpass", + // passed to auth provider + { + // ... + } +) + +if (success && !location) { + // user is authenticated +} +``` + +If `success` is true and `location` isn't set, the user is authenticated successfully, and their authentication details are available within the `authIdentity` object. + +The next section explains the flow if `location` is set. + +Check out the [AuthIdentity](https://docs.medusajs.com/references/auth/models/AuthIdentity/index.html.md) reference for the received properties in `authIdentity`. + +![Diagram showcasing the basic authentication flow](https://res.cloudinary.com/dza7lstvk/image/upload/v1711373749/Medusa%20Resources/basic-auth_lgpqsj.jpg) + +### Auth Identity with Same Identifier + +If an auth identity, such as a `customer`, tries to register with an email of another auth identity, the `register` method returns an error. This can happen either if another customer is using the same email, or an admin user has the same email. + +There are two ways to handle this: + +- Consider the customer authenticated if the `authenticate` method validates that the email and password are correct. This allows admin users, for example, to authenticate as customers. +- Return an error message to the customer, informing them that the email is already in use. + +*** + +## Auth Flow 2: Third-Party Service Authentication + +The third-party service authentication method requires using the `authenticate` method first: + +```ts +const { success, authIdentity, location } = await authModuleService.authenticate( + "google", + // passed to auth provider + { + // ... + } +) + +if (location) { + // return the location for the front-end to redirect to +} + +if (!success) { + // authentication failed +} + +// authentication successful +``` + +If the `authenticate` method returns a `location` property, the authentication process requires the user to perform an action with a third-party service. So, you return the `location` to the front-end or client to redirect to that URL. + +For example, when using the `google` provider, the `location` is the URL that the user is navigated to login. + +![Diagram showcasing the first part of the third-party authentication flow](https://res.cloudinary.com/dza7lstvk/image/upload/v1711374847/Medusa%20Resources/third-party-auth-1_enyedy.jpg) + +### Overriding Callback URL + +The Google and GitHub providers allow you to override their `callbackUrl` option during authentication. This is useful when you redirect the user after authentication to a URL based on its actor type. For example, you redirect admin users and customers to different pages. + +```ts +const { success, authIdentity, location } = await authModuleService.authenticate( + "google", + // passed to auth provider + { + // ... + callback_url: "example.com", + } +) +``` + +### validateCallback + +Providers handling this authentication flow must implement the `validateCallback` method. It implements the logic to validate the authentication with the third-party service. + +So, once the user performs the required action with the third-party service (for example, log-in with Google), the frontend must redirect to an API route that uses the [validateCallback method of the Auth Module's main service](https://docs.medusajs.com/references/auth/validateCallback/index.html.md). + +The method calls the specified provider’s `validateCallback` method passing it the authentication details it received in the second parameter: + +```ts +const { success, authIdentity } = await authModuleService.validateCallback( + "google", + // passed to auth provider + { + // request data, such as + url, + headers, + query, + body, + protocol, + } +) + +if (success) { + // authentication succeeded +} +``` + +For providers like Google, the `query` object contains the query parameters from the original callback URL, such as the `code` and `state` parameters. + +If the returned `success` property is `true`, the authentication with the third-party provider was successful. + +![Diagram showcasing the second part of the third-party authentication flow](https://res.cloudinary.com/dza7lstvk/image/upload/v1711375123/Medusa%20Resources/third-party-auth-2_kmjxju.jpg) + +*** + +## Reset Password + +To update a user's password or other authentication details, use the `updateProvider` method of the Auth Module's main service. It calls the `update` method of the specified authentication provider. + +For example: + +```ts +const { success } = await authModuleService.updateProvider( + "emailpass", + // passed to the auth provider + { + entity_id: "user@example.com", + password: "supersecret", + } +) + +if (success) { + // password reset successfully +} +``` + +The method accepts as a first parameter the ID of the provider, and as a second parameter the data necessary to reset the password. + +In the example above, you use the `emailpass` provider, so you have to pass an object having an `email` and `password` properties. + +If the returned `success` property is `true`, the password has reset successfully. + + +# Auth Identity and Actor Types + +In this document, you’ll learn about concepts related to identity and actors in the Auth Module. + +## What is an Auth Identity? + +The [AuthIdentity data model](https://docs.medusajs.com/references/auth/models/AuthIdentity/index.html.md) represents a user registered by an [authentication provider](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/auth/auth-providers/index.html.md). When a user is registered using an authentication provider, the provider creates a record of `AuthIdentity`. + +Then, when the user logs-in in the future with the same authentication provider, the associated auth identity is used to validate their credentials. + +*** + +## Actor Types + +An actor type is a type of user that can be authenticated. The Auth Module doesn't store or manage any user-like models, such as for customers or users. Instead, the user types are created and managed by other modules. For example, a customer is managed by the [Customer Module](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/customer/index.html.md). + +Then, when an auth identity is created for the actor type, the ID of the user is stored in the `app_metadata` property of the auth identity. + +For example, an auth identity of a customer has the following `app_metadata` property: + +```json +{ + "app_metadata": { + "customer_id": "cus_123" + } +} +``` + +The ID of the user is stored in the key `{actor_type}_id` of the `app_metadata` property. + +*** + +## Protect Routes by Actor Type + +When you protect routes with the `authenticate` middleware, you specify in its first parameter the actor type that must be authenticated to access the specified API routes. + +For example: + +```ts title="src/api/middlewares.ts" highlights={highlights} +import { + defineMiddlewares, + authenticate, +} from "@medusajs/framework/http" + +export default defineMiddlewares({ + routes: [ + { + matcher: "/custom/admin*", + middlewares: [ + authenticate("user", ["session", "bearer", "api-key"]), + ], + }, + ], +}) +``` + +By specifying `user` as the first parameter of `authenticate`, only authenticated users of actor type `user` (admin users) can access API routes starting with `/custom/admin`. + +*** + +## Custom Actor Types + +You can define custom actor types that allows a custom user, managed by your custom module, to authenticate into Medusa. + +For example, if you have a custom module with a `Manager` data model, you can authenticate managers with the `manager` actor type. + +Learn how to create a custom actor type in [this guide](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/auth/create-actor-type/index.html.md). + + +# How to Use Authentication Routes + +In this document, you'll learn about the authentication routes and how to use them to create and log-in users, and reset their password. + +These routes are added by Medusa's HTTP layer, not the Auth Module. + +## Types of Authentication Flows + +### 1. Basic Authentication Flow + +This authentication flow doesn't require validation with third-party services. + +[How to register customer in storefront using basic authentication flow](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/storefront-development/customers/register/index.html.md). + +The steps are: + +![Diagram showcasing the basic authentication flow between the frontend and the Medusa application](https://res.cloudinary.com/dza7lstvk/image/upload/v1725539370/Medusa%20Resources/basic-auth-routes_pgpjch.jpg) + +1. Register the user with the [Register Route](#register-route). +2. Use the authentication token to create the user with their respective API route. + - For example, for customers you would use the [Create Customer API route](https://docs.medusajs.com/api/store#customers_postcustomers). + - For admin users, you accept an invite using the [Accept Invite API route](https://docs.medusajs.com/api/admin#invites_postinvitesaccept) +3. Authenticate the user with the [Auth Route](#login-route). + +After registration, you only use the [Auth Route](#login-route) for subsequent authentication. + +To handle errors related to existing identities, refer to [this section](#handling-existing-identities). + +### 2. Third-Party Service Authenticate Flow + +This authentication flow authenticates the user with a third-party service, such as Google. + +[How to authenticate customer with a third-party provider in the storefront.](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/storefront-development/customers/third-party-login/index.html.md). + +It requires the following steps: + +![Diagram showcasing the authentication flow between the frontend, Medusa application, and third-party service](https://res.cloudinary.com/dza7lstvk/image/upload/v1725528159/Medusa%20Resources/Third_Party_Auth_tvf4ng.jpg) + +1. Authenticate the user with the [Auth Route](#login-route). +2. The auth route returns a URL to authenticate with third-party service, such as login with Google. The frontend (such as a storefront), when it receives a `location` property in the response, must redirect to the returned location. +3. Once the authentication with the third-party service finishes, it redirects back to the frontend with a `code` query parameter. So, make sure your third-party service is configured to redirect to your frontend page after successful authentication. +4. The frontend sends a request to the [Validate Callback Route](#validate-callback-route) passing it the query parameters received from the third-party service, such as the `code` and `state` query parameters. +5. If the callback validation is successful, the frontend receives the authentication token. +6. Decode the received token in the frontend using tools like [react-jwt](https://www.npmjs.com/package/react-jwt). + - If the decoded data has an `actor_id` property, then the user is already registered. So, use this token for subsequent authenticated requests. + - If not, follow the rest of the steps. +7. The frontend uses the authentication token to create the user with their respective API route. + - For example, for customers you would use the [Create Customer API route](https://docs.medusajs.com/api/store#customers_postcustomers). + - For admin users, you accept an invite using the [Accept Invite API route](https://docs.medusajs.com/api/admin#invites_postinvitesaccept) +8. The frontend sends a request to the [Refresh Token Route](#refresh-token-route) to retrieve a new token with the user information populated. + +*** + +## Register Route + +The Medusa application defines an API route at `/auth/{actor_type}/{provider}/register` that creates an auth identity for an actor type, such as a `customer`. It returns a JWT token that you pass to an API route that creates the user. + +```bash +curl -X POST http://localhost:9000/auth/{actor_type}/{providers}/register +-H 'Content-Type: application/json' \ +--data-raw '{ + "email": "Whitney_Schultz@gmail.com" + // ... +}' +``` + +This API route is useful for providers like `emailpass` that uses custom logic to authenticate a user. For authentication providers that authenticate with third-party services, such as Google, use the [Auth Route](#login-route) instead. + +For example, if you're registering a customer, you: + +1. Send a request to `/auth/customer/emailpass/register` to retrieve the registration JWT token. +2. Send a request to the [Create Customer API route](https://docs.medusajs.com/api/store#customers_postcustomers) to create the customer, passing the [JWT token in the header](https://docs.medusajs.com/api/store#authentication). + +### Path Parameters + +Its path parameters are: + +- `{actor_type}`: the actor type of the user you're authenticating. For example, `customer`. +- `{provider}`: the auth provider to handle the authentication. For example, `emailpass`. + +### Request Body Parameters + +This route accepts in the request body the data that the specified authentication provider requires to handle authentication. + +For example, the EmailPass provider requires an `email` and `password` fields in the request body. + +### Response Fields + +If the authentication is successful, you'll receive a `token` field in the response body object: + +```json +{ + "token": "..." +} +``` + +Use that token in the header of subsequent requests to send authenticated requests. + +### Handling Existing Identities + +An auth identity with the same email may already exist in Medusa. This can happen if: + +- Another actor type is using that email. For example, an admin user is trying to register as a customer. +- The same email belongs to a record of the same actor type. For example, another customer has the same email. + +In these scenarios, the Register Route will return an error instead of a token: + +```json +{ + "type": "unauthorized", + "message": "Identity with email already exists" +} +``` + +To handle these scenarios, you can use the [Login Route](#login-route) to validate that the email and password match the existing identity. If so, you can allow the admin user, for example, to register as a customer. + +Otherwise, if the email and password don't match the existing identity, such as when the email belongs to another customer, the [Login Route](#login-route) returns an error: + +```json +{ + "type": "unauthorized", + "message": "Invalid email or password" +} +``` + +You can show that error message to the customer. + +*** + +## Login Route + +The Medusa application defines an API route at `/auth/{actor_type}/{provider}` that authenticates a user of an actor type. It returns a JWT token that can be passed in [the header of subsequent requests](https://docs.medusajs.com/api/store#authentication) to send authenticated requests. + +```bash +curl -X POST http://localhost:9000/auth/{actor_type}/{providers} +-H 'Content-Type: application/json' \ +--data-raw '{ + "email": "Whitney_Schultz@gmail.com" + // ... +}' +``` + +For example, if you're authenticating a customer, you send a request to `/auth/customer/emailpass`. + +### Path Parameters + +Its path parameters are: + +- `{actor_type}`: the actor type of the user you're authenticating. For example, `customer`. +- `{provider}`: the auth provider to handle the authentication. For example, `emailpass`. + +### Request Body Parameters + +This route accepts in the request body the data that the specified authentication provider requires to handle authentication. + +For example, the EmailPass provider requires an `email` and `password` fields in the request body. + +#### Overriding Callback URL + +For the [GitHub](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/auth/auth-providers/github/index.html.md) and [Google](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/auth/auth-providers/google/index.html.md) providers, you can pass a `callback_url` body parameter that overrides the `callbackUrl` set in the provider's configurations. + +This is useful if you want to redirect the user to a different URL after authentication based on their actor type. For example, you can set different `callback_url` for admin users and customers. + +### Response Fields + +If the authentication is successful, you'll receive a `token` field in the response body object: + +```json +{ + "token": "..." +} +``` + +Use that token in the header of subsequent requests to send authenticated requests. + +If the authentication requires more action with a third-party service, you'll receive a `location` property: + +```json +{ + "location": "https://..." +} +``` + +Redirect to that URL in the frontend to continue the authentication process with the third-party service. + +[How to login Customers using the authentication route](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/storefront-development/customers/login/index.html.md). + +*** + +## Validate Callback Route + +The Medusa application defines an API route at `/auth/{actor_type}/{provider}/callback` that's useful for validating the authentication callback or redirect from third-party services like Google. + +```bash +curl -X POST http://localhost:9000/auth/{actor_type}/{providers}/callback?code=123&state=456 +``` + +Refer to the [third-party authentication flow](#2-third-party-service-authenticate-flow) section to see how this route fits into the authentication flow. + +### Path Parameters + +Its path parameters are: + +- `{actor_type}`: the actor type of the user you're authenticating. For example, `customer`. +- `{provider}`: the auth provider to handle the authentication. For example, `google`. + +### Query Parameters + +This route accepts all the query parameters that the third-party service sends to the frontend after the user completes the authentication process, such as the `code` and `state` query parameters. + +### Response Fields + +If the authentication is successful, you'll receive a `token` field in the response body object: + +```json +{ + "token": "..." +} +``` + +In your frontend, decode the token using tools like [react-jwt](https://www.npmjs.com/package/react-jwt): + +- If the decoded data has an `actor_id` property, the user is already registered. So, use this token for subsequent authenticated requests. +- If not, use the token in the header of a request that creates the user, such as the [Create Customer API route](https://docs.medusajs.com/api/store#customers_postcustomers). + +*** + +## Refresh Token Route + +The Medusa application defines an API route at `/auth/token/refresh` that's useful after authenticating a user with a third-party service to populate the user's token with their new information. + +It requires the user's JWT token that they received from the authentication or callback routes. + +```bash +curl -X POST http://localhost:9000/auth/token/refresh \ +-H 'Authorization: Bearer {token}' +``` + +### Response Fields + +If the token was refreshed successfully, you'll receive a `token` field in the response body object: + +```json +{ + "token": "..." +} +``` + +Use that token in the header of subsequent requests to send authenticated requests. + +*** + +## Reset Password Routes + +To reset a user's password: + +1. Generate a token using the [Generate Reset Password Token API route](#generate-reset-password-token-route). + - The API route emits the `auth.password_reset` event, passing the token in the payload. + - You can create a subscriber, as seen in [this guide](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/auth/reset-password/index.html.md), that listens to the event and send a notification to the user. +2. Pass the token to the [Reset Password API route](#reset-password-route) to reset the password. + - The URL in the user's notification should direct them to a frontend URL, which sends a request to this route. + +[Storefront Development: How to Reset a Customer's Password.](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/storefront-development/customers/reset-password/index.html.md) + +### Generate Reset Password Token Route + +The Medusa application defines an API route at `/auth/{actor_type}/{auth_provider}/reset-password` that emits the `auth.password_reset` event, passing the token in the payload. + +```bash +curl -X POST http://localhost:9000/auth/{actor_type}/{providers}/reset-password +-H 'Content-Type: application/json' \ +--data-raw '{ + "identifier": "Whitney_Schultz@gmail.com" +}' +``` + +This API route is useful for providers like `emailpass` that store a user's password and use it for authentication. + +#### Path Parameters + +Its path parameters are: + +- `{actor_type}`: the actor type of the user you're authenticating. For example, `customer`. +- `{provider}`: the auth provider to handle the authentication. For example, `emailpass`. + +#### Request Body Parameters + +This route accepts in the request body an object having the following property: + +- `identifier`: The user's identifier in the specified auth provider. For example, for the `emailpass` auth provider, you pass the user's email. + +#### Response Fields + +If the authentication is successful, the request returns a `201` response code. + +### Reset Password Route + +The Medusa application defines an API route at `/auth/{actor_type}/{auth_provider}/update` that accepts a token and, if valid, updates the user's password. + +```bash +curl -X POST http://localhost:9000/auth/{actor_type}/{providers}/update +-H 'Content-Type: application/json' \ +-H 'Authorization: Bearer {token}' \ +--data-raw '{ + "email": "Whitney_Schultz@gmail.com", + "password": "supersecret" +}' +``` + +This API route is useful for providers like `emailpass` that store a user's password and use it for logging them in. + +#### Path Parameters + +Its path parameters are: + +- `{actor_type}`: the actor type of the user you're authenticating. For example, `customer`. +- `{provider}`: the auth provider to handle the authentication. For example, `emailpass`. + +#### Pass Token in Authorization Header + +Before [Medusa v2.6](https://github.com/medusajs/medusa/releases/tag/v2.6), you passed the token as a query parameter. Now, you must pass it in the `Authorization` header. + +In the request's authorization header, you must pass the token generated using the [Generate Reset Password Token route](#generate-reset-password-token-route). You pass it as a bearer token. + +### Request Body Parameters + +This route accepts in the request body an object that has the data necessary for the provider to update the user's password. + +For the `emailpass` provider, you must pass the following properties: + +- `email`: The user's email. +- `password`: The new password. + +### Response Fields + +If the authentication is successful, the request returns an object with a `success` property set to `true`: + +```json +{ + "success": "true" +} +``` + + +# Auth Providers + +In this document, you’ll learn how the Auth Module handles authentication using providers. + +## What's an Auth Module Provider? + +An auth module provider handles authenticating customers and users, either using custom logic or by integrating a third-party service. + +For example, the EmailPass Auth Module Provider authenticates a user using their email and password, whereas the Google Auth Module Provider authenticates users using their Google account. + +### Auth Providers List + +- [Emailpass](https://docs.medusajs.com/commerce-modules/auth/auth-providers/emailpass/index.html.md) +- [Google](https://docs.medusajs.com/commerce-modules/auth/auth-providers/google/index.html.md) +- [GitHub](https://docs.medusajs.com/commerce-modules/auth/auth-providers/github/index.html.md) + +*** + +## Configure Allowed Auth Providers of Actor Types + +By default, users of all actor types can authenticate with all installed auth module providers. + +To restrict the auth providers used for actor types, use the [authMethodsPerActor option](https://docs.medusajs.com/references/medusa-config#http-authMethodsPerActor-1-3/index.html.md) in Medusa's configurations: + +```ts title="medusa-config.ts" +module.exports = defineConfig({ + projectConfig: { + http: { + authMethodsPerActor: { + user: ["google"], + customer: ["emailpass"], + }, + // ... + }, + // ... + }, +}) +``` + +When you specify the `authMethodsPerActor` configuration, it overrides the default. So, if you don't specify any providers for an actor type, users of that actor type can't authenticate with any provider. + +*** + +## How to Create an Auth Module Provider + +Refer to [this guide](https://docs.medusajs.com/references/auth/provider/index.html.md) to learn how to create an auth module provider. + + +# How to Create an Actor Type + +In this document, learn how to create an actor type and authenticate its associated data model. + +## 0. Create Module with Data Model + +Before creating an actor type, you must have a module with a data model representing the actor type. + +Learn how to create a module in [this guide](https://docs.medusajs.com/docs/learn/fundamentals/modules/index.html.md). + +The rest of this guide uses this `Manager` data model as an example: + +```ts title="src/modules/manager/models/manager.ts" +import { model } from "@medusajs/framework/utils" + +const Manager = model.define("manager", { + id: model.id().primaryKey(), + firstName: model.text(), + lastName: model.text(), + email: model.text(), +}) + +export default Manager +``` + +*** + +## 1. Create Workflow + +Start by creating a workflow that does two things: + +- Creates a record of the `Manager` data model. +- Sets the `app_metadata` property of the associated `AuthIdentity` record based on the new actor type. + +For example, create the file `src/workflows/create-manager.ts`. with the following content: + +```ts title="src/workflows/create-manager.ts" highlights={workflowHighlights} +import { + createWorkflow, + createStep, + StepResponse, + WorkflowResponse, +} from "@medusajs/framework/workflows-sdk" +import { + setAuthAppMetadataStep, +} from "@medusajs/medusa/core-flows" +import ManagerModuleService from "../modules/manager/service" + +type CreateManagerWorkflowInput = { + manager: { + first_name: string + last_name: string + email: string + } + authIdentityId: string +} + +const createManagerStep = createStep( + "create-manager-step", + async ({ + manager: managerData, + }: Pick, + { container }) => { + const managerModuleService: ManagerModuleService = + container.resolve("managerModuleService") + + const manager = await managerModuleService.createManager( + managerData + ) + + return new StepResponse(manager) + } +) + +const createManagerWorkflow = createWorkflow( + "create-manager", + function (input: CreateManagerWorkflowInput) { + const manager = createManagerStep({ + manager: input.manager, + }) + + setAuthAppMetadataStep({ + authIdentityId: input.authIdentityId, + actorType: "manager", + value: manager.id, + }) + + return new WorkflowResponse(manager) + } +) + +export default createManagerWorkflow +``` + +This workflow accepts the manager’s data and the associated auth identity’s ID as inputs. The next sections explain how the auth identity ID is retrieved. + +The workflow has two steps: + +1. Create the manager using the `createManagerStep`. +2. Set the `app_metadata` property of the associated auth identity using the `setAuthAppMetadataStep` from Medusa's core workflows. You specify the actor type `manager` in the `actorType` property of the step’s input. + +*** + +## 2. Define the Create API Route + +Next, you’ll use the workflow defined in the previous section in an API route that creates a manager. + +So, create the file `src/api/manager/route.ts` with the following content: + +```ts title="src/api/manager/route.ts" highlights={createRouteHighlights} +import type { + AuthenticatedMedusaRequest, + MedusaResponse, +} from "@medusajs/framework/http" +import { MedusaError } from "@medusajs/framework/utils" +import createManagerWorkflow from "../../workflows/create-manager" + +type RequestBody = { + first_name: string + last_name: string + email: string +} + +export async function POST( + req: AuthenticatedMedusaRequest, + res: MedusaResponse +) { + // If `actor_id` is present, the request carries + // authentication for an existing manager + if (req.auth_context.actor_id) { + throw new MedusaError( + MedusaError.Types.INVALID_DATA, + "Request already authenticated as a manager." + ) + } + + const { result } = await createManagerWorkflow(req.scope) + .run({ + input: { + manager: req.body, + authIdentityId: req.auth_context.auth_identity_id, + }, + }) + + res.status(200).json({ manager: result }) +} +``` + +Since the manager must be associated with an `AuthIdentity` record, the request is expected to be authenticated, even if the manager isn’t created yet. This can be achieved by: + +1. Obtaining a token usng the [/auth route](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/auth/authentication-route/index.html.md). +2. Passing the token in the bearer header of the request to this route. + +In the API route, you create the manager using the workflow from the previous section and return it in the response. + +*** + +## 3. Apply the `authenticate` Middleware + +The last step is to apply the `authenticate` middleware on the API routes that require a manager’s authentication. + +To do that, create the file `src/api/middlewares.ts` with the following content: + +```ts title="src/api/middlewares.ts" highlights={middlewareHighlights} +import { + defineMiddlewares, + authenticate, +} from "@medusajs/framework/http" + +export default defineMiddlewares({ + routes: [ + { + matcher: "/manager", + method: "POST", + middlewares: [ + authenticate("manager", ["session", "bearer"], { + allowUnregistered: true, + }), + ], + }, + { + matcher: "/manager/me*", + middlewares: [ + authenticate("manager", ["session", "bearer"]), + ], + }, + ], +}) +``` + +This applies middlewares on two route patterns: + +1. The `authenticate` middleware is applied on the `/manager` API route for `POST` requests while allowing unregistered managers. This requires that a bearer token be passed in the request to access the manager’s auth identity but doesn’t require the manager to be registered. +2. The `authenticate` middleware is applied on all routes starting with `/manager/me`, restricting these routes to authenticated managers only. + +### Retrieve Manager API Route + +For example, create the file `src/api/manager/me/route.ts` with the following content: + +```ts title="src/api/manager/me/route.ts" +import { + AuthenticatedMedusaRequest, + MedusaResponse, +} from "@medusajs/framework/http" +import ManagerModuleService from "../../../modules/manager/service" + +export async function GET( + req: AuthenticatedMedusaRequest, + res: MedusaResponse +): Promise { + const managerModuleService: ManagerModuleService = + req.scope.resolve("managerModuleService") + + const manager = await managerModuleService.retrieveManager( + req.auth_context.actor_id + ) + + res.json({ manager }) +} +``` + +This route is only accessible by authenticated managers. You access the manager’s ID using `req.auth_context.actor_id`. + +*** + +## Test Custom Actor Type Authentication Flow + +To authenticate managers: + +1. Send a `POST` request to `/auth/manager/emailpass/register` to create an auth identity for the manager: + +```bash +curl -X POST 'http://localhost:9000/auth/manager/emailpass/register' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "email": "manager@gmail.com", + "password": "supersecret" +}' +``` + +Copy the returned token to use it in the next request. + +2. Send a `POST` request to `/manager` to create a manager: + +```bash +curl -X POST 'http://localhost:9000/manager' \ +-H 'Content-Type: application/json' \ +-H 'Authorization: Bearer {token}' \ +--data-raw '{ + "first_name": "John", + "last_name": "Doe", + "email": "manager@gmail.com" +}' +``` + +Replace `{token}` with the token returned in the previous step. + +3. Send a `POST` request to `/auth/manager/emailpass` again to retrieve an authenticated token for the manager: + +```bash +curl -X POST 'http://localhost:9000/auth/manager/emailpass' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "email": "manager@gmail.com", + "password": "supersecret" +}' +``` + +4. You can now send authenticated requests as a manager. For example, send a `GET` request to `/manager/me` to retrieve the authenticated manager’s details: + +```bash +curl 'http://localhost:9000/manager/me' \ +-H 'Authorization: Bearer {token}' +``` + +Whenever you want to log in as a manager, use the `/auth/manager/emailpass` API route, as explained in step 3. + +*** + +## Delete User of Actor Type + +When you delete a user of the actor type, you must update its auth identity to remove the association to the user. + +For example, create the following workflow that deletes a manager and updates its auth identity, create the file `src/workflows/delete-manager.ts` with the following content: + +```ts title="src/workflows/delete-manager.ts" collapsibleLines="1-6" expandButtonLabel="Show Imports" +import { + createStep, + StepResponse, +} from "@medusajs/framework/workflows-sdk" +import ManagerModuleService from "../modules/manager/service" + +export type DeleteManagerWorkflow = { + id: string +} + +const deleteManagerStep = createStep( + "delete-manager-step", + async ( + { id }: DeleteManagerWorkflow, + { container }) => { + const managerModuleService: ManagerModuleService = + container.resolve("managerModuleService") + + const manager = await managerModuleService.retrieve(id) + + await managerModuleService.deleteManagers(id) + + return new StepResponse(undefined, { manager }) + }, + async ({ manager }, { container }) => { + const managerModuleService: ManagerModuleService = + container.resolve("managerModuleService") + + await managerModuleService.createManagers(manager) + } + ) +``` + +You add a step that deletes the manager using the `deleteManagers` method of the module's main service. In the compensation function, you create the manager again. + +Next, in the same file, add the workflow that deletes a manager: + +```ts title="src/workflows/delete-manager.ts" collapsibleLines="1-15" expandButtonLabel="Show Imports" highlights={deleteHighlights} +// other imports +import { MedusaError } from "@medusajs/framework/utils" +import { + WorkflowData, + WorkflowResponse, + createWorkflow, + transform, +} from "@medusajs/framework/workflows-sdk" +import { + setAuthAppMetadataStep, + useQueryGraphStep, +} from "@medusajs/medusa/core-flows" + +// ... + +export const deleteManagerWorkflow = createWorkflow( + "delete-manager", + ( + input: WorkflowData + ): WorkflowResponse => { + deleteManagerStep(input) + + const { data: authIdentities } = useQueryGraphStep({ + entity: "auth_identity", + fields: ["id"], + filters: { + app_metadata: { + // the ID is of the format `{actor_type}_id`. + manager_id: input.id, + }, + }, + }) + + const authIdentity = transform( + { authIdentities }, + ({ authIdentities }) => { + const authIdentity = authIdentities[0] + + if (!authIdentity) { + throw new MedusaError( + MedusaError.Types.NOT_FOUND, + "Auth identity not found" + ) + } + + return authIdentity + } + ) + + setAuthAppMetadataStep({ + authIdentityId: authIdentity.id, + actorType: "manager", + value: null, + }) + + return new WorkflowResponse(input.id) + } +) +``` + +In the workflow, you: + +1. Use the `deleteManagerStep` defined earlier to delete the manager. +2. Retrieve the auth identity of the manager using Query. To do that, you filter the `app_metadata` property of an auth identity, which holds the user's ID under `{actor_type_name}_id`. So, in this case, it's `manager_id`. +3. Check that the auth identity exist, then, update the auth identity to remove the ID of the manager from it. + +You can use this workflow when deleting a manager, such as in an API route. + + +# Auth Module Options + +In this document, you'll learn about the options of the Auth Module. + +## providers + +The `providers` option is an array of auth module providers. + +When the Medusa application starts, these providers are registered and can be used to handle authentication. + +By default, the `emailpass` provider is registered to authenticate customers and admin users. + +For example: + +```ts title="medusa-config.ts" +import { Modules, ContainerRegistrationKeys } from "@medusajs/framework/utils" + +// ... + +module.exports = defineConfig({ + // ... + modules: [ + { + resolve: "@medusajs/medusa/auth", + dependencies: [Modules.CACHE, ContainerRegistrationKeys.LOGGER], + options: { + providers: [ + { + resolve: "@medusajs/medusa/auth-emailpass", + id: "emailpass", + options: { + // provider options... + }, + }, + ], + }, + }, + ], +}) +``` + +The `providers` option is an array of objects that accept the following properties: + +- `resolve`: A string indicating the package name of the module provider or the path to it relative to the `src` directory. +- `id`: A string indicating the provider's unique name or ID. +- `options`: An optional object of the module provider's options. + +*** + +## Auth CORS + +The Medusa application's authentication API routes are defined under the `/auth` prefix that requires setting the `authCors` property of the `http` configuration. + +By default, the Medusa application you created will have an `AUTH_CORS` environment variable, which is used as the value of `authCors`. + +Refer to [Medusa's configuration guide](https://docs.medusajs.com/references/medusa-config#authCors/index.html.md) to learn more about the `authCors` configuration. + +*** + +## authMethodsPerActor Configuration + +The Medusa application's configuration accept an `authMethodsPerActor` configuration which restricts the allowed auth providers used with an actor type. + +Learn more about the `authMethodsPerActor` configuration in [this guide](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/auth/auth-providers#configure-allowed-auth-providers-of-actor-types/index.html.md). + + +# How to Handle Password Reset Token Event + +In this guide, you'll learn how to handle the `auth.password_reset` event, which is emitted when a request is sent to the [Generate Reset Password Token API route](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/auth/authentication-route#generate-reset-password-token-route/index.html.md). + +Refer to this [Medusa Admin User Guide](https://docs.medusajs.com/user-guide/reset-password/index.html.md) to learn how to reset your user admin password using the dashboard. + +You'll create a subscriber that listens to the event. When the event is emitted, the subscriber sends an email notification to the user. + +### Prerequisites + +- [A notification provider module, such as SendGrid](https://docs.medusajs.com/architectural-modules/notification/sendgrid/index.html.md) + +## 1. Create Subscriber + +The first step is to create a subscriber that listens to the `auth.password_reset` and sends the user a notification with instructions to reset their password. + +Create the file `src/subscribers/handle-reset.ts` with the following content: + +```ts title="src/subscribers/handle-reset.ts" highlights={highlights} collapsibleLines="1-6" expandMoreLabel="Show Imports" +import { + SubscriberArgs, + type SubscriberConfig, +} from "@medusajs/medusa" +import { Modules } from "@medusajs/framework/utils" + +export default async function resetPasswordTokenHandler({ + event: { data: { + entity_id: email, + token, + actor_type, + } }, + container, +}: SubscriberArgs<{ entity_id: string, token: string, actor_type: string }>) { + const notificationModuleService = container.resolve( + Modules.NOTIFICATION + ) + + const urlPrefix = actor_type === "customer" ? + "https://storefront.com" : + "https://admin.com/app" + + await notificationModuleService.createNotifications({ + to: email, + channel: "email", + template: "reset-password-template", + data: { + // a URL to a frontend application + url: `${urlPrefix}/reset-password?token=${token}&email=${email}`, + }, + }) +} + +export const config: SubscriberConfig = { + event: "auth.password_reset", +} +``` + +You subscribe to the `auth.password_reset` event. The event has a data payload object with the following properties: + +- `entity_id`: The identifier of the user. When using the `emailpass` provider, it's the user's email. +- `token`: The token to reset the user's password. +- `actor_type`: The user's actor type. For example, if the user is a customer, the `actor_type` is `customer`. If it's an admin user, the `actor_type` is `user`. + +This event's payload previously had an `actorType` field. It was renamed to `actor_type` after [Medusa v2.0.7](https://github.com/medusajs/medusa/releases/tag/v2.0.7). + +In the subscriber, you: + +- Decide the frontend URL based on whether the user is a customer or admin user by checking the value of `actor_type`. +- Resolve the Notification Module and use its `createNotifications` method to send the notification. +- You pass to the `createNotifications` method an object having the following properties: + - `to`: The identifier to send the notification to, which in this case is the email. + - `channel`: The channel to send the notification through, which in this case is email. + - `template`: The template ID in the third-party service. + - `data`: The data payload to pass to the template. You pass the URL to redirect the user to. You must pass the token and email in the URL so that the frontend can send them later to the Medusa application when reseting the password. + +*** + +## 2. Test it Out: Generate Reset Password Token + +To test the subscriber out, send a request to the `/auth/{actor_type}/{auth_provider}/reset-password` API route, replacing `{actor_type}` and `{auth_provider}` with the user's actor type and provider used for authentication respectively. + +For example, to generate a reset password token for an admin user using the `emailpass` provider, send the following request: + +```bash +curl --location 'http://localhost:9000/auth/user/emailpass/reset-password' \ +--header 'Content-Type: application/json' \ +--data-raw '{ + "identifier": "admin-test@gmail.com" +}' +``` + +In the request body, you must pass an `identifier` parameter. Its value is the user's identifier, which is the email in this case. + +If the token is generated successfully, the request returns a response with `201` status code. In the terminal, you'll find the following message indicating that the `auth.password_reset` event was emitted and your subscriber ran: + +```plain +info: Processing auth.password_reset which has 1 subscribers +``` + +The notification is sent to the user with the frontend URL to enter a new password. + +*** + +## Next Steps: Implementing Frontend + +In your frontend, you must have a page that accepts `token` and `email` query parameters. + +The page shows the user password fields to enter their new password, then submits the new password, token, and email to the [Reset Password Route](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/auth/authentication-route#reset-password-route/index.html.md). + +### Examples + +- [Storefront Guide: Reset Customer Password](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/storefront-development/customers/reset-password/index.html.md) + + +# Customer Accounts + +In this document, you’ll learn how registered and unregistered accounts are distinguished in the Medusa application. + +Refer to this [Medusa Admin User Guide](https://docs.medusajs.com/user-guide/customers/index.html.md) to learn how to manage customers using the dashboard. + +## `has_account` Property + +The [Customer data model](https://docs.medusajs.com/references/customer/models/Customer/index.html.md) has a `has_account` property, which is a boolean that indicates whether a customer is registered. + +When a guest customer places an order, a new `Customer` record is created with `has_account` set to `false`. + +When this or another guest customer registers an account with the same email, a new `Customer` record is created with `has_account` set to `true`. + +*** + +## Email Uniqueness + +The above behavior means that two `Customer` records may exist with the same email. However, the main difference is the `has_account` property's value. + +So, there can only be one guest customer (having `has_account=false`) and one registered customer (having `has_account=true`) with the same email. + + +# Links between Customer Module and Other Modules + +This document showcases the module links defined between the Customer Module and other commerce modules. + +## Summary + +The Customer Module has the following links to other modules: + +Read-only links are used to query data across modules, but the relations aren't stored in a pivot table in the database. + +- [`Customer` data model \<> `AccountHolder` data model of Payment Module](#payment-module). +- [`Cart` data model of Cart Module \<> `Customer` data model](#cart-module). (Read-only). +- [`Order` data model of Order Module \<> `Customer` data model](#order-module). (Read-only). + +*** + +## Payment Module + +Medusa defines a link between the `Customer` and `AccountHolder` data models, allowing payment providers to save payment methods for a customer, if the payment provider supports it. + +This link is available starting from Medusa `v2.5.0`. + +### Retrieve with Query + +To retrieve the account holder associated with a customer with [Query](https://docs.medusajs.com/docs/learn/fundamentals/module-links/query/index.html.md), pass `customer.*` in `fields`: + +### query.graph + +```ts +const { data: customers } = await query.graph({ + entity: "customer", + fields: [ + "account_holder.*", + ], +}) + +// customers.account_holder +``` + +### useQueryGraphStep + +```ts +import { useQueryGraphStep } from "@medusajs/medusa/core-flows" + +// ... + +const { data: customers } = useQueryGraphStep({ + entity: "customer", + fields: [ + "account_holder.*", + ], +}) + +// customers.account_holder +``` + +### Manage with Link + +To manage the account holders of a customer, use [Link](https://docs.medusajs.com/docs/learn/fundamentals/module-links/link/index.html.md): + +### link.create + +```ts +import { Modules } from "@medusajs/framework/utils" + +// ... + +await link.create({ + [Modules.CUSTOMER]: { + customer_id: "cus_123", + }, + [Modules.PAYMENT]: { + account_holder_id: "acchld_123", + }, +}) +``` + +### createRemoteLinkStep + +```ts +import { createRemoteLinkStep } from "@medusajs/medusa/core-flows" + +// ... + +createRemoteLinkStep({ + [Modules.CUSTOMER]: { + customer_id: "cus_123", + }, + [Modules.PAYMENT]: { + account_holder_id: "acchld_123", + }, +}) +``` + +*** + +## Cart Module + +Medusa defines a read-only link between the `Customer` data model and the [Cart Module](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/cart/index.html.md)'s `Cart` data model. This means you can retrieve the details of a customer's carts, but you don't manage the links in a pivot table in the database. The customer of a cart is determined by the `customer_id` property of the `Cart` data model. + +### Retrieve with Query + +To retrieve a customer's carts with [Query](https://docs.medusajs.com/docs/learn/fundamentals/module-links/query/index.html.md), pass `carts.*` in `fields`: + +### query.graph + +```ts +const { data: customers } = await query.graph({ + entity: "customer", + fields: [ + "carts.*", + ], +}) + +// customers.carts +``` + +### useQueryGraphStep + +```ts +import { useQueryGraphStep } from "@medusajs/medusa/core-flows" + +// ... + +const { data: customers } = useQueryGraphStep({ + entity: "customer", + fields: [ + "carts.*", + ], +}) + +// customers.carts +``` + +*** + +## Order Module + +Medusa defines a read-only link between the `Customer` data model and the [Order Module](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/order/index.html.md)'s `Order` data model. This means you can retrieve the details of a customer's orders, but you don't manage the links in a pivot table in the database. The customer of an order is determined by the `customer_id` property of the `Order` data model. + +### Retrieve with Query + +To retrieve a customer's orders with [Query](https://docs.medusajs.com/docs/learn/fundamentals/module-links/query/index.html.md), pass `orders.*` in `fields`: + +### query.graph + +```ts +const { data: customers } = await query.graph({ + entity: "customer", + fields: [ + "orders.*", + ], +}) + +// customers.orders +``` + +### useQueryGraphStep + +```ts +import { useQueryGraphStep } from "@medusajs/medusa/core-flows" + +// ... + +const { data: customers } = useQueryGraphStep({ + entity: "customer", + fields: [ + "orders.*", + ], +}) + +// customers.orders +``` + + +# Fulfillment Module Provider + +In this document, you’ll learn what a fulfillment module provider is. + +Refer to this [Medusa Admin User Guide](https://docs.medusajs.com/user-guide/settings/locations-and-shipping/locations#manage-fulfillment-providers/index.html.md) to learn how to add a fulfillment provider to a location using the dashboard. + +## What’s a Fulfillment Module Provider? + +A fulfillment module provider handles fulfilling items, typically using a third-party integration. + +Fulfillment module providers registered in the Fulfillment Module's [options](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/fulfillment/module-options/index.html.md) are stored and represented by the [FulfillmentProvider data model](https://docs.medusajs.com/references/fulfillment/models/FulfillmentProvider/index.html.md). + +*** + +## Configure Fulfillment Providers + +The Fulfillment Module accepts a `providers` option that allows you to register providers in your application. + +Learn more about the `providers` option in [this documentation](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/fulfillment/module-options/index.html.md). + +*** + +## How to Create a Fulfillment Provider? + +Refer to [this guide](https://docs.medusajs.com/references/fulfillment/provider/index.html.md) to learn how to create a fulfillment module provider. + + # Fulfillment Concepts In this document, you’ll learn about some basic fulfillment concepts. @@ -19551,33 +20196,6 @@ The `Fulfillment` data model has three properties to keep track of the current s - `delivered_at`: The date the fulfillment was delivered. If set, then the fulfillment has been delivered. -# Fulfillment Module Provider - -In this document, you’ll learn what a fulfillment module provider is. - -Refer to this [Medusa Admin User Guide](https://docs.medusajs.com/user-guide/settings/locations-and-shipping/locations#manage-fulfillment-providers/index.html.md) to learn how to add a fulfillment provider to a location using the dashboard. - -## What’s a Fulfillment Module Provider? - -A fulfillment module provider handles fulfilling items, typically using a third-party integration. - -Fulfillment module providers registered in the Fulfillment Module's [options](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/fulfillment/module-options/index.html.md) are stored and represented by the [FulfillmentProvider data model](https://docs.medusajs.com/references/fulfillment/models/FulfillmentProvider/index.html.md). - -*** - -## Configure Fulfillment Providers - -The Fulfillment Module accepts a `providers` option that allows you to register providers in your application. - -Learn more about the `providers` option in [this documentation](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/fulfillment/module-options/index.html.md). - -*** - -## How to Create a Fulfillment Provider? - -Refer to [this guide](https://docs.medusajs.com/references/fulfillment/provider/index.html.md) to learn how to create a fulfillment module provider. - - # Links between Fulfillment Module and Other Modules This document showcases the module links defined between the Fulfillment Module and other commerce modules. @@ -19936,6 +20554,51 @@ createRemoteLinkStep({ ``` +# Fulfillment Module Options + +In this document, you'll learn about the options of the Fulfillment Module. + +## providers + +The `providers` option is an array of fulfillment module providers. + +When the Medusa application starts, these providers are registered and can be used to process fulfillments. + +For example: + +```ts title="medusa-config.ts" +import { Modules } from "@medusajs/framework/utils" + +// ... + +module.exports = defineConfig({ + // ... + modules: [ + { + resolve: "@medusajs/medusa/fulfillment", + options: { + providers: [ + { + resolve: `@medusajs/medusa/fulfillment-manual`, + id: "manual", + options: { + // provider options... + }, + }, + ], + }, + }, + ], +}) +``` + +The `providers` option is an array of objects that accept the following properties: + +- `resolve`: A string indicating either the package name of the module provider or the path to it relative to the `src` directory. +- `id`: A string indicating the provider's unique name or ID. +- `options`: An optional object of the module provider's options. + + # Shipping Option In this document, you’ll learn about shipping options and their rules. @@ -20000,49 +20663,47 @@ When fulfilling an item, you might use a third-party fulfillment provider that r The `ShippingOption` data model has a `data` property. It's an object that stores custom data relevant later when creating and processing a fulfillment. -# Fulfillment Module Options +# Inventory Concepts -In this document, you'll learn about the options of the Fulfillment Module. +In this document, you’ll learn about the main concepts in the Inventory Module, and how data is stored and related. -## providers +## InventoryItem -The `providers` option is an array of fulfillment module providers. +An inventory item, represented by the [InventoryItem data model](https://docs.medusajs.com/references/inventory-next/models/InventoryItem/index.html.md), is a stock-kept item, such as a product, whose inventory can be managed. -When the Medusa application starts, these providers are registered and can be used to process fulfillments. +The `InventoryItem` data model mainly holds details related to the underlying stock item, but has relations to other data models that include its inventory details. -For example: +![A diagram showcasing the relation between data models in the Inventory Module](https://res.cloudinary.com/dza7lstvk/image/upload/v1709658103/Medusa%20Resources/inventory-architecture_kxr2ql.png) -```ts title="medusa-config.ts" -import { Modules } from "@medusajs/framework/utils" +### Inventory Shipping Requirement -// ... +An inventory item has a `requires_shipping` field (enabled by default) that indicates whether the item requires shipping. For example, if you're selling a digital license that has limited stock quantity but doesn't require shipping. -module.exports = defineConfig({ - // ... - modules: [ - { - resolve: "@medusajs/medusa/fulfillment", - options: { - providers: [ - { - resolve: `@medusajs/medusa/fulfillment-manual`, - id: "manual", - options: { - // provider options... - }, - }, - ], - }, - }, - ], -}) -``` +When a product variant is purchased in the Medusa application, this field is used to determine whether the item requires shipping. Learn more in [this documentation](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/product/selling-products/index.html.md). -The `providers` option is an array of objects that accept the following properties: +*** -- `resolve`: A string indicating either the package name of the module provider or the path to it relative to the `src` directory. -- `id`: A string indicating the provider's unique name or ID. -- `options`: An optional object of the module provider's options. +## InventoryLevel + +An inventory level, represented by the [InventoryLevel data model](https://docs.medusajs.com/references/inventory-next/models/InventoryLevel/index.html.md), holds the inventory and quantity details of an inventory item in a specific location. + +It has three quantity-related properties: + +- `stocked_quantity`: The available stock quantity of an item in the associated location. +- `reserved_quantity`: The quantity reserved from the available `stocked_quantity`. It indicates the quantity that's still not removed from stock, but considered as unavailable when checking whether an item is in stock. +- `incoming_quantity`: The incoming stock quantity of an item into the associated location. This property doesn't play into the `stocked_quantity` or when checking whether an item is in stock. + +### Associated Location + +The inventory level's location is determined by the `location_id` property. Medusa links the `InventoryLevel` data model with the `StockLocation` data model from the Stock Location Module. + +*** + +## ReservationItem + +A reservation item, represented by the [ReservationItem](https://docs.medusajs.com/references/inventory-next/models/ReservationItem/index.html.md) data model, represents unavailable quantity of an inventory item in a location. It's used when an order is placed but not fulfilled yet. + +The reserved quantity is associated with a location, so it has a similar relation to that of the `InventoryLevel` with the Stock Location Module. # Inventory Module in Medusa Flows @@ -20106,6 +20767,145 @@ This flow is implemented within the [confirmReturnReceiveWorkflow](https://docs. If a returned item is considered damaged or is dismissed, its quantity doesn't increment the `stocked_quantity` of the inventory item's level. +# Links between Inventory Module and Other Modules + +This document showcases the module links defined between the Inventory Module and other commerce modules. + +## Summary + +The Inventory Module has the following links to other modules: + +Read-only links are used to query data across modules, but the relations aren't stored in a pivot table in the database. + +- [`ProductVariant` data model of Product Module \<> `InventoryItem` data model](#product-module). +- [`InventoryLevel` data model \<> `StockLocation` data model of Stock Location Module](#stock-location-module). (Read-only). + +*** + +## Product Module + +Each product variant has different inventory details. Medusa defines a link between the `ProductVariant` and `InventoryItem` data models. + +![A diagram showcasing an example of how data models from the Inventory and Product Module are linked.](https://res.cloudinary.com/dza7lstvk/image/upload/v1709658720/Medusa%20Resources/inventory-product_ejnray.jpg) + +A product variant whose `manage_inventory` property is enabled has an associated inventory item. Through that inventory's items relations in the Inventory Module, you can manage and check the variant's inventory quantity. + +Learn more about product variant's inventory management in [this guide](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/product/variant-inventory/index.html.md). + +### Retrieve with Query + +To retrieve the product variants of an inventory item with [Query](https://docs.medusajs.com/docs/learn/fundamentals/module-links/query/index.html.md), pass `variants.*` in `fields`: + +### query.graph + +```ts +const { data: inventoryItems } = await query.graph({ + entity: "inventory_item", + fields: [ + "variants.*", + ], +}) + +// inventoryItems.variants +``` + +### useQueryGraphStep + +```ts +import { useQueryGraphStep } from "@medusajs/medusa/core-flows" + +// ... + +const { data: inventoryItems } = useQueryGraphStep({ + entity: "inventory_item", + fields: [ + "variants.*", + ], +}) + +// inventoryItems.variants +``` + +### Manage with Link + +To manage the variants of an inventory item, use [Link](https://docs.medusajs.com/docs/learn/fundamentals/module-links/link/index.html.md): + +### link.create + +```ts +import { Modules } from "@medusajs/framework/utils" + +// ... + +await link.create({ + [Modules.PRODUCT]: { + variant_id: "variant_123", + }, + [Modules.INVENTORY]: { + inventory_item_id: "iitem_123", + }, +}) +``` + +### createRemoteLinkStep + +```ts +import { Modules } from "@medusajs/framework/utils" +import { createRemoteLinkStep } from "@medusajs/medusa/core-flows" + +// ... + +createRemoteLinkStep({ + [Modules.PRODUCT]: { + variant_id: "variant_123", + }, + [Modules.INVENTORY]: { + inventory_item_id: "iitem_123", + }, +}) +``` + +*** + +## Stock Location Module + +Medusa defines a read-only link between the `InventoryLevel` data model and the [Stock Location Module](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/stock-location/index.html.md)'s `StockLocation` data model. This means you can retrieve the details of an inventory level's stock locations, but you don't manage the links in a pivot table in the database. The stock location of an inventory level is determined by the `location_id` property of the `InventoryLevel` data model. + +### Retrieve with Query + +To retrieve the stock locations of an inventory level with [Query](https://docs.medusajs.com/docs/learn/fundamentals/module-links/query/index.html.md), pass `stock_locations.*` in `fields`: + +### query.graph + +```ts +const { data: inventoryLevels } = await query.graph({ + entity: "inventory_level", + fields: [ + "stock_locations.*", + ], +}) + +// inventoryLevels.stock_locations +``` + +### useQueryGraphStep + +```ts +import { useQueryGraphStep } from "@medusajs/medusa/core-flows" + +// ... + +const { data: inventoryLevels } = useQueryGraphStep({ + entity: "inventory_level", + fields: [ + "stock_locations.*", + ], +}) + +// inventoryLevels.stock_locations +``` + + # Inventory Kits In this guide, you'll learn how inventory kits can be used in the Medusa application to support use cases like multi-part products, bundled products, and shared inventory across products. @@ -20494,186 +21294,53 @@ The bundled product has the same inventory items as those of the products part o You can now [execute the workflow](https://docs.medusajs.com/docs/learn/fundamentals/workflows#3-execute-the-workflow/index.html.md) in [API routes](https://docs.medusajs.com/docs/learn/fundamentals/api-routes/index.html.md), [scheduled jobs](https://docs.medusajs.com/docs/learn/fundamentals/scheduled-jobs/index.html.md), or [subscribers](https://docs.medusajs.com/docs/learn/fundamentals/events-and-subscribers/index.html.md). -# Inventory Concepts +# Order Concepts -In this document, you’ll learn about the main concepts in the Inventory Module, and how data is stored and related. +In this document, you’ll learn about orders and related concepts -## InventoryItem +## Order Items -An inventory item, represented by the [InventoryItem data model](https://docs.medusajs.com/references/inventory-next/models/InventoryItem/index.html.md), is a stock-kept item, such as a product, whose inventory can be managed. +The items purchased in the order are represented by the [OrderItem data model](https://docs.medusajs.com/references/order/models/OrderItem/index.html.md). An order can have multiple items. -The `InventoryItem` data model mainly holds details related to the underlying stock item, but has relations to other data models that include its inventory details. +![A diagram showcasing the relation between an order and its items.](https://res.cloudinary.com/dza7lstvk/image/upload/v1712304722/Medusa%20Resources/order-order-items_uvckxd.jpg) -![A diagram showcasing the relation between data models in the Inventory Module](https://res.cloudinary.com/dza7lstvk/image/upload/v1709658103/Medusa%20Resources/inventory-architecture_kxr2ql.png) +### Item’s Product Details -### Inventory Shipping Requirement - -An inventory item has a `requires_shipping` field (enabled by default) that indicates whether the item requires shipping. For example, if you're selling a digital license that has limited stock quantity but doesn't require shipping. - -When a product variant is purchased in the Medusa application, this field is used to determine whether the item requires shipping. Learn more in [this documentation](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/product/selling-products/index.html.md). +The details of the purchased products are represented by the [LineItem data model](https://docs.medusajs.com/references/order/models/OrderLineItem/index.html.md). Not only does a line item hold the details of the product, but also details related to its price, adjustments due to promotions, and taxes. *** -## InventoryLevel +## Order’s Shipping Method -An inventory level, represented by the [InventoryLevel data model](https://docs.medusajs.com/references/inventory-next/models/InventoryLevel/index.html.md), holds the inventory and quantity details of an inventory item in a specific location. +An order has one or more shipping methods used to handle item shipment. -It has three quantity-related properties: +Each shipping method is represented by the [OrderShippingMethod data model](https://docs.medusajs.com/references/order/models/OrderShippingMethod/index.html.md) that holds its details. The shipping method is linked to the order through the [OrderShipping data model](https://docs.medusajs.com/references/order/models/OrderShipping/index.html.md). -- `stocked_quantity`: The available stock quantity of an item in the associated location. -- `reserved_quantity`: The quantity reserved from the available `stocked_quantity`. It indicates the quantity that's still not removed from stock, but considered as unavailable when checking whether an item is in stock. -- `incoming_quantity`: The incoming stock quantity of an item into the associated location. This property doesn't play into the `stocked_quantity` or when checking whether an item is in stock. +![A diagram showcasing the relation between an order and its items.](https://res.cloudinary.com/dza7lstvk/image/upload/v1719570409/Medusa%20Resources/order-shipping-method_tkggvd.jpg) -### Associated Location +### data Property -The inventory level's location is determined by the `location_id` property. Medusa links the `InventoryLevel` data model with the `StockLocation` data model from the Stock Location Module. +When fulfilling the order, you can use a third-party fulfillment provider that requires additional custom data to be passed along from the order creation process. + +The `OrderShippingMethod` data model has a `data` property. It’s an object used to store custom data relevant later for fulfillment. + +The Medusa application passes the `data` property to the Fulfillment Module when fulfilling items. *** -## ReservationItem +## Order Totals -A reservation item, represented by the [ReservationItem](https://docs.medusajs.com/references/inventory-next/models/ReservationItem/index.html.md) data model, represents unavailable quantity of an inventory item in a location. It's used when an order is placed but not fulfilled yet. - -The reserved quantity is associated with a location, so it has a similar relation to that of the `InventoryLevel` with the Stock Location Module. - - -# Links between Inventory Module and Other Modules - -This document showcases the module links defined between the Inventory Module and other commerce modules. - -## Summary - -The Inventory Module has the following links to other modules: - -Read-only links are used to query data across modules, but the relations aren't stored in a pivot table in the database. - -- [`ProductVariant` data model of Product Module \<> `InventoryItem` data model](#product-module). -- [`InventoryLevel` data model \<> `StockLocation` data model of Stock Location Module](#stock-location-module). (Read-only). +The order’s total amounts (including tax total, total after an item is returned, etc…) are represented by the [OrderSummary data model](https://docs.medusajs.com/references/order/models/OrderSummary/index.html.md). *** -## Product Module +## Order Payments -Each product variant has different inventory details. Medusa defines a link between the `ProductVariant` and `InventoryItem` data models. +Payments made on an order, whether they’re capture or refund payments, are recorded as transactions represented by the [OrderTransaction data model](https://docs.medusajs.com/references/order/models/OrderTransaction/index.html.md). -![A diagram showcasing an example of how data models from the Inventory and Product Module are linked.](https://res.cloudinary.com/dza7lstvk/image/upload/v1709658720/Medusa%20Resources/inventory-product_ejnray.jpg) +An order can have multiple transactions. The sum of these transactions must be equal to the order summary’s total. Otherwise, there’s an outstanding amount. -A product variant whose `manage_inventory` property is enabled has an associated inventory item. Through that inventory's items relations in the Inventory Module, you can manage and check the variant's inventory quantity. - -Learn more about product variant's inventory management in [this guide](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/product/variant-inventory/index.html.md). - -### Retrieve with Query - -To retrieve the product variants of an inventory item with [Query](https://docs.medusajs.com/docs/learn/fundamentals/module-links/query/index.html.md), pass `variants.*` in `fields`: - -### query.graph - -```ts -const { data: inventoryItems } = await query.graph({ - entity: "inventory_item", - fields: [ - "variants.*", - ], -}) - -// inventoryItems.variants -``` - -### useQueryGraphStep - -```ts -import { useQueryGraphStep } from "@medusajs/medusa/core-flows" - -// ... - -const { data: inventoryItems } = useQueryGraphStep({ - entity: "inventory_item", - fields: [ - "variants.*", - ], -}) - -// inventoryItems.variants -``` - -### Manage with Link - -To manage the variants of an inventory item, use [Link](https://docs.medusajs.com/docs/learn/fundamentals/module-links/link/index.html.md): - -### link.create - -```ts -import { Modules } from "@medusajs/framework/utils" - -// ... - -await link.create({ - [Modules.PRODUCT]: { - variant_id: "variant_123", - }, - [Modules.INVENTORY]: { - inventory_item_id: "iitem_123", - }, -}) -``` - -### createRemoteLinkStep - -```ts -import { Modules } from "@medusajs/framework/utils" -import { createRemoteLinkStep } from "@medusajs/medusa/core-flows" - -// ... - -createRemoteLinkStep({ - [Modules.PRODUCT]: { - variant_id: "variant_123", - }, - [Modules.INVENTORY]: { - inventory_item_id: "iitem_123", - }, -}) -``` - -*** - -## Stock Location Module - -Medusa defines a read-only link between the `InventoryLevel` data model and the [Stock Location Module](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/stock-location/index.html.md)'s `StockLocation` data model. This means you can retrieve the details of an inventory level's stock locations, but you don't manage the links in a pivot table in the database. The stock location of an inventory level is determined by the `location_id` property of the `InventoryLevel` data model. - -### Retrieve with Query - -To retrieve the stock locations of an inventory level with [Query](https://docs.medusajs.com/docs/learn/fundamentals/module-links/query/index.html.md), pass `stock_locations.*` in `fields`: - -### query.graph - -```ts -const { data: inventoryLevels } = await query.graph({ - entity: "inventory_level", - fields: [ - "stock_locations.*", - ], -}) - -// inventoryLevels.stock_locations -``` - -### useQueryGraphStep - -```ts -import { useQueryGraphStep } from "@medusajs/medusa/core-flows" - -// ... - -const { data: inventoryLevels } = useQueryGraphStep({ - entity: "inventory_level", - fields: [ - "stock_locations.*", - ], -}) - -// inventoryLevels.stock_locations -``` +Learn more about transactions in [this guide](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/order/transactions/index.html.md). # Order Claim @@ -20787,55 +21454,6 @@ Once the Order Edit is confirmed, any additional payment or refund required can This is determined by the comparison between the `OrderSummary` and the order's transactions, as mentioned in [this guide](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/order/transactions#checking-outstanding-amount/index.html.md). -# Order Concepts - -In this document, you’ll learn about orders and related concepts - -## Order Items - -The items purchased in the order are represented by the [OrderItem data model](https://docs.medusajs.com/references/order/models/OrderItem/index.html.md). An order can have multiple items. - -![A diagram showcasing the relation between an order and its items.](https://res.cloudinary.com/dza7lstvk/image/upload/v1712304722/Medusa%20Resources/order-order-items_uvckxd.jpg) - -### Item’s Product Details - -The details of the purchased products are represented by the [LineItem data model](https://docs.medusajs.com/references/order/models/OrderLineItem/index.html.md). Not only does a line item hold the details of the product, but also details related to its price, adjustments due to promotions, and taxes. - -*** - -## Order’s Shipping Method - -An order has one or more shipping methods used to handle item shipment. - -Each shipping method is represented by the [OrderShippingMethod data model](https://docs.medusajs.com/references/order/models/OrderShippingMethod/index.html.md) that holds its details. The shipping method is linked to the order through the [OrderShipping data model](https://docs.medusajs.com/references/order/models/OrderShipping/index.html.md). - -![A diagram showcasing the relation between an order and its items.](https://res.cloudinary.com/dza7lstvk/image/upload/v1719570409/Medusa%20Resources/order-shipping-method_tkggvd.jpg) - -### data Property - -When fulfilling the order, you can use a third-party fulfillment provider that requires additional custom data to be passed along from the order creation process. - -The `OrderShippingMethod` data model has a `data` property. It’s an object used to store custom data relevant later for fulfillment. - -The Medusa application passes the `data` property to the Fulfillment Module when fulfilling items. - -*** - -## Order Totals - -The order’s total amounts (including tax total, total after an item is returned, etc…) are represented by the [OrderSummary data model](https://docs.medusajs.com/references/order/models/OrderSummary/index.html.md). - -*** - -## Order Payments - -Payments made on an order, whether they’re capture or refund payments, are recorded as transactions represented by the [OrderTransaction data model](https://docs.medusajs.com/references/order/models/OrderTransaction/index.html.md). - -An order can have multiple transactions. The sum of these transactions must be equal to the order summary’s total. Otherwise, there’s an outstanding amount. - -Learn more about transactions in [this guide](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/order/transactions/index.html.md). - - # Order Exchange In this document, you’ll learn about order exchanges. @@ -20889,43 +21507,34 @@ Any payment or refund made is stored in the [Transaction data model](https://doc When an exchange is confirmed, the order’s version is incremented. -# Order Change +# Order Versioning -In this document, you'll learn about the Order Change data model and possible actions in it. +In this document, you’ll learn how an order and its details are versioned. -## OrderChange Data Model +## What's Versioning? -The [OrderChange data model](https://docs.medusajs.com/references/order/models/OrderChange/index.html.md) represents any kind of change to an order, such as a return, exchange, or edit. +Versioning means assigning a version number to a record, such as an order and its items. This is useful to view the different versions of the order following changes in its lifetime. -Its `change_type` property indicates what the order change is created for: - -1. `edit`: The order change is making edits to the order, as explained in [this guide](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/order/edit/index.html.md). -2. `exchange`: The order change is associated with an exchange, which you can learn about in [this guide](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/order/exchange/index.html.md). -3. `claim`: The order change is associated with a claim, which you can learn about in [this guide](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/order/claim/index.html.md). -4. `return_request` or `return_receive`: The order change is associated with a return, which you can learn about in [this guide](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/order/return/index.html.md). - -Once the order change is confirmed, its changes are applied on the order. +When changes are made on an order, such as an item is added or returned, the order's version changes. *** -## Order Change Actions +## version Property -The actions to perform on the original order by a change, such as adding an item, are represented by the [OrderChangeAction data model](https://docs.medusajs.com/references/order/models/OrderChangeAction/index.html.md). +The `Order` and `OrderSummary` data models have a `version` property that indicates the current version. By default, its value is `1`. -The `OrderChangeAction` has an `action` property that indicates the type of action to perform on the order, and a `details` property that holds more details related to the action. +Other order-related data models, such as `OrderItem`, also has a `version` property, but it indicates the version it belongs to. -The following table lists the possible `action` values that Medusa uses and what `details` they carry. +*** -|Action|Description|Details| -|---|---|---|---|---| -|\`ITEM\_ADD\`|Add an item to the order.|\`details\`| -|\`ITEM\_UPDATE\`|Update an item in the order.|\`details\`| -|\`RETURN\_ITEM\`|Set an item to be returned.|\`details\`| -|\`RECEIVE\_RETURN\_ITEM\`|Mark a return item as received.|\`details\`| -|\`RECEIVE\_DAMAGED\_RETURN\_ITEM\`|Mark a return item that's damaged as received.|\`details\`| -|\`SHIPPING\_ADD\`|Add a shipping method for new or returned items.|No details added. The ID to the shipping method is added in the | -|\`SHIPPING\_ADD\`|Add a shipping method for new or returned items.|No details added. The ID to the shipping method is added in the | -|\`WRITE\_OFF\_ITEM\`|Remove an item's quantity as part of the claim, without adding the quantity back to the item variant's inventory.|\`details\`| +## How the Version Changes + +When the order is changed, such as an item is exchanged, this changes the version of the order and its related data: + +1. The version of the order and its summary is incremented. +2. Related order data that have a `version` property, such as the `OrderItem`, are duplicated. The duplicated item has the new version, whereas the original item has the previous version. + +When the order is retrieved, only the related data having the same version is retrieved. # Promotions Adjustments in Orders @@ -21050,174 +21659,6 @@ await orderModuleService.setOrderShippingMethodAdjustments( ``` -# Order Return - -In this document, you’ll learn about order returns. - -Refer to this [Medusa Admin User Guide](https://docs.medusajs.com/user-guide/orders/returns/index.html.md) to learn how to manage an order's returns using the dashboard. - -## What is a Return? - -A return is the return of items delivered from the customer back to the merchant. It is represented by the [Return data model](https://docs.medusajs.com/references/order/models/Return/index.html.md). - -A return is requested either by the customer from the storefront, or the merchant from the admin. Medusa supports an automated Return Merchandise Authorization (RMA) flow. - -![Diagram showcasing the automated RMA flow.](https://res.cloudinary.com/dza7lstvk/image/upload/v1719578128/Medusa%20Resources/return-rma_pzprwq.jpg) - -Once the merchant receives the returned items, they mark the return as received. - -*** - -## Returned Items - -The items to be returned are represented by the [ReturnItem data model](references/order/models/ReturnItem). - -The `ReturnItem` model has two properties storing the item's quantity: - -1. `received_quantity`: The quantity of the item that's received and can be added to the item's inventory quantity. -2. `damaged_quantity`: The quantity of the item that's damaged, meaning it can't be sold again or added to the item's inventory quantity. - -*** - -## Return Shipping Methods - -A return has shipping methods used to return the items to the merchant. The shipping methods are represented by the [OrderShippingMethod data model](references/order/models/OrderShippingMethod). - -In the Medusa application, the shipping method for a return is created only from a shipping option, provided by the Fulfillment Module, that has the rule `is_return` enabled. - -*** - -## Refund Payment - -The `refund_amount` property of the `Return` data model holds the amount a merchant must refund the customer. - -The [OrderTransaction data model](references/order/models/OrderTransaction) represents the refunds made for the return. - -*** - -## Returns in Exchanges and Claims - -When a merchant creates an exchange or a claim, it includes returning items from the customer. - -The `Return` data model also represents the return of these items. In this case, the return is associated with the exchange or claim it was created for. - -*** - -## How Returns Impact an Order’s Version - -The order’s version is incremented when: - -1. A return is requested. -2. A return is marked as received. - - -# Tax Lines in Order Module - -In this document, you’ll learn about tax lines in an order. - -## What are Tax Lines? - -A tax line indicates the tax rate of a line item or a shipping method. - -The [OrderLineItemTaxLine data model](https://docs.medusajs.com/references/order/models/OrderLineItemTaxLine/index.html.md) represents a line item’s tax line, and the [OrderShippingMethodTaxLine data model](https://docs.medusajs.com/references/order/models/OrderShippingMethodTaxLine/index.html.md) represents a shipping method’s tax line. - -![A diagram showcasing the relation between orders, items and shipping methods, and tax lines](https://res.cloudinary.com/dza7lstvk/image/upload/v1712307225/Medusa%20Resources/order-tax-lines_sixujd.jpg) - -*** - -## Tax Inclusivity - -By default, the tax amount is calculated by taking the tax rate from the line item or shipping method’s amount and then adding it to the item/method’s subtotal. - -However, line items and shipping methods have an `is_tax_inclusive` property that, when enabled, indicates that the item or method’s price already includes taxes. - -So, instead of calculating the tax rate and adding it to the item/method’s subtotal, it’s calculated as part of the subtotal. - -The following diagram is a simplified showcase of how a subtotal is calculated from the tax perspective. - -![A diagram showcasing how a subtotal is calculated from the tax perspective](https://res.cloudinary.com/dza7lstvk/image/upload/v1712307395/Medusa%20Resources/order-tax-inclusive_oebdnm.jpg) - -For example, if a line item's amount is `5000`, the tax rate is `10`, and `is_tax_inclusive` is enabled, the tax amount is 10% of `5000`, which is `500`. The item's unit price becomes `4500`. - - -# Transactions - -In this document, you’ll learn about an order’s transactions and its use. - -## What is a Transaction? - -A transaction represents any order payment process, such as capturing or refunding an amount. It’s represented by the [OrderTransaction data model](https://docs.medusajs.com/references/order/models/OrderTransaction/index.html.md). - -The transaction’s main purpose is to ensure a correct balance between paid and outstanding amounts. - -Transactions are also associated with returns, claims, and exchanges if additional payment or refund is required. - -*** - -## Checking Outstanding Amount - -The order’s total amounts are stored in the `OrderSummary`'s `totals` property, which is a JSON object holding the total details of the order. - -```json -{ - "totals": { - "total": 30, - "subtotal": 30, - // ... - } -} -``` - -To check the outstanding amount of the order, its transaction amounts are summed. Then, the following conditions are checked: - -|Condition|Result| -|---|---|---| -|summary’s total - transaction amounts total = 0|There’s no outstanding amount.| -|summary’s total - transaction amounts total > 0|The customer owes additional payment to the merchant.| -|summary’s total - transaction amounts total \< 0|The merchant owes the customer a refund.| - -*** - -## Transaction Reference - -The Order Module doesn’t provide payment processing functionalities, so it doesn’t store payments that can be processed. Payment functionalities are provided by the [Payment Module](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/payment/index.html.md). - -The `OrderTransaction` data model has two properties that determine which data model and record holds the actual payment’s details: - -- `reference`: indicates the table’s name in the database. For example, `payment` from the Payment Module. -- `reference_id`: indicates the ID of the record in the table. For example, `pay_123`. - - -# Order Versioning - -In this document, you’ll learn how an order and its details are versioned. - -## What's Versioning? - -Versioning means assigning a version number to a record, such as an order and its items. This is useful to view the different versions of the order following changes in its lifetime. - -When changes are made on an order, such as an item is added or returned, the order's version changes. - -*** - -## version Property - -The `Order` and `OrderSummary` data models have a `version` property that indicates the current version. By default, its value is `1`. - -Other order-related data models, such as `OrderItem`, also has a `version` property, but it indicates the version it belongs to. - -*** - -## How the Version Changes - -When the order is changed, such as an item is exchanged, this changes the version of the order and its related data: - -1. The version of the order and its summary is incremented. -2. Related order data that have a `version` property, such as the `OrderItem`, are duplicated. The duplicated item has the new version, whereas the original item has the previous version. - -When the order is retrieved, only the related data having the same version is retrieved. - - # Links between Order Module and Other Modules This document showcases the module links defined between the Order Module and other commerce modules. @@ -21740,433 +22181,181 @@ const { data: orders } = useQueryGraphStep({ ``` -# Pricing Concepts +# Order Return -In this document, you’ll learn about the main concepts in the Pricing Module. +In this document, you’ll learn about order returns. -## Price Set +Refer to this [Medusa Admin User Guide](https://docs.medusajs.com/user-guide/orders/returns/index.html.md) to learn how to manage an order's returns using the dashboard. -A [PriceSet](https://docs.medusajs.com/references/pricing/models/PriceSet/index.html.md) represents a collection of prices that are linked to a resource (for example, a product or a shipping option). +## What is a Return? -Each of these prices are represented by the [Price data module](https://docs.medusajs.com/references/pricing/models/Price/index.html.md). +A return is the return of items delivered from the customer back to the merchant. It is represented by the [Return data model](https://docs.medusajs.com/references/order/models/Return/index.html.md). -![A diagram showcasing the relation between the price set and price](https://res.cloudinary.com/dza7lstvk/image/upload/v1709648650/Medusa%20Resources/price-set-money-amount_xeees0.jpg) +A return is requested either by the customer from the storefront, or the merchant from the admin. Medusa supports an automated Return Merchandise Authorization (RMA) flow. + +![Diagram showcasing the automated RMA flow.](https://res.cloudinary.com/dza7lstvk/image/upload/v1719578128/Medusa%20Resources/return-rma_pzprwq.jpg) + +Once the merchant receives the returned items, they mark the return as received. *** -## Price List +## Returned Items -A [PriceList](https://docs.medusajs.com/references/pricing/models/PriceList/index.html.md) is a group of prices only enabled if their conditions and rules are satisfied. +The items to be returned are represented by the [ReturnItem data model](references/order/models/ReturnItem). -A price list has optional `start_date` and `end_date` properties that indicate the date range in which a price list can be applied. +The `ReturnItem` model has two properties storing the item's quantity: -Its associated prices are represented by the `Price` data model. - - -# Links between Pricing Module and Other Modules - -This document showcases the module links defined between the Pricing Module and other commerce modules. - -## Summary - -The Pricing Module has the following links to other modules: - -- [`ShippingOption` data model of Fulfillment Module \<> `PriceSet` data model](#fulfillment-module). -- [`ProductVariant` data model of Product Module \<> `PriceSet` data model](#product-module). +1. `received_quantity`: The quantity of the item that's received and can be added to the item's inventory quantity. +2. `damaged_quantity`: The quantity of the item that's damaged, meaning it can't be sold again or added to the item's inventory quantity. *** -## Fulfillment Module +## Return Shipping Methods -The Fulfillment Module provides fulfillment-related functionalities, including shipping options that the customer chooses from when they place their order. However, it doesn't provide pricing-related functionalities for these options. +A return has shipping methods used to return the items to the merchant. The shipping methods are represented by the [OrderShippingMethod data model](references/order/models/OrderShippingMethod). -Medusa defines a link between the `PriceSet` and `ShippingOption` data models. A shipping option's price is stored as a price set. - -![A diagram showcasing an example of how data models from the Pricing and Fulfillment modules are linked](https://res.cloudinary.com/dza7lstvk/image/upload/v1716561747/Medusa%20Resources/pricing-fulfillment_spywwa.jpg) - -### Retrieve with Query - -To retrieve the shipping option of a price set with [Query](https://docs.medusajs.com/docs/learn/fundamentals/module-links/query/index.html.md), pass `shipping_option.*` in `fields`: - -### query.graph - -```ts -const { data: priceSets } = await query.graph({ - entity: "price_set", - fields: [ - "shipping_option.*", - ], -}) - -// priceSets.shipping_option -``` - -### useQueryGraphStep - -```ts -import { useQueryGraphStep } from "@medusajs/medusa/core-flows" - -// ... - -const { data: priceSets } = useQueryGraphStep({ - entity: "price_set", - fields: [ - "shipping_option.*", - ], -}) - -// priceSets.shipping_option -``` - -### Manage with Link - -To manage the price set of a shipping option, use [Link](https://docs.medusajs.com/docs/learn/fundamentals/module-links/link/index.html.md): - -### link.create - -```ts -import { Modules } from "@medusajs/framework/utils" - -// ... - -await link.create({ - [Modules.FULFILLMENT]: { - shipping_option_id: "so_123", - }, - [Modules.PRICING]: { - price_set_id: "pset_123", - }, -}) -``` - -### createRemoteLinkStep - -```ts -import { Modules } from "@medusajs/framework/utils" -import { createRemoteLinkStep } from "@medusajs/medusa/core-flows" - -// ... - -createRemoteLinkStep({ - [Modules.FULFILLMENT]: { - shipping_option_id: "so_123", - }, - [Modules.PRICING]: { - price_set_id: "pset_123", - }, -}) -``` +In the Medusa application, the shipping method for a return is created only from a shipping option, provided by the Fulfillment Module, that has the rule `is_return` enabled. *** -## Product Module +## Refund Payment -The Product Module doesn't store or manage the prices of product variants. +The `refund_amount` property of the `Return` data model holds the amount a merchant must refund the customer. -Medusa defines a link between the `ProductVariant` and the `PriceSet`. A product variant’s prices are stored as prices belonging to a price set. - -![A diagram showcasing an example of how data models from the Pricing and Product Module are linked. The PriceSet is linked to the ProductVariant of the Product Module.](https://res.cloudinary.com/dza7lstvk/image/upload/v1709651039/Medusa%20Resources/pricing-product_m4xaut.jpg) - -So, when you want to add prices for a product variant, you create a price set and add the prices to it. - -You can then benefit from adding rules to prices or using the `calculatePrices` method to retrieve the price of a product variant within a specified context. - -### Retrieve with Query - -To retrieve the variant of a price set with [Query](https://docs.medusajs.com/docs/learn/fundamentals/module-links/query/index.html.md), pass `variant.*` in `fields`: - -### query.graph - -```ts -const { data: priceSets } = await query.graph({ - entity: "price_set", - fields: [ - "variant.*", - ], -}) - -// priceSets.variant -``` - -### useQueryGraphStep - -```ts -import { useQueryGraphStep } from "@medusajs/medusa/core-flows" - -// ... - -const { data: priceSets } = useQueryGraphStep({ - entity: "price_set", - fields: [ - "variant.*", - ], -}) - -// priceSets.variant -``` - -### Manage with Link - -To manage the price set of a variant, use [Link](https://docs.medusajs.com/docs/learn/fundamentals/module-links/link/index.html.md): - -### link.create - -```ts -import { Modules } from "@medusajs/framework/utils" - -// ... - -await link.create({ - [Modules.PRODUCT]: { - variant_id: "variant_123", - }, - [Modules.PRICING]: { - price_set_id: "pset_123", - }, -}) -``` - -### createRemoteLinkStep - -```ts -import { Modules } from "@medusajs/framework/utils" -import { createRemoteLinkStep } from "@medusajs/medusa/core-flows" - -// ... - -createRemoteLinkStep({ - [Modules.PRODUCT]: { - variant_id: "variant_123", - }, - [Modules.PRICING]: { - price_set_id: "pset_123", - }, -}) -``` - - -# Price Rules - -In this document, you'll learn about price rules for price sets and price lists. - -## Price Rule - -You can restrict prices by rules. Each rule of a price is represented by the [PriceRule data model](https://docs.medusajs.com/references/pricing/models/PriceRule/index.html.md). - -The `Price` data model has a `rules_count` property, which indicates how many rules, represented by `PriceRule`, are applied to the price. - -For exmaple, you create a price restricted to `10557` zip codes. - -![A diagram showcasing the relation between the PriceRule and Price](https://res.cloudinary.com/dza7lstvk/image/upload/v1709648772/Medusa%20Resources/price-rule-1_vy8bn9.jpg) - -A price can have multiple price rules. - -For example, a price can be restricted by a region and a zip code. - -![A diagram showcasing the relation between the PriceRule and Price with multiple rules.](https://res.cloudinary.com/dza7lstvk/image/upload/v1709649296/Medusa%20Resources/price-rule-3_pwpocz.jpg) +The [OrderTransaction data model](references/order/models/OrderTransaction) represents the refunds made for the return. *** -## Price List Rules +## Returns in Exchanges and Claims -Rules applied to a price list are represented by the [PriceListRule data model](https://docs.medusajs.com/references/pricing/models/PriceListRule/index.html.md). +When a merchant creates an exchange or a claim, it includes returning items from the customer. -The `rules_count` property of a `PriceList` indicates how many rules are applied to it. +The `Return` data model also represents the return of these items. In this case, the return is associated with the exchange or claim it was created for. -![A diagram showcasing the relation between the PriceSet, PriceList, Price, RuleType, and PriceListRuleValue](https://res.cloudinary.com/dza7lstvk/image/upload/v1709641999/Medusa%20Resources/price-list_zd10yd.jpg) +*** + +## How Returns Impact an Order’s Version + +The order’s version is incremented when: + +1. A return is requested. +2. A return is marked as received. -# Prices Calculation +# Order Change -In this document, you'll learn how prices are calculated when you use the [calculatePrices method](https://docs.medusajs.com/references/pricing/calculatePrices/index.html.md) of the Pricing Module's main service. +In this document, you'll learn about the Order Change data model and possible actions in it. -## calculatePrices Method +## OrderChange Data Model -The [calculatePrices method](https://docs.medusajs.com/references/pricing/calculatePrices/index.html.md) accepts as parameters the ID of one or more price sets and a context. +The [OrderChange data model](https://docs.medusajs.com/references/order/models/OrderChange/index.html.md) represents any kind of change to an order, such as a return, exchange, or edit. -It returns a price object with the best matching price for each price set. +Its `change_type` property indicates what the order change is created for: -### Calculation Context +1. `edit`: The order change is making edits to the order, as explained in [this guide](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/order/edit/index.html.md). +2. `exchange`: The order change is associated with an exchange, which you can learn about in [this guide](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/order/exchange/index.html.md). +3. `claim`: The order change is associated with a claim, which you can learn about in [this guide](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/order/claim/index.html.md). +4. `return_request` or `return_receive`: The order change is associated with a return, which you can learn about in [this guide](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/order/return/index.html.md). -The calculation context is an optional object passed as a second parameter to the `calculatePrices` method. It accepts rules to restrict the selected prices in the price set. +Once the order change is confirmed, its changes are applied on the order. -For example: +*** -```ts -const price = await pricingModuleService.calculatePrices( - { id: [priceSetId] }, - { - context: { - currency_code: currencyCode, - region_id: "reg_123", - }, +## Order Change Actions + +The actions to perform on the original order by a change, such as adding an item, are represented by the [OrderChangeAction data model](https://docs.medusajs.com/references/order/models/OrderChangeAction/index.html.md). + +The `OrderChangeAction` has an `action` property that indicates the type of action to perform on the order, and a `details` property that holds more details related to the action. + +The following table lists the possible `action` values that Medusa uses and what `details` they carry. + +|Action|Description|Details| +|---|---|---|---|---| +|\`ITEM\_ADD\`|Add an item to the order.|\`details\`| +|\`ITEM\_UPDATE\`|Update an item in the order.|\`details\`| +|\`RETURN\_ITEM\`|Set an item to be returned.|\`details\`| +|\`RECEIVE\_RETURN\_ITEM\`|Mark a return item as received.|\`details\`| +|\`RECEIVE\_DAMAGED\_RETURN\_ITEM\`|Mark a return item that's damaged as received.|\`details\`| +|\`SHIPPING\_ADD\`|Add a shipping method for new or returned items.|No details added. The ID to the shipping method is added in the | +|\`SHIPPING\_ADD\`|Add a shipping method for new or returned items.|No details added. The ID to the shipping method is added in the | +|\`WRITE\_OFF\_ITEM\`|Remove an item's quantity as part of the claim, without adding the quantity back to the item variant's inventory.|\`details\`| + + +# Tax Lines in Order Module + +In this document, you’ll learn about tax lines in an order. + +## What are Tax Lines? + +A tax line indicates the tax rate of a line item or a shipping method. + +The [OrderLineItemTaxLine data model](https://docs.medusajs.com/references/order/models/OrderLineItemTaxLine/index.html.md) represents a line item’s tax line, and the [OrderShippingMethodTaxLine data model](https://docs.medusajs.com/references/order/models/OrderShippingMethodTaxLine/index.html.md) represents a shipping method’s tax line. + +![A diagram showcasing the relation between orders, items and shipping methods, and tax lines](https://res.cloudinary.com/dza7lstvk/image/upload/v1712307225/Medusa%20Resources/order-tax-lines_sixujd.jpg) + +*** + +## Tax Inclusivity + +By default, the tax amount is calculated by taking the tax rate from the line item or shipping method’s amount and then adding it to the item/method’s subtotal. + +However, line items and shipping methods have an `is_tax_inclusive` property that, when enabled, indicates that the item or method’s price already includes taxes. + +So, instead of calculating the tax rate and adding it to the item/method’s subtotal, it’s calculated as part of the subtotal. + +The following diagram is a simplified showcase of how a subtotal is calculated from the tax perspective. + +![A diagram showcasing how a subtotal is calculated from the tax perspective](https://res.cloudinary.com/dza7lstvk/image/upload/v1712307395/Medusa%20Resources/order-tax-inclusive_oebdnm.jpg) + +For example, if a line item's amount is `5000`, the tax rate is `10`, and `is_tax_inclusive` is enabled, the tax amount is 10% of `5000`, which is `500`. The item's unit price becomes `4500`. + + +# Transactions + +In this document, you’ll learn about an order’s transactions and its use. + +## What is a Transaction? + +A transaction represents any order payment process, such as capturing or refunding an amount. It’s represented by the [OrderTransaction data model](https://docs.medusajs.com/references/order/models/OrderTransaction/index.html.md). + +The transaction’s main purpose is to ensure a correct balance between paid and outstanding amounts. + +Transactions are also associated with returns, claims, and exchanges if additional payment or refund is required. + +*** + +## Checking Outstanding Amount + +The order’s total amounts are stored in the `OrderSummary`'s `totals` property, which is a JSON object holding the total details of the order. + +```json +{ + "totals": { + "total": 30, + "subtotal": 30, + // ... } -) +} ``` -In this example, you retrieve the prices in a price set for the specified currency code and region ID. +To check the outstanding amount of the order, its transaction amounts are summed. Then, the following conditions are checked: -### Returned Price Object - -For each price set, the `calculatePrices` method selects two prices: - -- A calculated price: Either a price that belongs to a price list and best matches the specified context, or the same as the original price. -- An original price, which is either: - - The same price as the calculated price if the price list it belongs to is of type `override`; - - Or a price that doesn't belong to a price list and best matches the specified context. - -Both prices are returned in an object that has the following properties: - -- id: (\`string\`) The ID of the price set from which the price was selected. -- is\_calculated\_price\_price\_list: (\`boolean\`) Whether the calculated price belongs to a price list. -- calculated\_amount: (\`number\`) The amount of the calculated price, or \`null\` if there isn't a calculated price. This is the amount shown to the customer. -- is\_original\_price\_price\_list: (\`boolean\`) Whether the original price belongs to a price list. -- original\_amount: (\`number\`) The amount of the original price, or \`null\` if there isn't an original price. This amount is useful to compare with the \`calculated\_amount\`, such as to check for discounted value. -- currency\_code: (\`string\`) The currency code of the calculated price, or \`null\` if there isn't a calculated price. -- is\_calculated\_price\_tax\_inclusive: (\`boolean\`) Whether the calculated price is tax inclusive. Learn more about tax-inclusivity in \[this document]\(../tax-inclusive-pricing/page.mdx) -- is\_original\_price\_tax\_inclusive: (\`boolean\`) Whether the original price is tax inclusive. Learn more about tax-inclusivity in \[this document]\(../tax-inclusive-pricing/page.mdx) -- calculated\_price: (\`object\`) The calculated price's price details. - - - id: (\`string\`) The ID of the price. - - - price\_list\_id: (\`string\`) The ID of the associated price list. - - - price\_list\_type: (\`string\`) The price list's type. For example, \`sale\`. - - - min\_quantity: (\`number\`) The price's min quantity condition. - - - max\_quantity: (\`number\`) The price's max quantity condition. -- original\_price: (\`object\`) The original price's price details. - - - id: (\`string\`) The ID of the price. - - - price\_list\_id: (\`string\`) The ID of the associated price list. - - - price\_list\_type: (\`string\`) The price list's type. For example, \`sale\`. - - - min\_quantity: (\`number\`) The price's min quantity condition. - - - max\_quantity: (\`number\`) The price's max quantity condition. +|Condition|Result| +|---|---|---| +|summary’s total - transaction amounts total = 0|There’s no outstanding amount.| +|summary’s total - transaction amounts total > 0|The customer owes additional payment to the merchant.| +|summary’s total - transaction amounts total \< 0|The merchant owes the customer a refund.| *** -## Examples +## Transaction Reference -Consider the following price set: +The Order Module doesn’t provide payment processing functionalities, so it doesn’t store payments that can be processed. Payment functionalities are provided by the [Payment Module](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/payment/index.html.md). -```ts -const priceSet = await pricingModuleService.createPriceSets({ - prices: [ - // default price - { - amount: 500, - currency_code: "EUR", - rules: {}, - }, - // prices with rules - { - amount: 400, - currency_code: "EUR", - rules: { - region_id: "reg_123", - }, - }, - { - amount: 450, - currency_code: "EUR", - rules: { - city: "krakow", - }, - }, - { - amount: 500, - currency_code: "EUR", - rules: { - city: "warsaw", - region_id: "reg_123", - }, - }, - ], -}) -``` +The `OrderTransaction` data model has two properties that determine which data model and record holds the actual payment’s details: -### Default Price Selection - -### Code - -```ts -const price = await pricingModuleService.calculatePrices( - { id: [priceSet.id] }, - { - context: { - currency_code: "EUR" - } - } -) -``` - -### Result - -### Calculate Prices with Rules - -### Code - -```ts -const price = await pricingModuleService.calculatePrices( - { id: [priceSet.id] }, - { - context: { - currency_code: "EUR", - region_id: "reg_123", - city: "krakow" - } - } -) -``` - -### Result - -### Price Selection with Price List - -### Code - -```ts -const priceList = pricingModuleService.createPriceLists([{ - title: "Summer Price List", - description: "Price list for summer sale", - starts_at: Date.parse("01/10/2023").toString(), - ends_at: Date.parse("31/10/2023").toString(), - rules: { - region_id: ['PL'] - }, - type: "sale", - prices: [ - { - amount: 400, - currency_code: "EUR", - price_set_id: priceSet.id, - }, - { - amount: 450, - currency_code: "EUR", - price_set_id: priceSet.id, - }, - ], -}]); - -const price = await pricingModuleService.calculatePrices( - { id: [priceSet.id] }, - { - context: { - currency_code: "EUR", - region_id: "PL", - city: "krakow" - } - } -) -``` - -### Result +- `reference`: indicates the table’s name in the database. For example, `payment` from the Payment Module. +- `reference_id`: indicates the ID of the record in the table. For example, `pay_123`. # Account Holders and Saved Payment Methods @@ -22210,111 +22399,6 @@ Consequently, the Payment Module uses the payment provider to create an account This flow is only supported if the chosen payment provider has implemented the necessary [save payment methods](#save-payment-methods). -# Tax-Inclusive Pricing - -In this document, you’ll learn about tax-inclusive pricing and how it's used when calculating prices. - -## What is Tax-Inclusive Pricing? - -A tax-inclusive price is a price of a resource that includes taxes. Medusa calculates the tax amount from the price rather than adds the amount to it. - -For example, if a product’s price is $50, the tax rate is 2%, and tax-inclusive pricing is enabled, then the product's price is $49, and the applied tax amount is $1. - -*** - -## How is Tax-Inclusive Pricing Set? - -The [PricePreference data model](https://docs.medusajs.com/references/pricing/models/PricePreference/index.html.md) holds the tax-inclusive setting for a context. It has two properties that indicate the context: - -- `attribute`: The name of the attribute to compare against. For example, `region_id` or `currency_code`. -- `value`: The attribute’s value. For example, `reg_123` or `usd`. - -Only `region_id` and `currency_code` are supported as an `attribute` at the moment. - -The `is_tax_inclusive` property indicates whether tax-inclusivity is enabled in the specified context. - -For example: - -```json -{ - "attribute": "currency_code", - "value": "USD", - "is_tax_inclusive": true, -} -``` - -In this example, tax-inclusivity is enabled for the `USD` currency code. - -*** - -## Tax-Inclusive Pricing in Price Calculation - -### Tax Context - -As mentioned in the [Price Calculation documentation](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/pricing/price-calculation#calculation-context/index.html.md), The `calculatePrices` method accepts as a parameter a calculation context. - -To get accurate tax results, pass the `region_id` and / or `currency_code` in the calculation context. - -### Returned Tax Properties - -The `calculatePrices` method returns two properties related to tax-inclusivity: - -Learn more about the returned properties in [this guide](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/pricing/price-calculation#returned-price-object/index.html.md). - -- `is_calculated_price_tax_inclusive`: Whether the selected `calculated_price` is tax-inclusive. -- `is_original_price_tax_inclusive` : Whether the selected `original_price` is tax-inclusive. - -A price is considered tax-inclusive if: - -1. It belongs to the region or currency code specified in the calculation context; -2. and the region or currency code has a price preference with `is_tax_inclusive` enabled. - -### Tax Context Precedence - -A region’s price preference’s `is_tax_inclusive`'s value takes higher precedence in determining whether a price is tax-inclusive if: - -- both the `region_id` and `currency_code` are provided in the calculation context; -- the selected price belongs to the region; -- and the region has a price preference - - -# Payment Collection - -In this document, you’ll learn what a payment collection is and how the Medusa application uses it with the Cart Module. - -## What's a Payment Collection? - -A payment collection stores payment details related to a resource, such as a cart or an order. It’s represented by the [PaymentCollection data model](https://docs.medusajs.com/references/payment/models/PaymentCollection/index.html.md). - -Every purchase or request for payment starts with a payment collection. The collection holds details necessary to complete the payment, including: - -- The [payment sessions](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/payment/payment-session/index.html.md) that represents the payment amount to authorize. -- The [payments](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/payment/payment/index.html.md) that are created when a payment session is authorized. They can be captured and refunded. -- The [payment providers](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/payment/payment-provider/index.html.md) that handle the processing of each payment session, including the authorization, capture, and refund. - -*** - -## Multiple Payments - -The payment collection supports multiple payment sessions and payments. - -You can use this to accept payments in increments or split payments across payment providers. - -![Diagram showcasing how a payment collection can have multiple payment sessions and payments](https://res.cloudinary.com/dza7lstvk/image/upload/v1711554695/Medusa%20Resources/payment-collection-multiple-payments_oi3z3n.jpg) - -*** - -## Usage with the Cart Module - -The Cart Module provides cart management features. However, it doesn’t provide any features related to accepting payment. - -During checkout, the Medusa application links a cart to a payment collection, which will be used for further payment processing. - -It also implements the payment flow during checkout as explained in [this documentation](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/payment/payment-flow/index.html.md). - -![Diagram showcasing the relation between the Payment and Cart modules](https://res.cloudinary.com/dza7lstvk/image/upload/v1711537849/Medusa%20Resources/cart-payment_ixziqm.jpg) - - # Links between Payment Module and Other Modules This document showcases the module links defined between the Payment Module and other commerce modules. @@ -22714,6 +22798,125 @@ The `providers` option is an array of objects that accept the following properti - `options`: An optional object of the module provider's options. +# Payment + +In this document, you’ll learn what a payment is and how it's created, captured, and refunded. + +## What's a Payment? + +When a payment session is authorized, a payment, represented by the [Payment data model](https://docs.medusajs.com/references/payment/models/Payment/index.html.md), is created. This payment can later be captured or refunded. + +A payment carries many of the data and relations of a payment session: + +- It belongs to the same payment collection. +- It’s associated with the same payment provider, which handles further payment processing. +- It stores the payment session’s `data` property in its `data` property, as it’s still useful for the payment provider’s processing. + +*** + +## Capture Payments + +When a payment is captured, a capture, represented by the [Capture data model](https://docs.medusajs.com/references/payment/models/Capture/index.html.md), is created. It holds details related to the capture, such as the amount, the capture date, and more. + +The payment can also be captured incrementally, each time a capture record is created for that amount. + +![A diagram showcasing how a payment's multiple captures are stored](https://res.cloudinary.com/dza7lstvk/image/upload/v1711565445/Medusa%20Resources/payment-capture_f5fve1.jpg) + +*** + +## Refund Payments + +When a payment is refunded, a refund, represented by the [Refund data model](https://docs.medusajs.com/references/payment/models/Refund/index.html.md), is created. It holds details related to the refund, such as the amount, refund date, and more. + +A payment can be refunded multiple times, and each time a refund record is created. + +![A diagram showcasing how a payment's multiple refunds are stored](https://res.cloudinary.com/dza7lstvk/image/upload/v1711565555/Medusa%20Resources/payment-refund_lgfvyy.jpg) + + +# Payment Module Provider + +In this document, you’ll learn what a payment module provider is. + +Refer to this [Medusa Admin User Guide](https://docs.medusajs.com/user-guide/settings/regions/index.html.md) to learn how to manage the payment providers available in a region using the dashboard. + +## What's a Payment Module Provider? + +A payment module provider registers a payment provider that handles payment processing in the Medusa application. It integrates third-party payment providers, such as Stripe. + +To authorize a payment amount with a payment provider, a payment session is created and associated with that payment provider. The payment provider is then used to handle the authorization. + +After the payment session is authorized, the payment provider is associated with the resulting payment and handles its payment processing, such as to capture or refund payment. + +### List of Payment Module Providers + +- [Stripe](https://docs.medusajs.com/commerce-modules/payment/payment-provider/stripe/index.html.md) + +*** + +## System Payment Provider + +The Payment Module provides a `system` payment provider that acts as a placeholder payment provider. + +It doesn’t handle payment processing and delegates that to the merchant. It acts similarly to a cash-on-delivery (COD) payment method. + +*** + +## How are Payment Providers Created? + +A payment provider is a module whose main service extends the `AbstractPaymentProvider` imported from `@medusajs/framework/utils`. + +Refer to [this guide](https://docs.medusajs.com/references/payment/provider/index.html.md) on how to create a payment provider for the Payment Module. + +*** + +## Configure Payment Providers + +The Payment Module accepts a `providers` option that allows you to register providers in your application. + +Learn more about this option in [this documentation](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/payment/module-options#providers/index.html.md). + +*** + +## PaymentProvider Data Model + +When the Medusa application starts and registers the payment providers, it also creates a record of the `PaymentProvider` data model if none exists. + +This data model is used to reference a payment provider and determine whether it’s installed in the application. + + +# Payment Session + +In this document, you’ll learn what a payment session is. + +## What's a Payment Session? + +A payment session, represented by the [PaymentSession data model](https://docs.medusajs.com/references/payment/models/PaymentSession/index.html.md), is a payment amount to be authorized. It’s associated with a payment provider that handles authorizing it. + +A payment collection can have multiple payment sessions. Using this feature, you can implement payment in installments or payments using multiple providers. + +![Diagram showcasing how every payment session has a different payment provider](https://res.cloudinary.com/dza7lstvk/image/upload/v1711565056/Medusa%20Resources/payment-session-provider_guxzqt.jpg) + +*** + +## data Property + +Payment providers may need additional data to process the payment later. The `PaymentSession` data model has a `data` property used to store that data. + +For example, the customer's ID in Stripe is stored in the `data` property. + +*** + +## Payment Session Status + +The `status` property of a payment session indicates its current status. Its value can be: + +- `pending`: The payment session is awaiting authorization. +- `requires_more`: The payment session requires an action before it’s authorized. For example, to enter a 3DS code. +- `authorized`: The payment session is authorized. +- `error`: An error occurred while authorizing the payment. +- `canceled`: The authorization of the payment session has been canceled. + + # Accept Payment Flow In this document, you’ll learn how to implement an accept-payment flow using workflows or the Payment Module's main service. @@ -22881,123 +23084,41 @@ You can then: Some payment providers allow capturing the payment automatically once it’s authorized. In that case, you don’t need to do it manually. -# Payment +# Payment Collection -In this document, you’ll learn what a payment is and how it's created, captured, and refunded. +In this document, you’ll learn what a payment collection is and how the Medusa application uses it with the Cart Module. -## What's a Payment? +## What's a Payment Collection? -When a payment session is authorized, a payment, represented by the [Payment data model](https://docs.medusajs.com/references/payment/models/Payment/index.html.md), is created. This payment can later be captured or refunded. +A payment collection stores payment details related to a resource, such as a cart or an order. It’s represented by the [PaymentCollection data model](https://docs.medusajs.com/references/payment/models/PaymentCollection/index.html.md). -A payment carries many of the data and relations of a payment session: +Every purchase or request for payment starts with a payment collection. The collection holds details necessary to complete the payment, including: -- It belongs to the same payment collection. -- It’s associated with the same payment provider, which handles further payment processing. -- It stores the payment session’s `data` property in its `data` property, as it’s still useful for the payment provider’s processing. +- The [payment sessions](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/payment/payment-session/index.html.md) that represents the payment amount to authorize. +- The [payments](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/payment/payment/index.html.md) that are created when a payment session is authorized. They can be captured and refunded. +- The [payment providers](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/payment/payment-provider/index.html.md) that handle the processing of each payment session, including the authorization, capture, and refund. *** -## Capture Payments +## Multiple Payments -When a payment is captured, a capture, represented by the [Capture data model](https://docs.medusajs.com/references/payment/models/Capture/index.html.md), is created. It holds details related to the capture, such as the amount, the capture date, and more. +The payment collection supports multiple payment sessions and payments. -The payment can also be captured incrementally, each time a capture record is created for that amount. +You can use this to accept payments in increments or split payments across payment providers. -![A diagram showcasing how a payment's multiple captures are stored](https://res.cloudinary.com/dza7lstvk/image/upload/v1711565445/Medusa%20Resources/payment-capture_f5fve1.jpg) +![Diagram showcasing how a payment collection can have multiple payment sessions and payments](https://res.cloudinary.com/dza7lstvk/image/upload/v1711554695/Medusa%20Resources/payment-collection-multiple-payments_oi3z3n.jpg) *** -## Refund Payments +## Usage with the Cart Module -When a payment is refunded, a refund, represented by the [Refund data model](https://docs.medusajs.com/references/payment/models/Refund/index.html.md), is created. It holds details related to the refund, such as the amount, refund date, and more. +The Cart Module provides cart management features. However, it doesn’t provide any features related to accepting payment. -A payment can be refunded multiple times, and each time a refund record is created. +During checkout, the Medusa application links a cart to a payment collection, which will be used for further payment processing. -![A diagram showcasing how a payment's multiple refunds are stored](https://res.cloudinary.com/dza7lstvk/image/upload/v1711565555/Medusa%20Resources/payment-refund_lgfvyy.jpg) +It also implements the payment flow during checkout as explained in [this documentation](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/payment/payment-flow/index.html.md). - -# Payment Module Provider - -In this document, you’ll learn what a payment module provider is. - -Refer to this [Medusa Admin User Guide](https://docs.medusajs.com/user-guide/settings/regions/index.html.md) to learn how to manage the payment providers available in a region using the dashboard. - -## What's a Payment Module Provider? - -A payment module provider registers a payment provider that handles payment processing in the Medusa application. It integrates third-party payment providers, such as Stripe. - -To authorize a payment amount with a payment provider, a payment session is created and associated with that payment provider. The payment provider is then used to handle the authorization. - -After the payment session is authorized, the payment provider is associated with the resulting payment and handles its payment processing, such as to capture or refund payment. - -### List of Payment Module Providers - -- [Stripe](https://docs.medusajs.com/commerce-modules/payment/payment-provider/stripe/index.html.md) - -*** - -## System Payment Provider - -The Payment Module provides a `system` payment provider that acts as a placeholder payment provider. - -It doesn’t handle payment processing and delegates that to the merchant. It acts similarly to a cash-on-delivery (COD) payment method. - -*** - -## How are Payment Providers Created? - -A payment provider is a module whose main service extends the `AbstractPaymentProvider` imported from `@medusajs/framework/utils`. - -Refer to [this guide](https://docs.medusajs.com/references/payment/provider/index.html.md) on how to create a payment provider for the Payment Module. - -*** - -## Configure Payment Providers - -The Payment Module accepts a `providers` option that allows you to register providers in your application. - -Learn more about this option in [this documentation](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/payment/module-options#providers/index.html.md). - -*** - -## PaymentProvider Data Model - -When the Medusa application starts and registers the payment providers, it also creates a record of the `PaymentProvider` data model if none exists. - -This data model is used to reference a payment provider and determine whether it’s installed in the application. - - -# Payment Session - -In this document, you’ll learn what a payment session is. - -## What's a Payment Session? - -A payment session, represented by the [PaymentSession data model](https://docs.medusajs.com/references/payment/models/PaymentSession/index.html.md), is a payment amount to be authorized. It’s associated with a payment provider that handles authorizing it. - -A payment collection can have multiple payment sessions. Using this feature, you can implement payment in installments or payments using multiple providers. - -![Diagram showcasing how every payment session has a different payment provider](https://res.cloudinary.com/dza7lstvk/image/upload/v1711565056/Medusa%20Resources/payment-session-provider_guxzqt.jpg) - -*** - -## data Property - -Payment providers may need additional data to process the payment later. The `PaymentSession` data model has a `data` property used to store that data. - -For example, the customer's ID in Stripe is stored in the `data` property. - -*** - -## Payment Session Status - -The `status` property of a payment session indicates its current status. Its value can be: - -- `pending`: The payment session is awaiting authorization. -- `requires_more`: The payment session requires an action before it’s authorized. For example, to enter a 3DS code. -- `authorized`: The payment session is authorized. -- `error`: An error occurred while authorizing the payment. -- `canceled`: The authorization of the payment session has been canceled. +![Diagram showcasing the relation between the Payment and Cart modules](https://res.cloudinary.com/dza7lstvk/image/upload/v1711537849/Medusa%20Resources/cart-payment_ixziqm.jpg) # Webhook Events @@ -23546,6 +23667,29 @@ The following guides provide more details on inventory management in the Medusa - [Storefront guide: how to retrieve a product variant's inventory details](https://docs.medusajs.com/resources/storefront-development/products/inventory/index.html.md). +# Pricing Concepts + +In this document, you’ll learn about the main concepts in the Pricing Module. + +## Price Set + +A [PriceSet](https://docs.medusajs.com/references/pricing/models/PriceSet/index.html.md) represents a collection of prices that are linked to a resource (for example, a product or a shipping option). + +Each of these prices are represented by the [Price data module](https://docs.medusajs.com/references/pricing/models/Price/index.html.md). + +![A diagram showcasing the relation between the price set and price](https://res.cloudinary.com/dza7lstvk/image/upload/v1709648650/Medusa%20Resources/price-set-money-amount_xeees0.jpg) + +*** + +## Price List + +A [PriceList](https://docs.medusajs.com/references/pricing/models/PriceList/index.html.md) is a group of prices only enabled if their conditions and rules are satisfied. + +A price list has optional `start_date` and `end_date` properties that indicate the date range in which a price list can be applied. + +Its associated prices are represented by the `Price` data model. + + # Configure Selling Products In this guide, you'll learn how to set up and configure your products based on their shipping and inventory requirements, the product type, how you want to sell them, or your commerce ecosystem. @@ -23597,66 +23741,266 @@ By combining configurations of shipment requirements and inventory management, y |Item that doesn't require shipping and its variant inventory isn't managed by Medusa.||| -# Customer Accounts +# Prices Calculation -In this document, you’ll learn how registered and unregistered accounts are distinguished in the Medusa application. +In this document, you'll learn how prices are calculated when you use the [calculatePrices method](https://docs.medusajs.com/references/pricing/calculatePrices/index.html.md) of the Pricing Module's main service. -Refer to this [Medusa Admin User Guide](https://docs.medusajs.com/user-guide/customers/index.html.md) to learn how to manage customers using the dashboard. +## calculatePrices Method -## `has_account` Property +The [calculatePrices method](https://docs.medusajs.com/references/pricing/calculatePrices/index.html.md) accepts as parameters the ID of one or more price sets and a context. -The [Customer data model](https://docs.medusajs.com/references/customer/models/Customer/index.html.md) has a `has_account` property, which is a boolean that indicates whether a customer is registered. +It returns a price object with the best matching price for each price set. -When a guest customer places an order, a new `Customer` record is created with `has_account` set to `false`. +### Calculation Context -When this or another guest customer registers an account with the same email, a new `Customer` record is created with `has_account` set to `true`. +The calculation context is an optional object passed as a second parameter to the `calculatePrices` method. It accepts rules to restrict the selected prices in the price set. + +For example: + +```ts +const price = await pricingModuleService.calculatePrices( + { id: [priceSetId] }, + { + context: { + currency_code: currencyCode, + region_id: "reg_123", + }, + } +) +``` + +In this example, you retrieve the prices in a price set for the specified currency code and region ID. + +### Returned Price Object + +For each price set, the `calculatePrices` method selects two prices: + +- A calculated price: Either a price that belongs to a price list and best matches the specified context, or the same as the original price. +- An original price, which is either: + - The same price as the calculated price if the price list it belongs to is of type `override`; + - Or a price that doesn't belong to a price list and best matches the specified context. + +Both prices are returned in an object that has the following properties: + +- id: (\`string\`) The ID of the price set from which the price was selected. +- is\_calculated\_price\_price\_list: (\`boolean\`) Whether the calculated price belongs to a price list. +- calculated\_amount: (\`number\`) The amount of the calculated price, or \`null\` if there isn't a calculated price. This is the amount shown to the customer. +- is\_original\_price\_price\_list: (\`boolean\`) Whether the original price belongs to a price list. +- original\_amount: (\`number\`) The amount of the original price, or \`null\` if there isn't an original price. This amount is useful to compare with the \`calculated\_amount\`, such as to check for discounted value. +- currency\_code: (\`string\`) The currency code of the calculated price, or \`null\` if there isn't a calculated price. +- is\_calculated\_price\_tax\_inclusive: (\`boolean\`) Whether the calculated price is tax inclusive. Learn more about tax-inclusivity in \[this document]\(../tax-inclusive-pricing/page.mdx) +- is\_original\_price\_tax\_inclusive: (\`boolean\`) Whether the original price is tax inclusive. Learn more about tax-inclusivity in \[this document]\(../tax-inclusive-pricing/page.mdx) +- calculated\_price: (\`object\`) The calculated price's price details. + + - id: (\`string\`) The ID of the price. + + - price\_list\_id: (\`string\`) The ID of the associated price list. + + - price\_list\_type: (\`string\`) The price list's type. For example, \`sale\`. + + - min\_quantity: (\`number\`) The price's min quantity condition. + + - max\_quantity: (\`number\`) The price's max quantity condition. +- original\_price: (\`object\`) The original price's price details. + + - id: (\`string\`) The ID of the price. + + - price\_list\_id: (\`string\`) The ID of the associated price list. + + - price\_list\_type: (\`string\`) The price list's type. For example, \`sale\`. + + - min\_quantity: (\`number\`) The price's min quantity condition. + + - max\_quantity: (\`number\`) The price's max quantity condition. *** -## Email Uniqueness +## Examples -The above behavior means that two `Customer` records may exist with the same email. However, the main difference is the `has_account` property's value. +Consider the following price set: -So, there can only be one guest customer (having `has_account=false`) and one registered customer (having `has_account=true`) with the same email. +```ts +const priceSet = await pricingModuleService.createPriceSets({ + prices: [ + // default price + { + amount: 500, + currency_code: "EUR", + rules: {}, + }, + // prices with rules + { + amount: 400, + currency_code: "EUR", + rules: { + region_id: "reg_123", + }, + }, + { + amount: 450, + currency_code: "EUR", + rules: { + city: "krakow", + }, + }, + { + amount: 500, + currency_code: "EUR", + rules: { + city: "warsaw", + region_id: "reg_123", + }, + }, + ], +}) +``` + +### Default Price Selection + +### Code + +```ts +const price = await pricingModuleService.calculatePrices( + { id: [priceSet.id] }, + { + context: { + currency_code: "EUR" + } + } +) +``` + +### Result + +### Calculate Prices with Rules + +### Code + +```ts +const price = await pricingModuleService.calculatePrices( + { id: [priceSet.id] }, + { + context: { + currency_code: "EUR", + region_id: "reg_123", + city: "krakow" + } + } +) +``` + +### Result + +### Price Selection with Price List + +### Code + +```ts +const priceList = pricingModuleService.createPriceLists([{ + title: "Summer Price List", + description: "Price list for summer sale", + starts_at: Date.parse("01/10/2023").toString(), + ends_at: Date.parse("31/10/2023").toString(), + rules: { + region_id: ['PL'] + }, + type: "sale", + prices: [ + { + amount: 400, + currency_code: "EUR", + price_set_id: priceSet.id, + }, + { + amount: 450, + currency_code: "EUR", + price_set_id: priceSet.id, + }, + ], +}]); + +const price = await pricingModuleService.calculatePrices( + { id: [priceSet.id] }, + { + context: { + currency_code: "EUR", + region_id: "PL", + city: "krakow" + } + } +) +``` + +### Result -# Links between Customer Module and Other Modules +# Price Rules -This document showcases the module links defined between the Customer Module and other commerce modules. +In this document, you'll learn about price rules for price sets and price lists. + +## Price Rule + +You can restrict prices by rules. Each rule of a price is represented by the [PriceRule data model](https://docs.medusajs.com/references/pricing/models/PriceRule/index.html.md). + +The `Price` data model has a `rules_count` property, which indicates how many rules, represented by `PriceRule`, are applied to the price. + +For exmaple, you create a price restricted to `10557` zip codes. + +![A diagram showcasing the relation between the PriceRule and Price](https://res.cloudinary.com/dza7lstvk/image/upload/v1709648772/Medusa%20Resources/price-rule-1_vy8bn9.jpg) + +A price can have multiple price rules. + +For example, a price can be restricted by a region and a zip code. + +![A diagram showcasing the relation between the PriceRule and Price with multiple rules.](https://res.cloudinary.com/dza7lstvk/image/upload/v1709649296/Medusa%20Resources/price-rule-3_pwpocz.jpg) + +*** + +## Price List Rules + +Rules applied to a price list are represented by the [PriceListRule data model](https://docs.medusajs.com/references/pricing/models/PriceListRule/index.html.md). + +The `rules_count` property of a `PriceList` indicates how many rules are applied to it. + +![A diagram showcasing the relation between the PriceSet, PriceList, Price, RuleType, and PriceListRuleValue](https://res.cloudinary.com/dza7lstvk/image/upload/v1709641999/Medusa%20Resources/price-list_zd10yd.jpg) + + +# Links between Pricing Module and Other Modules + +This document showcases the module links defined between the Pricing Module and other commerce modules. ## Summary -The Customer Module has the following links to other modules: +The Pricing Module has the following links to other modules: -Read-only links are used to query data across modules, but the relations aren't stored in a pivot table in the database. - -- [`Customer` data model \<> `AccountHolder` data model of Payment Module](#payment-module). -- [`Cart` data model of Cart Module \<> `Customer` data model](#cart-module). (Read-only). -- [`Order` data model of Order Module \<> `Customer` data model](#order-module). (Read-only). +- [`ShippingOption` data model of Fulfillment Module \<> `PriceSet` data model](#fulfillment-module). +- [`ProductVariant` data model of Product Module \<> `PriceSet` data model](#product-module). *** -## Payment Module +## Fulfillment Module -Medusa defines a link between the `Customer` and `AccountHolder` data models, allowing payment providers to save payment methods for a customer, if the payment provider supports it. +The Fulfillment Module provides fulfillment-related functionalities, including shipping options that the customer chooses from when they place their order. However, it doesn't provide pricing-related functionalities for these options. -This link is available starting from Medusa `v2.5.0`. +Medusa defines a link between the `PriceSet` and `ShippingOption` data models. A shipping option's price is stored as a price set. + +![A diagram showcasing an example of how data models from the Pricing and Fulfillment modules are linked](https://res.cloudinary.com/dza7lstvk/image/upload/v1716561747/Medusa%20Resources/pricing-fulfillment_spywwa.jpg) ### Retrieve with Query -To retrieve the account holder associated with a customer with [Query](https://docs.medusajs.com/docs/learn/fundamentals/module-links/query/index.html.md), pass `customer.*` in `fields`: +To retrieve the shipping option of a price set with [Query](https://docs.medusajs.com/docs/learn/fundamentals/module-links/query/index.html.md), pass `shipping_option.*` in `fields`: ### query.graph ```ts -const { data: customers } = await query.graph({ - entity: "customer", +const { data: priceSets } = await query.graph({ + entity: "price_set", fields: [ - "account_holder.*", + "shipping_option.*", ], }) -// customers.account_holder +// priceSets.shipping_option ``` ### useQueryGraphStep @@ -23666,19 +24010,19 @@ import { useQueryGraphStep } from "@medusajs/medusa/core-flows" // ... -const { data: customers } = useQueryGraphStep({ - entity: "customer", +const { data: priceSets } = useQueryGraphStep({ + entity: "price_set", fields: [ - "account_holder.*", + "shipping_option.*", ], }) -// customers.account_holder +// priceSets.shipping_option ``` ### Manage with Link -To manage the account holders of a customer, use [Link](https://docs.medusajs.com/docs/learn/fundamentals/module-links/link/index.html.md): +To manage the price set of a shipping option, use [Link](https://docs.medusajs.com/docs/learn/fundamentals/module-links/link/index.html.md): ### link.create @@ -23688,11 +24032,11 @@ import { Modules } from "@medusajs/framework/utils" // ... await link.create({ - [Modules.CUSTOMER]: { - customer_id: "cus_123", + [Modules.FULFILLMENT]: { + shipping_option_id: "so_123", }, - [Modules.PAYMENT]: { - account_holder_id: "acchld_123", + [Modules.PRICING]: { + price_set_id: "pset_123", }, }) ``` @@ -23700,41 +24044,50 @@ await link.create({ ### createRemoteLinkStep ```ts +import { Modules } from "@medusajs/framework/utils" import { createRemoteLinkStep } from "@medusajs/medusa/core-flows" // ... createRemoteLinkStep({ - [Modules.CUSTOMER]: { - customer_id: "cus_123", + [Modules.FULFILLMENT]: { + shipping_option_id: "so_123", }, - [Modules.PAYMENT]: { - account_holder_id: "acchld_123", + [Modules.PRICING]: { + price_set_id: "pset_123", }, }) ``` *** -## Cart Module +## Product Module -Medusa defines a read-only link between the `Customer` data model and the [Cart Module](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/cart/index.html.md)'s `Cart` data model. This means you can retrieve the details of a customer's carts, but you don't manage the links in a pivot table in the database. The customer of a cart is determined by the `customer_id` property of the `Cart` data model. +The Product Module doesn't store or manage the prices of product variants. + +Medusa defines a link between the `ProductVariant` and the `PriceSet`. A product variant’s prices are stored as prices belonging to a price set. + +![A diagram showcasing an example of how data models from the Pricing and Product Module are linked. The PriceSet is linked to the ProductVariant of the Product Module.](https://res.cloudinary.com/dza7lstvk/image/upload/v1709651039/Medusa%20Resources/pricing-product_m4xaut.jpg) + +So, when you want to add prices for a product variant, you create a price set and add the prices to it. + +You can then benefit from adding rules to prices or using the `calculatePrices` method to retrieve the price of a product variant within a specified context. ### Retrieve with Query -To retrieve a customer's carts with [Query](https://docs.medusajs.com/docs/learn/fundamentals/module-links/query/index.html.md), pass `carts.*` in `fields`: +To retrieve the variant of a price set with [Query](https://docs.medusajs.com/docs/learn/fundamentals/module-links/query/index.html.md), pass `variant.*` in `fields`: ### query.graph ```ts -const { data: customers } = await query.graph({ - entity: "customer", +const { data: priceSets } = await query.graph({ + entity: "price_set", fields: [ - "carts.*", + "variant.*", ], }) -// customers.carts +// priceSets.variant ``` ### useQueryGraphStep @@ -23744,56 +24097,123 @@ import { useQueryGraphStep } from "@medusajs/medusa/core-flows" // ... -const { data: customers } = useQueryGraphStep({ - entity: "customer", +const { data: priceSets } = useQueryGraphStep({ + entity: "price_set", fields: [ - "carts.*", + "variant.*", ], }) -// customers.carts +// priceSets.variant ``` -*** +### Manage with Link -## Order Module +To manage the price set of a variant, use [Link](https://docs.medusajs.com/docs/learn/fundamentals/module-links/link/index.html.md): -Medusa defines a read-only link between the `Customer` data model and the [Order Module](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/order/index.html.md)'s `Order` data model. This means you can retrieve the details of a customer's orders, but you don't manage the links in a pivot table in the database. The customer of an order is determined by the `customer_id` property of the `Order` data model. - -### Retrieve with Query - -To retrieve a customer's orders with [Query](https://docs.medusajs.com/docs/learn/fundamentals/module-links/query/index.html.md), pass `orders.*` in `fields`: - -### query.graph +### link.create ```ts -const { data: customers } = await query.graph({ - entity: "customer", - fields: [ - "orders.*", - ], -}) - -// customers.orders -``` - -### useQueryGraphStep - -```ts -import { useQueryGraphStep } from "@medusajs/medusa/core-flows" +import { Modules } from "@medusajs/framework/utils" // ... -const { data: customers } = useQueryGraphStep({ - entity: "customer", - fields: [ - "orders.*", - ], +await link.create({ + [Modules.PRODUCT]: { + variant_id: "variant_123", + }, + [Modules.PRICING]: { + price_set_id: "pset_123", + }, }) - -// customers.orders ``` +### createRemoteLinkStep + +```ts +import { Modules } from "@medusajs/framework/utils" +import { createRemoteLinkStep } from "@medusajs/medusa/core-flows" + +// ... + +createRemoteLinkStep({ + [Modules.PRODUCT]: { + variant_id: "variant_123", + }, + [Modules.PRICING]: { + price_set_id: "pset_123", + }, +}) +``` + + +# Tax-Inclusive Pricing + +In this document, you’ll learn about tax-inclusive pricing and how it's used when calculating prices. + +## What is Tax-Inclusive Pricing? + +A tax-inclusive price is a price of a resource that includes taxes. Medusa calculates the tax amount from the price rather than adds the amount to it. + +For example, if a product’s price is $50, the tax rate is 2%, and tax-inclusive pricing is enabled, then the product's price is $49, and the applied tax amount is $1. + +*** + +## How is Tax-Inclusive Pricing Set? + +The [PricePreference data model](https://docs.medusajs.com/references/pricing/models/PricePreference/index.html.md) holds the tax-inclusive setting for a context. It has two properties that indicate the context: + +- `attribute`: The name of the attribute to compare against. For example, `region_id` or `currency_code`. +- `value`: The attribute’s value. For example, `reg_123` or `usd`. + +Only `region_id` and `currency_code` are supported as an `attribute` at the moment. + +The `is_tax_inclusive` property indicates whether tax-inclusivity is enabled in the specified context. + +For example: + +```json +{ + "attribute": "currency_code", + "value": "USD", + "is_tax_inclusive": true, +} +``` + +In this example, tax-inclusivity is enabled for the `USD` currency code. + +*** + +## Tax-Inclusive Pricing in Price Calculation + +### Tax Context + +As mentioned in the [Price Calculation documentation](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/pricing/price-calculation#calculation-context/index.html.md), The `calculatePrices` method accepts as a parameter a calculation context. + +To get accurate tax results, pass the `region_id` and / or `currency_code` in the calculation context. + +### Returned Tax Properties + +The `calculatePrices` method returns two properties related to tax-inclusivity: + +Learn more about the returned properties in [this guide](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/pricing/price-calculation#returned-price-object/index.html.md). + +- `is_calculated_price_tax_inclusive`: Whether the selected `calculated_price` is tax-inclusive. +- `is_original_price_tax_inclusive` : Whether the selected `original_price` is tax-inclusive. + +A price is considered tax-inclusive if: + +1. It belongs to the region or currency code specified in the calculation context; +2. and the region or currency code has a price preference with `is_tax_inclusive` enabled. + +### Tax Context Precedence + +A region’s price preference’s `is_tax_inclusive`'s value takes higher precedence in determining whether a price is tax-inclusive if: + +- both the `region_id` and `currency_code` are provided in the calculation context; +- the selected price belongs to the region; +- and the region has a price preference + # Links between Region Module and Other Modules @@ -23973,442 +24393,6 @@ createRemoteLinkStep({ ``` -# Application Method - -In this document, you'll learn what an application method is. - -## What is an Application Method? - -The [ApplicationMethod data model](https://docs.medusajs.com/references/promotion/models/ApplicationMethod/index.html.md) defines how a promotion is applied: - -|Property|Purpose| -|---|---| -|\`type\`|Does the promotion discount a fixed amount or a percentage?| -|\`target\_type\`|Is the promotion applied on a cart item, shipping method, or the entire order?| -|\`allocation\`|Is the discounted amount applied on each item or split between the applicable items?| - -## Target Promotion Rules - -When the promotion is applied to a cart item or a shipping method, you can restrict which items/shipping methods the promotion is applied to. - -The `ApplicationMethod` data model has a collection of `PromotionRule` records to restrict which items or shipping methods the promotion applies to. The `target_rules` property represents this relation. - -![A diagram showcasing the target\_rules relation between the ApplicationMethod and PromotionRule data models](https://res.cloudinary.com/dza7lstvk/image/upload/v1709898273/Medusa%20Resources/application-method-target-rules_hqaymz.jpg) - -In this example, the promotion is only applied on products in the cart having the SKU `SHIRT`. - -*** - -## Buy Promotion Rules - -When the promotion’s type is `buyget`, you must specify the “buy X” condition. For example, a cart must have two shirts before the promotion can be applied. - -The application method has a collection of `PromotionRule` items to define the “buy X” rule. The `buy_rules` property represents this relation. - -![A diagram showcasing the buy\_rules relation between the ApplicationMethod and PromotionRule data models](https://res.cloudinary.com/dza7lstvk/image/upload/v1709898453/Medusa%20Resources/application-method-buy-rules_djjuhw.jpg) - -In this example, the cart must have two products with the SKU `SHIRT` for the promotion to be applied. - - -# Promotion Actions - -In this document, you’ll learn about promotion actions and how they’re computed using the [computeActions method](https://docs.medusajs.com/references/promotion/computeActions/index.html.md). - -## computeActions Method - -The Promotion Module's main service has a [computeActions method](https://docs.medusajs.com/references/promotion/computeActions/index.html.md) that returns an array of actions to perform on a cart when one or more promotions are applied. - -Actions inform you what adjustment must be made to a cart item or shipping method. Each action is an object having the `action` property indicating the type of action. - -*** - -## Action Types - -### `addItemAdjustment` Action - -The `addItemAdjustment` action indicates that an adjustment must be made to an item. For example, removing $5 off its amount. - -This action has the following format: - -```ts -export interface AddItemAdjustmentAction { - action: "addItemAdjustment" - item_id: string - amount: number - code: string - description?: string -} -``` - -This action means that a new record should be created of the `LineItemAdjustment` data model in the Cart Module, or `OrderLineItemAdjustment` data model in the Order Module. - -Refer to [this reference](https://docs.medusajs.com/references/promotion/interfaces/promotion.AddItemAdjustmentAction/index.html.md) for details on the object’s properties. - -### `removeItemAdjustment` Action - -The `removeItemAdjustment` action indicates that an adjustment must be removed from a line item. For example, remove the $5 discount. - -The `computeActions` method accepts any previous item adjustments in the `items` property of the second parameter. - -This action has the following format: - -```ts -export interface RemoveItemAdjustmentAction { - action: "removeItemAdjustment" - adjustment_id: string - description?: string - code: string -} -``` - -This action means that a new record should be removed of the `LineItemAdjustment` (or `OrderLineItemAdjustment`) with the specified ID in the `adjustment_id` property. - -Refer to [this reference](https://docs.medusajs.com/references/promotion/interfaces/promotion.RemoveItemAdjustmentAction/index.html.md) for details on the object’s properties. - -### `addShippingMethodAdjustment` Action - -The `addShippingMethodAdjustment` action indicates that an adjustment must be made on a shipping method. For example, make the shipping method free. - -This action has the following format: - -```ts -export interface AddShippingMethodAdjustment { - action: "addShippingMethodAdjustment" - shipping_method_id: string - amount: number - code: string - description?: string -} -``` - -This action means that a new record should be created of the `ShippingMethodAdjustment` data model in the Cart Module, or `OrderShippingMethodAdjustment` data model in the Order Module. - -Refer to [this reference](https://docs.medusajs.com/references/promotion/interfaces/promotion.AddShippingMethodAdjustment/index.html.md) for details on the object’s properties. - -### `removeShippingMethodAdjustment` Action - -The `removeShippingMethodAdjustment` action indicates that an adjustment must be removed from a shipping method. For example, remove the free shipping discount. - -The `computeActions` method accepts any previous shipping method adjustments in the `shipping_methods` property of the second parameter. - -This action has the following format: - -```ts -export interface RemoveShippingMethodAdjustment { - action: "removeShippingMethodAdjustment" - adjustment_id: string - code: string -} -``` - -When the Medusa application receives this action type, it removes the `ShippingMethodAdjustment` (or `OrderShippingMethodAdjustment`) with the specified ID in the `adjustment_id` property. - -Refer to [this reference](https://docs.medusajs.com/references/promotion/interfaces/promotion.RemoveShippingMethodAdjustment/index.html.md) for details on the object’s properties. - -### `campaignBudgetExceeded` Action - -When the `campaignBudgetExceeded` action is returned, the promotions within a campaign can no longer be used as the campaign budget has been exceeded. - -This action has the following format: - -```ts -export interface CampaignBudgetExceededAction { - action: "campaignBudgetExceeded" - code: string -} -``` - -Refer to [this reference](https://docs.medusajs.com/references/promotion/interfaces/promotion.CampaignBudgetExceededAction/index.html.md) for details on the object’s properties. - - -# Campaign - -In this document, you'll learn about campaigns. - -Refer to this [Medusa Admin User Guide](https://docs.medusajs.com/user-guide/promotions/campaigns/index.html.md) to learn how to manage campaigns using the dashboard. - -## What is a Campaign? - -A [Campaign](https://docs.medusajs.com/references/promotion/models/Campaign/index.html.md) combines promotions under the same conditions, such as start and end dates. - -![A diagram showcasing the relation between the Campaign and Promotion data models](https://res.cloudinary.com/dza7lstvk/image/upload/v1709899225/Medusa%20Resources/campagin-promotion_hh3qsi.jpg) - -*** - -## Campaign Limits - -Each campaign has a budget represented by the [CampaignBudget data model](https://docs.medusajs.com/references/promotion/models/CampaignBudget/index.html.md). The budget limits how many times the promotion can be used. - -There are two types of budgets: - -- `spend`: An amount that, when crossed, the promotion becomes unusable. For example, if the amount limit is set to `$100`, and the total amount of usage of this promotion crosses that threshold, the promotion can no longer be applied. -- `usage`: The number of times that a promotion can be used. For example, if the usage limit is set to `10`, the promotion can be used only 10 times by customers. After that, it can no longer be applied. - -![A diagram showcasing the relation between the Campaign and CampaignBudget data models](https://res.cloudinary.com/dza7lstvk/image/upload/v1709899463/Medusa%20Resources/campagin-budget_rvqlmi.jpg) - - -# Promotion Concepts - -In this document, you’ll learn about the main promotion and rule concepts in the Promotion Module. - -Refer to this [Medusa Admin User Guide](https://docs.medusajs.com/user-guide/promotions/index.html.md) to learn how to manage promotions using the dashboard. - -## What is a Promotion? - -A promotion, represented by the [Promotion data model](https://docs.medusajs.com/references/promotion/models/Promotion/index.html.md), is a discount that can be applied on cart items, shipping methods, or entire orders. - -A promotion has two types: - -- `standard`: A standard promotion with rules. -- `buyget`: “A buy X get Y” promotion with rules. - -|\`standard\`|\`buyget\`| -|---|---| -|A coupon code that gives customers 10% off their entire order.|Buy two shirts and get another for free.| -|A coupon code that gives customers $15 off any shirt in their order.|Buy two shirts and get 10% off the entire order.| -|A discount applied automatically for VIP customers that removes 10% off their shipping method’s amount.|Spend $100 and get free shipping.| - -The Medusa Admin UI may not provide a way to create each of these promotion examples. However, they are supported by the Promotion Module and Medusa's workflows and API routes. - -*** - -## PromotionRule - -A promotion can be restricted by a set of rules, each rule is represented by the [PromotionRule data model](https://docs.medusajs.com/references/promotion/models/PromotionRule/index.html.md). - -For example, you can create a promotion that only customers of the `VIP` customer group can use. - -![A diagram showcasing the relation between Promotion and PromotionRule](https://res.cloudinary.com/dza7lstvk/image/upload/v1709833196/Medusa%20Resources/promotion-promotion-rule_msbx0w.jpg) - -A `PromotionRule`'s `attribute` property indicates the property's name to which this rule is applied. - -For example, `customer_group_id`. Its value is stored in the `PromotionRuleValue` data model. So, a rule can have multiple values. - -When testing whether a promotion can be applied to a cart, the rule's `attribute` property and its values are tested on the cart itself. - -For example, the cart's customer must be part of the customer group(s) indicated in the promotion rule's value. - -*** - -## Flexible Rules - -The `PromotionRule`'s `operator` property adds more flexibility to the rule’s condition rather than simple equality (`eq`). - -For example, to restrict the promotion to only `VIP` and `B2B` customer groups: - -- Add a `PromotionRule` record with its `attribute` property set to `customer_group_id` and `operator` property to `in`. -- Add two `PromotionRuleValue` records associated with the rule: one with the value `VIP` and the other `B2B`. - -![A diagram showcasing the relation between PromotionRule and PromotionRuleValue when a rule has multiple values](https://res.cloudinary.com/dza7lstvk/image/upload/v1709897383/Medusa%20Resources/promotion-promotion-rule-multiple_hctpmt.jpg) - -In this case, a customer’s group must be in the `VIP` and `B2B` set of values to use the promotion. - - -# Links between Promotion Module and Other Modules - -This document showcases the module links defined between the Promotion Module and other commerce modules. - -## Summary - -The Promotion Module has the following links to other modules: - -Read-only links are used to query data across modules, but the relations aren't stored in a pivot table in the database. - -- [`Cart` data model of the Cart Module \<> `Promotion` data model](#cart-module). -- [`LineItemAdjustment` data model of the Cart Module \<> `Promotion` data model](#cart-module). (Read-only). -- [`Order` data model of the Order Module \<> `Promotion` data model](#order-module). - -*** - -## Cart Module - -A promotion can be applied on line items and shipping methods of a cart. Medusa defines a link between the `Cart` and `Promotion` data models. - -![A diagram showcasing an example of how data models from the Cart and Promotion modules are linked](https://res.cloudinary.com/dza7lstvk/image/upload/v1711538015/Medusa%20Resources/cart-promotion_kuh9vm.jpg) - -Medusa also defines a read-only link between the `Promotion` data model and the [Cart Module](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/cart/index.html.md)'s `LineItemAdjustment` data model. This means you can retrieve the details of the promotion applied on a line item, but you don't manage the links in a pivot table in the database. The promotion of a line item is determined by the `promotion_id` property of the `LineItemAdjustment` data model. - -### Retrieve with Query - -To retrieve the carts that a promotion is applied on with [Query](https://docs.medusajs.com/docs/learn/fundamentals/module-links/query/index.html.md), pass `carts.*` in `fields`: - -To retrieve the line item adjustments of a promotion, pass `line_item_adjustments.*` in `fields`. - -### query.graph - -```ts -const { data: promotions } = await query.graph({ - entity: "promotion", - fields: [ - "carts.*", - ], -}) - -// promotions.carts -``` - -### useQueryGraphStep - -```ts -import { useQueryGraphStep } from "@medusajs/medusa/core-flows" - -// ... - -const { data: promotions } = useQueryGraphStep({ - entity: "promotion", - fields: [ - "carts.*", - ], -}) - -// promotions.carts -``` - -### Manage with Link - -To manage the promotions of a cart, use [Link](https://docs.medusajs.com/docs/learn/fundamentals/module-links/link/index.html.md): - -### link.create - -```ts -import { Modules } from "@medusajs/framework/utils" - -// ... - -await link.create({ - [Modules.CART]: { - cart_id: "cart_123", - }, - [Modules.PROMOTION]: { - promotion_id: "promo_123", - }, -}) -``` - -### createRemoteLinkStep - -```ts -import { Modules } from "@medusajs/framework/utils" -import { createRemoteLinkStep } from "@medusajs/medusa/core-flows" - -// ... - -createRemoteLinkStep({ - [Modules.CART]: { - cart_id: "cart_123", - }, - [Modules.PROMOTION]: { - promotion_id: "promo_123", - }, -}) -``` - -*** - -## Order Module - -An order is associated with the promotion applied on it. Medusa defines a link between the `Order` and `Promotion` data models. - -![A diagram showcasing an example of how data models from the Order and Promotion modules are linked](https://res.cloudinary.com/dza7lstvk/image/upload/v1716555015/Medusa%20Resources/order-promotion_dgjzzd.jpg) - -### Retrieve with Query - -To retrieve the orders a promotion is applied on with [Query](https://docs.medusajs.com/docs/learn/fundamentals/module-links/query/index.html.md), pass `orders.*` in `fields`: - -### query.graph - -```ts -const { data: promotions } = await query.graph({ - entity: "promotion", - fields: [ - "orders.*", - ], -}) - -// promotions.orders -``` - -### useQueryGraphStep - -```ts -import { useQueryGraphStep } from "@medusajs/medusa/core-flows" - -// ... - -const { data: promotions } = useQueryGraphStep({ - entity: "promotion", - fields: [ - "orders.*", - ], -}) - -// promotions.orders -``` - -### Manage with Link - -To manage the promotion of an order, use [Link](https://docs.medusajs.com/docs/learn/fundamentals/module-links/link/index.html.md): - -### link.create - -```ts -import { Modules } from "@medusajs/framework/utils" - -// ... - -await link.create({ - [Modules.ORDER]: { - order_id: "order_123", - }, - [Modules.PROMOTION]: { - promotion_id: "promo_123", - }, -}) -``` - -### createRemoteLinkStep - -```ts -import { Modules } from "@medusajs/framework/utils" -import { createRemoteLinkStep } from "@medusajs/medusa/core-flows" - -// ... - -createRemoteLinkStep({ - [Modules.ORDER]: { - order_id: "order_123", - }, - [Modules.PROMOTION]: { - promotion_id: "promo_123", - }, -}) -``` - - -# Publishable API Keys with Sales Channels - -In this document, you’ll learn what publishable API keys are and how to use them with sales channels. - -## Publishable API Keys with Sales Channels - -A publishable API key, provided by the API Key Module, is a client key scoped to one or more sales channels. - -When sending a request to a Store API route, you must pass a publishable API key in the header of the request: - -```bash -curl http://localhost:9000/store/products \ - x-publishable-api-key: {your_publishable_api_key} -``` - -The Medusa application infers the associated sales channels and ensures that only data relevant to the sales channel are used. - -*** - -## How to Create a Publishable API Key? - -To create a publishable API key, either use the [Medusa Admin](https://docs.medusajs.com/user-guide/settings/developer/publishable-api-keys/index.html.md) or the [Admin API Routes](https://docs.medusajs.com/api/admin#publishable-api-keys). - - # Links between Sales Channel Module and Other Modules This document showcases the module links defined between the Sales Channel Module and other commerce modules. @@ -24755,6 +24739,30 @@ createRemoteLinkStep({ ``` +# Publishable API Keys with Sales Channels + +In this document, you’ll learn what publishable API keys are and how to use them with sales channels. + +## Publishable API Keys with Sales Channels + +A publishable API key, provided by the API Key Module, is a client key scoped to one or more sales channels. + +When sending a request to a Store API route, you must pass a publishable API key in the header of the request: + +```bash +curl http://localhost:9000/store/products \ + x-publishable-api-key: {your_publishable_api_key} +``` + +The Medusa application infers the associated sales channels and ensures that only data relevant to the sales channel are used. + +*** + +## How to Create a Publishable API Key? + +To create a publishable API key, either use the [Medusa Admin](https://docs.medusajs.com/user-guide/settings/developer/publishable-api-keys/index.html.md) or the [Admin API Routes](https://docs.medusajs.com/api/admin#publishable-api-keys). + + # Links between Stock Location Module and Other Modules This document showcases the module links defined between the Stock Location Module and other commerce modules. @@ -25000,6 +25008,61 @@ Medusa uses stock locations to provide inventory details, from the Inventory Mod The `StockLocationAddress` data model belongs to the `StockLocation` data model. It provides more detailed information of the location, such as country code or street address. +# Links between Store Module and Other Modules + +This document showcases the module links defined between the Store Module and other commerce modules. + +## Summary + +The Store Module has the following links to other modules: + +Read-only links are used to query data across modules, but the relations aren't stored in a pivot table in the database. + +- [`Currency` data model \<> `Currency` data model of Currency Module](#currency-module). (Read-only). + +*** + +## Currency Module + +The Store Module has a `Currency` data model that stores the supported currencies of a store. However, these currencies don't hold all the details of a currency, such as its name or symbol. + +Instead, Medusa defines a read-only link between the [Currency Module](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/currency/index.html.md)'s `Currency` data model and the Store Module's `Currency` data model. This means you can retrieve the details of a store's supported currencies, but you don't manage the links in a pivot table in the database. The currencies of a store are determined by the `currency_code` of the `Currency` data model in the Store Module. + +### Retrieve with Query + +To retrieve the details of a store's currencies with [Query](https://docs.medusajs.com/docs/learn/fundamentals/module-links/query/index.html.md), pass `supported_currencies.currency.*` in `fields`: + +### query.graph + +```ts +const { data: stores } = await query.graph({ + entity: "store", + fields: [ + "supported_currencies.currency.*", + ], +}) + +// stores.supported_currencies +``` + +### useQueryGraphStep + +```ts +import { useQueryGraphStep } from "@medusajs/medusa/core-flows" + +// ... + +const { data: stores } = useQueryGraphStep({ + entity: "store", + fields: [ + "supported_currencies.currency.*", + ], +}) + +// stores.supported_currencies +``` + + # User Module Options In this document, you'll learn about the options of the User Module. @@ -25160,59 +25223,6 @@ The objects in the array accept the following properties: - `options`: An optional object of the module provider's options. -# Tax Rates and Rules - -In this document, you’ll learn about tax rates and rules. - -Refer to this [Medusa Admin User Guide](https://docs.medusajs.com/user-guide/settings/tax-regions#manage-tax-rate-overrides/index.html.md) to learn how to manage tax rates using the dashboard. - -## What are Tax Rates? - -A tax rate is a percentage amount used to calculate the tax amount for each taxable item’s price, such as line items or shipping methods, in a cart. The sum of all calculated tax amounts are then added to the cart’s total as a tax total. - -Each tax region has a default tax rate. This tax rate is applied to all taxable items of a cart in that region. - -### Combinable Tax Rates - -Tax regions can have parent tax regions. To inherit the tax rates of the parent tax region, set the `is_combinable` of the child’s tax rates to `true`. - -Then, when tax rates are retrieved for a taxable item in the child region, both the child and the parent tax regions’ applicable rates are returned. - -*** - -## Override Tax Rates with Rules - -You can create tax rates that override the default for specific conditions or rules. - -For example, you can have a default tax rate is 10%, but for products of type “Shirt” is %15. - -A tax region can have multiple tax rates, and each tax rate can have multiple tax rules. The [TaxRateRule data model](https://docs.medusajs.com/references/tax/models/TaxRateRule/index.html.md) represents a tax rate’s rule. - -![A diagram showcasing the relation between TaxRegion, TaxRate, and TaxRateRule](https://res.cloudinary.com/dza7lstvk/image/upload/v1711462167/Medusa%20Resources/tax-rate-rule_enzbp2.jpg) - -These two properties of the data model identify the rule’s target: - -- `reference`: the name of the table in the database that this rule points to. For example, `product_type`. -- `reference_id`: the ID of the data model’s record that this points to. For example, a product type’s ID. - -So, to override the default tax rate for product types “Shirt”, you create a tax rate and associate with it a tax rule whose `reference` is `product_type` and `reference_id` the ID of the “Shirt” product type. - - -# Tax Region - -In this document, you’ll learn about tax regions and how to use them with the Region Module. - -Refer to this [Medusa Admin User Guide](https://docs.medusajs.com/user-guide/settings/tax-regions/index.html.md) to learn how to manage tax regions using the dashboard. - -## What is a Tax Region? - -A tax region, represented by the [TaxRegion data model](https://docs.medusajs.com/references/tax/models/TaxRegion/index.html.md), stores tax settings related to a region that your store serves. - -Tax regions can inherit settings and rules from a parent tax region. - -Each tax region has tax rules and a tax provider. - - # Tax Calculation with the Tax Provider In this document, you’ll learn how tax lines are calculated and what a tax provider is. @@ -25290,41 +25300,331 @@ TODO add once tax provider guide is updated + add module providers match other m Refer to [this guide](/modules/tax/provider) to learn more about creating a tax provider. */} -# Links between Store Module and Other Modules +# Tax Region -This document showcases the module links defined between the Store Module and other commerce modules. +In this document, you’ll learn about tax regions and how to use them with the Region Module. -## Summary +Refer to this [Medusa Admin User Guide](https://docs.medusajs.com/user-guide/settings/tax-regions/index.html.md) to learn how to manage tax regions using the dashboard. -The Store Module has the following links to other modules: +## What is a Tax Region? -Read-only links are used to query data across modules, but the relations aren't stored in a pivot table in the database. +A tax region, represented by the [TaxRegion data model](https://docs.medusajs.com/references/tax/models/TaxRegion/index.html.md), stores tax settings related to a region that your store serves. -- [`Currency` data model \<> `Currency` data model of Currency Module](#currency-module). (Read-only). +Tax regions can inherit settings and rules from a parent tax region. + +Each tax region has tax rules and a tax provider. + + +# Tax Rates and Rules + +In this document, you’ll learn about tax rates and rules. + +Refer to this [Medusa Admin User Guide](https://docs.medusajs.com/user-guide/settings/tax-regions#manage-tax-rate-overrides/index.html.md) to learn how to manage tax rates using the dashboard. + +## What are Tax Rates? + +A tax rate is a percentage amount used to calculate the tax amount for each taxable item’s price, such as line items or shipping methods, in a cart. The sum of all calculated tax amounts are then added to the cart’s total as a tax total. + +Each tax region has a default tax rate. This tax rate is applied to all taxable items of a cart in that region. + +### Combinable Tax Rates + +Tax regions can have parent tax regions. To inherit the tax rates of the parent tax region, set the `is_combinable` of the child’s tax rates to `true`. + +Then, when tax rates are retrieved for a taxable item in the child region, both the child and the parent tax regions’ applicable rates are returned. *** -## Currency Module +## Override Tax Rates with Rules -The Store Module has a `Currency` data model that stores the supported currencies of a store. However, these currencies don't hold all the details of a currency, such as its name or symbol. +You can create tax rates that override the default for specific conditions or rules. -Instead, Medusa defines a read-only link between the [Currency Module](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/currency/index.html.md)'s `Currency` data model and the Store Module's `Currency` data model. This means you can retrieve the details of a store's supported currencies, but you don't manage the links in a pivot table in the database. The currencies of a store are determined by the `currency_code` of the `Currency` data model in the Store Module. +For example, you can have a default tax rate is 10%, but for products of type “Shirt” is %15. + +A tax region can have multiple tax rates, and each tax rate can have multiple tax rules. The [TaxRateRule data model](https://docs.medusajs.com/references/tax/models/TaxRateRule/index.html.md) represents a tax rate’s rule. + +![A diagram showcasing the relation between TaxRegion, TaxRate, and TaxRateRule](https://res.cloudinary.com/dza7lstvk/image/upload/v1711462167/Medusa%20Resources/tax-rate-rule_enzbp2.jpg) + +These two properties of the data model identify the rule’s target: + +- `reference`: the name of the table in the database that this rule points to. For example, `product_type`. +- `reference_id`: the ID of the data model’s record that this points to. For example, a product type’s ID. + +So, to override the default tax rate for product types “Shirt”, you create a tax rate and associate with it a tax rule whose `reference` is `product_type` and `reference_id` the ID of the “Shirt” product type. + + +# Promotion Actions + +In this document, you’ll learn about promotion actions and how they’re computed using the [computeActions method](https://docs.medusajs.com/references/promotion/computeActions/index.html.md). + +## computeActions Method + +The Promotion Module's main service has a [computeActions method](https://docs.medusajs.com/references/promotion/computeActions/index.html.md) that returns an array of actions to perform on a cart when one or more promotions are applied. + +Actions inform you what adjustment must be made to a cart item or shipping method. Each action is an object having the `action` property indicating the type of action. + +*** + +## Action Types + +### `addItemAdjustment` Action + +The `addItemAdjustment` action indicates that an adjustment must be made to an item. For example, removing $5 off its amount. + +This action has the following format: + +```ts +export interface AddItemAdjustmentAction { + action: "addItemAdjustment" + item_id: string + amount: number + code: string + description?: string +} +``` + +This action means that a new record should be created of the `LineItemAdjustment` data model in the Cart Module, or `OrderLineItemAdjustment` data model in the Order Module. + +Refer to [this reference](https://docs.medusajs.com/references/promotion/interfaces/promotion.AddItemAdjustmentAction/index.html.md) for details on the object’s properties. + +### `removeItemAdjustment` Action + +The `removeItemAdjustment` action indicates that an adjustment must be removed from a line item. For example, remove the $5 discount. + +The `computeActions` method accepts any previous item adjustments in the `items` property of the second parameter. + +This action has the following format: + +```ts +export interface RemoveItemAdjustmentAction { + action: "removeItemAdjustment" + adjustment_id: string + description?: string + code: string +} +``` + +This action means that a new record should be removed of the `LineItemAdjustment` (or `OrderLineItemAdjustment`) with the specified ID in the `adjustment_id` property. + +Refer to [this reference](https://docs.medusajs.com/references/promotion/interfaces/promotion.RemoveItemAdjustmentAction/index.html.md) for details on the object’s properties. + +### `addShippingMethodAdjustment` Action + +The `addShippingMethodAdjustment` action indicates that an adjustment must be made on a shipping method. For example, make the shipping method free. + +This action has the following format: + +```ts +export interface AddShippingMethodAdjustment { + action: "addShippingMethodAdjustment" + shipping_method_id: string + amount: number + code: string + description?: string +} +``` + +This action means that a new record should be created of the `ShippingMethodAdjustment` data model in the Cart Module, or `OrderShippingMethodAdjustment` data model in the Order Module. + +Refer to [this reference](https://docs.medusajs.com/references/promotion/interfaces/promotion.AddShippingMethodAdjustment/index.html.md) for details on the object’s properties. + +### `removeShippingMethodAdjustment` Action + +The `removeShippingMethodAdjustment` action indicates that an adjustment must be removed from a shipping method. For example, remove the free shipping discount. + +The `computeActions` method accepts any previous shipping method adjustments in the `shipping_methods` property of the second parameter. + +This action has the following format: + +```ts +export interface RemoveShippingMethodAdjustment { + action: "removeShippingMethodAdjustment" + adjustment_id: string + code: string +} +``` + +When the Medusa application receives this action type, it removes the `ShippingMethodAdjustment` (or `OrderShippingMethodAdjustment`) with the specified ID in the `adjustment_id` property. + +Refer to [this reference](https://docs.medusajs.com/references/promotion/interfaces/promotion.RemoveShippingMethodAdjustment/index.html.md) for details on the object’s properties. + +### `campaignBudgetExceeded` Action + +When the `campaignBudgetExceeded` action is returned, the promotions within a campaign can no longer be used as the campaign budget has been exceeded. + +This action has the following format: + +```ts +export interface CampaignBudgetExceededAction { + action: "campaignBudgetExceeded" + code: string +} +``` + +Refer to [this reference](https://docs.medusajs.com/references/promotion/interfaces/promotion.CampaignBudgetExceededAction/index.html.md) for details on the object’s properties. + + +# Campaign + +In this document, you'll learn about campaigns. + +Refer to this [Medusa Admin User Guide](https://docs.medusajs.com/user-guide/promotions/campaigns/index.html.md) to learn how to manage campaigns using the dashboard. + +## What is a Campaign? + +A [Campaign](https://docs.medusajs.com/references/promotion/models/Campaign/index.html.md) combines promotions under the same conditions, such as start and end dates. + +![A diagram showcasing the relation between the Campaign and Promotion data models](https://res.cloudinary.com/dza7lstvk/image/upload/v1709899225/Medusa%20Resources/campagin-promotion_hh3qsi.jpg) + +*** + +## Campaign Limits + +Each campaign has a budget represented by the [CampaignBudget data model](https://docs.medusajs.com/references/promotion/models/CampaignBudget/index.html.md). The budget limits how many times the promotion can be used. + +There are two types of budgets: + +- `spend`: An amount that, when crossed, the promotion becomes unusable. For example, if the amount limit is set to `$100`, and the total amount of usage of this promotion crosses that threshold, the promotion can no longer be applied. +- `usage`: The number of times that a promotion can be used. For example, if the usage limit is set to `10`, the promotion can be used only 10 times by customers. After that, it can no longer be applied. + +![A diagram showcasing the relation between the Campaign and CampaignBudget data models](https://res.cloudinary.com/dza7lstvk/image/upload/v1709899463/Medusa%20Resources/campagin-budget_rvqlmi.jpg) + + +# Application Method + +In this document, you'll learn what an application method is. + +## What is an Application Method? + +The [ApplicationMethod data model](https://docs.medusajs.com/references/promotion/models/ApplicationMethod/index.html.md) defines how a promotion is applied: + +|Property|Purpose| +|---|---| +|\`type\`|Does the promotion discount a fixed amount or a percentage?| +|\`target\_type\`|Is the promotion applied on a cart item, shipping method, or the entire order?| +|\`allocation\`|Is the discounted amount applied on each item or split between the applicable items?| + +## Target Promotion Rules + +When the promotion is applied to a cart item or a shipping method, you can restrict which items/shipping methods the promotion is applied to. + +The `ApplicationMethod` data model has a collection of `PromotionRule` records to restrict which items or shipping methods the promotion applies to. The `target_rules` property represents this relation. + +![A diagram showcasing the target\_rules relation between the ApplicationMethod and PromotionRule data models](https://res.cloudinary.com/dza7lstvk/image/upload/v1709898273/Medusa%20Resources/application-method-target-rules_hqaymz.jpg) + +In this example, the promotion is only applied on products in the cart having the SKU `SHIRT`. + +*** + +## Buy Promotion Rules + +When the promotion’s type is `buyget`, you must specify the “buy X” condition. For example, a cart must have two shirts before the promotion can be applied. + +The application method has a collection of `PromotionRule` items to define the “buy X” rule. The `buy_rules` property represents this relation. + +![A diagram showcasing the buy\_rules relation between the ApplicationMethod and PromotionRule data models](https://res.cloudinary.com/dza7lstvk/image/upload/v1709898453/Medusa%20Resources/application-method-buy-rules_djjuhw.jpg) + +In this example, the cart must have two products with the SKU `SHIRT` for the promotion to be applied. + + +# Promotion Concepts + +In this document, you’ll learn about the main promotion and rule concepts in the Promotion Module. + +Refer to this [Medusa Admin User Guide](https://docs.medusajs.com/user-guide/promotions/index.html.md) to learn how to manage promotions using the dashboard. + +## What is a Promotion? + +A promotion, represented by the [Promotion data model](https://docs.medusajs.com/references/promotion/models/Promotion/index.html.md), is a discount that can be applied on cart items, shipping methods, or entire orders. + +A promotion has two types: + +- `standard`: A standard promotion with rules. +- `buyget`: “A buy X get Y” promotion with rules. + +|\`standard\`|\`buyget\`| +|---|---| +|A coupon code that gives customers 10% off their entire order.|Buy two shirts and get another for free.| +|A coupon code that gives customers $15 off any shirt in their order.|Buy two shirts and get 10% off the entire order.| +|A discount applied automatically for VIP customers that removes 10% off their shipping method’s amount.|Spend $100 and get free shipping.| + +The Medusa Admin UI may not provide a way to create each of these promotion examples. However, they are supported by the Promotion Module and Medusa's workflows and API routes. + +*** + +## PromotionRule + +A promotion can be restricted by a set of rules, each rule is represented by the [PromotionRule data model](https://docs.medusajs.com/references/promotion/models/PromotionRule/index.html.md). + +For example, you can create a promotion that only customers of the `VIP` customer group can use. + +![A diagram showcasing the relation between Promotion and PromotionRule](https://res.cloudinary.com/dza7lstvk/image/upload/v1709833196/Medusa%20Resources/promotion-promotion-rule_msbx0w.jpg) + +A `PromotionRule`'s `attribute` property indicates the property's name to which this rule is applied. + +For example, `customer_group_id`. Its value is stored in the `PromotionRuleValue` data model. So, a rule can have multiple values. + +When testing whether a promotion can be applied to a cart, the rule's `attribute` property and its values are tested on the cart itself. + +For example, the cart's customer must be part of the customer group(s) indicated in the promotion rule's value. + +*** + +## Flexible Rules + +The `PromotionRule`'s `operator` property adds more flexibility to the rule’s condition rather than simple equality (`eq`). + +For example, to restrict the promotion to only `VIP` and `B2B` customer groups: + +- Add a `PromotionRule` record with its `attribute` property set to `customer_group_id` and `operator` property to `in`. +- Add two `PromotionRuleValue` records associated with the rule: one with the value `VIP` and the other `B2B`. + +![A diagram showcasing the relation between PromotionRule and PromotionRuleValue when a rule has multiple values](https://res.cloudinary.com/dza7lstvk/image/upload/v1709897383/Medusa%20Resources/promotion-promotion-rule-multiple_hctpmt.jpg) + +In this case, a customer’s group must be in the `VIP` and `B2B` set of values to use the promotion. + + +# Links between Promotion Module and Other Modules + +This document showcases the module links defined between the Promotion Module and other commerce modules. + +## Summary + +The Promotion Module has the following links to other modules: + +Read-only links are used to query data across modules, but the relations aren't stored in a pivot table in the database. + +- [`Cart` data model of the Cart Module \<> `Promotion` data model](#cart-module). +- [`LineItemAdjustment` data model of the Cart Module \<> `Promotion` data model](#cart-module). (Read-only). +- [`Order` data model of the Order Module \<> `Promotion` data model](#order-module). + +*** + +## Cart Module + +A promotion can be applied on line items and shipping methods of a cart. Medusa defines a link between the `Cart` and `Promotion` data models. + +![A diagram showcasing an example of how data models from the Cart and Promotion modules are linked](https://res.cloudinary.com/dza7lstvk/image/upload/v1711538015/Medusa%20Resources/cart-promotion_kuh9vm.jpg) + +Medusa also defines a read-only link between the `Promotion` data model and the [Cart Module](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/cart/index.html.md)'s `LineItemAdjustment` data model. This means you can retrieve the details of the promotion applied on a line item, but you don't manage the links in a pivot table in the database. The promotion of a line item is determined by the `promotion_id` property of the `LineItemAdjustment` data model. ### Retrieve with Query -To retrieve the details of a store's currencies with [Query](https://docs.medusajs.com/docs/learn/fundamentals/module-links/query/index.html.md), pass `supported_currencies.currency.*` in `fields`: +To retrieve the carts that a promotion is applied on with [Query](https://docs.medusajs.com/docs/learn/fundamentals/module-links/query/index.html.md), pass `carts.*` in `fields`: + +To retrieve the line item adjustments of a promotion, pass `line_item_adjustments.*` in `fields`. ### query.graph ```ts -const { data: stores } = await query.graph({ - entity: "store", +const { data: promotions } = await query.graph({ + entity: "promotion", fields: [ - "supported_currencies.currency.*", + "carts.*", ], }) -// stores.supported_currencies +// promotions.carts ``` ### useQueryGraphStep @@ -25334,14 +25634,134 @@ import { useQueryGraphStep } from "@medusajs/medusa/core-flows" // ... -const { data: stores } = useQueryGraphStep({ - entity: "store", +const { data: promotions } = useQueryGraphStep({ + entity: "promotion", fields: [ - "supported_currencies.currency.*", + "carts.*", ], }) -// stores.supported_currencies +// promotions.carts +``` + +### Manage with Link + +To manage the promotions of a cart, use [Link](https://docs.medusajs.com/docs/learn/fundamentals/module-links/link/index.html.md): + +### link.create + +```ts +import { Modules } from "@medusajs/framework/utils" + +// ... + +await link.create({ + [Modules.CART]: { + cart_id: "cart_123", + }, + [Modules.PROMOTION]: { + promotion_id: "promo_123", + }, +}) +``` + +### createRemoteLinkStep + +```ts +import { Modules } from "@medusajs/framework/utils" +import { createRemoteLinkStep } from "@medusajs/medusa/core-flows" + +// ... + +createRemoteLinkStep({ + [Modules.CART]: { + cart_id: "cart_123", + }, + [Modules.PROMOTION]: { + promotion_id: "promo_123", + }, +}) +``` + +*** + +## Order Module + +An order is associated with the promotion applied on it. Medusa defines a link between the `Order` and `Promotion` data models. + +![A diagram showcasing an example of how data models from the Order and Promotion modules are linked](https://res.cloudinary.com/dza7lstvk/image/upload/v1716555015/Medusa%20Resources/order-promotion_dgjzzd.jpg) + +### Retrieve with Query + +To retrieve the orders a promotion is applied on with [Query](https://docs.medusajs.com/docs/learn/fundamentals/module-links/query/index.html.md), pass `orders.*` in `fields`: + +### query.graph + +```ts +const { data: promotions } = await query.graph({ + entity: "promotion", + fields: [ + "orders.*", + ], +}) + +// promotions.orders +``` + +### useQueryGraphStep + +```ts +import { useQueryGraphStep } from "@medusajs/medusa/core-flows" + +// ... + +const { data: promotions } = useQueryGraphStep({ + entity: "promotion", + fields: [ + "orders.*", + ], +}) + +// promotions.orders +``` + +### Manage with Link + +To manage the promotion of an order, use [Link](https://docs.medusajs.com/docs/learn/fundamentals/module-links/link/index.html.md): + +### link.create + +```ts +import { Modules } from "@medusajs/framework/utils" + +// ... + +await link.create({ + [Modules.ORDER]: { + order_id: "order_123", + }, + [Modules.PROMOTION]: { + promotion_id: "promo_123", + }, +}) +``` + +### createRemoteLinkStep + +```ts +import { Modules } from "@medusajs/framework/utils" +import { createRemoteLinkStep } from "@medusajs/medusa/core-flows" + +// ... + +createRemoteLinkStep({ + [Modules.ORDER]: { + order_id: "order_123", + }, + [Modules.PROMOTION]: { + promotion_id: "promo_123", + }, +}) ``` @@ -25686,6 +26106,86 @@ When you set up the webhook in Stripe, choose the following events to listen to: - [Customize Stripe Integration in Next.js Starter](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/nextjs-starter/guides/customize-stripe/index.html.md). +# Get Product Variant Prices using Query + +In this document, you'll learn how to retrieve product variant prices in the Medusa application using [Query](https://docs.medusajs.com/docs/learn/fundamentals/module-links/query/index.html.md). + +The Product Module doesn't provide pricing functionalities. The Medusa application links the Product Module's `ProductVariant` data model to the Pricing Module's `PriceSet` data model. + +So, to retrieve data across the linked records of the two modules, you use Query. + +## Retrieve All Product Variant Prices + +To retrieve all product variant prices, retrieve the product using Query and include among its fields `variants.prices.*`. + +For example: + +```ts highlights={[["6"]]} +const { data: products } = await query.graph({ + entity: "product", + fields: [ + "*", + "variants.*", + "variants.prices.*", + ], + filters: { + id: [ + "prod_123", + ], + }, +}) +``` + +Each variant in the retrieved products has a `prices` array property with all the product variant prices. Each price object has the properties of the [Pricing Module's Price data model](https://docs.medusajs.com/references/pricing/models/Price/index.html.md). + +*** + +## Retrieve Calculated Price for a Context + +The Pricing Module can calculate prices of a variant based on a [context](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/pricing/price-calculation#calculation-context/index.html.md), such as the region ID or the currency code. + +Learn more about prices calculation in [this Pricing Module documentation](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/pricing/price-calculation/index.html.md). + +To retrieve calculated prices of variants based on a context, retrieve the products using Query and: + +- Pass `variants.calculated_price.*` in the `fields` property. +- Pass a `context` property in the object parameter. Its value is an object of objects that sets the context for the retrieved fields. + +For example: + +```ts highlights={[["10"], ["15"], ["16"], ["17"], ["18"], ["19"], ["20"], ["21"], ["22"]]} +import { QueryContext } from "@medusajs/framework/utils" + +// ... + +const { data: products } = await query.graph({ + entity: "product", + fields: [ + "*", + "variants.*", + "variants.calculated_price.*", + ], + filters: { + id: "prod_123", + }, + context: { + variants: { + calculated_price: QueryContext({ + region_id: "reg_01J3MRPDNXXXDSCC76Y6YCZARS", + currency_code: "eur", + }), + }, + }, +}) +``` + +For the context of the product variant's calculated price, you pass an object to `context` with the property `variants`, whose value is another object with the property `calculated_price`. + +`calculated_price`'s value is created using `QueryContext` from the Modules SDK, passing it a [calculation context object](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/pricing/price-calculation#calculation-context/index.html.md). + +Each variant in the retrieved products has a `calculated_price` object. Learn more about its properties in [this Pricing Module guide](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/pricing/price-calculation#returned-price-object/index.html.md). + + # Calculate Product Variant Price with Taxes In this document, you'll learn how to calculate a product variant's price with taxes. @@ -25871,255 +26371,183 @@ For each product variant, you: - `priceWithoutTax`: The variant's price without taxes applied. -# Get Product Variant Prices using Query - -In this document, you'll learn how to retrieve product variant prices in the Medusa application using [Query](https://docs.medusajs.com/docs/learn/fundamentals/module-links/query/index.html.md). - -The Product Module doesn't provide pricing functionalities. The Medusa application links the Product Module's `ProductVariant` data model to the Pricing Module's `PriceSet` data model. - -So, to retrieve data across the linked records of the two modules, you use Query. - -## Retrieve All Product Variant Prices - -To retrieve all product variant prices, retrieve the product using Query and include among its fields `variants.prices.*`. - -For example: - -```ts highlights={[["6"]]} -const { data: products } = await query.graph({ - entity: "product", - fields: [ - "*", - "variants.*", - "variants.prices.*", - ], - filters: { - id: [ - "prod_123", - ], - }, -}) -``` - -Each variant in the retrieved products has a `prices` array property with all the product variant prices. Each price object has the properties of the [Pricing Module's Price data model](https://docs.medusajs.com/references/pricing/models/Price/index.html.md). - -*** - -## Retrieve Calculated Price for a Context - -The Pricing Module can calculate prices of a variant based on a [context](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/pricing/price-calculation#calculation-context/index.html.md), such as the region ID or the currency code. - -Learn more about prices calculation in [this Pricing Module documentation](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/pricing/price-calculation/index.html.md). - -To retrieve calculated prices of variants based on a context, retrieve the products using Query and: - -- Pass `variants.calculated_price.*` in the `fields` property. -- Pass a `context` property in the object parameter. Its value is an object of objects that sets the context for the retrieved fields. - -For example: - -```ts highlights={[["10"], ["15"], ["16"], ["17"], ["18"], ["19"], ["20"], ["21"], ["22"]]} -import { QueryContext } from "@medusajs/framework/utils" - -// ... - -const { data: products } = await query.graph({ - entity: "product", - fields: [ - "*", - "variants.*", - "variants.calculated_price.*", - ], - filters: { - id: "prod_123", - }, - context: { - variants: { - calculated_price: QueryContext({ - region_id: "reg_01J3MRPDNXXXDSCC76Y6YCZARS", - currency_code: "eur", - }), - }, - }, -}) -``` - -For the context of the product variant's calculated price, you pass an object to `context` with the property `variants`, whose value is another object with the property `calculated_price`. - -`calculated_price`'s value is created using `QueryContext` from the Modules SDK, passing it a [calculation context object](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/pricing/price-calculation#calculation-context/index.html.md). - -Each variant in the retrieved products has a `calculated_price` object. Learn more about its properties in [this Pricing Module guide](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/commerce-modules/pricing/price-calculation#returned-price-object/index.html.md). - - ## Workflows -- [createApiKeysWorkflow](https://docs.medusajs.com/references/medusa-workflows/createApiKeysWorkflow/index.html.md) -- [deleteApiKeysWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteApiKeysWorkflow/index.html.md) - [linkSalesChannelsToApiKeyWorkflow](https://docs.medusajs.com/references/medusa-workflows/linkSalesChannelsToApiKeyWorkflow/index.html.md) - [revokeApiKeysWorkflow](https://docs.medusajs.com/references/medusa-workflows/revokeApiKeysWorkflow/index.html.md) +- [deleteApiKeysWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteApiKeysWorkflow/index.html.md) +- [createApiKeysWorkflow](https://docs.medusajs.com/references/medusa-workflows/createApiKeysWorkflow/index.html.md) - [updateApiKeysWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateApiKeysWorkflow/index.html.md) -- [batchLinksWorkflow](https://docs.medusajs.com/references/medusa-workflows/batchLinksWorkflow/index.html.md) -- [createLinksWorkflow](https://docs.medusajs.com/references/medusa-workflows/createLinksWorkflow/index.html.md) -- [dismissLinksWorkflow](https://docs.medusajs.com/references/medusa-workflows/dismissLinksWorkflow/index.html.md) -- [updateLinksWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateLinksWorkflow/index.html.md) -- [addShippingMethodToCartWorkflow](https://docs.medusajs.com/references/medusa-workflows/addShippingMethodToCartWorkflow/index.html.md) -- [confirmVariantInventoryWorkflow](https://docs.medusajs.com/references/medusa-workflows/confirmVariantInventoryWorkflow/index.html.md) -- [addToCartWorkflow](https://docs.medusajs.com/references/medusa-workflows/addToCartWorkflow/index.html.md) -- [completeCartWorkflow](https://docs.medusajs.com/references/medusa-workflows/completeCartWorkflow/index.html.md) -- [createCartWorkflow](https://docs.medusajs.com/references/medusa-workflows/createCartWorkflow/index.html.md) -- [listShippingOptionsForCartWorkflow](https://docs.medusajs.com/references/medusa-workflows/listShippingOptionsForCartWorkflow/index.html.md) -- [createPaymentCollectionForCartWorkflow](https://docs.medusajs.com/references/medusa-workflows/createPaymentCollectionForCartWorkflow/index.html.md) -- [listShippingOptionsForCartWithPricingWorkflow](https://docs.medusajs.com/references/medusa-workflows/listShippingOptionsForCartWithPricingWorkflow/index.html.md) -- [refreshCartItemsWorkflow](https://docs.medusajs.com/references/medusa-workflows/refreshCartItemsWorkflow/index.html.md) -- [refreshCartShippingMethodsWorkflow](https://docs.medusajs.com/references/medusa-workflows/refreshCartShippingMethodsWorkflow/index.html.md) -- [transferCartCustomerWorkflow](https://docs.medusajs.com/references/medusa-workflows/transferCartCustomerWorkflow/index.html.md) -- [refreshPaymentCollectionForCartWorkflow](https://docs.medusajs.com/references/medusa-workflows/refreshPaymentCollectionForCartWorkflow/index.html.md) -- [updateCartPromotionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateCartPromotionsWorkflow/index.html.md) -- [updateCartWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateCartWorkflow/index.html.md) -- [updateLineItemInCartWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateLineItemInCartWorkflow/index.html.md) -- [updateTaxLinesWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateTaxLinesWorkflow/index.html.md) -- [validateExistingPaymentCollectionStep](https://docs.medusajs.com/references/medusa-workflows/validateExistingPaymentCollectionStep/index.html.md) - [generateResetPasswordTokenWorkflow](https://docs.medusajs.com/references/medusa-workflows/generateResetPasswordTokenWorkflow/index.html.md) - [createCustomerAccountWorkflow](https://docs.medusajs.com/references/medusa-workflows/createCustomerAccountWorkflow/index.html.md) - [createCustomerAddressesWorkflow](https://docs.medusajs.com/references/medusa-workflows/createCustomerAddressesWorkflow/index.html.md) -- [createCustomersWorkflow](https://docs.medusajs.com/references/medusa-workflows/createCustomersWorkflow/index.html.md) - [deleteCustomerAddressesWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteCustomerAddressesWorkflow/index.html.md) - [deleteCustomersWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteCustomersWorkflow/index.html.md) - [removeCustomerAccountWorkflow](https://docs.medusajs.com/references/medusa-workflows/removeCustomerAccountWorkflow/index.html.md) - [updateCustomersWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateCustomersWorkflow/index.html.md) - [updateCustomerAddressesWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateCustomerAddressesWorkflow/index.html.md) -- [uploadFilesWorkflow](https://docs.medusajs.com/references/medusa-workflows/uploadFilesWorkflow/index.html.md) -- [deleteFilesWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteFilesWorkflow/index.html.md) -- [createCustomerGroupsWorkflow](https://docs.medusajs.com/references/medusa-workflows/createCustomerGroupsWorkflow/index.html.md) +- [createLinksWorkflow](https://docs.medusajs.com/references/medusa-workflows/createLinksWorkflow/index.html.md) +- [batchLinksWorkflow](https://docs.medusajs.com/references/medusa-workflows/batchLinksWorkflow/index.html.md) +- [dismissLinksWorkflow](https://docs.medusajs.com/references/medusa-workflows/dismissLinksWorkflow/index.html.md) +- [updateLinksWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateLinksWorkflow/index.html.md) +- [createCustomersWorkflow](https://docs.medusajs.com/references/medusa-workflows/createCustomersWorkflow/index.html.md) +- [addToCartWorkflow](https://docs.medusajs.com/references/medusa-workflows/addToCartWorkflow/index.html.md) +- [completeCartWorkflow](https://docs.medusajs.com/references/medusa-workflows/completeCartWorkflow/index.html.md) +- [addShippingMethodToCartWorkflow](https://docs.medusajs.com/references/medusa-workflows/addShippingMethodToCartWorkflow/index.html.md) +- [confirmVariantInventoryWorkflow](https://docs.medusajs.com/references/medusa-workflows/confirmVariantInventoryWorkflow/index.html.md) +- [createCartCreditLinesWorkflow](https://docs.medusajs.com/references/medusa-workflows/createCartCreditLinesWorkflow/index.html.md) +- [createCartWorkflow](https://docs.medusajs.com/references/medusa-workflows/createCartWorkflow/index.html.md) +- [createPaymentCollectionForCartWorkflow](https://docs.medusajs.com/references/medusa-workflows/createPaymentCollectionForCartWorkflow/index.html.md) +- [deleteCartCreditLinesWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteCartCreditLinesWorkflow/index.html.md) +- [refreshCartItemsWorkflow](https://docs.medusajs.com/references/medusa-workflows/refreshCartItemsWorkflow/index.html.md) +- [listShippingOptionsForCartWorkflow](https://docs.medusajs.com/references/medusa-workflows/listShippingOptionsForCartWorkflow/index.html.md) +- [listShippingOptionsForCartWithPricingWorkflow](https://docs.medusajs.com/references/medusa-workflows/listShippingOptionsForCartWithPricingWorkflow/index.html.md) +- [refreshPaymentCollectionForCartWorkflow](https://docs.medusajs.com/references/medusa-workflows/refreshPaymentCollectionForCartWorkflow/index.html.md) +- [refreshCartShippingMethodsWorkflow](https://docs.medusajs.com/references/medusa-workflows/refreshCartShippingMethodsWorkflow/index.html.md) +- [updateCartPromotionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateCartPromotionsWorkflow/index.html.md) +- [transferCartCustomerWorkflow](https://docs.medusajs.com/references/medusa-workflows/transferCartCustomerWorkflow/index.html.md) +- [updateCartWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateCartWorkflow/index.html.md) +- [updateTaxLinesWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateTaxLinesWorkflow/index.html.md) +- [updateLineItemInCartWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateLineItemInCartWorkflow/index.html.md) +- [validateExistingPaymentCollectionStep](https://docs.medusajs.com/references/medusa-workflows/validateExistingPaymentCollectionStep/index.html.md) - [deleteCustomerGroupsWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteCustomerGroupsWorkflow/index.html.md) +- [createCustomerGroupsWorkflow](https://docs.medusajs.com/references/medusa-workflows/createCustomerGroupsWorkflow/index.html.md) - [linkCustomerGroupsToCustomerWorkflow](https://docs.medusajs.com/references/medusa-workflows/linkCustomerGroupsToCustomerWorkflow/index.html.md) -- [updateCustomerGroupsWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateCustomerGroupsWorkflow/index.html.md) - [linkCustomersToCustomerGroupWorkflow](https://docs.medusajs.com/references/medusa-workflows/linkCustomersToCustomerGroupWorkflow/index.html.md) - [createDefaultsWorkflow](https://docs.medusajs.com/references/medusa-workflows/createDefaultsWorkflow/index.html.md) -- [batchShippingOptionRulesWorkflow](https://docs.medusajs.com/references/medusa-workflows/batchShippingOptionRulesWorkflow/index.html.md) -- [calculateShippingOptionsPricesWorkflow](https://docs.medusajs.com/references/medusa-workflows/calculateShippingOptionsPricesWorkflow/index.html.md) +- [updateCustomerGroupsWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateCustomerGroupsWorkflow/index.html.md) - [cancelFulfillmentWorkflow](https://docs.medusajs.com/references/medusa-workflows/cancelFulfillmentWorkflow/index.html.md) +- [batchShippingOptionRulesWorkflow](https://docs.medusajs.com/references/medusa-workflows/batchShippingOptionRulesWorkflow/index.html.md) - [createFulfillmentWorkflow](https://docs.medusajs.com/references/medusa-workflows/createFulfillmentWorkflow/index.html.md) -- [createShippingOptionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/createShippingOptionsWorkflow/index.html.md) +- [calculateShippingOptionsPricesWorkflow](https://docs.medusajs.com/references/medusa-workflows/calculateShippingOptionsPricesWorkflow/index.html.md) +- [createReturnFulfillmentWorkflow](https://docs.medusajs.com/references/medusa-workflows/createReturnFulfillmentWorkflow/index.html.md) - [createServiceZonesWorkflow](https://docs.medusajs.com/references/medusa-workflows/createServiceZonesWorkflow/index.html.md) - [createShipmentWorkflow](https://docs.medusajs.com/references/medusa-workflows/createShipmentWorkflow/index.html.md) -- [createReturnFulfillmentWorkflow](https://docs.medusajs.com/references/medusa-workflows/createReturnFulfillmentWorkflow/index.html.md) +- [createShippingOptionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/createShippingOptionsWorkflow/index.html.md) - [createShippingProfilesWorkflow](https://docs.medusajs.com/references/medusa-workflows/createShippingProfilesWorkflow/index.html.md) -- [markFulfillmentAsDeliveredWorkflow](https://docs.medusajs.com/references/medusa-workflows/markFulfillmentAsDeliveredWorkflow/index.html.md) - [deleteFulfillmentSetsWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteFulfillmentSetsWorkflow/index.html.md) - [deleteServiceZonesWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteServiceZonesWorkflow/index.html.md) - [deleteShippingOptionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteShippingOptionsWorkflow/index.html.md) +- [markFulfillmentAsDeliveredWorkflow](https://docs.medusajs.com/references/medusa-workflows/markFulfillmentAsDeliveredWorkflow/index.html.md) - [updateFulfillmentWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateFulfillmentWorkflow/index.html.md) -- [validateFulfillmentDeliverabilityStep](https://docs.medusajs.com/references/medusa-workflows/validateFulfillmentDeliverabilityStep/index.html.md) - [updateServiceZonesWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateServiceZonesWorkflow/index.html.md) - [updateShippingProfilesWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateShippingProfilesWorkflow/index.html.md) - [updateShippingOptionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateShippingOptionsWorkflow/index.html.md) -- [deleteLineItemsWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteLineItemsWorkflow/index.html.md) +- [validateFulfillmentDeliverabilityStep](https://docs.medusajs.com/references/medusa-workflows/validateFulfillmentDeliverabilityStep/index.html.md) +- [deleteFilesWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteFilesWorkflow/index.html.md) +- [uploadFilesWorkflow](https://docs.medusajs.com/references/medusa-workflows/uploadFilesWorkflow/index.html.md) - [batchInventoryItemLevelsWorkflow](https://docs.medusajs.com/references/medusa-workflows/batchInventoryItemLevelsWorkflow/index.html.md) - [bulkCreateDeleteLevelsWorkflow](https://docs.medusajs.com/references/medusa-workflows/bulkCreateDeleteLevelsWorkflow/index.html.md) -- [createInventoryLevelsWorkflow](https://docs.medusajs.com/references/medusa-workflows/createInventoryLevelsWorkflow/index.html.md) - [deleteInventoryItemWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteInventoryItemWorkflow/index.html.md) +- [createInventoryLevelsWorkflow](https://docs.medusajs.com/references/medusa-workflows/createInventoryLevelsWorkflow/index.html.md) - [createInventoryItemsWorkflow](https://docs.medusajs.com/references/medusa-workflows/createInventoryItemsWorkflow/index.html.md) - [deleteInventoryLevelsWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteInventoryLevelsWorkflow/index.html.md) +- [updateInventoryItemsWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateInventoryItemsWorkflow/index.html.md) - [validateInventoryLevelsDelete](https://docs.medusajs.com/references/medusa-workflows/validateInventoryLevelsDelete/index.html.md) - [updateInventoryLevelsWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateInventoryLevelsWorkflow/index.html.md) -- [updateInventoryItemsWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateInventoryItemsWorkflow/index.html.md) -- [acceptInviteWorkflow](https://docs.medusajs.com/references/medusa-workflows/acceptInviteWorkflow/index.html.md) - [createInvitesWorkflow](https://docs.medusajs.com/references/medusa-workflows/createInvitesWorkflow/index.html.md) +- [acceptInviteWorkflow](https://docs.medusajs.com/references/medusa-workflows/acceptInviteWorkflow/index.html.md) - [deleteInvitesWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteInvitesWorkflow/index.html.md) - [refreshInviteTokensWorkflow](https://docs.medusajs.com/references/medusa-workflows/refreshInviteTokensWorkflow/index.html.md) +- [deleteLineItemsWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteLineItemsWorkflow/index.html.md) +- [capturePaymentWorkflow](https://docs.medusajs.com/references/medusa-workflows/capturePaymentWorkflow/index.html.md) +- [processPaymentWorkflow](https://docs.medusajs.com/references/medusa-workflows/processPaymentWorkflow/index.html.md) +- [refundPaymentsWorkflow](https://docs.medusajs.com/references/medusa-workflows/refundPaymentsWorkflow/index.html.md) +- [refundPaymentWorkflow](https://docs.medusajs.com/references/medusa-workflows/refundPaymentWorkflow/index.html.md) +- [validatePaymentsRefundStep](https://docs.medusajs.com/references/medusa-workflows/validatePaymentsRefundStep/index.html.md) +- [validateRefundStep](https://docs.medusajs.com/references/medusa-workflows/validateRefundStep/index.html.md) - [createPaymentSessionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/createPaymentSessionsWorkflow/index.html.md) -- [createRefundReasonsWorkflow](https://docs.medusajs.com/references/medusa-workflows/createRefundReasonsWorkflow/index.html.md) -- [deletePaymentSessionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/deletePaymentSessionsWorkflow/index.html.md) - [deleteRefundReasonsWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteRefundReasonsWorkflow/index.html.md) +- [deletePaymentSessionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/deletePaymentSessionsWorkflow/index.html.md) +- [createRefundReasonsWorkflow](https://docs.medusajs.com/references/medusa-workflows/createRefundReasonsWorkflow/index.html.md) - [updateRefundReasonsWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateRefundReasonsWorkflow/index.html.md) - [acceptOrderTransferValidationStep](https://docs.medusajs.com/references/medusa-workflows/acceptOrderTransferValidationStep/index.html.md) -- [acceptOrderTransferWorkflow](https://docs.medusajs.com/references/medusa-workflows/acceptOrderTransferWorkflow/index.html.md) - [addOrderLineItemsWorkflow](https://docs.medusajs.com/references/medusa-workflows/addOrderLineItemsWorkflow/index.html.md) -- [archiveOrderWorkflow](https://docs.medusajs.com/references/medusa-workflows/archiveOrderWorkflow/index.html.md) -- [beginExchangeOrderWorkflow](https://docs.medusajs.com/references/medusa-workflows/beginExchangeOrderWorkflow/index.html.md) -- [beginClaimOrderWorkflow](https://docs.medusajs.com/references/medusa-workflows/beginClaimOrderWorkflow/index.html.md) -- [beginOrderEditOrderWorkflow](https://docs.medusajs.com/references/medusa-workflows/beginOrderEditOrderWorkflow/index.html.md) +- [acceptOrderTransferWorkflow](https://docs.medusajs.com/references/medusa-workflows/acceptOrderTransferWorkflow/index.html.md) - [beginClaimOrderValidationStep](https://docs.medusajs.com/references/medusa-workflows/beginClaimOrderValidationStep/index.html.md) -- [beginOrderExchangeValidationStep](https://docs.medusajs.com/references/medusa-workflows/beginOrderExchangeValidationStep/index.html.md) +- [archiveOrderWorkflow](https://docs.medusajs.com/references/medusa-workflows/archiveOrderWorkflow/index.html.md) +- [beginClaimOrderWorkflow](https://docs.medusajs.com/references/medusa-workflows/beginClaimOrderWorkflow/index.html.md) +- [beginExchangeOrderWorkflow](https://docs.medusajs.com/references/medusa-workflows/beginExchangeOrderWorkflow/index.html.md) +- [beginOrderEditOrderWorkflow](https://docs.medusajs.com/references/medusa-workflows/beginOrderEditOrderWorkflow/index.html.md) - [beginOrderEditValidationStep](https://docs.medusajs.com/references/medusa-workflows/beginOrderEditValidationStep/index.html.md) - [beginReceiveReturnValidationStep](https://docs.medusajs.com/references/medusa-workflows/beginReceiveReturnValidationStep/index.html.md) -- [beginReturnOrderWorkflow](https://docs.medusajs.com/references/medusa-workflows/beginReturnOrderWorkflow/index.html.md) -- [beginReturnOrderValidationStep](https://docs.medusajs.com/references/medusa-workflows/beginReturnOrderValidationStep/index.html.md) - [beginReceiveReturnWorkflow](https://docs.medusajs.com/references/medusa-workflows/beginReceiveReturnWorkflow/index.html.md) +- [beginOrderExchangeValidationStep](https://docs.medusajs.com/references/medusa-workflows/beginOrderExchangeValidationStep/index.html.md) +- [beginReturnOrderValidationStep](https://docs.medusajs.com/references/medusa-workflows/beginReturnOrderValidationStep/index.html.md) - [cancelBeginOrderClaimValidationStep](https://docs.medusajs.com/references/medusa-workflows/cancelBeginOrderClaimValidationStep/index.html.md) +- [beginReturnOrderWorkflow](https://docs.medusajs.com/references/medusa-workflows/beginReturnOrderWorkflow/index.html.md) - [cancelBeginOrderClaimWorkflow](https://docs.medusajs.com/references/medusa-workflows/cancelBeginOrderClaimWorkflow/index.html.md) - [cancelBeginOrderEditValidationStep](https://docs.medusajs.com/references/medusa-workflows/cancelBeginOrderEditValidationStep/index.html.md) +- [cancelBeginOrderExchangeValidationStep](https://docs.medusajs.com/references/medusa-workflows/cancelBeginOrderExchangeValidationStep/index.html.md) - [cancelBeginOrderEditWorkflow](https://docs.medusajs.com/references/medusa-workflows/cancelBeginOrderEditWorkflow/index.html.md) - [cancelBeginOrderExchangeWorkflow](https://docs.medusajs.com/references/medusa-workflows/cancelBeginOrderExchangeWorkflow/index.html.md) -- [cancelBeginOrderExchangeValidationStep](https://docs.medusajs.com/references/medusa-workflows/cancelBeginOrderExchangeValidationStep/index.html.md) - [cancelClaimValidateOrderStep](https://docs.medusajs.com/references/medusa-workflows/cancelClaimValidateOrderStep/index.html.md) -- [cancelExchangeValidateOrder](https://docs.medusajs.com/references/medusa-workflows/cancelExchangeValidateOrder/index.html.md) -- [cancelOrderExchangeWorkflow](https://docs.medusajs.com/references/medusa-workflows/cancelOrderExchangeWorkflow/index.html.md) - [cancelOrderClaimWorkflow](https://docs.medusajs.com/references/medusa-workflows/cancelOrderClaimWorkflow/index.html.md) - [cancelOrderChangeWorkflow](https://docs.medusajs.com/references/medusa-workflows/cancelOrderChangeWorkflow/index.html.md) -- [cancelOrderFulfillmentValidateOrder](https://docs.medusajs.com/references/medusa-workflows/cancelOrderFulfillmentValidateOrder/index.html.md) -- [cancelOrderFulfillmentWorkflow](https://docs.medusajs.com/references/medusa-workflows/cancelOrderFulfillmentWorkflow/index.html.md) +- [cancelExchangeValidateOrder](https://docs.medusajs.com/references/medusa-workflows/cancelExchangeValidateOrder/index.html.md) +- [cancelOrderExchangeWorkflow](https://docs.medusajs.com/references/medusa-workflows/cancelOrderExchangeWorkflow/index.html.md) - [cancelOrderTransferRequestWorkflow](https://docs.medusajs.com/references/medusa-workflows/cancelOrderTransferRequestWorkflow/index.html.md) -- [cancelOrderWorkflow](https://docs.medusajs.com/references/medusa-workflows/cancelOrderWorkflow/index.html.md) +- [cancelOrderFulfillmentWorkflow](https://docs.medusajs.com/references/medusa-workflows/cancelOrderFulfillmentWorkflow/index.html.md) +- [cancelOrderFulfillmentValidateOrder](https://docs.medusajs.com/references/medusa-workflows/cancelOrderFulfillmentValidateOrder/index.html.md) - [cancelReceiveReturnValidationStep](https://docs.medusajs.com/references/medusa-workflows/cancelReceiveReturnValidationStep/index.html.md) +- [cancelOrderWorkflow](https://docs.medusajs.com/references/medusa-workflows/cancelOrderWorkflow/index.html.md) - [cancelRequestReturnValidationStep](https://docs.medusajs.com/references/medusa-workflows/cancelRequestReturnValidationStep/index.html.md) - [cancelReturnReceiveWorkflow](https://docs.medusajs.com/references/medusa-workflows/cancelReturnReceiveWorkflow/index.html.md) - [cancelReturnRequestWorkflow](https://docs.medusajs.com/references/medusa-workflows/cancelReturnRequestWorkflow/index.html.md) - [cancelReturnWorkflow](https://docs.medusajs.com/references/medusa-workflows/cancelReturnWorkflow/index.html.md) +- [cancelReturnValidateOrder](https://docs.medusajs.com/references/medusa-workflows/cancelReturnValidateOrder/index.html.md) - [cancelTransferOrderRequestValidationStep](https://docs.medusajs.com/references/medusa-workflows/cancelTransferOrderRequestValidationStep/index.html.md) - [cancelValidateOrder](https://docs.medusajs.com/references/medusa-workflows/cancelValidateOrder/index.html.md) -- [cancelReturnValidateOrder](https://docs.medusajs.com/references/medusa-workflows/cancelReturnValidateOrder/index.html.md) +- [completeOrderWorkflow](https://docs.medusajs.com/references/medusa-workflows/completeOrderWorkflow/index.html.md) - [confirmClaimRequestValidationStep](https://docs.medusajs.com/references/medusa-workflows/confirmClaimRequestValidationStep/index.html.md) - [confirmClaimRequestWorkflow](https://docs.medusajs.com/references/medusa-workflows/confirmClaimRequestWorkflow/index.html.md) -- [completeOrderWorkflow](https://docs.medusajs.com/references/medusa-workflows/completeOrderWorkflow/index.html.md) -- [confirmOrderEditRequestValidationStep](https://docs.medusajs.com/references/medusa-workflows/confirmOrderEditRequestValidationStep/index.html.md) -- [confirmOrderEditRequestWorkflow](https://docs.medusajs.com/references/medusa-workflows/confirmOrderEditRequestWorkflow/index.html.md) - [confirmExchangeRequestValidationStep](https://docs.medusajs.com/references/medusa-workflows/confirmExchangeRequestValidationStep/index.html.md) - [confirmExchangeRequestWorkflow](https://docs.medusajs.com/references/medusa-workflows/confirmExchangeRequestWorkflow/index.html.md) +- [confirmOrderEditRequestValidationStep](https://docs.medusajs.com/references/medusa-workflows/confirmOrderEditRequestValidationStep/index.html.md) +- [confirmOrderEditRequestWorkflow](https://docs.medusajs.com/references/medusa-workflows/confirmOrderEditRequestWorkflow/index.html.md) - [confirmReceiveReturnValidationStep](https://docs.medusajs.com/references/medusa-workflows/confirmReceiveReturnValidationStep/index.html.md) - [confirmReturnReceiveWorkflow](https://docs.medusajs.com/references/medusa-workflows/confirmReturnReceiveWorkflow/index.html.md) - [confirmReturnRequestValidationStep](https://docs.medusajs.com/references/medusa-workflows/confirmReturnRequestValidationStep/index.html.md) - [confirmReturnRequestWorkflow](https://docs.medusajs.com/references/medusa-workflows/confirmReturnRequestWorkflow/index.html.md) -- [createClaimShippingMethodValidationStep](https://docs.medusajs.com/references/medusa-workflows/createClaimShippingMethodValidationStep/index.html.md) - [createAndCompleteReturnOrderWorkflow](https://docs.medusajs.com/references/medusa-workflows/createAndCompleteReturnOrderWorkflow/index.html.md) +- [createClaimShippingMethodValidationStep](https://docs.medusajs.com/references/medusa-workflows/createClaimShippingMethodValidationStep/index.html.md) - [createClaimShippingMethodWorkflow](https://docs.medusajs.com/references/medusa-workflows/createClaimShippingMethodWorkflow/index.html.md) - [createCompleteReturnValidationStep](https://docs.medusajs.com/references/medusa-workflows/createCompleteReturnValidationStep/index.html.md) - [createExchangeShippingMethodValidationStep](https://docs.medusajs.com/references/medusa-workflows/createExchangeShippingMethodValidationStep/index.html.md) - [createExchangeShippingMethodWorkflow](https://docs.medusajs.com/references/medusa-workflows/createExchangeShippingMethodWorkflow/index.html.md) -- [createOrUpdateOrderPaymentCollectionWorkflow](https://docs.medusajs.com/references/medusa-workflows/createOrUpdateOrderPaymentCollectionWorkflow/index.html.md) - [createFulfillmentValidateOrder](https://docs.medusajs.com/references/medusa-workflows/createFulfillmentValidateOrder/index.html.md) +- [createOrUpdateOrderPaymentCollectionWorkflow](https://docs.medusajs.com/references/medusa-workflows/createOrUpdateOrderPaymentCollectionWorkflow/index.html.md) - [createOrderChangeWorkflow](https://docs.medusajs.com/references/medusa-workflows/createOrderChangeWorkflow/index.html.md) -- [createOrderChangeActionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/createOrderChangeActionsWorkflow/index.html.md) - [createOrderEditShippingMethodValidationStep](https://docs.medusajs.com/references/medusa-workflows/createOrderEditShippingMethodValidationStep/index.html.md) -- [createOrderShipmentWorkflow](https://docs.medusajs.com/references/medusa-workflows/createOrderShipmentWorkflow/index.html.md) - [createOrderEditShippingMethodWorkflow](https://docs.medusajs.com/references/medusa-workflows/createOrderEditShippingMethodWorkflow/index.html.md) -- [createOrderWorkflow](https://docs.medusajs.com/references/medusa-workflows/createOrderWorkflow/index.html.md) -- [createOrderPaymentCollectionWorkflow](https://docs.medusajs.com/references/medusa-workflows/createOrderPaymentCollectionWorkflow/index.html.md) +- [createOrderChangeActionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/createOrderChangeActionsWorkflow/index.html.md) - [createOrderFulfillmentWorkflow](https://docs.medusajs.com/references/medusa-workflows/createOrderFulfillmentWorkflow/index.html.md) +- [createOrderPaymentCollectionWorkflow](https://docs.medusajs.com/references/medusa-workflows/createOrderPaymentCollectionWorkflow/index.html.md) +- [createOrderShipmentWorkflow](https://docs.medusajs.com/references/medusa-workflows/createOrderShipmentWorkflow/index.html.md) +- [createOrderWorkflow](https://docs.medusajs.com/references/medusa-workflows/createOrderWorkflow/index.html.md) - [createOrdersWorkflow](https://docs.medusajs.com/references/medusa-workflows/createOrdersWorkflow/index.html.md) -- [createReturnShippingMethodWorkflow](https://docs.medusajs.com/references/medusa-workflows/createReturnShippingMethodWorkflow/index.html.md) - [createReturnShippingMethodValidationStep](https://docs.medusajs.com/references/medusa-workflows/createReturnShippingMethodValidationStep/index.html.md) +- [createReturnShippingMethodWorkflow](https://docs.medusajs.com/references/medusa-workflows/createReturnShippingMethodWorkflow/index.html.md) - [createShipmentValidateOrder](https://docs.medusajs.com/references/medusa-workflows/createShipmentValidateOrder/index.html.md) - [declineOrderChangeWorkflow](https://docs.medusajs.com/references/medusa-workflows/declineOrderChangeWorkflow/index.html.md) -- [deleteOrderChangeActionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteOrderChangeActionsWorkflow/index.html.md) - [declineOrderTransferRequestWorkflow](https://docs.medusajs.com/references/medusa-workflows/declineOrderTransferRequestWorkflow/index.html.md) - [declineTransferOrderRequestValidationStep](https://docs.medusajs.com/references/medusa-workflows/declineTransferOrderRequestValidationStep/index.html.md) -- [deleteOrderChangeWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteOrderChangeWorkflow/index.html.md) +- [deleteOrderChangeActionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteOrderChangeActionsWorkflow/index.html.md) - [deleteOrderPaymentCollections](https://docs.medusajs.com/references/medusa-workflows/deleteOrderPaymentCollections/index.html.md) -- [dismissItemReturnRequestWorkflow](https://docs.medusajs.com/references/medusa-workflows/dismissItemReturnRequestWorkflow/index.html.md) - [dismissItemReturnRequestValidationStep](https://docs.medusajs.com/references/medusa-workflows/dismissItemReturnRequestValidationStep/index.html.md) -- [exchangeRequestItemReturnValidationStep](https://docs.medusajs.com/references/medusa-workflows/exchangeRequestItemReturnValidationStep/index.html.md) -- [getOrderDetailWorkflow](https://docs.medusajs.com/references/medusa-workflows/getOrderDetailWorkflow/index.html.md) -- [getOrdersListWorkflow](https://docs.medusajs.com/references/medusa-workflows/getOrdersListWorkflow/index.html.md) +- [deleteOrderChangeWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteOrderChangeWorkflow/index.html.md) +- [dismissItemReturnRequestWorkflow](https://docs.medusajs.com/references/medusa-workflows/dismissItemReturnRequestWorkflow/index.html.md) - [exchangeAddNewItemValidationStep](https://docs.medusajs.com/references/medusa-workflows/exchangeAddNewItemValidationStep/index.html.md) -- [markOrderFulfillmentAsDeliveredWorkflow](https://docs.medusajs.com/references/medusa-workflows/markOrderFulfillmentAsDeliveredWorkflow/index.html.md) +- [getOrderDetailWorkflow](https://docs.medusajs.com/references/medusa-workflows/getOrderDetailWorkflow/index.html.md) +- [exchangeRequestItemReturnValidationStep](https://docs.medusajs.com/references/medusa-workflows/exchangeRequestItemReturnValidationStep/index.html.md) +- [getOrdersListWorkflow](https://docs.medusajs.com/references/medusa-workflows/getOrdersListWorkflow/index.html.md) - [markPaymentCollectionAsPaid](https://docs.medusajs.com/references/medusa-workflows/markPaymentCollectionAsPaid/index.html.md) - [orderClaimAddNewItemValidationStep](https://docs.medusajs.com/references/medusa-workflows/orderClaimAddNewItemValidationStep/index.html.md) +- [markOrderFulfillmentAsDeliveredWorkflow](https://docs.medusajs.com/references/medusa-workflows/markOrderFulfillmentAsDeliveredWorkflow/index.html.md) - [orderClaimAddNewItemWorkflow](https://docs.medusajs.com/references/medusa-workflows/orderClaimAddNewItemWorkflow/index.html.md) -- [orderClaimItemWorkflow](https://docs.medusajs.com/references/medusa-workflows/orderClaimItemWorkflow/index.html.md) - [orderClaimRequestItemReturnValidationStep](https://docs.medusajs.com/references/medusa-workflows/orderClaimRequestItemReturnValidationStep/index.html.md) - [orderClaimItemValidationStep](https://docs.medusajs.com/references/medusa-workflows/orderClaimItemValidationStep/index.html.md) +- [orderClaimItemWorkflow](https://docs.medusajs.com/references/medusa-workflows/orderClaimItemWorkflow/index.html.md) - [orderClaimRequestItemReturnWorkflow](https://docs.medusajs.com/references/medusa-workflows/orderClaimRequestItemReturnWorkflow/index.html.md) - [orderEditAddNewItemValidationStep](https://docs.medusajs.com/references/medusa-workflows/orderEditAddNewItemValidationStep/index.html.md) - [orderEditAddNewItemWorkflow](https://docs.medusajs.com/references/medusa-workflows/orderEditAddNewItemWorkflow/index.html.md) @@ -26128,204 +26556,191 @@ Each variant in the retrieved products has a `calculated_price` object. Learn mo - [orderExchangeRequestItemReturnWorkflow](https://docs.medusajs.com/references/medusa-workflows/orderExchangeRequestItemReturnWorkflow/index.html.md) - [orderFulfillmentDeliverablilityValidationStep](https://docs.medusajs.com/references/medusa-workflows/orderFulfillmentDeliverablilityValidationStep/index.html.md) - [orderExchangeAddNewItemWorkflow](https://docs.medusajs.com/references/medusa-workflows/orderExchangeAddNewItemWorkflow/index.html.md) -- [receiveCompleteReturnValidationStep](https://docs.medusajs.com/references/medusa-workflows/receiveCompleteReturnValidationStep/index.html.md) -- [receiveItemReturnRequestWorkflow](https://docs.medusajs.com/references/medusa-workflows/receiveItemReturnRequestWorkflow/index.html.md) - [receiveAndCompleteReturnOrderWorkflow](https://docs.medusajs.com/references/medusa-workflows/receiveAndCompleteReturnOrderWorkflow/index.html.md) - [receiveItemReturnRequestValidationStep](https://docs.medusajs.com/references/medusa-workflows/receiveItemReturnRequestValidationStep/index.html.md) +- [receiveCompleteReturnValidationStep](https://docs.medusajs.com/references/medusa-workflows/receiveCompleteReturnValidationStep/index.html.md) +- [receiveItemReturnRequestWorkflow](https://docs.medusajs.com/references/medusa-workflows/receiveItemReturnRequestWorkflow/index.html.md) - [removeAddItemClaimActionWorkflow](https://docs.medusajs.com/references/medusa-workflows/removeAddItemClaimActionWorkflow/index.html.md) - [removeClaimAddItemActionValidationStep](https://docs.medusajs.com/references/medusa-workflows/removeClaimAddItemActionValidationStep/index.html.md) -- [removeClaimItemActionValidationStep](https://docs.medusajs.com/references/medusa-workflows/removeClaimItemActionValidationStep/index.html.md) -- [removeExchangeItemActionValidationStep](https://docs.medusajs.com/references/medusa-workflows/removeExchangeItemActionValidationStep/index.html.md) - [removeClaimShippingMethodValidationStep](https://docs.medusajs.com/references/medusa-workflows/removeClaimShippingMethodValidationStep/index.html.md) +- [removeClaimItemActionValidationStep](https://docs.medusajs.com/references/medusa-workflows/removeClaimItemActionValidationStep/index.html.md) - [removeClaimShippingMethodWorkflow](https://docs.medusajs.com/references/medusa-workflows/removeClaimShippingMethodWorkflow/index.html.md) -- [removeExchangeShippingMethodValidationStep](https://docs.medusajs.com/references/medusa-workflows/removeExchangeShippingMethodValidationStep/index.html.md) - [removeExchangeShippingMethodWorkflow](https://docs.medusajs.com/references/medusa-workflows/removeExchangeShippingMethodWorkflow/index.html.md) +- [removeExchangeItemActionValidationStep](https://docs.medusajs.com/references/medusa-workflows/removeExchangeItemActionValidationStep/index.html.md) +- [removeExchangeShippingMethodValidationStep](https://docs.medusajs.com/references/medusa-workflows/removeExchangeShippingMethodValidationStep/index.html.md) - [removeItemClaimActionWorkflow](https://docs.medusajs.com/references/medusa-workflows/removeItemClaimActionWorkflow/index.html.md) -- [removeItemExchangeActionWorkflow](https://docs.medusajs.com/references/medusa-workflows/removeItemExchangeActionWorkflow/index.html.md) - [removeItemOrderEditActionWorkflow](https://docs.medusajs.com/references/medusa-workflows/removeItemOrderEditActionWorkflow/index.html.md) -- [removeItemReceiveReturnActionWorkflow](https://docs.medusajs.com/references/medusa-workflows/removeItemReceiveReturnActionWorkflow/index.html.md) -- [removeItemReturnActionWorkflow](https://docs.medusajs.com/references/medusa-workflows/removeItemReturnActionWorkflow/index.html.md) - [removeItemReceiveReturnActionValidationStep](https://docs.medusajs.com/references/medusa-workflows/removeItemReceiveReturnActionValidationStep/index.html.md) +- [removeItemExchangeActionWorkflow](https://docs.medusajs.com/references/medusa-workflows/removeItemExchangeActionWorkflow/index.html.md) +- [removeItemReceiveReturnActionWorkflow](https://docs.medusajs.com/references/medusa-workflows/removeItemReceiveReturnActionWorkflow/index.html.md) - [removeOrderEditItemActionValidationStep](https://docs.medusajs.com/references/medusa-workflows/removeOrderEditItemActionValidationStep/index.html.md) -- [removeReturnItemActionValidationStep](https://docs.medusajs.com/references/medusa-workflows/removeReturnItemActionValidationStep/index.html.md) - [removeOrderEditShippingMethodValidationStep](https://docs.medusajs.com/references/medusa-workflows/removeOrderEditShippingMethodValidationStep/index.html.md) -- [removeOrderEditShippingMethodWorkflow](https://docs.medusajs.com/references/medusa-workflows/removeOrderEditShippingMethodWorkflow/index.html.md) +- [removeItemReturnActionWorkflow](https://docs.medusajs.com/references/medusa-workflows/removeItemReturnActionWorkflow/index.html.md) - [removeReturnShippingMethodValidationStep](https://docs.medusajs.com/references/medusa-workflows/removeReturnShippingMethodValidationStep/index.html.md) +- [removeReturnItemActionValidationStep](https://docs.medusajs.com/references/medusa-workflows/removeReturnItemActionValidationStep/index.html.md) - [removeReturnShippingMethodWorkflow](https://docs.medusajs.com/references/medusa-workflows/removeReturnShippingMethodWorkflow/index.html.md) +- [removeOrderEditShippingMethodWorkflow](https://docs.medusajs.com/references/medusa-workflows/removeOrderEditShippingMethodWorkflow/index.html.md) - [requestItemReturnWorkflow](https://docs.medusajs.com/references/medusa-workflows/requestItemReturnWorkflow/index.html.md) -- [requestItemReturnValidationStep](https://docs.medusajs.com/references/medusa-workflows/requestItemReturnValidationStep/index.html.md) -- [requestOrderTransferValidationStep](https://docs.medusajs.com/references/medusa-workflows/requestOrderTransferValidationStep/index.html.md) -- [requestOrderEditRequestWorkflow](https://docs.medusajs.com/references/medusa-workflows/requestOrderEditRequestWorkflow/index.html.md) - [requestOrderEditRequestValidationStep](https://docs.medusajs.com/references/medusa-workflows/requestOrderEditRequestValidationStep/index.html.md) -- [throwUnlessPaymentCollectionNotPaid](https://docs.medusajs.com/references/medusa-workflows/throwUnlessPaymentCollectionNotPaid/index.html.md) +- [requestItemReturnValidationStep](https://docs.medusajs.com/references/medusa-workflows/requestItemReturnValidationStep/index.html.md) +- [requestOrderEditRequestWorkflow](https://docs.medusajs.com/references/medusa-workflows/requestOrderEditRequestWorkflow/index.html.md) - [requestOrderTransferWorkflow](https://docs.medusajs.com/references/medusa-workflows/requestOrderTransferWorkflow/index.html.md) +- [throwUnlessPaymentCollectionNotPaid](https://docs.medusajs.com/references/medusa-workflows/throwUnlessPaymentCollectionNotPaid/index.html.md) +- [requestOrderTransferValidationStep](https://docs.medusajs.com/references/medusa-workflows/requestOrderTransferValidationStep/index.html.md) - [throwUnlessStatusIsNotPaid](https://docs.medusajs.com/references/medusa-workflows/throwUnlessStatusIsNotPaid/index.html.md) - [updateClaimAddItemValidationStep](https://docs.medusajs.com/references/medusa-workflows/updateClaimAddItemValidationStep/index.html.md) -- [updateClaimAddItemWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateClaimAddItemWorkflow/index.html.md) -- [updateClaimShippingMethodValidationStep](https://docs.medusajs.com/references/medusa-workflows/updateClaimShippingMethodValidationStep/index.html.md) -- [updateClaimShippingMethodWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateClaimShippingMethodWorkflow/index.html.md) -- [updateClaimItemWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateClaimItemWorkflow/index.html.md) -- [updateExchangeAddItemValidationStep](https://docs.medusajs.com/references/medusa-workflows/updateExchangeAddItemValidationStep/index.html.md) - [updateClaimItemValidationStep](https://docs.medusajs.com/references/medusa-workflows/updateClaimItemValidationStep/index.html.md) +- [updateClaimAddItemWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateClaimAddItemWorkflow/index.html.md) +- [updateClaimItemWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateClaimItemWorkflow/index.html.md) +- [updateClaimShippingMethodWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateClaimShippingMethodWorkflow/index.html.md) +- [updateExchangeAddItemValidationStep](https://docs.medusajs.com/references/medusa-workflows/updateExchangeAddItemValidationStep/index.html.md) +- [updateClaimShippingMethodValidationStep](https://docs.medusajs.com/references/medusa-workflows/updateClaimShippingMethodValidationStep/index.html.md) - [updateExchangeAddItemWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateExchangeAddItemWorkflow/index.html.md) - [updateExchangeShippingMethodValidationStep](https://docs.medusajs.com/references/medusa-workflows/updateExchangeShippingMethodValidationStep/index.html.md) - [updateExchangeShippingMethodWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateExchangeShippingMethodWorkflow/index.html.md) -- [updateOrderChangesWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateOrderChangesWorkflow/index.html.md) -- [updateOrderEditAddItemValidationStep](https://docs.medusajs.com/references/medusa-workflows/updateOrderEditAddItemValidationStep/index.html.md) -- [updateOrderEditAddItemWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateOrderEditAddItemWorkflow/index.html.md) -- [updateOrderEditItemQuantityValidationStep](https://docs.medusajs.com/references/medusa-workflows/updateOrderEditItemQuantityValidationStep/index.html.md) - [updateOrderChangeActionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateOrderChangeActionsWorkflow/index.html.md) +- [updateOrderChangesWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateOrderChangesWorkflow/index.html.md) +- [updateOrderEditItemQuantityValidationStep](https://docs.medusajs.com/references/medusa-workflows/updateOrderEditItemQuantityValidationStep/index.html.md) +- [updateOrderEditAddItemWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateOrderEditAddItemWorkflow/index.html.md) +- [updateOrderEditAddItemValidationStep](https://docs.medusajs.com/references/medusa-workflows/updateOrderEditAddItemValidationStep/index.html.md) - [updateOrderEditItemQuantityWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateOrderEditItemQuantityWorkflow/index.html.md) - [updateOrderEditShippingMethodWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateOrderEditShippingMethodWorkflow/index.html.md) - [updateOrderEditShippingMethodValidationStep](https://docs.medusajs.com/references/medusa-workflows/updateOrderEditShippingMethodValidationStep/index.html.md) -- [updateOrderWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateOrderWorkflow/index.html.md) - [updateOrderTaxLinesWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateOrderTaxLinesWorkflow/index.html.md) -- [updateReceiveItemReturnRequestValidationStep](https://docs.medusajs.com/references/medusa-workflows/updateReceiveItemReturnRequestValidationStep/index.html.md) - [updateOrderValidationStep](https://docs.medusajs.com/references/medusa-workflows/updateOrderValidationStep/index.html.md) +- [updateReceiveItemReturnRequestValidationStep](https://docs.medusajs.com/references/medusa-workflows/updateReceiveItemReturnRequestValidationStep/index.html.md) +- [updateOrderWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateOrderWorkflow/index.html.md) - [updateReceiveItemReturnRequestWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateReceiveItemReturnRequestWorkflow/index.html.md) -- [updateReturnShippingMethodValidationStep](https://docs.medusajs.com/references/medusa-workflows/updateReturnShippingMethodValidationStep/index.html.md) -- [updateRequestItemReturnWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateRequestItemReturnWorkflow/index.html.md) - [updateRequestItemReturnValidationStep](https://docs.medusajs.com/references/medusa-workflows/updateRequestItemReturnValidationStep/index.html.md) +- [updateReturnShippingMethodValidationStep](https://docs.medusajs.com/references/medusa-workflows/updateReturnShippingMethodValidationStep/index.html.md) - [updateReturnShippingMethodWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateReturnShippingMethodWorkflow/index.html.md) +- [updateRequestItemReturnWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateRequestItemReturnWorkflow/index.html.md) - [updateReturnWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateReturnWorkflow/index.html.md) - [updateReturnValidationStep](https://docs.medusajs.com/references/medusa-workflows/updateReturnValidationStep/index.html.md) -- [processPaymentWorkflow](https://docs.medusajs.com/references/medusa-workflows/processPaymentWorkflow/index.html.md) -- [capturePaymentWorkflow](https://docs.medusajs.com/references/medusa-workflows/capturePaymentWorkflow/index.html.md) -- [refundPaymentsWorkflow](https://docs.medusajs.com/references/medusa-workflows/refundPaymentsWorkflow/index.html.md) -- [validatePaymentsRefundStep](https://docs.medusajs.com/references/medusa-workflows/validatePaymentsRefundStep/index.html.md) -- [refundPaymentWorkflow](https://docs.medusajs.com/references/medusa-workflows/refundPaymentWorkflow/index.html.md) -- [validateRefundStep](https://docs.medusajs.com/references/medusa-workflows/validateRefundStep/index.html.md) -- [createPriceListPricesWorkflow](https://docs.medusajs.com/references/medusa-workflows/createPriceListPricesWorkflow/index.html.md) - [batchPriceListPricesWorkflow](https://docs.medusajs.com/references/medusa-workflows/batchPriceListPricesWorkflow/index.html.md) -- [createPriceListsWorkflow](https://docs.medusajs.com/references/medusa-workflows/createPriceListsWorkflow/index.html.md) -- [removePriceListPricesWorkflow](https://docs.medusajs.com/references/medusa-workflows/removePriceListPricesWorkflow/index.html.md) - [deletePriceListsWorkflow](https://docs.medusajs.com/references/medusa-workflows/deletePriceListsWorkflow/index.html.md) +- [createPriceListsWorkflow](https://docs.medusajs.com/references/medusa-workflows/createPriceListsWorkflow/index.html.md) +- [createPriceListPricesWorkflow](https://docs.medusajs.com/references/medusa-workflows/createPriceListPricesWorkflow/index.html.md) +- [removePriceListPricesWorkflow](https://docs.medusajs.com/references/medusa-workflows/removePriceListPricesWorkflow/index.html.md) - [updatePriceListPricesWorkflow](https://docs.medusajs.com/references/medusa-workflows/updatePriceListPricesWorkflow/index.html.md) - [updatePriceListsWorkflow](https://docs.medusajs.com/references/medusa-workflows/updatePriceListsWorkflow/index.html.md) -- [createPricePreferencesWorkflow](https://docs.medusajs.com/references/medusa-workflows/createPricePreferencesWorkflow/index.html.md) -- [deletePricePreferencesWorkflow](https://docs.medusajs.com/references/medusa-workflows/deletePricePreferencesWorkflow/index.html.md) -- [updatePricePreferencesWorkflow](https://docs.medusajs.com/references/medusa-workflows/updatePricePreferencesWorkflow/index.html.md) -- [deleteProductCategoriesWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteProductCategoriesWorkflow/index.html.md) -- [createProductCategoriesWorkflow](https://docs.medusajs.com/references/medusa-workflows/createProductCategoriesWorkflow/index.html.md) -- [updateProductCategoriesWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateProductCategoriesWorkflow/index.html.md) - [batchLinkProductsToCategoryWorkflow](https://docs.medusajs.com/references/medusa-workflows/batchLinkProductsToCategoryWorkflow/index.html.md) -- [batchProductsWorkflow](https://docs.medusajs.com/references/medusa-workflows/batchProductsWorkflow/index.html.md) -- [createCollectionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/createCollectionsWorkflow/index.html.md) -- [batchLinkProductsToCollectionWorkflow](https://docs.medusajs.com/references/medusa-workflows/batchLinkProductsToCollectionWorkflow/index.html.md) - [batchProductVariantsWorkflow](https://docs.medusajs.com/references/medusa-workflows/batchProductVariantsWorkflow/index.html.md) -- [createProductOptionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/createProductOptionsWorkflow/index.html.md) +- [batchLinkProductsToCollectionWorkflow](https://docs.medusajs.com/references/medusa-workflows/batchLinkProductsToCollectionWorkflow/index.html.md) +- [batchProductsWorkflow](https://docs.medusajs.com/references/medusa-workflows/batchProductsWorkflow/index.html.md) - [createProductTagsWorkflow](https://docs.medusajs.com/references/medusa-workflows/createProductTagsWorkflow/index.html.md) +- [createCollectionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/createCollectionsWorkflow/index.html.md) +- [createProductOptionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/createProductOptionsWorkflow/index.html.md) - [createProductTypesWorkflow](https://docs.medusajs.com/references/medusa-workflows/createProductTypesWorkflow/index.html.md) -- [deleteCollectionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteCollectionsWorkflow/index.html.md) - [createProductVariantsWorkflow](https://docs.medusajs.com/references/medusa-workflows/createProductVariantsWorkflow/index.html.md) - [createProductsWorkflow](https://docs.medusajs.com/references/medusa-workflows/createProductsWorkflow/index.html.md) +- [deleteCollectionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteCollectionsWorkflow/index.html.md) - [deleteProductOptionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteProductOptionsWorkflow/index.html.md) -- [deleteProductVariantsWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteProductVariantsWorkflow/index.html.md) - [deleteProductTypesWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteProductTypesWorkflow/index.html.md) +- [deleteProductVariantsWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteProductVariantsWorkflow/index.html.md) - [deleteProductTagsWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteProductTagsWorkflow/index.html.md) - [deleteProductsWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteProductsWorkflow/index.html.md) -- [updateCollectionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateCollectionsWorkflow/index.html.md) - [exportProductsWorkflow](https://docs.medusajs.com/references/medusa-workflows/exportProductsWorkflow/index.html.md) -- [importProductsWorkflow](https://docs.medusajs.com/references/medusa-workflows/importProductsWorkflow/index.html.md) - [updateProductOptionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateProductOptionsWorkflow/index.html.md) -- [updateProductVariantsWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateProductVariantsWorkflow/index.html.md) -- [updateProductTagsWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateProductTagsWorkflow/index.html.md) +- [importProductsWorkflow](https://docs.medusajs.com/references/medusa-workflows/importProductsWorkflow/index.html.md) +- [updateCollectionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateCollectionsWorkflow/index.html.md) - [updateProductTypesWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateProductTypesWorkflow/index.html.md) +- [updateProductVariantsWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateProductVariantsWorkflow/index.html.md) +- [upsertVariantPricesWorkflow](https://docs.medusajs.com/references/medusa-workflows/upsertVariantPricesWorkflow/index.html.md) +- [updateProductTagsWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateProductTagsWorkflow/index.html.md) - [updateProductsWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateProductsWorkflow/index.html.md) - [validateProductInputStep](https://docs.medusajs.com/references/medusa-workflows/validateProductInputStep/index.html.md) -- [upsertVariantPricesWorkflow](https://docs.medusajs.com/references/medusa-workflows/upsertVariantPricesWorkflow/index.html.md) +- [updatePricePreferencesWorkflow](https://docs.medusajs.com/references/medusa-workflows/updatePricePreferencesWorkflow/index.html.md) +- [deletePricePreferencesWorkflow](https://docs.medusajs.com/references/medusa-workflows/deletePricePreferencesWorkflow/index.html.md) +- [createPricePreferencesWorkflow](https://docs.medusajs.com/references/medusa-workflows/createPricePreferencesWorkflow/index.html.md) +- [deleteRegionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteRegionsWorkflow/index.html.md) +- [createRegionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/createRegionsWorkflow/index.html.md) +- [updateRegionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateRegionsWorkflow/index.html.md) +- [createProductCategoriesWorkflow](https://docs.medusajs.com/references/medusa-workflows/createProductCategoriesWorkflow/index.html.md) +- [deleteProductCategoriesWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteProductCategoriesWorkflow/index.html.md) +- [updateProductCategoriesWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateProductCategoriesWorkflow/index.html.md) - [addOrRemoveCampaignPromotionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/addOrRemoveCampaignPromotionsWorkflow/index.html.md) - [batchPromotionRulesWorkflow](https://docs.medusajs.com/references/medusa-workflows/batchPromotionRulesWorkflow/index.html.md) -- [createPromotionRulesWorkflow](https://docs.medusajs.com/references/medusa-workflows/createPromotionRulesWorkflow/index.html.md) -- [createPromotionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/createPromotionsWorkflow/index.html.md) - [createCampaignsWorkflow](https://docs.medusajs.com/references/medusa-workflows/createCampaignsWorkflow/index.html.md) +- [createPromotionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/createPromotionsWorkflow/index.html.md) +- [createPromotionRulesWorkflow](https://docs.medusajs.com/references/medusa-workflows/createPromotionRulesWorkflow/index.html.md) - [deleteCampaignsWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteCampaignsWorkflow/index.html.md) - [deletePromotionRulesWorkflow](https://docs.medusajs.com/references/medusa-workflows/deletePromotionRulesWorkflow/index.html.md) - [deletePromotionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/deletePromotionsWorkflow/index.html.md) -- [updateCampaignsWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateCampaignsWorkflow/index.html.md) -- [updatePromotionsStatusWorkflow](https://docs.medusajs.com/references/medusa-workflows/updatePromotionsStatusWorkflow/index.html.md) -- [updatePromotionsValidationStep](https://docs.medusajs.com/references/medusa-workflows/updatePromotionsValidationStep/index.html.md) - [updatePromotionRulesWorkflow](https://docs.medusajs.com/references/medusa-workflows/updatePromotionRulesWorkflow/index.html.md) +- [updateCampaignsWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateCampaignsWorkflow/index.html.md) +- [updatePromotionsValidationStep](https://docs.medusajs.com/references/medusa-workflows/updatePromotionsValidationStep/index.html.md) +- [updatePromotionsStatusWorkflow](https://docs.medusajs.com/references/medusa-workflows/updatePromotionsStatusWorkflow/index.html.md) - [updatePromotionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/updatePromotionsWorkflow/index.html.md) -- [createReservationsWorkflow](https://docs.medusajs.com/references/medusa-workflows/createReservationsWorkflow/index.html.md) -- [deleteReservationsWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteReservationsWorkflow/index.html.md) - [deleteReservationsByLineItemsWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteReservationsByLineItemsWorkflow/index.html.md) +- [deleteReservationsWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteReservationsWorkflow/index.html.md) +- [createReservationsWorkflow](https://docs.medusajs.com/references/medusa-workflows/createReservationsWorkflow/index.html.md) - [updateReservationsWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateReservationsWorkflow/index.html.md) - [createReturnReasonsWorkflow](https://docs.medusajs.com/references/medusa-workflows/createReturnReasonsWorkflow/index.html.md) - [deleteReturnReasonsWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteReturnReasonsWorkflow/index.html.md) - [updateReturnReasonsWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateReturnReasonsWorkflow/index.html.md) -- [createRegionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/createRegionsWorkflow/index.html.md) -- [deleteRegionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteRegionsWorkflow/index.html.md) -- [updateRegionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateRegionsWorkflow/index.html.md) +- [createSalesChannelsWorkflow](https://docs.medusajs.com/references/medusa-workflows/createSalesChannelsWorkflow/index.html.md) - [deleteSalesChannelsWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteSalesChannelsWorkflow/index.html.md) - [linkProductsToSalesChannelWorkflow](https://docs.medusajs.com/references/medusa-workflows/linkProductsToSalesChannelWorkflow/index.html.md) -- [createSalesChannelsWorkflow](https://docs.medusajs.com/references/medusa-workflows/createSalesChannelsWorkflow/index.html.md) - [updateSalesChannelsWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateSalesChannelsWorkflow/index.html.md) -- [createLocationFulfillmentSetWorkflow](https://docs.medusajs.com/references/medusa-workflows/createLocationFulfillmentSetWorkflow/index.html.md) -- [createStockLocationsWorkflow](https://docs.medusajs.com/references/medusa-workflows/createStockLocationsWorkflow/index.html.md) -- [deleteStockLocationsWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteStockLocationsWorkflow/index.html.md) -- [linkSalesChannelsToStockLocationWorkflow](https://docs.medusajs.com/references/medusa-workflows/linkSalesChannelsToStockLocationWorkflow/index.html.md) -- [updateStockLocationsWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateStockLocationsWorkflow/index.html.md) -- [createStoresWorkflow](https://docs.medusajs.com/references/medusa-workflows/createStoresWorkflow/index.html.md) -- [deleteStoresWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteStoresWorkflow/index.html.md) -- [updateStoresWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateStoresWorkflow/index.html.md) - [deleteShippingProfileWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteShippingProfileWorkflow/index.html.md) - [validateStepShippingProfileDelete](https://docs.medusajs.com/references/medusa-workflows/validateStepShippingProfileDelete/index.html.md) +- [createLocationFulfillmentSetWorkflow](https://docs.medusajs.com/references/medusa-workflows/createLocationFulfillmentSetWorkflow/index.html.md) +- [deleteStockLocationsWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteStockLocationsWorkflow/index.html.md) +- [createStockLocationsWorkflow](https://docs.medusajs.com/references/medusa-workflows/createStockLocationsWorkflow/index.html.md) +- [linkSalesChannelsToStockLocationWorkflow](https://docs.medusajs.com/references/medusa-workflows/linkSalesChannelsToStockLocationWorkflow/index.html.md) +- [updateStockLocationsWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateStockLocationsWorkflow/index.html.md) +- [deleteStoresWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteStoresWorkflow/index.html.md) +- [updateStoresWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateStoresWorkflow/index.html.md) +- [createStoresWorkflow](https://docs.medusajs.com/references/medusa-workflows/createStoresWorkflow/index.html.md) - [createUsersWorkflow](https://docs.medusajs.com/references/medusa-workflows/createUsersWorkflow/index.html.md) -- [createUserAccountWorkflow](https://docs.medusajs.com/references/medusa-workflows/createUserAccountWorkflow/index.html.md) - [deleteUsersWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteUsersWorkflow/index.html.md) -- [updateUsersWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateUsersWorkflow/index.html.md) - [removeUserAccountWorkflow](https://docs.medusajs.com/references/medusa-workflows/removeUserAccountWorkflow/index.html.md) +- [createUserAccountWorkflow](https://docs.medusajs.com/references/medusa-workflows/createUserAccountWorkflow/index.html.md) +- [updateUsersWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateUsersWorkflow/index.html.md) - [createTaxRateRulesWorkflow](https://docs.medusajs.com/references/medusa-workflows/createTaxRateRulesWorkflow/index.html.md) - [createTaxRatesWorkflow](https://docs.medusajs.com/references/medusa-workflows/createTaxRatesWorkflow/index.html.md) +- [deleteTaxRatesWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteTaxRatesWorkflow/index.html.md) - [createTaxRegionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/createTaxRegionsWorkflow/index.html.md) - [deleteTaxRateRulesWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteTaxRateRulesWorkflow/index.html.md) -- [deleteTaxRatesWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteTaxRatesWorkflow/index.html.md) - [deleteTaxRegionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/deleteTaxRegionsWorkflow/index.html.md) -- [maybeListTaxRateRuleIdsStep](https://docs.medusajs.com/references/medusa-workflows/maybeListTaxRateRuleIdsStep/index.html.md) -- [setTaxRateRulesWorkflow](https://docs.medusajs.com/references/medusa-workflows/setTaxRateRulesWorkflow/index.html.md) - [updateTaxRatesWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateTaxRatesWorkflow/index.html.md) +- [setTaxRateRulesWorkflow](https://docs.medusajs.com/references/medusa-workflows/setTaxRateRulesWorkflow/index.html.md) +- [maybeListTaxRateRuleIdsStep](https://docs.medusajs.com/references/medusa-workflows/maybeListTaxRateRuleIdsStep/index.html.md) - [updateTaxRegionsWorkflow](https://docs.medusajs.com/references/medusa-workflows/updateTaxRegionsWorkflow/index.html.md) ## Steps +- [setAuthAppMetadataStep](https://docs.medusajs.com/references/medusa-workflows/steps/setAuthAppMetadataStep/index.html.md) - [createApiKeysStep](https://docs.medusajs.com/references/medusa-workflows/steps/createApiKeysStep/index.html.md) - [deleteApiKeysStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteApiKeysStep/index.html.md) -- [linkSalesChannelsToApiKeyStep](https://docs.medusajs.com/references/medusa-workflows/steps/linkSalesChannelsToApiKeyStep/index.html.md) - [revokeApiKeysStep](https://docs.medusajs.com/references/medusa-workflows/steps/revokeApiKeysStep/index.html.md) - [updateApiKeysStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateApiKeysStep/index.html.md) +- [linkSalesChannelsToApiKeyStep](https://docs.medusajs.com/references/medusa-workflows/steps/linkSalesChannelsToApiKeyStep/index.html.md) - [validateSalesChannelsExistStep](https://docs.medusajs.com/references/medusa-workflows/steps/validateSalesChannelsExistStep/index.html.md) -- [createRemoteLinkStep](https://docs.medusajs.com/references/medusa-workflows/steps/createRemoteLinkStep/index.html.md) -- [dismissRemoteLinkStep](https://docs.medusajs.com/references/medusa-workflows/steps/dismissRemoteLinkStep/index.html.md) -- [updateRemoteLinksStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateRemoteLinksStep/index.html.md) -- [emitEventStep](https://docs.medusajs.com/references/medusa-workflows/steps/emitEventStep/index.html.md) -- [removeRemoteLinkStep](https://docs.medusajs.com/references/medusa-workflows/steps/removeRemoteLinkStep/index.html.md) -- [useQueryGraphStep](https://docs.medusajs.com/references/medusa-workflows/steps/useQueryGraphStep/index.html.md) -- [useRemoteQueryStep](https://docs.medusajs.com/references/medusa-workflows/steps/useRemoteQueryStep/index.html.md) -- [validatePresenceOfStep](https://docs.medusajs.com/references/medusa-workflows/steps/validatePresenceOfStep/index.html.md) - [addShippingMethodToCartStep](https://docs.medusajs.com/references/medusa-workflows/steps/addShippingMethodToCartStep/index.html.md) -- [createCartsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createCartsStep/index.html.md) -- [createLineItemAdjustmentsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createLineItemAdjustmentsStep/index.html.md) - [confirmInventoryStep](https://docs.medusajs.com/references/medusa-workflows/steps/confirmInventoryStep/index.html.md) - [createLineItemsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createLineItemsStep/index.html.md) -- [findOneOrAnyRegionStep](https://docs.medusajs.com/references/medusa-workflows/steps/findOneOrAnyRegionStep/index.html.md) +- [createLineItemAdjustmentsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createLineItemAdjustmentsStep/index.html.md) - [createPaymentCollectionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createPaymentCollectionsStep/index.html.md) +- [createCartsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createCartsStep/index.html.md) - [createShippingMethodAdjustmentsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createShippingMethodAdjustmentsStep/index.html.md) - [findOrCreateCustomerStep](https://docs.medusajs.com/references/medusa-workflows/steps/findOrCreateCustomerStep/index.html.md) +- [findOneOrAnyRegionStep](https://docs.medusajs.com/references/medusa-workflows/steps/findOneOrAnyRegionStep/index.html.md) +- [getActionsToComputeFromPromotionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/getActionsToComputeFromPromotionsStep/index.html.md) - [getLineItemActionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/getLineItemActionsStep/index.html.md) - [findSalesChannelStep](https://docs.medusajs.com/references/medusa-workflows/steps/findSalesChannelStep/index.html.md) -- [getActionsToComputeFromPromotionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/getActionsToComputeFromPromotionsStep/index.html.md) +- [getPromotionCodesToApply](https://docs.medusajs.com/references/medusa-workflows/steps/getPromotionCodesToApply/index.html.md) - [getVariantPriceSetsStep](https://docs.medusajs.com/references/medusa-workflows/steps/getVariantPriceSetsStep/index.html.md) - [getVariantsStep](https://docs.medusajs.com/references/medusa-workflows/steps/getVariantsStep/index.html.md) -- [getPromotionCodesToApply](https://docs.medusajs.com/references/medusa-workflows/steps/getPromotionCodesToApply/index.html.md) +- [removeLineItemAdjustmentsStep](https://docs.medusajs.com/references/medusa-workflows/steps/removeLineItemAdjustmentsStep/index.html.md) - [prepareAdjustmentsFromPromotionActionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/prepareAdjustmentsFromPromotionActionsStep/index.html.md) - [removeShippingMethodAdjustmentsStep](https://docs.medusajs.com/references/medusa-workflows/steps/removeShippingMethodAdjustmentsStep/index.html.md) - [removeShippingMethodFromCartStep](https://docs.medusajs.com/references/medusa-workflows/steps/removeShippingMethodFromCartStep/index.html.md) -- [removeLineItemAdjustmentsStep](https://docs.medusajs.com/references/medusa-workflows/steps/removeLineItemAdjustmentsStep/index.html.md) -- [reserveInventoryStep](https://docs.medusajs.com/references/medusa-workflows/steps/reserveInventoryStep/index.html.md) -- [retrieveCartStep](https://docs.medusajs.com/references/medusa-workflows/steps/retrieveCartStep/index.html.md) - [setTaxLinesForItemsStep](https://docs.medusajs.com/references/medusa-workflows/steps/setTaxLinesForItemsStep/index.html.md) +- [retrieveCartStep](https://docs.medusajs.com/references/medusa-workflows/steps/retrieveCartStep/index.html.md) +- [reserveInventoryStep](https://docs.medusajs.com/references/medusa-workflows/steps/reserveInventoryStep/index.html.md) - [updateCartsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateCartsStep/index.html.md) - [updateCartPromotionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateCartPromotionsStep/index.html.md) - [updateLineItemsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateLineItemsStep/index.html.md) @@ -26333,211 +26748,196 @@ Each variant in the retrieved products has a `calculated_price` object. Learn mo - [validateAndReturnShippingMethodsDataStep](https://docs.medusajs.com/references/medusa-workflows/steps/validateAndReturnShippingMethodsDataStep/index.html.md) - [validateCartPaymentsStep](https://docs.medusajs.com/references/medusa-workflows/steps/validateCartPaymentsStep/index.html.md) - [validateCartShippingOptionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/validateCartShippingOptionsStep/index.html.md) -- [validateCartShippingOptionsPriceStep](https://docs.medusajs.com/references/medusa-workflows/steps/validateCartShippingOptionsPriceStep/index.html.md) -- [validateLineItemPricesStep](https://docs.medusajs.com/references/medusa-workflows/steps/validateLineItemPricesStep/index.html.md) - [validateCartStep](https://docs.medusajs.com/references/medusa-workflows/steps/validateCartStep/index.html.md) +- [validateLineItemPricesStep](https://docs.medusajs.com/references/medusa-workflows/steps/validateLineItemPricesStep/index.html.md) +- [validateCartShippingOptionsPriceStep](https://docs.medusajs.com/references/medusa-workflows/steps/validateCartShippingOptionsPriceStep/index.html.md) - [validateShippingStep](https://docs.medusajs.com/references/medusa-workflows/steps/validateShippingStep/index.html.md) - [validateVariantPricesStep](https://docs.medusajs.com/references/medusa-workflows/steps/validateVariantPricesStep/index.html.md) -- [setAuthAppMetadataStep](https://docs.medusajs.com/references/medusa-workflows/steps/setAuthAppMetadataStep/index.html.md) -- [createCustomerAddressesStep](https://docs.medusajs.com/references/medusa-workflows/steps/createCustomerAddressesStep/index.html.md) -- [deleteCustomerAddressesStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteCustomerAddressesStep/index.html.md) - [createCustomersStep](https://docs.medusajs.com/references/medusa-workflows/steps/createCustomersStep/index.html.md) +- [createCustomerAddressesStep](https://docs.medusajs.com/references/medusa-workflows/steps/createCustomerAddressesStep/index.html.md) +- [maybeUnsetDefaultBillingAddressesStep](https://docs.medusajs.com/references/medusa-workflows/steps/maybeUnsetDefaultBillingAddressesStep/index.html.md) - [deleteCustomersStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteCustomersStep/index.html.md) +- [deleteCustomerAddressesStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteCustomerAddressesStep/index.html.md) - [maybeUnsetDefaultShippingAddressesStep](https://docs.medusajs.com/references/medusa-workflows/steps/maybeUnsetDefaultShippingAddressesStep/index.html.md) - [updateCustomerAddressesStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateCustomerAddressesStep/index.html.md) - [updateCustomersStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateCustomersStep/index.html.md) -- [maybeUnsetDefaultBillingAddressesStep](https://docs.medusajs.com/references/medusa-workflows/steps/maybeUnsetDefaultBillingAddressesStep/index.html.md) - [validateCustomerAccountCreation](https://docs.medusajs.com/references/medusa-workflows/steps/validateCustomerAccountCreation/index.html.md) -- [calculateShippingOptionsPricesStep](https://docs.medusajs.com/references/medusa-workflows/steps/calculateShippingOptionsPricesStep/index.html.md) +- [dismissRemoteLinkStep](https://docs.medusajs.com/references/medusa-workflows/steps/dismissRemoteLinkStep/index.html.md) +- [emitEventStep](https://docs.medusajs.com/references/medusa-workflows/steps/emitEventStep/index.html.md) +- [createRemoteLinkStep](https://docs.medusajs.com/references/medusa-workflows/steps/createRemoteLinkStep/index.html.md) +- [removeRemoteLinkStep](https://docs.medusajs.com/references/medusa-workflows/steps/removeRemoteLinkStep/index.html.md) +- [updateRemoteLinksStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateRemoteLinksStep/index.html.md) +- [useQueryGraphStep](https://docs.medusajs.com/references/medusa-workflows/steps/useQueryGraphStep/index.html.md) +- [useRemoteQueryStep](https://docs.medusajs.com/references/medusa-workflows/steps/useRemoteQueryStep/index.html.md) +- [validatePresenceOfStep](https://docs.medusajs.com/references/medusa-workflows/steps/validatePresenceOfStep/index.html.md) +- [createDefaultStoreStep](https://docs.medusajs.com/references/medusa-workflows/steps/createDefaultStoreStep/index.html.md) +- [deleteFilesStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteFilesStep/index.html.md) +- [uploadFilesStep](https://docs.medusajs.com/references/medusa-workflows/steps/uploadFilesStep/index.html.md) - [buildPriceSet](https://docs.medusajs.com/references/medusa-workflows/steps/buildPriceSet/index.html.md) - [cancelFulfillmentStep](https://docs.medusajs.com/references/medusa-workflows/steps/cancelFulfillmentStep/index.html.md) +- [calculateShippingOptionsPricesStep](https://docs.medusajs.com/references/medusa-workflows/steps/calculateShippingOptionsPricesStep/index.html.md) - [createFulfillmentSets](https://docs.medusajs.com/references/medusa-workflows/steps/createFulfillmentSets/index.html.md) - [createReturnFulfillmentStep](https://docs.medusajs.com/references/medusa-workflows/steps/createReturnFulfillmentStep/index.html.md) -- [createFulfillmentStep](https://docs.medusajs.com/references/medusa-workflows/steps/createFulfillmentStep/index.html.md) - [createServiceZonesStep](https://docs.medusajs.com/references/medusa-workflows/steps/createServiceZonesStep/index.html.md) - [createShippingOptionRulesStep](https://docs.medusajs.com/references/medusa-workflows/steps/createShippingOptionRulesStep/index.html.md) -- [createShippingOptionsPriceSetsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createShippingOptionsPriceSetsStep/index.html.md) +- [createFulfillmentStep](https://docs.medusajs.com/references/medusa-workflows/steps/createFulfillmentStep/index.html.md) - [createShippingProfilesStep](https://docs.medusajs.com/references/medusa-workflows/steps/createShippingProfilesStep/index.html.md) +- [createShippingOptionsPriceSetsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createShippingOptionsPriceSetsStep/index.html.md) +- [deleteFulfillmentSetsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteFulfillmentSetsStep/index.html.md) - [deleteServiceZonesStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteServiceZonesStep/index.html.md) - [deleteShippingOptionRulesStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteShippingOptionRulesStep/index.html.md) - [deleteShippingOptionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteShippingOptionsStep/index.html.md) -- [deleteFulfillmentSetsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteFulfillmentSetsStep/index.html.md) - [setShippingOptionsPricesStep](https://docs.medusajs.com/references/medusa-workflows/steps/setShippingOptionsPricesStep/index.html.md) -- [updateServiceZonesStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateServiceZonesStep/index.html.md) - [updateFulfillmentStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateFulfillmentStep/index.html.md) - [updateShippingOptionRulesStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateShippingOptionRulesStep/index.html.md) -- [validateShipmentStep](https://docs.medusajs.com/references/medusa-workflows/steps/validateShipmentStep/index.html.md) -- [upsertShippingOptionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/upsertShippingOptionsStep/index.html.md) - [updateShippingProfilesStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateShippingProfilesStep/index.html.md) +- [updateServiceZonesStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateServiceZonesStep/index.html.md) +- [upsertShippingOptionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/upsertShippingOptionsStep/index.html.md) - [validateShippingOptionPricesStep](https://docs.medusajs.com/references/medusa-workflows/steps/validateShippingOptionPricesStep/index.html.md) -- [adjustInventoryLevelsStep](https://docs.medusajs.com/references/medusa-workflows/steps/adjustInventoryLevelsStep/index.html.md) -- [attachInventoryItemToVariants](https://docs.medusajs.com/references/medusa-workflows/steps/attachInventoryItemToVariants/index.html.md) -- [deleteInventoryItemStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteInventoryItemStep/index.html.md) -- [createInventoryItemsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createInventoryItemsStep/index.html.md) -- [createInventoryLevelsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createInventoryLevelsStep/index.html.md) -- [deleteInventoryLevelsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteInventoryLevelsStep/index.html.md) -- [validateInventoryDeleteStep](https://docs.medusajs.com/references/medusa-workflows/steps/validateInventoryDeleteStep/index.html.md) -- [updateInventoryLevelsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateInventoryLevelsStep/index.html.md) -- [validateInventoryItemsForCreate](https://docs.medusajs.com/references/medusa-workflows/steps/validateInventoryItemsForCreate/index.html.md) -- [updateInventoryItemsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateInventoryItemsStep/index.html.md) -- [validateInventoryLocationsStep](https://docs.medusajs.com/references/medusa-workflows/steps/validateInventoryLocationsStep/index.html.md) -- [deleteFilesStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteFilesStep/index.html.md) -- [uploadFilesStep](https://docs.medusajs.com/references/medusa-workflows/steps/uploadFilesStep/index.html.md) +- [validateShipmentStep](https://docs.medusajs.com/references/medusa-workflows/steps/validateShipmentStep/index.html.md) - [createCustomerGroupsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createCustomerGroupsStep/index.html.md) -- [deleteCustomerGroupStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteCustomerGroupStep/index.html.md) - [linkCustomerGroupsToCustomerStep](https://docs.medusajs.com/references/medusa-workflows/steps/linkCustomerGroupsToCustomerStep/index.html.md) - [linkCustomersToCustomerGroupStep](https://docs.medusajs.com/references/medusa-workflows/steps/linkCustomersToCustomerGroupStep/index.html.md) +- [deleteCustomerGroupStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteCustomerGroupStep/index.html.md) - [updateCustomerGroupsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateCustomerGroupsStep/index.html.md) -- [createDefaultStoreStep](https://docs.medusajs.com/references/medusa-workflows/steps/createDefaultStoreStep/index.html.md) +- [attachInventoryItemToVariants](https://docs.medusajs.com/references/medusa-workflows/steps/attachInventoryItemToVariants/index.html.md) +- [createInventoryItemsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createInventoryItemsStep/index.html.md) +- [adjustInventoryLevelsStep](https://docs.medusajs.com/references/medusa-workflows/steps/adjustInventoryLevelsStep/index.html.md) +- [deleteInventoryItemStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteInventoryItemStep/index.html.md) +- [updateInventoryItemsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateInventoryItemsStep/index.html.md) +- [createInventoryLevelsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createInventoryLevelsStep/index.html.md) +- [updateInventoryLevelsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateInventoryLevelsStep/index.html.md) +- [deleteInventoryLevelsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteInventoryLevelsStep/index.html.md) +- [validateInventoryDeleteStep](https://docs.medusajs.com/references/medusa-workflows/steps/validateInventoryDeleteStep/index.html.md) +- [validateInventoryItemsForCreate](https://docs.medusajs.com/references/medusa-workflows/steps/validateInventoryItemsForCreate/index.html.md) +- [validateInventoryLocationsStep](https://docs.medusajs.com/references/medusa-workflows/steps/validateInventoryLocationsStep/index.html.md) +- [deleteInvitesStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteInvitesStep/index.html.md) - [createInviteStep](https://docs.medusajs.com/references/medusa-workflows/steps/createInviteStep/index.html.md) - [refreshInviteTokensStep](https://docs.medusajs.com/references/medusa-workflows/steps/refreshInviteTokensStep/index.html.md) - [validateTokenStep](https://docs.medusajs.com/references/medusa-workflows/steps/validateTokenStep/index.html.md) -- [deleteInvitesStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteInvitesStep/index.html.md) +- [deleteLineItemsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteLineItemsStep/index.html.md) +- [updateLineItemsStepWithSelector](https://docs.medusajs.com/references/medusa-workflows/steps/updateLineItemsStepWithSelector/index.html.md) +- [listLineItemsStep](https://docs.medusajs.com/references/medusa-workflows/steps/listLineItemsStep/index.html.md) +- [notifyOnFailureStep](https://docs.medusajs.com/references/medusa-workflows/steps/notifyOnFailureStep/index.html.md) +- [sendNotificationsStep](https://docs.medusajs.com/references/medusa-workflows/steps/sendNotificationsStep/index.html.md) - [capturePaymentStep](https://docs.medusajs.com/references/medusa-workflows/steps/capturePaymentStep/index.html.md) - [cancelPaymentStep](https://docs.medusajs.com/references/medusa-workflows/steps/cancelPaymentStep/index.html.md) - [authorizePaymentSessionStep](https://docs.medusajs.com/references/medusa-workflows/steps/authorizePaymentSessionStep/index.html.md) - [refundPaymentStep](https://docs.medusajs.com/references/medusa-workflows/steps/refundPaymentStep/index.html.md) - [refundPaymentsStep](https://docs.medusajs.com/references/medusa-workflows/steps/refundPaymentsStep/index.html.md) -- [createPaymentAccountHolderStep](https://docs.medusajs.com/references/medusa-workflows/steps/createPaymentAccountHolderStep/index.html.md) -- [deletePaymentSessionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deletePaymentSessionsStep/index.html.md) -- [createPaymentSessionStep](https://docs.medusajs.com/references/medusa-workflows/steps/createPaymentSessionStep/index.html.md) -- [createRefundReasonStep](https://docs.medusajs.com/references/medusa-workflows/steps/createRefundReasonStep/index.html.md) -- [deleteRefundReasonsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteRefundReasonsStep/index.html.md) -- [updatePaymentCollectionStep](https://docs.medusajs.com/references/medusa-workflows/steps/updatePaymentCollectionStep/index.html.md) -- [validateDeletedPaymentSessionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/validateDeletedPaymentSessionsStep/index.html.md) -- [updateRefundReasonsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateRefundReasonsStep/index.html.md) - [createPriceListPricesStep](https://docs.medusajs.com/references/medusa-workflows/steps/createPriceListPricesStep/index.html.md) - [deletePriceListsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deletePriceListsStep/index.html.md) - [createPriceListsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createPriceListsStep/index.html.md) - [getExistingPriceListsPriceIdsStep](https://docs.medusajs.com/references/medusa-workflows/steps/getExistingPriceListsPriceIdsStep/index.html.md) - [removePriceListPricesStep](https://docs.medusajs.com/references/medusa-workflows/steps/removePriceListPricesStep/index.html.md) +- [updatePriceListPricesStep](https://docs.medusajs.com/references/medusa-workflows/steps/updatePriceListPricesStep/index.html.md) - [updatePriceListsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updatePriceListsStep/index.html.md) - [validatePriceListsStep](https://docs.medusajs.com/references/medusa-workflows/steps/validatePriceListsStep/index.html.md) -- [updatePriceListPricesStep](https://docs.medusajs.com/references/medusa-workflows/steps/updatePriceListPricesStep/index.html.md) - [validateVariantPriceLinksStep](https://docs.medusajs.com/references/medusa-workflows/steps/validateVariantPriceLinksStep/index.html.md) +- [addOrderTransactionStep](https://docs.medusajs.com/references/medusa-workflows/steps/addOrderTransactionStep/index.html.md) +- [cancelOrderChangeStep](https://docs.medusajs.com/references/medusa-workflows/steps/cancelOrderChangeStep/index.html.md) +- [archiveOrdersStep](https://docs.medusajs.com/references/medusa-workflows/steps/archiveOrdersStep/index.html.md) +- [cancelOrderClaimStep](https://docs.medusajs.com/references/medusa-workflows/steps/cancelOrderClaimStep/index.html.md) +- [cancelOrderFulfillmentStep](https://docs.medusajs.com/references/medusa-workflows/steps/cancelOrderFulfillmentStep/index.html.md) +- [cancelOrdersStep](https://docs.medusajs.com/references/medusa-workflows/steps/cancelOrdersStep/index.html.md) +- [cancelOrderReturnStep](https://docs.medusajs.com/references/medusa-workflows/steps/cancelOrderReturnStep/index.html.md) +- [cancelOrderExchangeStep](https://docs.medusajs.com/references/medusa-workflows/steps/cancelOrderExchangeStep/index.html.md) +- [createCompleteReturnStep](https://docs.medusajs.com/references/medusa-workflows/steps/createCompleteReturnStep/index.html.md) +- [createOrderChangeStep](https://docs.medusajs.com/references/medusa-workflows/steps/createOrderChangeStep/index.html.md) +- [completeOrdersStep](https://docs.medusajs.com/references/medusa-workflows/steps/completeOrdersStep/index.html.md) +- [createOrderExchangeItemsFromActionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createOrderExchangeItemsFromActionsStep/index.html.md) +- [createOrderClaimItemsFromActionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createOrderClaimItemsFromActionsStep/index.html.md) +- [createOrderExchangesStep](https://docs.medusajs.com/references/medusa-workflows/steps/createOrderExchangesStep/index.html.md) +- [createOrderClaimsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createOrderClaimsStep/index.html.md) +- [createOrderLineItemsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createOrderLineItemsStep/index.html.md) +- [createOrdersStep](https://docs.medusajs.com/references/medusa-workflows/steps/createOrdersStep/index.html.md) +- [createReturnsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createReturnsStep/index.html.md) +- [deleteClaimsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteClaimsStep/index.html.md) +- [declineOrderChangeStep](https://docs.medusajs.com/references/medusa-workflows/steps/declineOrderChangeStep/index.html.md) +- [deleteExchangesStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteExchangesStep/index.html.md) +- [deleteOrderChangeActionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteOrderChangeActionsStep/index.html.md) +- [deleteOrderShippingMethods](https://docs.medusajs.com/references/medusa-workflows/steps/deleteOrderShippingMethods/index.html.md) +- [deleteOrderChangesStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteOrderChangesStep/index.html.md) +- [deleteOrderLineItems](https://docs.medusajs.com/references/medusa-workflows/steps/deleteOrderLineItems/index.html.md) +- [deleteReturnsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteReturnsStep/index.html.md) +- [registerOrderChangesStep](https://docs.medusajs.com/references/medusa-workflows/steps/registerOrderChangesStep/index.html.md) +- [previewOrderChangeStep](https://docs.medusajs.com/references/medusa-workflows/steps/previewOrderChangeStep/index.html.md) +- [registerOrderFulfillmentStep](https://docs.medusajs.com/references/medusa-workflows/steps/registerOrderFulfillmentStep/index.html.md) +- [registerOrderShipmentStep](https://docs.medusajs.com/references/medusa-workflows/steps/registerOrderShipmentStep/index.html.md) +- [updateOrderChangeActionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateOrderChangeActionsStep/index.html.md) +- [setOrderTaxLinesForItemsStep](https://docs.medusajs.com/references/medusa-workflows/steps/setOrderTaxLinesForItemsStep/index.html.md) +- [updateOrderChangesStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateOrderChangesStep/index.html.md) +- [updateReturnItemsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateReturnItemsStep/index.html.md) +- [updateOrdersStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateOrdersStep/index.html.md) +- [updateOrderShippingMethodsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateOrderShippingMethodsStep/index.html.md) +- [updateReturnsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateReturnsStep/index.html.md) - [createPricePreferencesStep](https://docs.medusajs.com/references/medusa-workflows/steps/createPricePreferencesStep/index.html.md) - [createPriceSetsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createPriceSetsStep/index.html.md) -- [deletePricePreferencesStep](https://docs.medusajs.com/references/medusa-workflows/steps/deletePricePreferencesStep/index.html.md) - [updatePricePreferencesAsArrayStep](https://docs.medusajs.com/references/medusa-workflows/steps/updatePricePreferencesAsArrayStep/index.html.md) +- [deletePricePreferencesStep](https://docs.medusajs.com/references/medusa-workflows/steps/deletePricePreferencesStep/index.html.md) - [updatePricePreferencesStep](https://docs.medusajs.com/references/medusa-workflows/steps/updatePricePreferencesStep/index.html.md) - [updatePriceSetsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updatePriceSetsStep/index.html.md) -- [listLineItemsStep](https://docs.medusajs.com/references/medusa-workflows/steps/listLineItemsStep/index.html.md) -- [deleteLineItemsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteLineItemsStep/index.html.md) -- [updateLineItemsStepWithSelector](https://docs.medusajs.com/references/medusa-workflows/steps/updateLineItemsStepWithSelector/index.html.md) +- [batchLinkProductsToCategoryStep](https://docs.medusajs.com/references/medusa-workflows/steps/batchLinkProductsToCategoryStep/index.html.md) +- [batchLinkProductsToCollectionStep](https://docs.medusajs.com/references/medusa-workflows/steps/batchLinkProductsToCollectionStep/index.html.md) +- [createCollectionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createCollectionsStep/index.html.md) +- [createProductOptionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createProductOptionsStep/index.html.md) +- [createProductTagsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createProductTagsStep/index.html.md) +- [createProductTypesStep](https://docs.medusajs.com/references/medusa-workflows/steps/createProductTypesStep/index.html.md) +- [createProductsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createProductsStep/index.html.md) +- [createProductVariantsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createProductVariantsStep/index.html.md) +- [createVariantPricingLinkStep](https://docs.medusajs.com/references/medusa-workflows/steps/createVariantPricingLinkStep/index.html.md) +- [deleteCollectionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteCollectionsStep/index.html.md) +- [deleteProductOptionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteProductOptionsStep/index.html.md) +- [deleteProductTagsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteProductTagsStep/index.html.md) +- [deleteProductTypesStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteProductTypesStep/index.html.md) +- [deleteProductsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteProductsStep/index.html.md) +- [generateProductCsvStep](https://docs.medusajs.com/references/medusa-workflows/steps/generateProductCsvStep/index.html.md) +- [getAllProductsStep](https://docs.medusajs.com/references/medusa-workflows/steps/getAllProductsStep/index.html.md) +- [getProductsStep](https://docs.medusajs.com/references/medusa-workflows/steps/getProductsStep/index.html.md) +- [getVariantAvailabilityStep](https://docs.medusajs.com/references/medusa-workflows/steps/getVariantAvailabilityStep/index.html.md) +- [deleteProductVariantsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteProductVariantsStep/index.html.md) +- [groupProductsForBatchStep](https://docs.medusajs.com/references/medusa-workflows/steps/groupProductsForBatchStep/index.html.md) +- [parseProductCsvStep](https://docs.medusajs.com/references/medusa-workflows/steps/parseProductCsvStep/index.html.md) +- [updateCollectionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateCollectionsStep/index.html.md) +- [updateProductOptionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateProductOptionsStep/index.html.md) +- [updateProductTagsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateProductTagsStep/index.html.md) +- [updateProductVariantsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateProductVariantsStep/index.html.md) +- [updateProductTypesStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateProductTypesStep/index.html.md) +- [waitConfirmationProductImportStep](https://docs.medusajs.com/references/medusa-workflows/steps/waitConfirmationProductImportStep/index.html.md) +- [updateProductsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateProductsStep/index.html.md) - [deleteProductCategoriesStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteProductCategoriesStep/index.html.md) - [createProductCategoriesStep](https://docs.medusajs.com/references/medusa-workflows/steps/createProductCategoriesStep/index.html.md) - [updateProductCategoriesStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateProductCategoriesStep/index.html.md) - [addCampaignPromotionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/addCampaignPromotionsStep/index.html.md) - [addRulesToPromotionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/addRulesToPromotionsStep/index.html.md) -- [createCampaignsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createCampaignsStep/index.html.md) - [createPromotionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createPromotionsStep/index.html.md) +- [createCampaignsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createCampaignsStep/index.html.md) - [deleteCampaignsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteCampaignsStep/index.html.md) - [deletePromotionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deletePromotionsStep/index.html.md) - [removeCampaignPromotionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/removeCampaignPromotionsStep/index.html.md) -- [updatePromotionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updatePromotionsStep/index.html.md) -- [addOrderTransactionStep](https://docs.medusajs.com/references/medusa-workflows/steps/addOrderTransactionStep/index.html.md) -- [archiveOrdersStep](https://docs.medusajs.com/references/medusa-workflows/steps/archiveOrdersStep/index.html.md) -- [cancelOrderChangeStep](https://docs.medusajs.com/references/medusa-workflows/steps/cancelOrderChangeStep/index.html.md) -- [cancelOrderClaimStep](https://docs.medusajs.com/references/medusa-workflows/steps/cancelOrderClaimStep/index.html.md) -- [cancelOrderExchangeStep](https://docs.medusajs.com/references/medusa-workflows/steps/cancelOrderExchangeStep/index.html.md) -- [updateCampaignsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateCampaignsStep/index.html.md) - [removeRulesFromPromotionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/removeRulesFromPromotionsStep/index.html.md) -- [cancelOrderFulfillmentStep](https://docs.medusajs.com/references/medusa-workflows/steps/cancelOrderFulfillmentStep/index.html.md) -- [cancelOrderReturnStep](https://docs.medusajs.com/references/medusa-workflows/steps/cancelOrderReturnStep/index.html.md) +- [updateCampaignsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateCampaignsStep/index.html.md) - [updatePromotionRulesStep](https://docs.medusajs.com/references/medusa-workflows/steps/updatePromotionRulesStep/index.html.md) -- [cancelOrdersStep](https://docs.medusajs.com/references/medusa-workflows/steps/cancelOrdersStep/index.html.md) -- [completeOrdersStep](https://docs.medusajs.com/references/medusa-workflows/steps/completeOrdersStep/index.html.md) -- [createCompleteReturnStep](https://docs.medusajs.com/references/medusa-workflows/steps/createCompleteReturnStep/index.html.md) -- [createOrderChangeStep](https://docs.medusajs.com/references/medusa-workflows/steps/createOrderChangeStep/index.html.md) -- [createOrderClaimItemsFromActionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createOrderClaimItemsFromActionsStep/index.html.md) -- [createOrderClaimsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createOrderClaimsStep/index.html.md) -- [createOrderExchangeItemsFromActionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createOrderExchangeItemsFromActionsStep/index.html.md) -- [createOrderExchangesStep](https://docs.medusajs.com/references/medusa-workflows/steps/createOrderExchangesStep/index.html.md) -- [createOrderLineItemsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createOrderLineItemsStep/index.html.md) -- [createReturnsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createReturnsStep/index.html.md) -- [declineOrderChangeStep](https://docs.medusajs.com/references/medusa-workflows/steps/declineOrderChangeStep/index.html.md) -- [createOrdersStep](https://docs.medusajs.com/references/medusa-workflows/steps/createOrdersStep/index.html.md) -- [deleteClaimsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteClaimsStep/index.html.md) -- [deleteExchangesStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteExchangesStep/index.html.md) -- [deleteOrderChangesStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteOrderChangesStep/index.html.md) -- [deleteOrderChangeActionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteOrderChangeActionsStep/index.html.md) -- [deleteOrderLineItems](https://docs.medusajs.com/references/medusa-workflows/steps/deleteOrderLineItems/index.html.md) -- [deleteOrderShippingMethods](https://docs.medusajs.com/references/medusa-workflows/steps/deleteOrderShippingMethods/index.html.md) -- [deleteReturnsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteReturnsStep/index.html.md) -- [previewOrderChangeStep](https://docs.medusajs.com/references/medusa-workflows/steps/previewOrderChangeStep/index.html.md) -- [registerOrderChangesStep](https://docs.medusajs.com/references/medusa-workflows/steps/registerOrderChangesStep/index.html.md) -- [registerOrderShipmentStep](https://docs.medusajs.com/references/medusa-workflows/steps/registerOrderShipmentStep/index.html.md) -- [setOrderTaxLinesForItemsStep](https://docs.medusajs.com/references/medusa-workflows/steps/setOrderTaxLinesForItemsStep/index.html.md) -- [updateOrderChangeActionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateOrderChangeActionsStep/index.html.md) -- [registerOrderFulfillmentStep](https://docs.medusajs.com/references/medusa-workflows/steps/registerOrderFulfillmentStep/index.html.md) -- [updateOrderChangesStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateOrderChangesStep/index.html.md) -- [updateOrderShippingMethodsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateOrderShippingMethodsStep/index.html.md) -- [updateOrdersStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateOrdersStep/index.html.md) -- [updateReturnItemsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateReturnItemsStep/index.html.md) -- [updateReturnsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateReturnsStep/index.html.md) -- [notifyOnFailureStep](https://docs.medusajs.com/references/medusa-workflows/steps/notifyOnFailureStep/index.html.md) -- [sendNotificationsStep](https://docs.medusajs.com/references/medusa-workflows/steps/sendNotificationsStep/index.html.md) -- [batchLinkProductsToCategoryStep](https://docs.medusajs.com/references/medusa-workflows/steps/batchLinkProductsToCategoryStep/index.html.md) -- [createCollectionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createCollectionsStep/index.html.md) -- [batchLinkProductsToCollectionStep](https://docs.medusajs.com/references/medusa-workflows/steps/batchLinkProductsToCollectionStep/index.html.md) -- [createProductTagsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createProductTagsStep/index.html.md) -- [createProductVariantsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createProductVariantsStep/index.html.md) -- [createProductOptionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createProductOptionsStep/index.html.md) -- [createProductTypesStep](https://docs.medusajs.com/references/medusa-workflows/steps/createProductTypesStep/index.html.md) -- [createProductsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createProductsStep/index.html.md) -- [createVariantPricingLinkStep](https://docs.medusajs.com/references/medusa-workflows/steps/createVariantPricingLinkStep/index.html.md) -- [deleteProductOptionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteProductOptionsStep/index.html.md) -- [deleteCollectionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteCollectionsStep/index.html.md) -- [deleteProductTagsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteProductTagsStep/index.html.md) -- [deleteProductVariantsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteProductVariantsStep/index.html.md) -- [deleteProductsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteProductsStep/index.html.md) -- [generateProductCsvStep](https://docs.medusajs.com/references/medusa-workflows/steps/generateProductCsvStep/index.html.md) -- [deleteProductTypesStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteProductTypesStep/index.html.md) -- [getAllProductsStep](https://docs.medusajs.com/references/medusa-workflows/steps/getAllProductsStep/index.html.md) -- [getProductsStep](https://docs.medusajs.com/references/medusa-workflows/steps/getProductsStep/index.html.md) -- [groupProductsForBatchStep](https://docs.medusajs.com/references/medusa-workflows/steps/groupProductsForBatchStep/index.html.md) -- [getVariantAvailabilityStep](https://docs.medusajs.com/references/medusa-workflows/steps/getVariantAvailabilityStep/index.html.md) -- [parseProductCsvStep](https://docs.medusajs.com/references/medusa-workflows/steps/parseProductCsvStep/index.html.md) -- [updateCollectionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateCollectionsStep/index.html.md) -- [updateProductOptionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateProductOptionsStep/index.html.md) -- [updateProductTagsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateProductTagsStep/index.html.md) -- [updateProductTypesStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateProductTypesStep/index.html.md) -- [updateProductVariantsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateProductVariantsStep/index.html.md) -- [updateProductsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateProductsStep/index.html.md) -- [waitConfirmationProductImportStep](https://docs.medusajs.com/references/medusa-workflows/steps/waitConfirmationProductImportStep/index.html.md) +- [updatePromotionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updatePromotionsStep/index.html.md) - [createRegionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createRegionsStep/index.html.md) - [deleteRegionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteRegionsStep/index.html.md) - [setRegionsPaymentProvidersStep](https://docs.medusajs.com/references/medusa-workflows/steps/setRegionsPaymentProvidersStep/index.html.md) - [updateRegionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateRegionsStep/index.html.md) -- [deleteReturnReasonStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteReturnReasonStep/index.html.md) -- [createReturnReasonsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createReturnReasonsStep/index.html.md) -- [updateReturnReasonsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateReturnReasonsStep/index.html.md) -- [deleteStockLocationsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteStockLocationsStep/index.html.md) -- [createStockLocations](https://docs.medusajs.com/references/medusa-workflows/steps/createStockLocations/index.html.md) -- [updateStockLocationsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateStockLocationsStep/index.html.md) - [createReservationsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createReservationsStep/index.html.md) - [deleteReservationsByLineItemsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteReservationsByLineItemsStep/index.html.md) - [deleteReservationsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteReservationsStep/index.html.md) - [updateReservationsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateReservationsStep/index.html.md) -- [createStoresStep](https://docs.medusajs.com/references/medusa-workflows/steps/createStoresStep/index.html.md) -- [deleteStoresStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteStoresStep/index.html.md) -- [updateStoresStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateStoresStep/index.html.md) -- [deleteTaxRateRulesStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteTaxRateRulesStep/index.html.md) -- [createTaxRateRulesStep](https://docs.medusajs.com/references/medusa-workflows/steps/createTaxRateRulesStep/index.html.md) -- [createTaxRatesStep](https://docs.medusajs.com/references/medusa-workflows/steps/createTaxRatesStep/index.html.md) -- [createTaxRegionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createTaxRegionsStep/index.html.md) -- [deleteTaxRatesStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteTaxRatesStep/index.html.md) -- [deleteTaxRegionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteTaxRegionsStep/index.html.md) -- [listTaxRateIdsStep](https://docs.medusajs.com/references/medusa-workflows/steps/listTaxRateIdsStep/index.html.md) -- [listTaxRateRuleIdsStep](https://docs.medusajs.com/references/medusa-workflows/steps/listTaxRateRuleIdsStep/index.html.md) -- [getItemTaxLinesStep](https://docs.medusajs.com/references/medusa-workflows/steps/getItemTaxLinesStep/index.html.md) -- [updateTaxRatesStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateTaxRatesStep/index.html.md) -- [updateTaxRegionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateTaxRegionsStep/index.html.md) -- [createUsersStep](https://docs.medusajs.com/references/medusa-workflows/steps/createUsersStep/index.html.md) -- [deleteUsersStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteUsersStep/index.html.md) -- [updateUsersStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateUsersStep/index.html.md) -- [deleteShippingProfilesStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteShippingProfilesStep/index.html.md) -- [listShippingOptionsForContextStep](https://docs.medusajs.com/references/medusa-workflows/steps/listShippingOptionsForContextStep/index.html.md) +- [createRefundReasonStep](https://docs.medusajs.com/references/medusa-workflows/steps/createRefundReasonStep/index.html.md) +- [createPaymentAccountHolderStep](https://docs.medusajs.com/references/medusa-workflows/steps/createPaymentAccountHolderStep/index.html.md) +- [createPaymentSessionStep](https://docs.medusajs.com/references/medusa-workflows/steps/createPaymentSessionStep/index.html.md) +- [deletePaymentSessionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deletePaymentSessionsStep/index.html.md) +- [updateRefundReasonsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateRefundReasonsStep/index.html.md) +- [updatePaymentCollectionStep](https://docs.medusajs.com/references/medusa-workflows/steps/updatePaymentCollectionStep/index.html.md) +- [deleteRefundReasonsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteRefundReasonsStep/index.html.md) +- [validateDeletedPaymentSessionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/validateDeletedPaymentSessionsStep/index.html.md) +- [createReturnReasonsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createReturnReasonsStep/index.html.md) +- [updateReturnReasonsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateReturnReasonsStep/index.html.md) +- [deleteReturnReasonStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteReturnReasonStep/index.html.md) - [associateLocationsWithSalesChannelsStep](https://docs.medusajs.com/references/medusa-workflows/steps/associateLocationsWithSalesChannelsStep/index.html.md) - [associateProductsWithSalesChannelsStep](https://docs.medusajs.com/references/medusa-workflows/steps/associateProductsWithSalesChannelsStep/index.html.md) - [canDeleteSalesChannelsOrThrowStep](https://docs.medusajs.com/references/medusa-workflows/steps/canDeleteSalesChannelsOrThrowStep/index.html.md) @@ -26547,403 +26947,28 @@ Each variant in the retrieved products has a `calculated_price` object. Learn mo - [detachLocationsFromSalesChannelsStep](https://docs.medusajs.com/references/medusa-workflows/steps/detachLocationsFromSalesChannelsStep/index.html.md) - [detachProductsFromSalesChannelsStep](https://docs.medusajs.com/references/medusa-workflows/steps/detachProductsFromSalesChannelsStep/index.html.md) - [updateSalesChannelsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateSalesChannelsStep/index.html.md) - - -# Medusa CLI Reference - -The Medusa CLI tool provides commands that facilitate your development. - -### Prerequisites - -- [Node.js v20+](https://nodejs.org/en/download) -- [Git CLI tool](https://git-scm.com/downloads) -- [PostgreSQL](https://www.postgresql.org/download/) - -## Usage - -In your Medusa application's directory, you can use the Medusa CLI tool using NPX. - -For example: - -```bash -npx medusa --help -``` - -*** - - -# db Commands - Medusa CLI Reference - -Commands starting with `db:` perform actions on the database. - -## db:setup - -Creates a database for the Medusa application with the specified name, if it doesn't exit. Then, it runs migrations and syncs links. - -It also updates your `.env` file with the database name. - -```bash -npx medusa db:setup --db -``` - -Use this command if you're setting up a Medusa project or database manually. - -### Options - -|Option|Description|Required|Default| -|---|---|---|---|---|---|---| -|\`--db \\`|The database name.|Yes|-| -|\`--skip-links\`|Skip syncing links to the database.|No|Links are synced by default.| -|\`--execute-safe-links\`|Skip prompts when syncing links and execute only safe actions.|No|Prompts are shown for unsafe actions, by default.| -|\`--execute-all-links\`|Skip prompts when syncing links and execute all (including unsafe) actions.|No|Prompts are shown for unsafe actions, by default.| -|\`--no-interactive\`|Disable the command's prompts.|No|-| - -*** - -## db:create - -Creates a database for the Medusa application with the specified name, if it doesn't exit. - -It also updates your `.env` file with the database name. - -```bash -npx medusa db:create --db -``` - -Use this command if you want to only create a database. - -### Options - -|Option|Description|Required|Default| -|---|---|---|---|---|---|---| -|\`--db \\`|The database name.|Yes|-| -|\`--no-interactive\`|Disable the command's prompts.|No|-| - -*** - -## db:generate - -Generate a migration file for the latest changes in one or more modules. - -```bash -npx medusa db:generate -``` - -### Arguments - -|Argument|Description|Required| -|---|---|---|---|---| -|\`module\_names\`|The name of one or more module (separated by spaces) to generate migrations for. For example, |Yes| - -*** - -## db:migrate - -Run the latest migrations to reflect changes on the database, sync link definitions with the database, and run migration data scripts. - -```bash -npx medusa db:migrate -``` - -Use this command if you've updated the Medusa packages, or you've created customizations and want to reflect them in the database. - -### Options - -|Option|Description|Required|Default| -|---|---|---|---|---|---|---| -|\`--skip-links\`|Skip syncing links to the database.|No|Links are synced by default.| -|\`--skip-scripts\`|Skip running data migration scripts. This option is added starting from -|No|Data migration scripts are run by default starting from -| -|\`--execute-safe-links\`|Skip prompts when syncing links and execute only safe actions.|No|Prompts are shown for unsafe actions, by default.| -|\`--execute-all-links\`|Skip prompts when syncing links and execute all (including unsafe) actions.|No|Prompts are shown for unsafe actions, by default.| - -*** - -## db:rollback - -Revert the last migrations ran on one or more modules. - -```bash -npx medusa db:rollback -``` - -### Arguments - -|Argument|Description|Required| -|---|---|---|---|---| -|\`module\_names\`|The name of one or more module (separated by spaces) to rollback their migrations for. For example, |Yes| - -*** - -## db:sync-links - -Sync the database with the link definitions in your application, including the definitions in Medusa's modules. - -```bash -npx medusa db:sync-links -``` - -### Options - -|Option|Description|Required|Default| -|---|---|---|---|---|---|---| -|\`--execute-safe\`|Skip prompts when syncing links and execute only safe actions.|No|Prompts are shown for unsafe actions, by default.| -|\`--execute-all\`|Skip prompts when syncing links and execute all (including unsafe) actions.|No|Prompts are shown for unsafe actions, by default.| - - -# develop Command - Medusa CLI Reference - -Start Medusa application in development. This command watches files for any changes, then rebuilds the files and restarts the Medusa application. - -```bash -npx medusa develop -``` - -## Options - -|Option|Description|Default| -|---|---|---|---|---| -|\`-H \\`|Set host of the Medusa server.|\`localhost\`| -|\`-p \\`|Set port of the Medusa server.|\`9000\`| - - -# build Command - Medusa CLI Reference - -Create a standalone build of the Medusa application. - -This creates a build that: - -- Doesn't rely on the source TypeScript files. -- Can be copied to a production server reliably. - -The build is outputted to a new `.medusa/server` directory. - -```bash -npx medusa build -``` - -Refer to [this section](#run-built-medusa-application) for next steps. - -## Options - -|Option|Description| -|---|---|---| -|\`--admin-only\`|Whether to only build the admin to host it separately. If this option is not passed, the admin is built to the | - -*** - -## Run Built Medusa Application - -After running the `build` command, use the following step to run the built Medusa application: - -- Change to the `.medusa/server` directory and install the dependencies: - -```bash npm2yarn -cd .medusa/server && npm install -``` - -- When running the application locally, make sure to copy the `.env` file from the root project's directory. In production, use system environment variables instead. - -```bash npm2yarn -cp .env .medusa/server/.env.production -``` - -- In the system environment variables, set `NODE_ENV` to `production`: - -```bash -NODE_ENV=production -``` - -- Use the `start` command to run the application: - -```bash npm2yarn -cd .medusa/server && npm run start -``` - -*** - -## Build Medusa Admin - -By default, the Medusa Admin is built to the `.medusa/server/public/admin` directory. - -If you want a separate build to host the admin standalone, such as on Vercel, pass the `--admin-only` option as explained in the [Options](#options) section. This outputs the admin to the `.medusa/admin` directory instead. - - -# start Command - Medusa CLI Reference - -Start the Medusa application in production. - -```bash -npx medusa start -``` - -## Options - -|Option|Description|Default| -|---|---|---|---|---| -|\`-H \\`|Set host of the Medusa server.|\`localhost\`| -|\`-p \\`|Set port of the Medusa server.|\`9000\`| - - -# new Command - Medusa CLI Reference - -Create a new Medusa application. Unlike the `create-medusa-app` CLI tool, this command provides more flexibility for experienced Medusa developers in creating and configuring their project. - -```bash -medusa new [ []] -``` - -## Arguments - -|Argument|Description|Required|Default| -|---|---|---|---|---|---|---| -|\`dir\_name\`|The name of the directory to create the Medusa application in.|Yes|-| -|\`starter\_url\`|The name of the directory to create the Medusa application in.|No|\`https://github.com/medusajs/medusa-starter-default\`| - -## Options - -|Option|Description| -|---|---|---| -|\`-y\`|Skip all prompts, such as databaes prompts. A database might not be created if default PostgreSQL credentials don't work.| -|\`--skip-db\`|Skip database creation.| -|\`--skip-env\`|Skip populating | -|\`--db-user \\`|The database user to use for database setup.| -|\`--db-database \\`|The name of the database used for database setup.| -|\`--db-pass \\`|The database password to use for database setup.| -|\`--db-port \\`|The database port to use for database setup.| -|\`--db-host \\`|The database host to use for database setup.| - - -# plugin Commands - Medusa CLI Reference - -Commands starting with `plugin:` perform actions related to [plugin](https://docs.medusajs.com/docs/learn/fundamentals/plugins/index.html.md) development. - -These commands are available starting from [Medusa v2.3.0](https://github.com/medusajs/medusa/releases/tag/v2.3.0). - -## plugin:publish - -Publish a plugin into the local packages registry. The command uses [Yalc](https://github.com/wclr/yalc) under the hood to publish the plugin to a local package registry. You can then install the plugin in a local Medusa project using the [plugin:add](#pluginadd) command. - -```bash -npx medusa plugin:publish -``` - -*** - -## plugin:add - -Install the specified plugins from the local package registry into a local Medusa application. Plugins can be added to the local package registry using the [plugin:publish](#pluginpublish) command. - -```bash -npx medusa plugin:add [names...] -``` - -### Arguments - -|Argument|Description|Required| -|---|---|---|---|---| -|\`names\`|The names of one or more plugins to install from the local package registry. A plugin's name is as specified in its |Yes| - -*** - -## plugin:develop - -Start a development server for a plugin. The command will watch for changes in the plugin's source code and automatically re-publish the changes into the local package registry. - -```bash -npx medusa plugin:develop -``` - -*** - -## plugin:db:generate - -Generate migrations for all modules in a plugin. - -```bash -npx medusa plugin:db:generate -``` - -*** - -## plugin:build - -Build a plugin before publishing it to NPM. The command will compile an output in the `.medusa/server` directory. - -```bash -npx medusa plugin:build -``` - - -# start-cluster Command - Medusa CLI Reference - -Starts the Medusa application in [cluster mode](https://expressjs.com/en/advanced/best-practice-performance.html#run-your-app-in-a-cluster). - -Running in cluster mode significantly improves performance as the workload and tasks are distributed among all available instances instead of a single one. - -```bash -npx medusa start-cluster -``` - -#### Options - -|Option|Description|Default| -|---|---|---|---|---| -|\`-c \\`|The number of CPUs that Medusa can consume.|Medusa will try to consume all CPUs.| -|\`-H \\`|Set host of the Medusa server.|\`localhost\`| -|\`-p \\`|Set port of the Medusa server.|\`9000\`| - - -# telemetry Command - Medusa CLI Reference - -Enable or disable the collection of anonymous data usage. If no option is provided, the command enables the collection of anonymous data usage. - -```bash -npx medusa telemetry -``` - -#### Options - -|Option|Description| -|---|---|---| -|\`--enable\`|Enable telemetry (default).| -|\`--disable\`|Disable telemetry.| - - -# user Command - Medusa CLI Reference - -Create a new admin user. - -```bash -npx medusa user --email [--password ] -``` - -## Options - -|Option|Description|Required|Default| -|---|---|---|---|---|---|---| -|\`-e \\`|The user's email.|Yes|-| -|\`-p \\`|The user's password.|No|-| -|\`-i \\`|The user's ID.|No|An automatically generated ID.| -|\`--invite\`|Whether to create an invite instead of a user. When using this option, you don't need to specify a password. -If ran successfully, you'll receive the invite token in the output.|No|\`false\`| - - -# exec Command - Medusa CLI Reference - -Run a custom CLI script. Learn more about it in [this guide](https://docs.medusajs.com/docs/learn/fundamentals/custom-cli-scripts/index.html.md). - -```bash -npx medusa exec [file] [args...] -``` - -## Arguments - -|Argument|Description|Required| -|---|---|---|---|---| -|\`file\`|The path to the TypeScript or JavaScript file holding the function to execute.|Yes| -|\`args\`|A list of arguments to pass to the function. These arguments are passed in the |No| +- [listShippingOptionsForContextStep](https://docs.medusajs.com/references/medusa-workflows/steps/listShippingOptionsForContextStep/index.html.md) +- [deleteShippingProfilesStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteShippingProfilesStep/index.html.md) +- [deleteStoresStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteStoresStep/index.html.md) +- [createStoresStep](https://docs.medusajs.com/references/medusa-workflows/steps/createStoresStep/index.html.md) +- [updateStoresStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateStoresStep/index.html.md) +- [createTaxRateRulesStep](https://docs.medusajs.com/references/medusa-workflows/steps/createTaxRateRulesStep/index.html.md) +- [createTaxRatesStep](https://docs.medusajs.com/references/medusa-workflows/steps/createTaxRatesStep/index.html.md) +- [createTaxRegionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/createTaxRegionsStep/index.html.md) +- [deleteTaxRatesStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteTaxRatesStep/index.html.md) +- [deleteTaxRateRulesStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteTaxRateRulesStep/index.html.md) +- [deleteTaxRegionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteTaxRegionsStep/index.html.md) +- [getItemTaxLinesStep](https://docs.medusajs.com/references/medusa-workflows/steps/getItemTaxLinesStep/index.html.md) +- [listTaxRateIdsStep](https://docs.medusajs.com/references/medusa-workflows/steps/listTaxRateIdsStep/index.html.md) +- [listTaxRateRuleIdsStep](https://docs.medusajs.com/references/medusa-workflows/steps/listTaxRateRuleIdsStep/index.html.md) +- [updateTaxRatesStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateTaxRatesStep/index.html.md) +- [updateTaxRegionsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateTaxRegionsStep/index.html.md) +- [deleteStockLocationsStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteStockLocationsStep/index.html.md) +- [updateStockLocationsStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateStockLocationsStep/index.html.md) +- [createStockLocations](https://docs.medusajs.com/references/medusa-workflows/steps/createStockLocations/index.html.md) +- [createUsersStep](https://docs.medusajs.com/references/medusa-workflows/steps/createUsersStep/index.html.md) +- [deleteUsersStep](https://docs.medusajs.com/references/medusa-workflows/steps/deleteUsersStep/index.html.md) +- [updateUsersStep](https://docs.medusajs.com/references/medusa-workflows/steps/updateUsersStep/index.html.md) # Medusa CLI Reference @@ -27076,6 +27101,126 @@ medusa new [ []] |\`--db-host \\`|The database host to use for database setup.| +# db Commands - Medusa CLI Reference + +Commands starting with `db:` perform actions on the database. + +## db:setup + +Creates a database for the Medusa application with the specified name, if it doesn't exit. Then, it runs migrations and syncs links. + +It also updates your `.env` file with the database name. + +```bash +npx medusa db:setup --db +``` + +Use this command if you're setting up a Medusa project or database manually. + +### Options + +|Option|Description|Required|Default| +|---|---|---|---|---|---|---| +|\`--db \\`|The database name.|Yes|-| +|\`--skip-links\`|Skip syncing links to the database.|No|Links are synced by default.| +|\`--execute-safe-links\`|Skip prompts when syncing links and execute only safe actions.|No|Prompts are shown for unsafe actions, by default.| +|\`--execute-all-links\`|Skip prompts when syncing links and execute all (including unsafe) actions.|No|Prompts are shown for unsafe actions, by default.| +|\`--no-interactive\`|Disable the command's prompts.|No|-| + +*** + +## db:create + +Creates a database for the Medusa application with the specified name, if it doesn't exit. + +It also updates your `.env` file with the database name. + +```bash +npx medusa db:create --db +``` + +Use this command if you want to only create a database. + +### Options + +|Option|Description|Required|Default| +|---|---|---|---|---|---|---| +|\`--db \\`|The database name.|Yes|-| +|\`--no-interactive\`|Disable the command's prompts.|No|-| + +*** + +## db:generate + +Generate a migration file for the latest changes in one or more modules. + +```bash +npx medusa db:generate +``` + +### Arguments + +|Argument|Description|Required| +|---|---|---|---|---| +|\`module\_names\`|The name of one or more module (separated by spaces) to generate migrations for. For example, |Yes| + +*** + +## db:migrate + +Run the latest migrations to reflect changes on the database, sync link definitions with the database, and run migration data scripts. + +```bash +npx medusa db:migrate +``` + +Use this command if you've updated the Medusa packages, or you've created customizations and want to reflect them in the database. + +### Options + +|Option|Description|Required|Default| +|---|---|---|---|---|---|---| +|\`--skip-links\`|Skip syncing links to the database.|No|Links are synced by default.| +|\`--skip-scripts\`|Skip running data migration scripts. This option is added starting from +|No|Data migration scripts are run by default starting from +| +|\`--execute-safe-links\`|Skip prompts when syncing links and execute only safe actions.|No|Prompts are shown for unsafe actions, by default.| +|\`--execute-all-links\`|Skip prompts when syncing links and execute all (including unsafe) actions.|No|Prompts are shown for unsafe actions, by default.| + +*** + +## db:rollback + +Revert the last migrations ran on one or more modules. + +```bash +npx medusa db:rollback +``` + +### Arguments + +|Argument|Description|Required| +|---|---|---|---|---| +|\`module\_names\`|The name of one or more module (separated by spaces) to rollback their migrations for. For example, |Yes| + +*** + +## db:sync-links + +Sync the database with the link definitions in your application, including the definitions in Medusa's modules. + +```bash +npx medusa db:sync-links +``` + +### Options + +|Option|Description|Required|Default| +|---|---|---|---|---|---|---| +|\`--execute-safe\`|Skip prompts when syncing links and execute only safe actions.|No|Prompts are shown for unsafe actions, by default.| +|\`--execute-all\`|Skip prompts when syncing links and execute all (including unsafe) actions.|No|Prompts are shown for unsafe actions, by default.| + + # exec Command - Medusa CLI Reference Run a custom CLI script. Learn more about it in [this guide](https://docs.medusajs.com/docs/learn/fundamentals/custom-cli-scripts/index.html.md). @@ -27092,6 +27237,222 @@ npx medusa exec [file] [args...] |\`args\`|A list of arguments to pass to the function. These arguments are passed in the |No| +# plugin Commands - Medusa CLI Reference + +Commands starting with `plugin:` perform actions related to [plugin](https://docs.medusajs.com/docs/learn/fundamentals/plugins/index.html.md) development. + +These commands are available starting from [Medusa v2.3.0](https://github.com/medusajs/medusa/releases/tag/v2.3.0). + +## plugin:publish + +Publish a plugin into the local packages registry. The command uses [Yalc](https://github.com/wclr/yalc) under the hood to publish the plugin to a local package registry. You can then install the plugin in a local Medusa project using the [plugin:add](#pluginadd) command. + +```bash +npx medusa plugin:publish +``` + +*** + +## plugin:add + +Install the specified plugins from the local package registry into a local Medusa application. Plugins can be added to the local package registry using the [plugin:publish](#pluginpublish) command. + +```bash +npx medusa plugin:add [names...] +``` + +### Arguments + +|Argument|Description|Required| +|---|---|---|---|---| +|\`names\`|The names of one or more plugins to install from the local package registry. A plugin's name is as specified in its |Yes| + +*** + +## plugin:develop + +Start a development server for a plugin. The command will watch for changes in the plugin's source code and automatically re-publish the changes into the local package registry. + +```bash +npx medusa plugin:develop +``` + +*** + +## plugin:db:generate + +Generate migrations for all modules in a plugin. + +```bash +npx medusa plugin:db:generate +``` + +*** + +## plugin:build + +Build a plugin before publishing it to NPM. The command will compile an output in the `.medusa/server` directory. + +```bash +npx medusa plugin:build +``` + + +# start-cluster Command - Medusa CLI Reference + +Starts the Medusa application in [cluster mode](https://expressjs.com/en/advanced/best-practice-performance.html#run-your-app-in-a-cluster). + +Running in cluster mode significantly improves performance as the workload and tasks are distributed among all available instances instead of a single one. + +```bash +npx medusa start-cluster +``` + +#### Options + +|Option|Description|Default| +|---|---|---|---|---| +|\`-c \\`|The number of CPUs that Medusa can consume.|Medusa will try to consume all CPUs.| +|\`-H \\`|Set host of the Medusa server.|\`localhost\`| +|\`-p \\`|Set port of the Medusa server.|\`9000\`| + + +# telemetry Command - Medusa CLI Reference + +Enable or disable the collection of anonymous data usage. If no option is provided, the command enables the collection of anonymous data usage. + +```bash +npx medusa telemetry +``` + +#### Options + +|Option|Description| +|---|---|---| +|\`--enable\`|Enable telemetry (default).| +|\`--disable\`|Disable telemetry.| + + +# start Command - Medusa CLI Reference + +Start the Medusa application in production. + +```bash +npx medusa start +``` + +## Options + +|Option|Description|Default| +|---|---|---|---|---| +|\`-H \\`|Set host of the Medusa server.|\`localhost\`| +|\`-p \\`|Set port of the Medusa server.|\`9000\`| + + +# user Command - Medusa CLI Reference + +Create a new admin user. + +```bash +npx medusa user --email [--password ] +``` + +## Options + +|Option|Description|Required|Default| +|---|---|---|---|---|---|---| +|\`-e \\`|The user's email.|Yes|-| +|\`-p \\`|The user's password.|No|-| +|\`-i \\`|The user's ID.|No|An automatically generated ID.| +|\`--invite\`|Whether to create an invite instead of a user. When using this option, you don't need to specify a password. +If ran successfully, you'll receive the invite token in the output.|No|\`false\`| + + +# Medusa CLI Reference + +The Medusa CLI tool provides commands that facilitate your development. + +### Prerequisites + +- [Node.js v20+](https://nodejs.org/en/download) +- [Git CLI tool](https://git-scm.com/downloads) +- [PostgreSQL](https://www.postgresql.org/download/) + +## Usage + +In your Medusa application's directory, you can use the Medusa CLI tool using NPX. + +For example: + +```bash +npx medusa --help +``` + +*** + + +# build Command - Medusa CLI Reference + +Create a standalone build of the Medusa application. + +This creates a build that: + +- Doesn't rely on the source TypeScript files. +- Can be copied to a production server reliably. + +The build is outputted to a new `.medusa/server` directory. + +```bash +npx medusa build +``` + +Refer to [this section](#run-built-medusa-application) for next steps. + +## Options + +|Option|Description| +|---|---|---| +|\`--admin-only\`|Whether to only build the admin to host it separately. If this option is not passed, the admin is built to the | + +*** + +## Run Built Medusa Application + +After running the `build` command, use the following step to run the built Medusa application: + +- Change to the `.medusa/server` directory and install the dependencies: + +```bash npm2yarn +cd .medusa/server && npm install +``` + +- When running the application locally, make sure to copy the `.env` file from the root project's directory. In production, use system environment variables instead. + +```bash npm2yarn +cp .env .medusa/server/.env.production +``` + +- In the system environment variables, set `NODE_ENV` to `production`: + +```bash +NODE_ENV=production +``` + +- Use the `start` command to run the application: + +```bash npm2yarn +cd .medusa/server && npm run start +``` + +*** + +## Build Medusa Admin + +By default, the Medusa Admin is built to the `.medusa/server/public/admin` directory. + +If you want a separate build to host the admin standalone, such as on Vercel, pass the `--admin-only` option as explained in the [Options](#options) section. This outputs the admin to the `.medusa/admin` directory instead. + + # db Commands - Medusa CLI Reference Commands starting with `db:` perform actions on the database. @@ -27212,6 +27573,137 @@ npx medusa db:sync-links |\`--execute-all\`|Skip prompts when syncing links and execute all (including unsafe) actions.|No|Prompts are shown for unsafe actions, by default.| +# exec Command - Medusa CLI Reference + +Run a custom CLI script. Learn more about it in [this guide](https://docs.medusajs.com/docs/learn/fundamentals/custom-cli-scripts/index.html.md). + +```bash +npx medusa exec [file] [args...] +``` + +## Arguments + +|Argument|Description|Required| +|---|---|---|---|---| +|\`file\`|The path to the TypeScript or JavaScript file holding the function to execute.|Yes| +|\`args\`|A list of arguments to pass to the function. These arguments are passed in the |No| + + +# develop Command - Medusa CLI Reference + +Start Medusa application in development. This command watches files for any changes, then rebuilds the files and restarts the Medusa application. + +```bash +npx medusa develop +``` + +## Options + +|Option|Description|Default| +|---|---|---|---|---| +|\`-H \\`|Set host of the Medusa server.|\`localhost\`| +|\`-p \\`|Set port of the Medusa server.|\`9000\`| + + +# new Command - Medusa CLI Reference + +Create a new Medusa application. Unlike the `create-medusa-app` CLI tool, this command provides more flexibility for experienced Medusa developers in creating and configuring their project. + +```bash +medusa new [ []] +``` + +## Arguments + +|Argument|Description|Required|Default| +|---|---|---|---|---|---|---| +|\`dir\_name\`|The name of the directory to create the Medusa application in.|Yes|-| +|\`starter\_url\`|The name of the directory to create the Medusa application in.|No|\`https://github.com/medusajs/medusa-starter-default\`| + +## Options + +|Option|Description| +|---|---|---| +|\`-y\`|Skip all prompts, such as databaes prompts. A database might not be created if default PostgreSQL credentials don't work.| +|\`--skip-db\`|Skip database creation.| +|\`--skip-env\`|Skip populating | +|\`--db-user \\`|The database user to use for database setup.| +|\`--db-database \\`|The name of the database used for database setup.| +|\`--db-pass \\`|The database password to use for database setup.| +|\`--db-port \\`|The database port to use for database setup.| +|\`--db-host \\`|The database host to use for database setup.| + + +# start Command - Medusa CLI Reference + +Start the Medusa application in production. + +```bash +npx medusa start +``` + +## Options + +|Option|Description|Default| +|---|---|---|---|---| +|\`-H \\`|Set host of the Medusa server.|\`localhost\`| +|\`-p \\`|Set port of the Medusa server.|\`9000\`| + + +# start-cluster Command - Medusa CLI Reference + +Starts the Medusa application in [cluster mode](https://expressjs.com/en/advanced/best-practice-performance.html#run-your-app-in-a-cluster). + +Running in cluster mode significantly improves performance as the workload and tasks are distributed among all available instances instead of a single one. + +```bash +npx medusa start-cluster +``` + +#### Options + +|Option|Description|Default| +|---|---|---|---|---| +|\`-c \\`|The number of CPUs that Medusa can consume.|Medusa will try to consume all CPUs.| +|\`-H \\`|Set host of the Medusa server.|\`localhost\`| +|\`-p \\`|Set port of the Medusa server.|\`9000\`| + + +# telemetry Command - Medusa CLI Reference + +Enable or disable the collection of anonymous data usage. If no option is provided, the command enables the collection of anonymous data usage. + +```bash +npx medusa telemetry +``` + +#### Options + +|Option|Description| +|---|---|---| +|\`--enable\`|Enable telemetry (default).| +|\`--disable\`|Disable telemetry.| + + +# user Command - Medusa CLI Reference + +Create a new admin user. + +```bash +npx medusa user --email [--password ] +``` + +## Options + +|Option|Description|Required|Default| +|---|---|---|---|---|---|---| +|\`-e \\`|The user's email.|Yes|-| +|\`-p \\`|The user's password.|No|-| +|\`-i \\`|The user's ID.|No|An automatically generated ID.| +|\`--invite\`|Whether to create an invite instead of a user. When using this option, you don't need to specify a password. +If ran successfully, you'll receive the invite token in the output.|No|\`false\`| + + # plugin Commands - Medusa CLI Reference Commands starting with `plugin:` perform actions related to [plugin](https://docs.medusajs.com/docs/learn/fundamentals/plugins/index.html.md) development. @@ -27273,76 +27765,6 @@ npx medusa plugin:build ``` -# start Command - Medusa CLI Reference - -Start the Medusa application in production. - -```bash -npx medusa start -``` - -## Options - -|Option|Description|Default| -|---|---|---|---|---| -|\`-H \\`|Set host of the Medusa server.|\`localhost\`| -|\`-p \\`|Set port of the Medusa server.|\`9000\`| - - -# user Command - Medusa CLI Reference - -Create a new admin user. - -```bash -npx medusa user --email [--password ] -``` - -## Options - -|Option|Description|Required|Default| -|---|---|---|---|---|---|---| -|\`-e \\`|The user's email.|Yes|-| -|\`-p \\`|The user's password.|No|-| -|\`-i \\`|The user's ID.|No|An automatically generated ID.| -|\`--invite\`|Whether to create an invite instead of a user. When using this option, you don't need to specify a password. -If ran successfully, you'll receive the invite token in the output.|No|\`false\`| - - -# telemetry Command - Medusa CLI Reference - -Enable or disable the collection of anonymous data usage. If no option is provided, the command enables the collection of anonymous data usage. - -```bash -npx medusa telemetry -``` - -#### Options - -|Option|Description| -|---|---|---| -|\`--enable\`|Enable telemetry (default).| -|\`--disable\`|Disable telemetry.| - - -# start-cluster Command - Medusa CLI Reference - -Starts the Medusa application in [cluster mode](https://expressjs.com/en/advanced/best-practice-performance.html#run-your-app-in-a-cluster). - -Running in cluster mode significantly improves performance as the workload and tasks are distributed among all available instances instead of a single one. - -```bash -npx medusa start-cluster -``` - -#### Options - -|Option|Description|Default| -|---|---|---|---|---| -|\`-c \\`|The number of CPUs that Medusa can consume.|Medusa will try to consume all CPUs.| -|\`-H \\`|Set host of the Medusa server.|\`localhost\`| -|\`-p \\`|Set port of the Medusa server.|\`9000\`| - - # Medusa JS SDK In this documentation, you'll learn how to install and use Medusa's JS SDK. @@ -27643,301 +28065,301 @@ The object or class passed to `auth.storage` configuration must have the followi ## JS SDK Admin -- [create](https://docs.medusajs.com/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.create/index.html.md) -- [delete](https://docs.medusajs.com/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.delete/index.html.md) -- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.retrieve/index.html.md) -- [list](https://docs.medusajs.com/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.list/index.html.md) -- [batchSalesChannels](https://docs.medusajs.com/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.batchSalesChannels/index.html.md) -- [revoke](https://docs.medusajs.com/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.revoke/index.html.md) -- [update](https://docs.medusajs.com/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.update/index.html.md) - [batchPromotions](https://docs.medusajs.com/references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.batchPromotions/index.html.md) - [create](https://docs.medusajs.com/references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.create/index.html.md) - [delete](https://docs.medusajs.com/references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.delete/index.html.md) - [list](https://docs.medusajs.com/references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.list/index.html.md) -- [update](https://docs.medusajs.com/references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.update/index.html.md) - [retrieve](https://docs.medusajs.com/references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.retrieve/index.html.md) +- [update](https://docs.medusajs.com/references/js_sdk/admin/Campaign/methods/js_sdk.admin.Campaign.update/index.html.md) +- [batchSalesChannels](https://docs.medusajs.com/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.batchSalesChannels/index.html.md) +- [create](https://docs.medusajs.com/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.create/index.html.md) +- [delete](https://docs.medusajs.com/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.delete/index.html.md) +- [list](https://docs.medusajs.com/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.list/index.html.md) +- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.retrieve/index.html.md) +- [revoke](https://docs.medusajs.com/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.revoke/index.html.md) +- [update](https://docs.medusajs.com/references/js_sdk/admin/ApiKey/methods/js_sdk.admin.ApiKey.update/index.html.md) +- [getItem](https://docs.medusajs.com/references/js_sdk/admin/CustomStorage/methods/js_sdk.admin.CustomStorage.getItem/index.html.md) +- [setItem](https://docs.medusajs.com/references/js_sdk/admin/CustomStorage/methods/js_sdk.admin.CustomStorage.setItem/index.html.md) +- [removeItem](https://docs.medusajs.com/references/js_sdk/admin/CustomStorage/methods/js_sdk.admin.CustomStorage.removeItem/index.html.md) +- [list](https://docs.medusajs.com/references/js_sdk/admin/Currency/methods/js_sdk.admin.Currency.list/index.html.md) +- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/Currency/methods/js_sdk.admin.Currency.retrieve/index.html.md) +- [addInboundItems](https://docs.medusajs.com/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.addInboundItems/index.html.md) - [addInboundShipping](https://docs.medusajs.com/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.addInboundShipping/index.html.md) - [addOutboundItems](https://docs.medusajs.com/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.addOutboundItems/index.html.md) -- [addInboundItems](https://docs.medusajs.com/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.addInboundItems/index.html.md) - [addItems](https://docs.medusajs.com/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.addItems/index.html.md) -- [cancel](https://docs.medusajs.com/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.cancel/index.html.md) - [addOutboundShipping](https://docs.medusajs.com/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.addOutboundShipping/index.html.md) - [cancelRequest](https://docs.medusajs.com/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.cancelRequest/index.html.md) - [create](https://docs.medusajs.com/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.create/index.html.md) -- [deleteOutboundShipping](https://docs.medusajs.com/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.deleteOutboundShipping/index.html.md) +- [cancel](https://docs.medusajs.com/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.cancel/index.html.md) - [deleteInboundShipping](https://docs.medusajs.com/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.deleteInboundShipping/index.html.md) +- [deleteOutboundShipping](https://docs.medusajs.com/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.deleteOutboundShipping/index.html.md) - [list](https://docs.medusajs.com/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.list/index.html.md) -- [removeInboundItem](https://docs.medusajs.com/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.removeInboundItem/index.html.md) -- [removeItem](https://docs.medusajs.com/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.removeItem/index.html.md) +- [removeOutboundItem](https://docs.medusajs.com/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.removeOutboundItem/index.html.md) - [request](https://docs.medusajs.com/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.request/index.html.md) +- [removeInboundItem](https://docs.medusajs.com/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.removeInboundItem/index.html.md) - [retrieve](https://docs.medusajs.com/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.retrieve/index.html.md) - [updateInboundItem](https://docs.medusajs.com/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.updateInboundItem/index.html.md) -- [removeOutboundItem](https://docs.medusajs.com/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.removeOutboundItem/index.html.md) -- [updateInboundShipping](https://docs.medusajs.com/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.updateInboundShipping/index.html.md) -- [updateOutboundItem](https://docs.medusajs.com/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.updateOutboundItem/index.html.md) +- [removeItem](https://docs.medusajs.com/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.removeItem/index.html.md) - [updateItem](https://docs.medusajs.com/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.updateItem/index.html.md) +- [updateOutboundItem](https://docs.medusajs.com/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.updateOutboundItem/index.html.md) - [updateOutboundShipping](https://docs.medusajs.com/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.updateOutboundShipping/index.html.md) -- [batchCustomerGroups](https://docs.medusajs.com/references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.batchCustomerGroups/index.html.md) -- [list](https://docs.medusajs.com/references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.list/index.html.md) -- [create](https://docs.medusajs.com/references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.create/index.html.md) -- [delete](https://docs.medusajs.com/references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.delete/index.html.md) -- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.retrieve/index.html.md) -- [clearToken](https://docs.medusajs.com/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.clearToken/index.html.md) -- [clearToken\_](https://docs.medusajs.com/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.clearToken_/index.html.md) -- [update](https://docs.medusajs.com/references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.update/index.html.md) +- [updateInboundShipping](https://docs.medusajs.com/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.updateInboundShipping/index.html.md) - [fetch](https://docs.medusajs.com/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.fetch/index.html.md) +- [clearToken\_](https://docs.medusajs.com/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.clearToken_/index.html.md) +- [clearToken](https://docs.medusajs.com/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.clearToken/index.html.md) - [fetchStream](https://docs.medusajs.com/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.fetchStream/index.html.md) - [getApiKeyHeader\_](https://docs.medusajs.com/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.getApiKeyHeader_/index.html.md) - [getJwtHeader\_](https://docs.medusajs.com/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.getJwtHeader_/index.html.md) +- [getPublishableKeyHeader\_](https://docs.medusajs.com/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.getPublishableKeyHeader_/index.html.md) - [getTokenStorageInfo\_](https://docs.medusajs.com/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.getTokenStorageInfo_/index.html.md) - [getToken\_](https://docs.medusajs.com/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.getToken_/index.html.md) -- [getPublishableKeyHeader\_](https://docs.medusajs.com/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.getPublishableKeyHeader_/index.html.md) +- [initClient](https://docs.medusajs.com/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.initClient/index.html.md) - [setToken](https://docs.medusajs.com/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.setToken/index.html.md) - [setToken\_](https://docs.medusajs.com/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.setToken_/index.html.md) -- [initClient](https://docs.medusajs.com/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.initClient/index.html.md) +- [batchCustomerGroups](https://docs.medusajs.com/references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.batchCustomerGroups/index.html.md) +- [delete](https://docs.medusajs.com/references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.delete/index.html.md) - [throwError\_](https://docs.medusajs.com/references/js_sdk/admin/Client/methods/js_sdk.admin.Client.throwError_/index.html.md) -- [getItem](https://docs.medusajs.com/references/js_sdk/admin/CustomStorage/methods/js_sdk.admin.CustomStorage.getItem/index.html.md) -- [list](https://docs.medusajs.com/references/js_sdk/admin/Currency/methods/js_sdk.admin.Currency.list/index.html.md) -- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/Currency/methods/js_sdk.admin.Currency.retrieve/index.html.md) -- [removeItem](https://docs.medusajs.com/references/js_sdk/admin/CustomStorage/methods/js_sdk.admin.CustomStorage.removeItem/index.html.md) -- [setItem](https://docs.medusajs.com/references/js_sdk/admin/CustomStorage/methods/js_sdk.admin.CustomStorage.setItem/index.html.md) -- [create](https://docs.medusajs.com/references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.create/index.html.md) -- [delete](https://docs.medusajs.com/references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.delete/index.html.md) +- [list](https://docs.medusajs.com/references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.list/index.html.md) +- [create](https://docs.medusajs.com/references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.create/index.html.md) +- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.retrieve/index.html.md) +- [update](https://docs.medusajs.com/references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.update/index.html.md) - [batchCustomers](https://docs.medusajs.com/references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.batchCustomers/index.html.md) +- [create](https://docs.medusajs.com/references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.create/index.html.md) - [list](https://docs.medusajs.com/references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.list/index.html.md) -- [create](https://docs.medusajs.com/references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.create/index.html.md) -- [update](https://docs.medusajs.com/references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.update/index.html.md) +- [delete](https://docs.medusajs.com/references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.delete/index.html.md) - [retrieve](https://docs.medusajs.com/references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.retrieve/index.html.md) -- [list](https://docs.medusajs.com/references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.list/index.html.md) -- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.retrieve/index.html.md) -- [update](https://docs.medusajs.com/references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.update/index.html.md) -- [addOutboundShipping](https://docs.medusajs.com/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.addOutboundShipping/index.html.md) +- [update](https://docs.medusajs.com/references/js_sdk/admin/CustomerGroup/methods/js_sdk.admin.CustomerGroup.update/index.html.md) - [addInboundItems](https://docs.medusajs.com/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.addInboundItems/index.html.md) +- [addOutboundShipping](https://docs.medusajs.com/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.addOutboundShipping/index.html.md) - [addOutboundItems](https://docs.medusajs.com/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.addOutboundItems/index.html.md) -- [cancel](https://docs.medusajs.com/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.cancel/index.html.md) -- [addInboundShipping](https://docs.medusajs.com/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.addInboundShipping/index.html.md) - [cancelRequest](https://docs.medusajs.com/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.cancelRequest/index.html.md) +- [addInboundShipping](https://docs.medusajs.com/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.addInboundShipping/index.html.md) +- [cancel](https://docs.medusajs.com/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.cancel/index.html.md) - [create](https://docs.medusajs.com/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.create/index.html.md) -- [deleteInboundShipping](https://docs.medusajs.com/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.deleteInboundShipping/index.html.md) - [deleteOutboundShipping](https://docs.medusajs.com/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.deleteOutboundShipping/index.html.md) +- [deleteInboundShipping](https://docs.medusajs.com/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.deleteInboundShipping/index.html.md) - [list](https://docs.medusajs.com/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.list/index.html.md) - [removeInboundItem](https://docs.medusajs.com/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.removeInboundItem/index.html.md) +- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.retrieve/index.html.md) - [removeOutboundItem](https://docs.medusajs.com/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.removeOutboundItem/index.html.md) - [request](https://docs.medusajs.com/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.request/index.html.md) -- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.retrieve/index.html.md) -- [updateInboundShipping](https://docs.medusajs.com/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.updateInboundShipping/index.html.md) -- [updateInboundItem](https://docs.medusajs.com/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.updateInboundItem/index.html.md) -- [updateOutboundItem](https://docs.medusajs.com/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.updateOutboundItem/index.html.md) - [updateOutboundShipping](https://docs.medusajs.com/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.updateOutboundShipping/index.html.md) -- [list](https://docs.medusajs.com/references/js_sdk/admin/FulfillmentProvider/methods/js_sdk.admin.FulfillmentProvider.list/index.html.md) -- [listFulfillmentOptions](https://docs.medusajs.com/references/js_sdk/admin/FulfillmentProvider/methods/js_sdk.admin.FulfillmentProvider.listFulfillmentOptions/index.html.md) -- [cancel](https://docs.medusajs.com/references/js_sdk/admin/Fulfillment/methods/js_sdk.admin.Fulfillment.cancel/index.html.md) -- [createShipment](https://docs.medusajs.com/references/js_sdk/admin/Fulfillment/methods/js_sdk.admin.Fulfillment.createShipment/index.html.md) -- [create](https://docs.medusajs.com/references/js_sdk/admin/Fulfillment/methods/js_sdk.admin.Fulfillment.create/index.html.md) -- [createServiceZone](https://docs.medusajs.com/references/js_sdk/admin/FulfillmentSet/methods/js_sdk.admin.FulfillmentSet.createServiceZone/index.html.md) -- [deleteServiceZone](https://docs.medusajs.com/references/js_sdk/admin/FulfillmentSet/methods/js_sdk.admin.FulfillmentSet.deleteServiceZone/index.html.md) +- [updateInboundItem](https://docs.medusajs.com/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.updateInboundItem/index.html.md) +- [updateInboundShipping](https://docs.medusajs.com/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.updateInboundShipping/index.html.md) +- [updateOutboundItem](https://docs.medusajs.com/references/js_sdk/admin/Exchange/methods/js_sdk.admin.Exchange.updateOutboundItem/index.html.md) +- [list](https://docs.medusajs.com/references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.list/index.html.md) +- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.retrieve/index.html.md) +- [create](https://docs.medusajs.com/references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.create/index.html.md) +- [update](https://docs.medusajs.com/references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.update/index.html.md) - [delete](https://docs.medusajs.com/references/js_sdk/admin/FulfillmentSet/methods/js_sdk.admin.FulfillmentSet.delete/index.html.md) +- [deleteServiceZone](https://docs.medusajs.com/references/js_sdk/admin/FulfillmentSet/methods/js_sdk.admin.FulfillmentSet.deleteServiceZone/index.html.md) - [retrieveServiceZone](https://docs.medusajs.com/references/js_sdk/admin/FulfillmentSet/methods/js_sdk.admin.FulfillmentSet.retrieveServiceZone/index.html.md) - [updateServiceZone](https://docs.medusajs.com/references/js_sdk/admin/FulfillmentSet/methods/js_sdk.admin.FulfillmentSet.updateServiceZone/index.html.md) -- [create](https://docs.medusajs.com/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.create/index.html.md) +- [createServiceZone](https://docs.medusajs.com/references/js_sdk/admin/FulfillmentSet/methods/js_sdk.admin.FulfillmentSet.createServiceZone/index.html.md) +- [listFulfillmentOptions](https://docs.medusajs.com/references/js_sdk/admin/FulfillmentProvider/methods/js_sdk.admin.FulfillmentProvider.listFulfillmentOptions/index.html.md) +- [list](https://docs.medusajs.com/references/js_sdk/admin/FulfillmentProvider/methods/js_sdk.admin.FulfillmentProvider.list/index.html.md) +- [cancel](https://docs.medusajs.com/references/js_sdk/admin/Fulfillment/methods/js_sdk.admin.Fulfillment.cancel/index.html.md) +- [create](https://docs.medusajs.com/references/js_sdk/admin/Fulfillment/methods/js_sdk.admin.Fulfillment.create/index.html.md) - [batchInventoryItemLocationLevels](https://docs.medusajs.com/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.batchInventoryItemLocationLevels/index.html.md) +- [createShipment](https://docs.medusajs.com/references/js_sdk/admin/Fulfillment/methods/js_sdk.admin.Fulfillment.createShipment/index.html.md) - [batchInventoryItemsLocationLevels](https://docs.medusajs.com/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.batchInventoryItemsLocationLevels/index.html.md) +- [create](https://docs.medusajs.com/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.create/index.html.md) - [batchUpdateLevels](https://docs.medusajs.com/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.batchUpdateLevels/index.html.md) -- [delete](https://docs.medusajs.com/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.delete/index.html.md) -- [list](https://docs.medusajs.com/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.list/index.html.md) -- [listLevels](https://docs.medusajs.com/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.listLevels/index.html.md) - [deleteLevel](https://docs.medusajs.com/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.deleteLevel/index.html.md) +- [delete](https://docs.medusajs.com/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.delete/index.html.md) +- [listLevels](https://docs.medusajs.com/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.listLevels/index.html.md) +- [list](https://docs.medusajs.com/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.list/index.html.md) - [retrieve](https://docs.medusajs.com/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.retrieve/index.html.md) - [update](https://docs.medusajs.com/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.update/index.html.md) - [updateLevel](https://docs.medusajs.com/references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.updateLevel/index.html.md) +- [list](https://docs.medusajs.com/references/js_sdk/admin/Notification/methods/js_sdk.admin.Notification.list/index.html.md) +- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/Notification/methods/js_sdk.admin.Notification.retrieve/index.html.md) +- [cancelFulfillment](https://docs.medusajs.com/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.cancelFulfillment/index.html.md) +- [cancel](https://docs.medusajs.com/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.cancel/index.html.md) +- [cancelTransfer](https://docs.medusajs.com/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.cancelTransfer/index.html.md) +- [createFulfillment](https://docs.medusajs.com/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.createFulfillment/index.html.md) +- [list](https://docs.medusajs.com/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.list/index.html.md) +- [createShipment](https://docs.medusajs.com/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.createShipment/index.html.md) +- [listChanges](https://docs.medusajs.com/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.listChanges/index.html.md) +- [listLineItems](https://docs.medusajs.com/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.listLineItems/index.html.md) +- [markAsDelivered](https://docs.medusajs.com/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.markAsDelivered/index.html.md) +- [requestTransfer](https://docs.medusajs.com/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.requestTransfer/index.html.md) +- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.retrieve/index.html.md) +- [update](https://docs.medusajs.com/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.update/index.html.md) - [accept](https://docs.medusajs.com/references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.accept/index.html.md) +- [retrievePreview](https://docs.medusajs.com/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.retrievePreview/index.html.md) - [create](https://docs.medusajs.com/references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.create/index.html.md) - [delete](https://docs.medusajs.com/references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.delete/index.html.md) - [list](https://docs.medusajs.com/references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.list/index.html.md) - [resend](https://docs.medusajs.com/references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.resend/index.html.md) - [retrieve](https://docs.medusajs.com/references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.retrieve/index.html.md) -- [list](https://docs.medusajs.com/references/js_sdk/admin/Notification/methods/js_sdk.admin.Notification.list/index.html.md) -- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/Notification/methods/js_sdk.admin.Notification.retrieve/index.html.md) -- [list](https://docs.medusajs.com/references/js_sdk/admin/Payment/methods/js_sdk.admin.Payment.list/index.html.md) -- [listPaymentProviders](https://docs.medusajs.com/references/js_sdk/admin/Payment/methods/js_sdk.admin.Payment.listPaymentProviders/index.html.md) -- [capture](https://docs.medusajs.com/references/js_sdk/admin/Payment/methods/js_sdk.admin.Payment.capture/index.html.md) -- [refund](https://docs.medusajs.com/references/js_sdk/admin/Payment/methods/js_sdk.admin.Payment.refund/index.html.md) -- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/Payment/methods/js_sdk.admin.Payment.retrieve/index.html.md) -- [cancel](https://docs.medusajs.com/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.cancel/index.html.md) -- [createFulfillment](https://docs.medusajs.com/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.createFulfillment/index.html.md) -- [cancelTransfer](https://docs.medusajs.com/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.cancelTransfer/index.html.md) -- [cancelFulfillment](https://docs.medusajs.com/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.cancelFulfillment/index.html.md) -- [createShipment](https://docs.medusajs.com/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.createShipment/index.html.md) -- [list](https://docs.medusajs.com/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.list/index.html.md) -- [listChanges](https://docs.medusajs.com/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.listChanges/index.html.md) -- [listLineItems](https://docs.medusajs.com/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.listLineItems/index.html.md) -- [markAsDelivered](https://docs.medusajs.com/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.markAsDelivered/index.html.md) -- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.retrieve/index.html.md) -- [requestTransfer](https://docs.medusajs.com/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.requestTransfer/index.html.md) -- [update](https://docs.medusajs.com/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.update/index.html.md) -- [create](https://docs.medusajs.com/references/js_sdk/admin/PaymentCollection/methods/js_sdk.admin.PaymentCollection.create/index.html.md) -- [delete](https://docs.medusajs.com/references/js_sdk/admin/PaymentCollection/methods/js_sdk.admin.PaymentCollection.delete/index.html.md) -- [markAsPaid](https://docs.medusajs.com/references/js_sdk/admin/PaymentCollection/methods/js_sdk.admin.PaymentCollection.markAsPaid/index.html.md) -- [batchPrices](https://docs.medusajs.com/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.batchPrices/index.html.md) -- [create](https://docs.medusajs.com/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.create/index.html.md) -- [delete](https://docs.medusajs.com/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.delete/index.html.md) -- [linkProducts](https://docs.medusajs.com/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.linkProducts/index.html.md) -- [list](https://docs.medusajs.com/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.list/index.html.md) -- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.retrieve/index.html.md) -- [update](https://docs.medusajs.com/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.update/index.html.md) -- [delete](https://docs.medusajs.com/references/js_sdk/admin/PricePreference/methods/js_sdk.admin.PricePreference.delete/index.html.md) -- [create](https://docs.medusajs.com/references/js_sdk/admin/PricePreference/methods/js_sdk.admin.PricePreference.create/index.html.md) -- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/PricePreference/methods/js_sdk.admin.PricePreference.retrieve/index.html.md) -- [list](https://docs.medusajs.com/references/js_sdk/admin/PricePreference/methods/js_sdk.admin.PricePreference.list/index.html.md) -- [update](https://docs.medusajs.com/references/js_sdk/admin/PricePreference/methods/js_sdk.admin.PricePreference.update/index.html.md) -- [batchVariantInventoryItems](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.batchVariantInventoryItems/index.html.md) -- [confirmImport](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.confirmImport/index.html.md) -- [retrievePreview](https://docs.medusajs.com/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.retrievePreview/index.html.md) -- [createOption](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.createOption/index.html.md) -- [batch](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.batch/index.html.md) -- [create](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.create/index.html.md) -- [createVariant](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.createVariant/index.html.md) -- [batchVariants](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.batchVariants/index.html.md) -- [delete](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.delete/index.html.md) -- [export](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.export/index.html.md) -- [deleteVariant](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.deleteVariant/index.html.md) -- [deleteOption](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.deleteOption/index.html.md) -- [list](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.list/index.html.md) -- [import](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.import/index.html.md) -- [listOptions](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.listOptions/index.html.md) -- [listVariants](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.listVariants/index.html.md) -- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.retrieve/index.html.md) -- [retrieveVariant](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.retrieveVariant/index.html.md) -- [retrieveOption](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.retrieveOption/index.html.md) -- [update](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.update/index.html.md) -- [updateOption](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.updateOption/index.html.md) -- [updateVariant](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.updateVariant/index.html.md) -- [delete](https://docs.medusajs.com/references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.delete/index.html.md) -- [create](https://docs.medusajs.com/references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.create/index.html.md) -- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.retrieve/index.html.md) -- [list](https://docs.medusajs.com/references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.list/index.html.md) -- [update](https://docs.medusajs.com/references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.update/index.html.md) -- [updateProducts](https://docs.medusajs.com/references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.updateProducts/index.html.md) -- [create](https://docs.medusajs.com/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.create/index.html.md) -- [delete](https://docs.medusajs.com/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.delete/index.html.md) -- [list](https://docs.medusajs.com/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.list/index.html.md) -- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.retrieve/index.html.md) -- [update](https://docs.medusajs.com/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.update/index.html.md) -- [updateProducts](https://docs.medusajs.com/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.updateProducts/index.html.md) -- [confirm](https://docs.medusajs.com/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.confirm/index.html.md) -- [cancelRequest](https://docs.medusajs.com/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.cancelRequest/index.html.md) - [addItems](https://docs.medusajs.com/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.addItems/index.html.md) +- [cancelRequest](https://docs.medusajs.com/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.cancelRequest/index.html.md) +- [confirm](https://docs.medusajs.com/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.confirm/index.html.md) - [initiateRequest](https://docs.medusajs.com/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.initiateRequest/index.html.md) -- [request](https://docs.medusajs.com/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.request/index.html.md) - [removeAddedItem](https://docs.medusajs.com/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.removeAddedItem/index.html.md) - [updateAddedItem](https://docs.medusajs.com/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.updateAddedItem/index.html.md) - [updateOriginalItem](https://docs.medusajs.com/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.updateOriginalItem/index.html.md) +- [request](https://docs.medusajs.com/references/js_sdk/admin/OrderEdit/methods/js_sdk.admin.OrderEdit.request/index.html.md) +- [delete](https://docs.medusajs.com/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.delete/index.html.md) +- [create](https://docs.medusajs.com/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.create/index.html.md) +- [batchPrices](https://docs.medusajs.com/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.batchPrices/index.html.md) +- [linkProducts](https://docs.medusajs.com/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.linkProducts/index.html.md) +- [list](https://docs.medusajs.com/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.list/index.html.md) +- [update](https://docs.medusajs.com/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.update/index.html.md) +- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/PriceList/methods/js_sdk.admin.PriceList.retrieve/index.html.md) +- [create](https://docs.medusajs.com/references/js_sdk/admin/PaymentCollection/methods/js_sdk.admin.PaymentCollection.create/index.html.md) +- [delete](https://docs.medusajs.com/references/js_sdk/admin/PaymentCollection/methods/js_sdk.admin.PaymentCollection.delete/index.html.md) +- [markAsPaid](https://docs.medusajs.com/references/js_sdk/admin/PaymentCollection/methods/js_sdk.admin.PaymentCollection.markAsPaid/index.html.md) +- [capture](https://docs.medusajs.com/references/js_sdk/admin/Payment/methods/js_sdk.admin.Payment.capture/index.html.md) +- [list](https://docs.medusajs.com/references/js_sdk/admin/Payment/methods/js_sdk.admin.Payment.list/index.html.md) +- [listPaymentProviders](https://docs.medusajs.com/references/js_sdk/admin/Payment/methods/js_sdk.admin.Payment.listPaymentProviders/index.html.md) +- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/Payment/methods/js_sdk.admin.Payment.retrieve/index.html.md) +- [refund](https://docs.medusajs.com/references/js_sdk/admin/Payment/methods/js_sdk.admin.Payment.refund/index.html.md) +- [create](https://docs.medusajs.com/references/js_sdk/admin/PricePreference/methods/js_sdk.admin.PricePreference.create/index.html.md) +- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/PricePreference/methods/js_sdk.admin.PricePreference.retrieve/index.html.md) +- [delete](https://docs.medusajs.com/references/js_sdk/admin/PricePreference/methods/js_sdk.admin.PricePreference.delete/index.html.md) +- [list](https://docs.medusajs.com/references/js_sdk/admin/PricePreference/methods/js_sdk.admin.PricePreference.list/index.html.md) +- [update](https://docs.medusajs.com/references/js_sdk/admin/PricePreference/methods/js_sdk.admin.PricePreference.update/index.html.md) +- [create](https://docs.medusajs.com/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.create/index.html.md) +- [delete](https://docs.medusajs.com/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.delete/index.html.md) +- [list](https://docs.medusajs.com/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.list/index.html.md) +- [update](https://docs.medusajs.com/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.update/index.html.md) +- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.retrieve/index.html.md) +- [updateProducts](https://docs.medusajs.com/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.updateProducts/index.html.md) +- [batch](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.batch/index.html.md) +- [batchVariantInventoryItems](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.batchVariantInventoryItems/index.html.md) +- [batchVariants](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.batchVariants/index.html.md) +- [create](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.create/index.html.md) +- [createOption](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.createOption/index.html.md) +- [confirmImport](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.confirmImport/index.html.md) +- [delete](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.delete/index.html.md) +- [deleteOption](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.deleteOption/index.html.md) +- [deleteVariant](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.deleteVariant/index.html.md) +- [export](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.export/index.html.md) +- [createVariant](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.createVariant/index.html.md) +- [import](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.import/index.html.md) +- [list](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.list/index.html.md) +- [listOptions](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.listOptions/index.html.md) +- [listVariants](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.listVariants/index.html.md) +- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.retrieve/index.html.md) +- [retrieveOption](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.retrieveOption/index.html.md) +- [retrieveVariant](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.retrieveVariant/index.html.md) +- [update](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.update/index.html.md) +- [updateOption](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.updateOption/index.html.md) +- [updateVariant](https://docs.medusajs.com/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.updateVariant/index.html.md) - [create](https://docs.medusajs.com/references/js_sdk/admin/ProductTag/methods/js_sdk.admin.ProductTag.create/index.html.md) - [delete](https://docs.medusajs.com/references/js_sdk/admin/ProductTag/methods/js_sdk.admin.ProductTag.delete/index.html.md) -- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/ProductTag/methods/js_sdk.admin.ProductTag.retrieve/index.html.md) - [list](https://docs.medusajs.com/references/js_sdk/admin/ProductTag/methods/js_sdk.admin.ProductTag.list/index.html.md) +- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/ProductTag/methods/js_sdk.admin.ProductTag.retrieve/index.html.md) +- [create](https://docs.medusajs.com/references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.create/index.html.md) +- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.retrieve/index.html.md) +- [delete](https://docs.medusajs.com/references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.delete/index.html.md) +- [list](https://docs.medusajs.com/references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.list/index.html.md) +- [update](https://docs.medusajs.com/references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.update/index.html.md) - [update](https://docs.medusajs.com/references/js_sdk/admin/ProductTag/methods/js_sdk.admin.ProductTag.update/index.html.md) +- [updateProducts](https://docs.medusajs.com/references/js_sdk/admin/ProductCategory/methods/js_sdk.admin.ProductCategory.updateProducts/index.html.md) - [list](https://docs.medusajs.com/references/js_sdk/admin/ProductVariant/methods/js_sdk.admin.ProductVariant.list/index.html.md) -- [delete](https://docs.medusajs.com/references/js_sdk/admin/ProductType/methods/js_sdk.admin.ProductType.delete/index.html.md) -- [create](https://docs.medusajs.com/references/js_sdk/admin/ProductType/methods/js_sdk.admin.ProductType.create/index.html.md) -- [list](https://docs.medusajs.com/references/js_sdk/admin/ProductType/methods/js_sdk.admin.ProductType.list/index.html.md) -- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/ProductType/methods/js_sdk.admin.ProductType.retrieve/index.html.md) -- [create](https://docs.medusajs.com/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.create/index.html.md) -- [update](https://docs.medusajs.com/references/js_sdk/admin/ProductType/methods/js_sdk.admin.ProductType.update/index.html.md) - [addRules](https://docs.medusajs.com/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.addRules/index.html.md) -- [listRuleAttributes](https://docs.medusajs.com/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.listRuleAttributes/index.html.md) +- [create](https://docs.medusajs.com/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.create/index.html.md) - [list](https://docs.medusajs.com/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.list/index.html.md) -- [listRuleValues](https://docs.medusajs.com/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.listRuleValues/index.html.md) - [delete](https://docs.medusajs.com/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.delete/index.html.md) +- [listRuleAttributes](https://docs.medusajs.com/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.listRuleAttributes/index.html.md) - [listRules](https://docs.medusajs.com/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.listRules/index.html.md) +- [listRuleValues](https://docs.medusajs.com/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.listRuleValues/index.html.md) +- [removeRules](https://docs.medusajs.com/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.removeRules/index.html.md) - [retrieve](https://docs.medusajs.com/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.retrieve/index.html.md) - [update](https://docs.medusajs.com/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.update/index.html.md) -- [removeRules](https://docs.medusajs.com/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.removeRules/index.html.md) - [updateRules](https://docs.medusajs.com/references/js_sdk/admin/Promotion/methods/js_sdk.admin.Promotion.updateRules/index.html.md) +- [delete](https://docs.medusajs.com/references/js_sdk/admin/ProductType/methods/js_sdk.admin.ProductType.delete/index.html.md) +- [create](https://docs.medusajs.com/references/js_sdk/admin/ProductType/methods/js_sdk.admin.ProductType.create/index.html.md) +- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/ProductType/methods/js_sdk.admin.ProductType.retrieve/index.html.md) +- [list](https://docs.medusajs.com/references/js_sdk/admin/ProductType/methods/js_sdk.admin.ProductType.list/index.html.md) +- [update](https://docs.medusajs.com/references/js_sdk/admin/ProductType/methods/js_sdk.admin.ProductType.update/index.html.md) - [list](https://docs.medusajs.com/references/js_sdk/admin/RefundReason/methods/js_sdk.admin.RefundReason.list/index.html.md) - [create](https://docs.medusajs.com/references/js_sdk/admin/Region/methods/js_sdk.admin.Region.create/index.html.md) +- [delete](https://docs.medusajs.com/references/js_sdk/admin/Region/methods/js_sdk.admin.Region.delete/index.html.md) - [list](https://docs.medusajs.com/references/js_sdk/admin/Region/methods/js_sdk.admin.Region.list/index.html.md) - [retrieve](https://docs.medusajs.com/references/js_sdk/admin/Region/methods/js_sdk.admin.Region.retrieve/index.html.md) -- [delete](https://docs.medusajs.com/references/js_sdk/admin/Region/methods/js_sdk.admin.Region.delete/index.html.md) - [update](https://docs.medusajs.com/references/js_sdk/admin/Region/methods/js_sdk.admin.Region.update/index.html.md) - [create](https://docs.medusajs.com/references/js_sdk/admin/ReturnReason/methods/js_sdk.admin.ReturnReason.create/index.html.md) - [delete](https://docs.medusajs.com/references/js_sdk/admin/ReturnReason/methods/js_sdk.admin.ReturnReason.delete/index.html.md) -- [list](https://docs.medusajs.com/references/js_sdk/admin/ReturnReason/methods/js_sdk.admin.ReturnReason.list/index.html.md) - [retrieve](https://docs.medusajs.com/references/js_sdk/admin/ReturnReason/methods/js_sdk.admin.ReturnReason.retrieve/index.html.md) -- [update](https://docs.medusajs.com/references/js_sdk/admin/ReturnReason/methods/js_sdk.admin.ReturnReason.update/index.html.md) -- [create](https://docs.medusajs.com/references/js_sdk/admin/Reservation/methods/js_sdk.admin.Reservation.create/index.html.md) +- [list](https://docs.medusajs.com/references/js_sdk/admin/ReturnReason/methods/js_sdk.admin.ReturnReason.list/index.html.md) - [delete](https://docs.medusajs.com/references/js_sdk/admin/Reservation/methods/js_sdk.admin.Reservation.delete/index.html.md) - [list](https://docs.medusajs.com/references/js_sdk/admin/Reservation/methods/js_sdk.admin.Reservation.list/index.html.md) +- [update](https://docs.medusajs.com/references/js_sdk/admin/ReturnReason/methods/js_sdk.admin.ReturnReason.update/index.html.md) +- [create](https://docs.medusajs.com/references/js_sdk/admin/Reservation/methods/js_sdk.admin.Reservation.create/index.html.md) - [retrieve](https://docs.medusajs.com/references/js_sdk/admin/Reservation/methods/js_sdk.admin.Reservation.retrieve/index.html.md) - [update](https://docs.medusajs.com/references/js_sdk/admin/Reservation/methods/js_sdk.admin.Reservation.update/index.html.md) +- [batchProducts](https://docs.medusajs.com/references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.batchProducts/index.html.md) - [delete](https://docs.medusajs.com/references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.delete/index.html.md) - [create](https://docs.medusajs.com/references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.create/index.html.md) -- [batchProducts](https://docs.medusajs.com/references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.batchProducts/index.html.md) - [list](https://docs.medusajs.com/references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.list/index.html.md) -- [update](https://docs.medusajs.com/references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.update/index.html.md) - [retrieve](https://docs.medusajs.com/references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.retrieve/index.html.md) +- [update](https://docs.medusajs.com/references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.update/index.html.md) - [updateProducts](https://docs.medusajs.com/references/js_sdk/admin/SalesChannel/methods/js_sdk.admin.SalesChannel.updateProducts/index.html.md) -- [delete](https://docs.medusajs.com/references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.delete/index.html.md) -- [create](https://docs.medusajs.com/references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.create/index.html.md) -- [list](https://docs.medusajs.com/references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.list/index.html.md) -- [update](https://docs.medusajs.com/references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.update/index.html.md) -- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.retrieve/index.html.md) -- [updateRules](https://docs.medusajs.com/references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.updateRules/index.html.md) -- [cancelReceive](https://docs.medusajs.com/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.cancelReceive/index.html.md) -- [addReturnShipping](https://docs.medusajs.com/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.addReturnShipping/index.html.md) -- [cancelRequest](https://docs.medusajs.com/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.cancelRequest/index.html.md) -- [cancel](https://docs.medusajs.com/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.cancel/index.html.md) - [addReturnItem](https://docs.medusajs.com/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.addReturnItem/index.html.md) +- [addReturnShipping](https://docs.medusajs.com/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.addReturnShipping/index.html.md) +- [cancel](https://docs.medusajs.com/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.cancel/index.html.md) +- [cancelRequest](https://docs.medusajs.com/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.cancelRequest/index.html.md) +- [cancelReceive](https://docs.medusajs.com/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.cancelReceive/index.html.md) - [confirmReceive](https://docs.medusajs.com/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.confirmReceive/index.html.md) -- [deleteReturnShipping](https://docs.medusajs.com/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.deleteReturnShipping/index.html.md) -- [initiateRequest](https://docs.medusajs.com/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.initiateRequest/index.html.md) -- [list](https://docs.medusajs.com/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.list/index.html.md) - [confirmRequest](https://docs.medusajs.com/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.confirmRequest/index.html.md) -- [receiveItems](https://docs.medusajs.com/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.receiveItems/index.html.md) +- [deleteReturnShipping](https://docs.medusajs.com/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.deleteReturnShipping/index.html.md) - [initiateReceive](https://docs.medusajs.com/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.initiateReceive/index.html.md) - [dismissItems](https://docs.medusajs.com/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.dismissItems/index.html.md) -- [removeDismissItem](https://docs.medusajs.com/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.removeDismissItem/index.html.md) -- [removeReturnItem](https://docs.medusajs.com/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.removeReturnItem/index.html.md) -- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.retrieve/index.html.md) +- [receiveItems](https://docs.medusajs.com/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.receiveItems/index.html.md) +- [initiateRequest](https://docs.medusajs.com/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.initiateRequest/index.html.md) - [removeReceiveItem](https://docs.medusajs.com/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.removeReceiveItem/index.html.md) +- [list](https://docs.medusajs.com/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.list/index.html.md) +- [removeDismissItem](https://docs.medusajs.com/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.removeDismissItem/index.html.md) +- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.retrieve/index.html.md) - [updateDismissItem](https://docs.medusajs.com/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.updateDismissItem/index.html.md) - [updateReceiveItem](https://docs.medusajs.com/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.updateReceiveItem/index.html.md) +- [removeReturnItem](https://docs.medusajs.com/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.removeReturnItem/index.html.md) - [updateRequest](https://docs.medusajs.com/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.updateRequest/index.html.md) - [updateReturnItem](https://docs.medusajs.com/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.updateReturnItem/index.html.md) - [updateReturnShipping](https://docs.medusajs.com/references/js_sdk/admin/Return/methods/js_sdk.admin.Return.updateReturnShipping/index.html.md) -- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/Store/methods/js_sdk.admin.Store.retrieve/index.html.md) -- [list](https://docs.medusajs.com/references/js_sdk/admin/Store/methods/js_sdk.admin.Store.list/index.html.md) -- [update](https://docs.medusajs.com/references/js_sdk/admin/Store/methods/js_sdk.admin.Store.update/index.html.md) -- [create](https://docs.medusajs.com/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.create/index.html.md) +- [create](https://docs.medusajs.com/references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.create/index.html.md) +- [delete](https://docs.medusajs.com/references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.delete/index.html.md) +- [update](https://docs.medusajs.com/references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.update/index.html.md) +- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.retrieve/index.html.md) +- [updateRules](https://docs.medusajs.com/references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.updateRules/index.html.md) +- [list](https://docs.medusajs.com/references/js_sdk/admin/ShippingOption/methods/js_sdk.admin.ShippingOption.list/index.html.md) +- [delete](https://docs.medusajs.com/references/js_sdk/admin/ShippingProfile/methods/js_sdk.admin.ShippingProfile.delete/index.html.md) +- [create](https://docs.medusajs.com/references/js_sdk/admin/ShippingProfile/methods/js_sdk.admin.ShippingProfile.create/index.html.md) +- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/ShippingProfile/methods/js_sdk.admin.ShippingProfile.retrieve/index.html.md) +- [list](https://docs.medusajs.com/references/js_sdk/admin/ShippingProfile/methods/js_sdk.admin.ShippingProfile.list/index.html.md) +- [update](https://docs.medusajs.com/references/js_sdk/admin/ShippingProfile/methods/js_sdk.admin.ShippingProfile.update/index.html.md) - [createFulfillmentSet](https://docs.medusajs.com/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.createFulfillmentSet/index.html.md) - [delete](https://docs.medusajs.com/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.delete/index.html.md) -- [updateFulfillmentProviders](https://docs.medusajs.com/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.updateFulfillmentProviders/index.html.md) - [list](https://docs.medusajs.com/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.list/index.html.md) -- [update](https://docs.medusajs.com/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.update/index.html.md) +- [create](https://docs.medusajs.com/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.create/index.html.md) +- [updateFulfillmentProviders](https://docs.medusajs.com/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.updateFulfillmentProviders/index.html.md) - [retrieve](https://docs.medusajs.com/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.retrieve/index.html.md) +- [update](https://docs.medusajs.com/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.update/index.html.md) - [updateSalesChannels](https://docs.medusajs.com/references/js_sdk/admin/StockLocation/methods/js_sdk.admin.StockLocation.updateSalesChannels/index.html.md) -- [create](https://docs.medusajs.com/references/js_sdk/admin/ShippingProfile/methods/js_sdk.admin.ShippingProfile.create/index.html.md) -- [delete](https://docs.medusajs.com/references/js_sdk/admin/ShippingProfile/methods/js_sdk.admin.ShippingProfile.delete/index.html.md) -- [list](https://docs.medusajs.com/references/js_sdk/admin/ShippingProfile/methods/js_sdk.admin.ShippingProfile.list/index.html.md) -- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/ShippingProfile/methods/js_sdk.admin.ShippingProfile.retrieve/index.html.md) -- [update](https://docs.medusajs.com/references/js_sdk/admin/ShippingProfile/methods/js_sdk.admin.ShippingProfile.update/index.html.md) +- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/Store/methods/js_sdk.admin.Store.retrieve/index.html.md) +- [update](https://docs.medusajs.com/references/js_sdk/admin/Store/methods/js_sdk.admin.Store.update/index.html.md) +- [list](https://docs.medusajs.com/references/js_sdk/admin/Store/methods/js_sdk.admin.Store.list/index.html.md) - [delete](https://docs.medusajs.com/references/js_sdk/admin/TaxRegion/methods/js_sdk.admin.TaxRegion.delete/index.html.md) -- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/TaxRegion/methods/js_sdk.admin.TaxRegion.retrieve/index.html.md) - [create](https://docs.medusajs.com/references/js_sdk/admin/TaxRegion/methods/js_sdk.admin.TaxRegion.create/index.html.md) -- [create](https://docs.medusajs.com/references/js_sdk/admin/TaxRate/methods/js_sdk.admin.TaxRate.create/index.html.md) - [list](https://docs.medusajs.com/references/js_sdk/admin/TaxRegion/methods/js_sdk.admin.TaxRegion.list/index.html.md) +- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/TaxRegion/methods/js_sdk.admin.TaxRegion.retrieve/index.html.md) +- [delete](https://docs.medusajs.com/references/js_sdk/admin/Upload/methods/js_sdk.admin.Upload.delete/index.html.md) +- [create](https://docs.medusajs.com/references/js_sdk/admin/Upload/methods/js_sdk.admin.Upload.create/index.html.md) +- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/Upload/methods/js_sdk.admin.Upload.retrieve/index.html.md) +- [create](https://docs.medusajs.com/references/js_sdk/admin/TaxRate/methods/js_sdk.admin.TaxRate.create/index.html.md) - [delete](https://docs.medusajs.com/references/js_sdk/admin/TaxRate/methods/js_sdk.admin.TaxRate.delete/index.html.md) - [retrieve](https://docs.medusajs.com/references/js_sdk/admin/TaxRate/methods/js_sdk.admin.TaxRate.retrieve/index.html.md) -- [update](https://docs.medusajs.com/references/js_sdk/admin/TaxRate/methods/js_sdk.admin.TaxRate.update/index.html.md) - [list](https://docs.medusajs.com/references/js_sdk/admin/TaxRate/methods/js_sdk.admin.TaxRate.list/index.html.md) -- [create](https://docs.medusajs.com/references/js_sdk/admin/Upload/methods/js_sdk.admin.Upload.create/index.html.md) -- [list](https://docs.medusajs.com/references/js_sdk/admin/User/methods/js_sdk.admin.User.list/index.html.md) -- [delete](https://docs.medusajs.com/references/js_sdk/admin/Upload/methods/js_sdk.admin.Upload.delete/index.html.md) -- [delete](https://docs.medusajs.com/references/js_sdk/admin/User/methods/js_sdk.admin.User.delete/index.html.md) -- [retrieve](https://docs.medusajs.com/references/js_sdk/admin/Upload/methods/js_sdk.admin.Upload.retrieve/index.html.md) +- [update](https://docs.medusajs.com/references/js_sdk/admin/TaxRate/methods/js_sdk.admin.TaxRate.update/index.html.md) - [me](https://docs.medusajs.com/references/js_sdk/admin/User/methods/js_sdk.admin.User.me/index.html.md) - [retrieve](https://docs.medusajs.com/references/js_sdk/admin/User/methods/js_sdk.admin.User.retrieve/index.html.md) - [update](https://docs.medusajs.com/references/js_sdk/admin/User/methods/js_sdk.admin.User.update/index.html.md) +- [delete](https://docs.medusajs.com/references/js_sdk/admin/User/methods/js_sdk.admin.User.delete/index.html.md) +- [list](https://docs.medusajs.com/references/js_sdk/admin/User/methods/js_sdk.admin.User.list/index.html.md) - [list](https://docs.medusajs.com/references/js_sdk/admin/WorkflowExecution/methods/js_sdk.admin.WorkflowExecution.list/index.html.md) - [retrieve](https://docs.medusajs.com/references/js_sdk/admin/WorkflowExecution/methods/js_sdk.admin.WorkflowExecution.retrieve/index.html.md) @@ -27946,10 +28368,10 @@ The object or class passed to `auth.storage` configuration must have the followi - [callback](https://docs.medusajs.com/references/js-sdk/auth/callback/index.html.md) - [login](https://docs.medusajs.com/references/js-sdk/auth/login/index.html.md) -- [register](https://docs.medusajs.com/references/js-sdk/auth/register/index.html.md) - [logout](https://docs.medusajs.com/references/js-sdk/auth/logout/index.html.md) - [refresh](https://docs.medusajs.com/references/js-sdk/auth/refresh/index.html.md) - [resetPassword](https://docs.medusajs.com/references/js-sdk/auth/resetPassword/index.html.md) +- [register](https://docs.medusajs.com/references/js-sdk/auth/register/index.html.md) - [updateProvider](https://docs.medusajs.com/references/js-sdk/auth/updateProvider/index.html.md) @@ -27958,12 +28380,12 @@ The object or class passed to `auth.storage` configuration must have the followi - [cart](https://docs.medusajs.com/references/js-sdk/store/cart/index.html.md) - [category](https://docs.medusajs.com/references/js-sdk/store/category/index.html.md) - [collection](https://docs.medusajs.com/references/js-sdk/store/collection/index.html.md) -- [order](https://docs.medusajs.com/references/js-sdk/store/order/index.html.md) -- [payment](https://docs.medusajs.com/references/js-sdk/store/payment/index.html.md) -- [customer](https://docs.medusajs.com/references/js-sdk/store/customer/index.html.md) - [fulfillment](https://docs.medusajs.com/references/js-sdk/store/fulfillment/index.html.md) -- [product](https://docs.medusajs.com/references/js-sdk/store/product/index.html.md) +- [order](https://docs.medusajs.com/references/js-sdk/store/order/index.html.md) +- [customer](https://docs.medusajs.com/references/js-sdk/store/customer/index.html.md) +- [payment](https://docs.medusajs.com/references/js-sdk/store/payment/index.html.md) - [region](https://docs.medusajs.com/references/js-sdk/store/region/index.html.md) +- [product](https://docs.medusajs.com/references/js-sdk/store/product/index.html.md) # Configure Medusa Backend @@ -28631,204 +29053,6 @@ Use these components to set the layout of your UI route. Use these components in your widgets and UI routes. -# Single Column Layout - Admin Components - -The Medusa Admin has pages with a single column of content. - -This doesn't include the sidebar, only the main content. - -![An example of an admin page with a single column](https://res.cloudinary.com/dza7lstvk/image/upload/v1728286605/Medusa%20Resources/single-column.png) - -To create a layout that you can use in UI routes to support one column of content, create the component `src/admin/layouts/single-column.tsx` with the following content: - -```tsx title="src/admin/layouts/single-column.tsx" -export type SingleColumnLayoutProps = { - children: React.ReactNode -} - -export const SingleColumnLayout = ({ children }: SingleColumnLayoutProps) => { - return ( -
- {children} -
- ) -} -``` - -The `SingleColumnLayout` accepts the content in the `children` props. - -*** - -## Example - -Use the `SingleColumnLayout` component in your UI routes that have a single column. For example: - -```tsx title="src/admin/routes/custom/page.tsx" highlights={[["9"]]} -import { defineRouteConfig } from "@medusajs/admin-sdk" -import { ChatBubbleLeftRight } from "@medusajs/icons" -import { Container } from "../../components/container" -import { SingleColumnLayout } from "../../layouts/single-column" -import { Header } from "../../components/header" - -const CustomPage = () => { - return ( - - -
- - - ) -} - -export const config = defineRouteConfig({ - label: "Custom", - icon: ChatBubbleLeftRight, -}) - -export default CustomPage -``` - -This UI route also uses a [Container](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/admin-components/components/container/index.html.md) and a [Header]() custom components. - - -# Two Column Layout - Admin Components - -The Medusa Admin has pages with two columns of content. - -This doesn't include the sidebar, only the main content. - -![An example of an admin page with two columns](https://res.cloudinary.com/dza7lstvk/image/upload/v1728286690/Medusa%20Resources/two-column_sdnkg0.png) - -To create a layout that you can use in UI routes to support two columns of content, create the component `src/admin/layouts/two-column.tsx` with the following content: - -```tsx title="src/admin/layouts/two-column.tsx" -export type TwoColumnLayoutProps = { - firstCol: React.ReactNode - secondCol: React.ReactNode -} - -export const TwoColumnLayout = ({ - firstCol, - secondCol, -}: TwoColumnLayoutProps) => { - return ( -
-
- {firstCol} -
-
- {secondCol} -
-
- ) -} -``` - -The `TwoColumnLayout` accepts two props: - -- `firstCol` indicating the content of the first column. -- `secondCol` indicating the content of the second column. - -*** - -## Example - -Use the `TwoColumnLayout` component in your UI routes that have a single column. For example: - -```tsx title="src/admin/routes/custom/page.tsx" highlights={[["9"]]} -import { defineRouteConfig } from "@medusajs/admin-sdk" -import { ChatBubbleLeftRight } from "@medusajs/icons" -import { Container } from "../../components/container" -import { Header } from "../../components/header" -import { TwoColumnLayout } from "../../layouts/two-column" - -const CustomPage = () => { - return ( - -
- - } - secondCol={ - -
- - } - /> - ) -} - -export const config = defineRouteConfig({ - label: "Custom", - icon: ChatBubbleLeftRight, -}) - -export default CustomPage -``` - -This UI route also uses [Container](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/admin-components/components/container/index.html.md) and [Header]() custom components. - - -# Container - Admin Components - -The Medusa Admin wraps each section of a page in a container. - -![Example of a container in the Medusa Admin](https://res.cloudinary.com/dza7lstvk/image/upload/v1728287102/Medusa%20Resources/container_soenir.png) - -To create a component that uses the same container styling in your widgets or UI routes, create the file `src/admin/components/container.tsx` with the following content: - -```tsx -import { - Container as UiContainer, - clx, -} from "@medusajs/ui" - -type ContainerProps = React.ComponentProps - -export const Container = (props: ContainerProps) => { - return ( - - ) -} -``` - -The `Container` component re-uses the component from the [Medusa UI package](https://docs.medusajs.com/ui/components/container/index.html.md) and applies to it classes to match the Medusa Admin's design conventions. - -*** - -## Example - -Use that `Container` component in any widget or UI route. - -For example, create the widget `src/admin/widgets/product-widget.tsx` with the following content: - -```tsx title="src/admin/widgets/product-widget.tsx" -import { defineWidgetConfig } from "@medusajs/admin-sdk" -import { Container } from "../components/container" -import { Header } from "../components/header" - -const ProductWidget = () => { - return ( - -
- - ) -} - -export const config = defineWidgetConfig({ - zone: "product.details.before", -}) - -export default ProductWidget -``` - -This widget also uses a [Header](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/admin-components/components/header/index.html.md) custom component. - - # Action Menu - Admin Components The Medusa Admin often provides additional actions in a dropdown shown when users click a three-dot icon. @@ -29054,6 +29278,552 @@ export default ProductWidget ``` +# Container - Admin Components + +The Medusa Admin wraps each section of a page in a container. + +![Example of a container in the Medusa Admin](https://res.cloudinary.com/dza7lstvk/image/upload/v1728287102/Medusa%20Resources/container_soenir.png) + +To create a component that uses the same container styling in your widgets or UI routes, create the file `src/admin/components/container.tsx` with the following content: + +```tsx +import { + Container as UiContainer, + clx, +} from "@medusajs/ui" + +type ContainerProps = React.ComponentProps + +export const Container = (props: ContainerProps) => { + return ( + + ) +} +``` + +The `Container` component re-uses the component from the [Medusa UI package](https://docs.medusajs.com/ui/components/container/index.html.md) and applies to it classes to match the Medusa Admin's design conventions. + +*** + +## Example + +Use that `Container` component in any widget or UI route. + +For example, create the widget `src/admin/widgets/product-widget.tsx` with the following content: + +```tsx title="src/admin/widgets/product-widget.tsx" +import { defineWidgetConfig } from "@medusajs/admin-sdk" +import { Container } from "../components/container" +import { Header } from "../components/header" + +const ProductWidget = () => { + return ( + +
+ + ) +} + +export const config = defineWidgetConfig({ + zone: "product.details.before", +}) + +export default ProductWidget +``` + +This widget also uses a [Header](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/admin-components/components/header/index.html.md) custom component. + + +# Data Table - Admin Components + +This component is available after [Medusa v2.4.0+](https://github.com/medusajs/medusa/releases/tag/v2.4.0). + +The [DataTable component in Medusa UI](https://docs.medusajs.com/ui/components/data-table/index.html.md) allows you to display data in a table with sorting, filtering, and pagination. It's used across the Medusa Admin dashboard to showcase a list of items, such as a list of products. + +![Example of a table in the product listing page](https://res.cloudinary.com/dza7lstvk/image/upload/v1728295658/Medusa%20Resources/list_ddt9zc.png) + +You can use this component in your Admin Extensions to display data in a table format, especially if you're retrieving them from API routes of the Medusa application. + +This guide focuses on how to use the `DataTable` component while fetching data from the backend. Refer to the [Medusa UI documentation](https://docs.medusajs.com/ui/components/data-table/index.html.md) for detailed information about the DataTable component and its different usages. + +## Example: DataTable with Data Fetching + +In this example, you'll create a UI widget that shows the list of products retrieved from the [List Products API Route](https://docs.medusajs.com/api/admin#products_getproducts) in a data table with pagination, filtering, searching, and sorting. + +Start by initializing the columns in the data table. To do that, use the `createDataTableColumnHelper` from Medusa UI: + +```tsx title="src/admin/routes/custom/page.tsx" +import { + createDataTableColumnHelper, +} from "@medusajs/ui" +import { + HttpTypes, +} from "@medusajs/framework/types" + +const columnHelper = createDataTableColumnHelper() + +const columns = [ + columnHelper.accessor("title", { + header: "Title", + // Enables sorting for the column. + enableSorting: true, + // If omitted, the header will be used instead if it's a string, + // otherwise the accessor key (id) will be used. + sortLabel: "Title", + // If omitted the default value will be "A-Z" + sortAscLabel: "A-Z", + // If omitted the default value will be "Z-A" + sortDescLabel: "Z-A", + }), + columnHelper.accessor("status", { + header: "Status", + cell: ({ getValue }) => { + const status = getValue() + return ( + + {status === "published" ? "Published" : "Draft"} + + ) + }, + }), +] +``` + +`createDataTableColumnHelper` utility creates a column helper that helps you define the columns for the data table. The column helper has an `accessor` method that accepts two parameters: + +1. The column's key in the table's data. +2. An object with the following properties: + - `header`: The column's header. + - `cell`: (optional) By default, a data's value for a column is displayed as a string. Use this property to specify custom rendering of the value. It accepts a function that returns a string or a React node. The function receives an object that has a `getValue` property function to retrieve the raw value of the cell. + - `enableSorting`: (optional) A boolean that enables sorting data by this column. + - `sortLabel`: (optional) The label for the sorting button. If omitted, the `header` will be used instead if it's a string, otherwise the accessor key (id) will be used. + - `sortAscLabel`: (optional) The label for the ascending sorting button. If omitted, the default value will be "A-Z". + - `sortDescLabel`: (optional) The label for the descending sorting button. If omitted, the default value will be "Z-A". + +Next, you'll define the filters that can be applied to the data table. You'll configure filtering by product status. + +To define the filters, add the following: + +```tsx title="src/admin/routes/custom/page.tsx" +// other imports... +import { + // ... + createDataTableFilterHelper, +} from "@medusajs/ui" + +const filterHelper = createDataTableFilterHelper() + +const filters = [ + filterHelper.accessor("status", { + type: "select", + label: "Status", + options: [ + { + label: "Published", + value: "published", + }, + { + label: "Draft", + value: "draft", + }, + ], + }), +] +``` + +`createDataTableFilterHelper` utility creates a filter helper that helps you define the filters for the data table. The filter helper has an `accessor` method that accepts two parameters: + +1. The key of a column in the table's data. +2. An object with the following properties: + - `type`: The type of filter. It can be either: + - `select`: A select dropdown allowing users to choose multiple values. + - `radio`: A radio button allowing users to choose one value. + - `date`: A date picker allowing users to choose a date. + - `label`: The filter's label. + - `options`: An array of objects with `label` and `value` properties. The `label` is the option's label, and the `value` is the value to filter by. + +You'll now start creating the UI widget's component. Start by adding the necessary state variables: + +```tsx title="src/admin/routes/custom/page.tsx" +// other imports... +import { + // ... + DataTablePaginationState, + DataTableFilteringState, + DataTableSortingState, +} from "@medusajs/ui" +import { useMemo, useState } from "react" + +// ... + +const limit = 15 + +const CustomPage = () => { + const [pagination, setPagination] = useState({ + pageSize: limit, + pageIndex: 0, + }) + const [search, setSearch] = useState("") + const [filtering, setFiltering] = useState({}) + const [sorting, setSorting] = useState(null) + + const offset = useMemo(() => { + return pagination.pageIndex * limit + }, [pagination]) + const statusFilters = useMemo(() => { + return (filtering.status || []) as ProductStatus + }, [filtering]) + + // TODO add data fetching logic +} +``` + +In the component, you've added the following state variables: + +- `pagination`: An object of type `DataTablePaginationState` that holds the pagination state. It has two properties: + - `pageSize`: The number of items to show per page. + - `pageIndex`: The current page index. +- `search`: A string that holds the search query. +- `filtering`: An object of type `DataTableFilteringState` that holds the filtering state. +- `sorting`: An object of type `DataTableSortingState` that holds the sorting state. + +You've also added two memoized variables: + +- `offset`: How many items to skip when fetching data based on the current page. +- `statusFilters`: The selected status filters, if any. + +Next, you'll fetch the products from the Medusa application. Assuming you have the JS SDK configured as explained in [this guide](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/js-sdk/index.html.md), add the following imports at the top of the file: + +```tsx title="src/admin/routes/custom/page.tsx" +import { sdk } from "../../lib/config" +import { useQuery } from "@tanstack/react-query" +``` + +This imports the JS SDK instance and `useQuery` from [Tanstack Query](https://tanstack.com/query/latest). + +Then, replace the `TODO` in the component with the following: + +```tsx title="src/admin/routes/custom/page.tsx" +const { data, isLoading } = useQuery({ + queryFn: () => sdk.admin.product.list({ + limit, + offset, + q: search, + status: statusFilters, + order: sorting ? `${sorting.desc ? "-" : ""}${sorting.id}` : undefined, + }), + queryKey: [["products", limit, offset, search, statusFilters, sorting?.id, sorting?.desc]], +}) + +// TODO configure data table +``` + +You use the `useQuery` hook to fetch the products from the Medusa application. In the `queryFn`, you call the `sdk.admin.product.list` method to fetch the products. You pass the following query parameters to the method: + +- `limit`: The number of products to fetch per page. +- `offset`: The number of products to skip based on the current page. +- `q`: The search query, if set. +- `status`: The status filters, if set. +- `order`: The sorting order, if set. + +So, whenever the user changes the current page, search query, status filters, or sorting, the products are fetched based on the new parameters. + +Next, you'll configure the data table. Medusa UI provides a `useDataTable` hook that helps you configure the data table. Add the following imports at the top of the file: + +```tsx title="src/admin/routes/custom/page.tsx" +import { + // ... + useDataTable, +} from "@medusajs/ui" +import { useNavigate } from "react-router-dom" +``` + +Then, replace the `TODO` in the component with the following: + +```tsx title="src/admin/routes/custom/page.tsx" +const navigate = useNavigate() + +const table = useDataTable({ + columns, + data: data?.products || [], + getRowId: (row) => row.id, + rowCount: data?.count || 0, + isLoading, + pagination: { + state: pagination, + onPaginationChange: setPagination, + }, + search: { + state: search, + onSearchChange: setSearch, + }, + filtering: { + state: filtering, + onFilteringChange: setFiltering, + }, + filters, + sorting: { + // Pass the pagination state and updater to the table instance + state: sorting, + onSortingChange: setSorting, + }, + onRowClick: (event, row) => { + // Handle row click, for example + navigate(`/products/${row.id}`) + }, +}) + +// TODO render component +``` + +The `useDataTable` hook accepts an object with the following properties: + +- columns: (\`array\`) The columns to display in the data table. You created this using the \`createDataTableColumnHelper\` utility. +- data: (\`array\`) The products fetched from the Medusa application. +- getRowId: (\`function\`) A function that returns the unique ID of a row. +- rowCount: (\`number\`) The total number of products that can be retrieved. This is used to determine the number of pages. +- isLoading: (\`boolean\`) A boolean that indicates if the data is being fetched. +- pagination: (\`object\`) An object to configure pagination. + + - state: (\`object\`) The pagination React state variable. + + - onPaginationChange: (\`function\`) A function that updates the pagination state. +- search: (\`object\`) An object to configure searching. + + - state: (\`string\`) The search query React state variable. + + - onSearchChange: (\`function\`) A function that updates the search query state. +- filtering: (\`object\`) An object to configure filtering. + + - state: (\`object\`) The filtering React state variable. + + - onFilteringChange: (\`function\`) A function that updates the filtering state. +- filters: (\`array\`) The filters to display in the data table. You created this using the \`createDataTableFilterHelper\` utility. +- sorting: (\`object\`) An object to configure sorting. + + - state: (\`object\`) The sorting React state variable. + + - onSortingChange: (\`function\`) A function that updates the sorting state. +- onRowClick: (\`function\`) A function that allows you to perform an action when the user clicks on a row. In this example, you navigate to the product's detail page. + + - event: (\`mouseevent\`) An instance of the \[MouseClickEvent]\(https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent) object. + + - row: (\`object\`) The data of the row that was clicked. + +Finally, you'll render the data table. But first, add the following imports at the top of the page: + +```tsx title="src/admin/routes/custom/page.tsx" +import { + // ... + DataTable, +} from "@medusajs/ui" +import { SingleColumnLayout } from "../../layouts/single-column" +import { Container } from "../../components/container" +``` + +Aside from the `DataTable` component, you also import the [SingleColumnLayout](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/admin-components/layouts/single-column/index.html.md) and [Container](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/admin-components/components/container/index.html.md) components implemented in other Admin Component guides. These components ensure a style consistent to other pages in the admin dashboard. + +Then, replace the `TODO` in the component with the following: + +```tsx title="src/admin/routes/custom/page.tsx" +return ( + + + + + Products +
+ + + +
+ + + + + + +) +``` + +You render the `DataTable` component and pass the `table` instance as a prop. In the `DataTable` component, you render a toolbar showing a heading, filter menu, sorting menu, and a search input. You also show pagination after the table. + +Lastly, export the component and the UI widget's configuration at the end of the file: + +```tsx title="src/admin/routes/custom/page.tsx" +// other imports... +import { defineRouteConfig } from "@medusajs/admin-sdk" +import { ChatBubbleLeftRight } from "@medusajs/icons" + +// ... + +export const config = defineRouteConfig({ + label: "Custom", + icon: ChatBubbleLeftRight, +}) + +export default CustomPage +``` + +If you start your Medusa application and go to `localhost:9000/app/custom`, you'll see the data table showing the list of products with pagination, filtering, searching, and sorting functionalities. + +### Full Example Code + +```tsx title="src/admin/routes/custom/page.tsx" +import { defineRouteConfig } from "@medusajs/admin-sdk" +import { ChatBubbleLeftRight } from "@medusajs/icons" +import { + Badge, + createDataTableColumnHelper, + createDataTableFilterHelper, + DataTable, + DataTableFilteringState, + DataTablePaginationState, + DataTableSortingState, + Heading, + useDataTable, +} from "@medusajs/ui" +import { useQuery } from "@tanstack/react-query" +import { SingleColumnLayout } from "../../layouts/single-column" +import { sdk } from "../../lib/config" +import { useMemo, useState } from "react" +import { Container } from "../../components/container" +import { HttpTypes, ProductStatus } from "@medusajs/framework/types" + +const columnHelper = createDataTableColumnHelper() + +const columns = [ + columnHelper.accessor("title", { + header: "Title", + // Enables sorting for the column. + enableSorting: true, + // If omitted, the header will be used instead if it's a string, + // otherwise the accessor key (id) will be used. + sortLabel: "Title", + // If omitted the default value will be "A-Z" + sortAscLabel: "A-Z", + // If omitted the default value will be "Z-A" + sortDescLabel: "Z-A", + }), + columnHelper.accessor("status", { + header: "Status", + cell: ({ getValue }) => { + const status = getValue() + return ( + + {status === "published" ? "Published" : "Draft"} + + ) + }, + }), +] + +const filterHelper = createDataTableFilterHelper() + +const filters = [ + filterHelper.accessor("status", { + type: "select", + label: "Status", + options: [ + { + label: "Published", + value: "published", + }, + { + label: "Draft", + value: "draft", + }, + ], + }), +] + +const limit = 15 + +const CustomPage = () => { + const [pagination, setPagination] = useState({ + pageSize: limit, + pageIndex: 0, + }) + const [search, setSearch] = useState("") + const [filtering, setFiltering] = useState({}) + const [sorting, setSorting] = useState(null) + + const offset = useMemo(() => { + return pagination.pageIndex * limit + }, [pagination]) + const statusFilters = useMemo(() => { + return (filtering.status || []) as ProductStatus + }, [filtering]) + + const { data, isLoading } = useQuery({ + queryFn: () => sdk.admin.product.list({ + limit, + offset, + q: search, + status: statusFilters, + order: sorting ? `${sorting.desc ? "-" : ""}${sorting.id}` : undefined, + }), + queryKey: [["products", limit, offset, search, statusFilters, sorting?.id, sorting?.desc]], + }) + + const table = useDataTable({ + columns, + data: data?.products || [], + getRowId: (row) => row.id, + rowCount: data?.count || 0, + isLoading, + pagination: { + state: pagination, + onPaginationChange: setPagination, + }, + search: { + state: search, + onSearchChange: setSearch, + }, + filtering: { + state: filtering, + onFilteringChange: setFiltering, + }, + filters, + sorting: { + // Pass the pagination state and updater to the table instance + state: sorting, + onSortingChange: setSorting, + }, + }) + + return ( + + + + + Products +
+ + + +
+ + + + + + + ) +} + +export const config = defineRouteConfig({ + label: "Custom", + icon: ChatBubbleLeftRight, +}) + +export default CustomPage +``` + + # Forms - Admin Components The Medusa Admin has two types of forms: @@ -29773,707 +30543,50 @@ export default ProductWidget This widget also uses a [Container](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/admin-components/components/container/index.html.md) custom component. -# JSON View - Admin Components +# Single Column Layout - Admin Components -Detail pages in the Medusa Admin show a JSON section to view the current page's details in JSON format. +The Medusa Admin has pages with a single column of content. -![Example of a JSON section in the admin](https://res.cloudinary.com/dza7lstvk/image/upload/v1728295129/Medusa%20Resources/json_dtbsgm.png) +This doesn't include the sidebar, only the main content. -To create a component that shows a JSON section in your customizations, create the file `src/admin/components/json-view-section.tsx` with the following content: +![An example of an admin page with a single column](https://res.cloudinary.com/dza7lstvk/image/upload/v1728286605/Medusa%20Resources/single-column.png) -```tsx title="src/admin/components/json-view-section.tsx" -import { - ArrowUpRightOnBox, - Check, - SquareTwoStack, - TriangleDownMini, - XMarkMini, -} from "@medusajs/icons" -import { - Badge, - Container, - Drawer, - Heading, - IconButton, - Kbd, -} from "@medusajs/ui" -import Primitive from "@uiw/react-json-view" -import { CSSProperties, MouseEvent, Suspense, useState } from "react" +To create a layout that you can use in UI routes to support one column of content, create the component `src/admin/layouts/single-column.tsx` with the following content: -type JsonViewSectionProps = { - data: object - title?: string +```tsx title="src/admin/layouts/single-column.tsx" +export type SingleColumnLayoutProps = { + children: React.ReactNode } -export const JsonViewSection = ({ data }: JsonViewSectionProps) => { - const numberOfKeys = Object.keys(data).length - +export const SingleColumnLayout = ({ children }: SingleColumnLayoutProps) => { return ( - -
- JSON - - {numberOfKeys} keys - -
- - - - - - - -
-
- - - - {numberOfKeys} - - - -
-
- - esc - - - - - - -
-
- -
-
} - > - - } /> - ( - null - )} - /> - ( - undefined - )} - /> - { - return ( - - {Object.keys(value as object).length} items - - ) - }} - /> - - - - - : - - { - return - }} - /> - - - - - - - - ) -} - -type CopiedProps = { - style?: CSSProperties - value: object | undefined -} - -const Copied = ({ style, value }: CopiedProps) => { - const [copied, setCopied] = useState(false) - - const handler = (e: MouseEvent) => { - e.stopPropagation() - setCopied(true) - - if (typeof value === "string") { - navigator.clipboard.writeText(value) - } else { - const json = JSON.stringify(value, null, 2) - navigator.clipboard.writeText(json) - } - - setTimeout(() => { - setCopied(false) - }, 2000) - } - - const styl = { whiteSpace: "nowrap", width: "20px" } - - if (copied) { - return ( - - - - ) - } - - return ( - - - +
+ {children} +
) } ``` -The `JsonViewSection` component shows a section with the "JSON" title and a button to show the data as JSON in a drawer or side window. - -The `JsonViewSection` accepts a `data` prop, which is the data to show as a JSON object in the drawer. +The `SingleColumnLayout` accepts the content in the `children` props. *** ## Example -Use the `JsonViewSection` component in any widget or UI route. +Use the `SingleColumnLayout` component in your UI routes that have a single column. For example: -For example, create the widget `src/admin/widgets/product-widget.tsx` with the following content: - -```tsx title="src/admin/widgets/product-widget.tsx" -import { defineWidgetConfig } from "@medusajs/admin-sdk" -import { JsonViewSection } from "../components/json-view-section" - -const ProductWidget = () => { - return -} - -export const config = defineWidgetConfig({ - zone: "product.details.before", -}) - -export default ProductWidget -``` - -This shows the JSON section at the top of the product page, passing it the object `{ name: "John" }`. - - -# Data Table - Admin Components - -This component is available after [Medusa v2.4.0+](https://github.com/medusajs/medusa/releases/tag/v2.4.0). - -The [DataTable component in Medusa UI](https://docs.medusajs.com/ui/components/data-table/index.html.md) allows you to display data in a table with sorting, filtering, and pagination. It's used across the Medusa Admin dashboard to showcase a list of items, such as a list of products. - -![Example of a table in the product listing page](https://res.cloudinary.com/dza7lstvk/image/upload/v1728295658/Medusa%20Resources/list_ddt9zc.png) - -You can use this component in your Admin Extensions to display data in a table format, especially if you're retrieving them from API routes of the Medusa application. - -This guide focuses on how to use the `DataTable` component while fetching data from the backend. Refer to the [Medusa UI documentation](https://docs.medusajs.com/ui/components/data-table/index.html.md) for detailed information about the DataTable component and its different usages. - -## Example: DataTable with Data Fetching - -In this example, you'll create a UI widget that shows the list of products retrieved from the [List Products API Route](https://docs.medusajs.com/api/admin#products_getproducts) in a data table with pagination, filtering, searching, and sorting. - -Start by initializing the columns in the data table. To do that, use the `createDataTableColumnHelper` from Medusa UI: - -```tsx title="src/admin/routes/custom/page.tsx" -import { - createDataTableColumnHelper, -} from "@medusajs/ui" -import { - HttpTypes, -} from "@medusajs/framework/types" - -const columnHelper = createDataTableColumnHelper() - -const columns = [ - columnHelper.accessor("title", { - header: "Title", - // Enables sorting for the column. - enableSorting: true, - // If omitted, the header will be used instead if it's a string, - // otherwise the accessor key (id) will be used. - sortLabel: "Title", - // If omitted the default value will be "A-Z" - sortAscLabel: "A-Z", - // If omitted the default value will be "Z-A" - sortDescLabel: "Z-A", - }), - columnHelper.accessor("status", { - header: "Status", - cell: ({ getValue }) => { - const status = getValue() - return ( - - {status === "published" ? "Published" : "Draft"} - - ) - }, - }), -] -``` - -`createDataTableColumnHelper` utility creates a column helper that helps you define the columns for the data table. The column helper has an `accessor` method that accepts two parameters: - -1. The column's key in the table's data. -2. An object with the following properties: - - `header`: The column's header. - - `cell`: (optional) By default, a data's value for a column is displayed as a string. Use this property to specify custom rendering of the value. It accepts a function that returns a string or a React node. The function receives an object that has a `getValue` property function to retrieve the raw value of the cell. - - `enableSorting`: (optional) A boolean that enables sorting data by this column. - - `sortLabel`: (optional) The label for the sorting button. If omitted, the `header` will be used instead if it's a string, otherwise the accessor key (id) will be used. - - `sortAscLabel`: (optional) The label for the ascending sorting button. If omitted, the default value will be "A-Z". - - `sortDescLabel`: (optional) The label for the descending sorting button. If omitted, the default value will be "Z-A". - -Next, you'll define the filters that can be applied to the data table. You'll configure filtering by product status. - -To define the filters, add the following: - -```tsx title="src/admin/routes/custom/page.tsx" -// other imports... -import { - // ... - createDataTableFilterHelper, -} from "@medusajs/ui" - -const filterHelper = createDataTableFilterHelper() - -const filters = [ - filterHelper.accessor("status", { - type: "select", - label: "Status", - options: [ - { - label: "Published", - value: "published", - }, - { - label: "Draft", - value: "draft", - }, - ], - }), -] -``` - -`createDataTableFilterHelper` utility creates a filter helper that helps you define the filters for the data table. The filter helper has an `accessor` method that accepts two parameters: - -1. The key of a column in the table's data. -2. An object with the following properties: - - `type`: The type of filter. It can be either: - - `select`: A select dropdown allowing users to choose multiple values. - - `radio`: A radio button allowing users to choose one value. - - `date`: A date picker allowing users to choose a date. - - `label`: The filter's label. - - `options`: An array of objects with `label` and `value` properties. The `label` is the option's label, and the `value` is the value to filter by. - -You'll now start creating the UI widget's component. Start by adding the necessary state variables: - -```tsx title="src/admin/routes/custom/page.tsx" -// other imports... -import { - // ... - DataTablePaginationState, - DataTableFilteringState, - DataTableSortingState, -} from "@medusajs/ui" -import { useMemo, useState } from "react" - -// ... - -const limit = 15 - -const CustomPage = () => { - const [pagination, setPagination] = useState({ - pageSize: limit, - pageIndex: 0, - }) - const [search, setSearch] = useState("") - const [filtering, setFiltering] = useState({}) - const [sorting, setSorting] = useState(null) - - const offset = useMemo(() => { - return pagination.pageIndex * limit - }, [pagination]) - const statusFilters = useMemo(() => { - return (filtering.status || []) as ProductStatus - }, [filtering]) - - // TODO add data fetching logic -} -``` - -In the component, you've added the following state variables: - -- `pagination`: An object of type `DataTablePaginationState` that holds the pagination state. It has two properties: - - `pageSize`: The number of items to show per page. - - `pageIndex`: The current page index. -- `search`: A string that holds the search query. -- `filtering`: An object of type `DataTableFilteringState` that holds the filtering state. -- `sorting`: An object of type `DataTableSortingState` that holds the sorting state. - -You've also added two memoized variables: - -- `offset`: How many items to skip when fetching data based on the current page. -- `statusFilters`: The selected status filters, if any. - -Next, you'll fetch the products from the Medusa application. Assuming you have the JS SDK configured as explained in [this guide](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/js-sdk/index.html.md), add the following imports at the top of the file: - -```tsx title="src/admin/routes/custom/page.tsx" -import { sdk } from "../../lib/config" -import { useQuery } from "@tanstack/react-query" -``` - -This imports the JS SDK instance and `useQuery` from [Tanstack Query](https://tanstack.com/query/latest). - -Then, replace the `TODO` in the component with the following: - -```tsx title="src/admin/routes/custom/page.tsx" -const { data, isLoading } = useQuery({ - queryFn: () => sdk.admin.product.list({ - limit, - offset, - q: search, - status: statusFilters, - order: sorting ? `${sorting.desc ? "-" : ""}${sorting.id}` : undefined, - }), - queryKey: [["products", limit, offset, search, statusFilters, sorting?.id, sorting?.desc]], -}) - -// TODO configure data table -``` - -You use the `useQuery` hook to fetch the products from the Medusa application. In the `queryFn`, you call the `sdk.admin.product.list` method to fetch the products. You pass the following query parameters to the method: - -- `limit`: The number of products to fetch per page. -- `offset`: The number of products to skip based on the current page. -- `q`: The search query, if set. -- `status`: The status filters, if set. -- `order`: The sorting order, if set. - -So, whenever the user changes the current page, search query, status filters, or sorting, the products are fetched based on the new parameters. - -Next, you'll configure the data table. Medusa UI provides a `useDataTable` hook that helps you configure the data table. Add the following imports at the top of the file: - -```tsx title="src/admin/routes/custom/page.tsx" -import { - // ... - useDataTable, -} from "@medusajs/ui" -import { useNavigate } from "react-router-dom" -``` - -Then, replace the `TODO` in the component with the following: - -```tsx title="src/admin/routes/custom/page.tsx" -const navigate = useNavigate() - -const table = useDataTable({ - columns, - data: data?.products || [], - getRowId: (row) => row.id, - rowCount: data?.count || 0, - isLoading, - pagination: { - state: pagination, - onPaginationChange: setPagination, - }, - search: { - state: search, - onSearchChange: setSearch, - }, - filtering: { - state: filtering, - onFilteringChange: setFiltering, - }, - filters, - sorting: { - // Pass the pagination state and updater to the table instance - state: sorting, - onSortingChange: setSorting, - }, - onRowClick: (event, row) => { - // Handle row click, for example - navigate(`/products/${row.id}`) - }, -}) - -// TODO render component -``` - -The `useDataTable` hook accepts an object with the following properties: - -- columns: (\`array\`) The columns to display in the data table. You created this using the \`createDataTableColumnHelper\` utility. -- data: (\`array\`) The products fetched from the Medusa application. -- getRowId: (\`function\`) A function that returns the unique ID of a row. -- rowCount: (\`number\`) The total number of products that can be retrieved. This is used to determine the number of pages. -- isLoading: (\`boolean\`) A boolean that indicates if the data is being fetched. -- pagination: (\`object\`) An object to configure pagination. - - - state: (\`object\`) The pagination React state variable. - - - onPaginationChange: (\`function\`) A function that updates the pagination state. -- search: (\`object\`) An object to configure searching. - - - state: (\`string\`) The search query React state variable. - - - onSearchChange: (\`function\`) A function that updates the search query state. -- filtering: (\`object\`) An object to configure filtering. - - - state: (\`object\`) The filtering React state variable. - - - onFilteringChange: (\`function\`) A function that updates the filtering state. -- filters: (\`array\`) The filters to display in the data table. You created this using the \`createDataTableFilterHelper\` utility. -- sorting: (\`object\`) An object to configure sorting. - - - state: (\`object\`) The sorting React state variable. - - - onSortingChange: (\`function\`) A function that updates the sorting state. -- onRowClick: (\`function\`) A function that allows you to perform an action when the user clicks on a row. In this example, you navigate to the product's detail page. - - - event: (\`mouseevent\`) An instance of the \[MouseClickEvent]\(https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent) object. - - - row: (\`object\`) The data of the row that was clicked. - -Finally, you'll render the data table. But first, add the following imports at the top of the page: - -```tsx title="src/admin/routes/custom/page.tsx" -import { - // ... - DataTable, -} from "@medusajs/ui" -import { SingleColumnLayout } from "../../layouts/single-column" -import { Container } from "../../components/container" -``` - -Aside from the `DataTable` component, you also import the [SingleColumnLayout](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/admin-components/layouts/single-column/index.html.md) and [Container](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/admin-components/components/container/index.html.md) components implemented in other Admin Component guides. These components ensure a style consistent to other pages in the admin dashboard. - -Then, replace the `TODO` in the component with the following: - -```tsx title="src/admin/routes/custom/page.tsx" -return ( - - - - - Products -
- - - -
- - - - - - -) -``` - -You render the `DataTable` component and pass the `table` instance as a prop. In the `DataTable` component, you render a toolbar showing a heading, filter menu, sorting menu, and a search input. You also show pagination after the table. - -Lastly, export the component and the UI widget's configuration at the end of the file: - -```tsx title="src/admin/routes/custom/page.tsx" -// other imports... +```tsx title="src/admin/routes/custom/page.tsx" highlights={[["9"]]} import { defineRouteConfig } from "@medusajs/admin-sdk" import { ChatBubbleLeftRight } from "@medusajs/icons" - -// ... - -export const config = defineRouteConfig({ - label: "Custom", - icon: ChatBubbleLeftRight, -}) - -export default CustomPage -``` - -If you start your Medusa application and go to `localhost:9000/app/custom`, you'll see the data table showing the list of products with pagination, filtering, searching, and sorting functionalities. - -### Full Example Code - -```tsx title="src/admin/routes/custom/page.tsx" -import { defineRouteConfig } from "@medusajs/admin-sdk" -import { ChatBubbleLeftRight } from "@medusajs/icons" -import { - Badge, - createDataTableColumnHelper, - createDataTableFilterHelper, - DataTable, - DataTableFilteringState, - DataTablePaginationState, - DataTableSortingState, - Heading, - useDataTable, -} from "@medusajs/ui" -import { useQuery } from "@tanstack/react-query" -import { SingleColumnLayout } from "../../layouts/single-column" -import { sdk } from "../../lib/config" -import { useMemo, useState } from "react" import { Container } from "../../components/container" -import { HttpTypes, ProductStatus } from "@medusajs/framework/types" - -const columnHelper = createDataTableColumnHelper() - -const columns = [ - columnHelper.accessor("title", { - header: "Title", - // Enables sorting for the column. - enableSorting: true, - // If omitted, the header will be used instead if it's a string, - // otherwise the accessor key (id) will be used. - sortLabel: "Title", - // If omitted the default value will be "A-Z" - sortAscLabel: "A-Z", - // If omitted the default value will be "Z-A" - sortDescLabel: "Z-A", - }), - columnHelper.accessor("status", { - header: "Status", - cell: ({ getValue }) => { - const status = getValue() - return ( - - {status === "published" ? "Published" : "Draft"} - - ) - }, - }), -] - -const filterHelper = createDataTableFilterHelper() - -const filters = [ - filterHelper.accessor("status", { - type: "select", - label: "Status", - options: [ - { - label: "Published", - value: "published", - }, - { - label: "Draft", - value: "draft", - }, - ], - }), -] - -const limit = 15 +import { SingleColumnLayout } from "../../layouts/single-column" +import { Header } from "../../components/header" const CustomPage = () => { - const [pagination, setPagination] = useState({ - pageSize: limit, - pageIndex: 0, - }) - const [search, setSearch] = useState("") - const [filtering, setFiltering] = useState({}) - const [sorting, setSorting] = useState(null) - - const offset = useMemo(() => { - return pagination.pageIndex * limit - }, [pagination]) - const statusFilters = useMemo(() => { - return (filtering.status || []) as ProductStatus - }, [filtering]) - - const { data, isLoading } = useQuery({ - queryFn: () => sdk.admin.product.list({ - limit, - offset, - q: search, - status: statusFilters, - order: sorting ? `${sorting.desc ? "-" : ""}${sorting.id}` : undefined, - }), - queryKey: [["products", limit, offset, search, statusFilters, sorting?.id, sorting?.desc]], - }) - - const table = useDataTable({ - columns, - data: data?.products || [], - getRowId: (row) => row.id, - rowCount: data?.count || 0, - isLoading, - pagination: { - state: pagination, - onPaginationChange: setPagination, - }, - search: { - state: search, - onSearchChange: setSearch, - }, - filtering: { - state: filtering, - onFilteringChange: setFiltering, - }, - filters, - sorting: { - // Pass the pagination state and updater to the table instance - state: sorting, - onSortingChange: setSorting, - }, - }) - return ( - - - Products -
- - - -
- - - - +
) @@ -30487,97 +30600,7 @@ export const config = defineRouteConfig({ export default CustomPage ``` - -# Section Row - Admin Components - -The Medusa Admin often shows information in rows of label-values, such as when showing a product's details. - -![Example of a section row in the Medusa Admin](https://res.cloudinary.com/dza7lstvk/image/upload/v1728292781/Medusa%20Resources/section-row_kknbnw.png) - -To create a component that shows information in the same structure, create the file `src/admin/components/section-row.tsx` with the following content: - -```tsx title="src/admin/components/section-row.tsx" -import { Text, clx } from "@medusajs/ui" - -export type SectionRowProps = { - title: string - value?: React.ReactNode | string | null - actions?: React.ReactNode -} - -export const SectionRow = ({ title, value, actions }: SectionRowProps) => { - const isValueString = typeof value === "string" || !value - - return ( -
- - {title} - - - {isValueString ? ( - - {value ?? "-"} - - ) : ( -
{value}
- )} - - {actions &&
{actions}
} -
- ) -} -``` - -The `SectionRow` component shows a title and a value in the same row. - -It accepts the following props: - -- title: (\`string\`) The title to show on the left side. -- value: (\`React.ReactNode\` \\| \`string\` \\| \`null\`) The value to show on the right side. -- actions: (\`React.ReactNode\`) The actions to show at the end of the row. - -*** - -## Example - -Use the `SectionRow` component in any widget or UI route. - -For example, create the widget `src/admin/widgets/product-widget.tsx` with the following content: - -```tsx title="src/admin/widgets/product-widget.tsx" -import { defineWidgetConfig } from "@medusajs/admin-sdk" -import { Container } from "../components/container" -import { Header } from "../components/header" -import { SectionRow } from "../components/section-row" - -const ProductWidget = () => { - return ( - -
- - - ) -} - -export const config = defineWidgetConfig({ - zone: "product.details.before", -}) - -export default ProductWidget -``` - -This widget also uses the [Container](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/admin-components/components/container/index.html.md) and [Header](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/admin-components/components/header/index.html.md) custom component. +This UI route also uses a [Container](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/admin-components/components/container/index.html.md) and a [Header]() custom components. # Table - Admin Components @@ -30870,6 +30893,405 @@ If `data` isn't `undefined`, you display the `Table` component passing it the fo To test it out, log into the Medusa Admin and open `http://localhost:9000/app/custom`. You'll find a table of products with pagination. +# Section Row - Admin Components + +The Medusa Admin often shows information in rows of label-values, such as when showing a product's details. + +![Example of a section row in the Medusa Admin](https://res.cloudinary.com/dza7lstvk/image/upload/v1728292781/Medusa%20Resources/section-row_kknbnw.png) + +To create a component that shows information in the same structure, create the file `src/admin/components/section-row.tsx` with the following content: + +```tsx title="src/admin/components/section-row.tsx" +import { Text, clx } from "@medusajs/ui" + +export type SectionRowProps = { + title: string + value?: React.ReactNode | string | null + actions?: React.ReactNode +} + +export const SectionRow = ({ title, value, actions }: SectionRowProps) => { + const isValueString = typeof value === "string" || !value + + return ( +
+ + {title} + + + {isValueString ? ( + + {value ?? "-"} + + ) : ( +
{value}
+ )} + + {actions &&
{actions}
} +
+ ) +} +``` + +The `SectionRow` component shows a title and a value in the same row. + +It accepts the following props: + +- title: (\`string\`) The title to show on the left side. +- value: (\`React.ReactNode\` \\| \`string\` \\| \`null\`) The value to show on the right side. +- actions: (\`React.ReactNode\`) The actions to show at the end of the row. + +*** + +## Example + +Use the `SectionRow` component in any widget or UI route. + +For example, create the widget `src/admin/widgets/product-widget.tsx` with the following content: + +```tsx title="src/admin/widgets/product-widget.tsx" +import { defineWidgetConfig } from "@medusajs/admin-sdk" +import { Container } from "../components/container" +import { Header } from "../components/header" +import { SectionRow } from "../components/section-row" + +const ProductWidget = () => { + return ( + +
+ + + ) +} + +export const config = defineWidgetConfig({ + zone: "product.details.before", +}) + +export default ProductWidget +``` + +This widget also uses the [Container](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/admin-components/components/container/index.html.md) and [Header](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/admin-components/components/header/index.html.md) custom component. + + +# Two Column Layout - Admin Components + +The Medusa Admin has pages with two columns of content. + +This doesn't include the sidebar, only the main content. + +![An example of an admin page with two columns](https://res.cloudinary.com/dza7lstvk/image/upload/v1728286690/Medusa%20Resources/two-column_sdnkg0.png) + +To create a layout that you can use in UI routes to support two columns of content, create the component `src/admin/layouts/two-column.tsx` with the following content: + +```tsx title="src/admin/layouts/two-column.tsx" +export type TwoColumnLayoutProps = { + firstCol: React.ReactNode + secondCol: React.ReactNode +} + +export const TwoColumnLayout = ({ + firstCol, + secondCol, +}: TwoColumnLayoutProps) => { + return ( +
+
+ {firstCol} +
+
+ {secondCol} +
+
+ ) +} +``` + +The `TwoColumnLayout` accepts two props: + +- `firstCol` indicating the content of the first column. +- `secondCol` indicating the content of the second column. + +*** + +## Example + +Use the `TwoColumnLayout` component in your UI routes that have a single column. For example: + +```tsx title="src/admin/routes/custom/page.tsx" highlights={[["9"]]} +import { defineRouteConfig } from "@medusajs/admin-sdk" +import { ChatBubbleLeftRight } from "@medusajs/icons" +import { Container } from "../../components/container" +import { Header } from "../../components/header" +import { TwoColumnLayout } from "../../layouts/two-column" + +const CustomPage = () => { + return ( + +
+ + } + secondCol={ + +
+ + } + /> + ) +} + +export const config = defineRouteConfig({ + label: "Custom", + icon: ChatBubbleLeftRight, +}) + +export default CustomPage +``` + +This UI route also uses [Container](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/admin-components/components/container/index.html.md) and [Header]() custom components. + + +# JSON View - Admin Components + +Detail pages in the Medusa Admin show a JSON section to view the current page's details in JSON format. + +![Example of a JSON section in the admin](https://res.cloudinary.com/dza7lstvk/image/upload/v1728295129/Medusa%20Resources/json_dtbsgm.png) + +To create a component that shows a JSON section in your customizations, create the file `src/admin/components/json-view-section.tsx` with the following content: + +```tsx title="src/admin/components/json-view-section.tsx" +import { + ArrowUpRightOnBox, + Check, + SquareTwoStack, + TriangleDownMini, + XMarkMini, +} from "@medusajs/icons" +import { + Badge, + Container, + Drawer, + Heading, + IconButton, + Kbd, +} from "@medusajs/ui" +import Primitive from "@uiw/react-json-view" +import { CSSProperties, MouseEvent, Suspense, useState } from "react" + +type JsonViewSectionProps = { + data: object + title?: string +} + +export const JsonViewSection = ({ data }: JsonViewSectionProps) => { + const numberOfKeys = Object.keys(data).length + + return ( + +
+ JSON + + {numberOfKeys} keys + +
+ + + + + + + +
+
+ + + + {numberOfKeys} + + + +
+
+ + esc + + + + + + +
+
+ +
+
} + > + + } /> + ( + null + )} + /> + ( + undefined + )} + /> + { + return ( + + {Object.keys(value as object).length} items + + ) + }} + /> + + + + + : + + { + return + }} + /> + + + + + + + + ) +} + +type CopiedProps = { + style?: CSSProperties + value: object | undefined +} + +const Copied = ({ style, value }: CopiedProps) => { + const [copied, setCopied] = useState(false) + + const handler = (e: MouseEvent) => { + e.stopPropagation() + setCopied(true) + + if (typeof value === "string") { + navigator.clipboard.writeText(value) + } else { + const json = JSON.stringify(value, null, 2) + navigator.clipboard.writeText(json) + } + + setTimeout(() => { + setCopied(false) + }, 2000) + } + + const styl = { whiteSpace: "nowrap", width: "20px" } + + if (copied) { + return ( + + + + ) + } + + return ( + + + + ) +} +``` + +The `JsonViewSection` component shows a section with the "JSON" title and a button to show the data as JSON in a drawer or side window. + +The `JsonViewSection` accepts a `data` prop, which is the data to show as a JSON object in the drawer. + +*** + +## Example + +Use the `JsonViewSection` component in any widget or UI route. + +For example, create the widget `src/admin/widgets/product-widget.tsx` with the following content: + +```tsx title="src/admin/widgets/product-widget.tsx" +import { defineWidgetConfig } from "@medusajs/admin-sdk" +import { JsonViewSection } from "../components/json-view-section" + +const ProductWidget = () => { + return +} + +export const config = defineWidgetConfig({ + zone: "product.details.before", +}) + +export default ProductWidget +``` + +This shows the JSON section at the top of the product page, passing it the object `{ name: "John" }`. + + # Service Factory Reference This section of the documentation provides a reference of the methods generated for services extending the service factory (`MedusaService`), and how to use them. @@ -30897,6 +31319,518 @@ Some examples of method names: The reference uses only the operation name to refer to the method. +# create Method - Service Factory Reference + +This method creates one or more records of the data model. + +## Create One Record + +```ts +const post = await postModuleService.createPosts({ + name: "My Post", + published_at: new Date(), + metadata: { + external_id: "1234", + }, +}) +``` + +If an object is passed of the method, an object of the created record is also returned. + +*** + +## Create Multiple Records + +```ts +const posts = await postModuleService.createPosts([ + { + name: "My Post", + published_at: new Date(), + }, + { + name: "My Other Post", + published_at: new Date(), + }, +]) +``` + +If an array is passed of the method, an array of the created records is also returned. + + +# delete Method - Service Factory Reference + +This method deletes one or more records. + +## Delete One Record + +```ts +await postModuleService.deletePosts("123") +``` + +To delete one record, pass its ID as a parameter of the method. + +*** + +## Delete Multiple Records + +```ts +await postModuleService.deletePosts([ + "123", + "321", +]) +``` + +To delete multiple records, pass an array of IDs as a parameter of the method. + +*** + +## Delete Records Matching Filters + +```ts +await postModuleService.deletePosts({ + name: "My Post", +}) +``` + +To delete records matching a set of filters, pass an object of filters as a parameter. + +Learn more about accepted filters in [this documentation](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/service-factory-reference/tips/filtering/index.html.md). + + +# list Method - Service Factory Reference + +This method retrieves a list of records. + +## Retrieve List of Records + +```ts +const posts = await postModuleService.listPosts() +``` + +If no parameters are passed, the method returns an array of the first `15` records. + +*** + +## Filter Records + +```ts +const posts = await postModuleService.listPosts({ + id: ["123", "321"], +}) +``` + +### Parameters + +To retrieve records matching a set of filters, pass an object of the filters as a first parameter. + +Learn more about accepted filters in [this documentation](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/service-factory-reference/tips/filtering/index.html.md). + +### Returns + +The method returns an array of the first `15` records matching the filters. + +*** + +## Retrieve Relations + +This applies to relations between data models of the same module. To retrieve linked records of different modules, use [Query](https://docs.medusajs.com/docs/learn/fundamentals/module-links/query/index.html.md). + +```ts +const posts = await postModuleService.listPosts({}, { + relations: ["author"], +}) +``` + +### Parameters + +To retrieve records with their relations, pass as a second parameter an object having a `relations` property. `relations`'s value is an array of relation names. + +### Returns + +The method returns an array of the first `15` records matching the filters. + +*** + +## Select Properties + +```ts +const posts = await postModuleService.listPosts({}, { + select: ["id", "name"], +}) +``` + +### Parameters + +By default, retrieved records have all their properties. To select specific properties to retrieve, pass in the second object parameter a `select` property. + +`select`'s value is an array of property names to retrieve. + +### Returns + +The method returns an array of the first `15` records matching the filters. + +*** + +## Paginate Relations + +```ts +const posts = await postModuleService.listPosts({}, { + take: 20, + skip: 10, +}) +``` + +### Parameters + +To paginate the returned records, the second object parameter accepts the following properties: + +- `take`: a number indicating how many records to retrieve. By default, it's `15`. +- `skip`: a number indicating how many records to skip before the retrieved records. By default, it's `0`. + +### Returns + +The method returns an array of records. The number of records is less than or equal to `take`'s value. + +*** + +## Sort Records + +```ts +const posts = await postModuleService.listPosts({}, { + order: { + name: "ASC", + }, +}) +``` + +### Parameters + +To sort records by one or more properties, pass to the second object parameter the `order` property. Its value is an object whose keys are the property names, and values can either be: + +- `ASC` to sort by this property in the ascending order. +- `DESC` to sort by this property in the descending order. + +### Returns + +The method returns an array of the first `15` records matching the filters. + + +# retrieve Method - Service Factory Reference + +This method retrieves one record of the data model by its ID. + +## Retrieve a Record + +```ts +const post = await postModuleService.retrievePost("123") +``` + +### Parameters + +Pass the ID of the record to retrieve. + +### Returns + +The method returns the record as an object. + +*** + +## Retrieve a Record's Relations + +This applies to relations between data models of the same module. To retrieve linked records of different modules, use [Query](https://docs.medusajs.com/docs/learn/fundamentals/module-links/query/index.html.md). + +```ts +const post = await postModuleService.retrievePost("123", { + relations: ["author"], +}) +``` + +### Parameters + +To retrieve the data model with relations, pass as a second parameter of the method an object with the property `relations`. `relations`'s value is an array of relation names. + +### Returns + +The method returns the record as an object. + +*** + +## Select Properties to Retrieve + +```ts +const post = await postModuleService.retrievePost("123", { + select: ["id", "name"], +}) +``` + +### Parameters + +By default, all of the record's properties are retrieved. To select specific ones, pass in the second object parameter a `select` property. Its value is an array of property names. + +### Returns + +The method returns the record as an object. + + +# listAndCount Method - Service Factory Reference + +This method retrieves a list of records with the total count. + +## Retrieve List of Records + +```ts +const [posts, count] = await postModuleService.listAndCountPosts() +``` + +If no parameters are passed, the method returns an array with two items: + +1. The first is an array of the first `15` records retrieved. +2. The second is the total count of records. + +*** + +## Filter Records + +```ts +const [posts, count] = await postModuleService.listAndCountPosts({ + id: ["123", "321"], +}) +``` + +### Parameters + +To retrieve records matching a set of filters, pass an object of the filters as a first parameter. + +Learn more about accepted filters in [this documentation](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/service-factory-reference/tips/filtering/index.html.md). + +### Returns + +The method returns an array with two items: + +1. The first is an array of the first `15` records retrieved matching the specified filters. +2. The second is the total count of records matching the specified filters. + +*** + +## Retrieve Relations + +This applies to relations between data models of the same module. To retrieve linked records of different modules, use [Query](https://docs.medusajs.com/docs/learn/fundamentals/module-links/query/index.html.md). + +```ts +const [posts, count] = await postModuleService.listAndCountPosts({}, { + relations: ["author"], +}) +``` + +### Parameters + +To retrieve records with their relations, pass as a second parameter an object having a `relations` property. Its value is an array of relation names. + +### Returns + +The method returns an array with two items: + +1. The first is an array of the first `15` records retrieved. +2. The second is the total count of records. + +*** + +## Select Properties + +```ts +const [posts, count] = await postModuleService.listAndCountPosts({}, { + select: ["id", "name"], +}) +``` + +### Parameters + +By default, retrieved records have all their properties. To select specific properties to retrieve, pass in the second object parameter a `select` property. + +`select`'s value is an array of property names to retrieve. + +### Returns + +The method returns an array with two items: + +1. The first is an array of the first `15` records retrieved. +2. The second is the total count of records. + +*** + +## Paginate Relations + +```ts +const [posts, count] = await postModuleService.listAndCountPosts({}, { + take: 20, + skip: 10, +}) +``` + +### Parameters + +To paginate the returned records, the second object parameter accepts the following properties: + +- `take`: a number indicating how many records to retrieve. By default, it's `15`. +- `skip`: a number indicating how many records to skip before the retrieved records. By default, it's `0`. + +### Returns + +The method returns an array with two items: + +1. The first is an array of the records retrieved. The number of records is less than or equal to `take`'s value. +2. The second is the total count of records. + +*** + +## Sort Records + +```ts +const [posts, count] = await postModuleService.listAndCountPosts({}, { + order: { + name: "ASC", + }, +}) +``` + +### Parameters + +To sort records by one or more properties, pass to the second object parameter the `order` property. Its value is an object whose keys are the property names, and values can either be: + +- `ASC` to sort by this property in the ascending order. +- `DESC` to sort by this property in the descending order. + +### Returns + +The method returns an array with two items: + +1. The first is an array of the first `15` records retrieved. +2. The second is the total count of records. + + +# update Method - Service Factory Reference + +This method updates one or more records of the data model. + +## Update One Record + +```ts +const post = await postModuleService.updatePosts({ + id: "123", + name: "My Post", +}) +``` + +### Parameters + +To update one record, pass an object that at least has an `id` property, identifying the ID of the record to update. + +You can pass in the same object any other properties to update. + +### Returns + +The method returns the updated record as an object. + +*** + +## Update Multiple Records + +```ts +const posts = await postModuleService.updatePosts([ + { + id: "123", + name: "My Post", + }, + { + id: "321", + published_at: new Date(), + }, +]) +``` + +### Parameters + +To update multiple records, pass an array of objects. Each object has at least an `id` property, identifying the ID of the record to update. + +You can pass in each object any other properties to update. + +### Returns + +The method returns an array of objects of updated records. + +*** + +## Update Records Matching a Filter + +```ts +const posts = await postModuleService.updatePosts({ + selector: { + name: "My Post", + }, + data: { + published_at: new Date(), + }, +}) +``` + +### Parameters + +To update records that match specified filters, pass as a parameter an object having two properties: + +- `selector`: An object of filters that a record must match to be updated. +- `data`: An object of the properties to update in every record that match the filters in `selector`. + +In the example above, you update the `published_at` property of every post record whose name is `My Post`. + +Learn more about accepted filters in [this documentation](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/service-factory-reference/tips/filtering/index.html.md). + +### Returns + +The method returns an array of objects of updated records. + +*** + +## Multiple Record Updates with Filters + +```ts +const posts = await postModuleService.updatePosts([ + { + selector: { + name: "My Post", + }, + data: { + published_at: new Date(), + }, + }, + { + selector: { + name: "Another Post", + }, + data: { + metadata: { + external_id: "123", + }, + }, + }, +]) +``` + +### Parameters + +To update records matching different sets of filters, pass an array of objects, each having two properties: + +- `selector`: An object of filters that a record must match to be updated. +- `data`: An object of the properties to update in every record that match the filters in `selector`. + +In the example above, you update the `published_at` property of post records whose name is `My Post`, and update the `metadata` property of post records whose name is `Another Post`. + +Learn more about accepted filters in [this documentation](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/service-factory-reference/tips/filtering/index.html.md). + +### Returns + +The method returns an array of objects of updated records. + + # Filter Records - Service Factory Reference Many of the service factory's generated methods allow passing filters to perform an operation, such as to update or delete records matching the filters. @@ -31040,442 +31974,6 @@ To use an `or` condition, pass to the filter object the `$or` property, whose va In the example above, posts whose name is `My Post` or their `published_at` date is less than the current date and time are retrieved. -# create Method - Service Factory Reference - -This method creates one or more records of the data model. - -## Create One Record - -```ts -const post = await postModuleService.createPosts({ - name: "My Post", - published_at: new Date(), - metadata: { - external_id: "1234", - }, -}) -``` - -If an object is passed of the method, an object of the created record is also returned. - -*** - -## Create Multiple Records - -```ts -const posts = await postModuleService.createPosts([ - { - name: "My Post", - published_at: new Date(), - }, - { - name: "My Other Post", - published_at: new Date(), - }, -]) -``` - -If an array is passed of the method, an array of the created records is also returned. - - -# list Method - Service Factory Reference - -This method retrieves a list of records. - -## Retrieve List of Records - -```ts -const posts = await postModuleService.listPosts() -``` - -If no parameters are passed, the method returns an array of the first `15` records. - -*** - -## Filter Records - -```ts -const posts = await postModuleService.listPosts({ - id: ["123", "321"], -}) -``` - -### Parameters - -To retrieve records matching a set of filters, pass an object of the filters as a first parameter. - -Learn more about accepted filters in [this documentation](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/service-factory-reference/tips/filtering/index.html.md). - -### Returns - -The method returns an array of the first `15` records matching the filters. - -*** - -## Retrieve Relations - -This applies to relations between data models of the same module. To retrieve linked records of different modules, use [Query](https://docs.medusajs.com/docs/learn/fundamentals/module-links/query/index.html.md). - -```ts -const posts = await postModuleService.listPosts({}, { - relations: ["author"], -}) -``` - -### Parameters - -To retrieve records with their relations, pass as a second parameter an object having a `relations` property. `relations`'s value is an array of relation names. - -### Returns - -The method returns an array of the first `15` records matching the filters. - -*** - -## Select Properties - -```ts -const posts = await postModuleService.listPosts({}, { - select: ["id", "name"], -}) -``` - -### Parameters - -By default, retrieved records have all their properties. To select specific properties to retrieve, pass in the second object parameter a `select` property. - -`select`'s value is an array of property names to retrieve. - -### Returns - -The method returns an array of the first `15` records matching the filters. - -*** - -## Paginate Relations - -```ts -const posts = await postModuleService.listPosts({}, { - take: 20, - skip: 10, -}) -``` - -### Parameters - -To paginate the returned records, the second object parameter accepts the following properties: - -- `take`: a number indicating how many records to retrieve. By default, it's `15`. -- `skip`: a number indicating how many records to skip before the retrieved records. By default, it's `0`. - -### Returns - -The method returns an array of records. The number of records is less than or equal to `take`'s value. - -*** - -## Sort Records - -```ts -const posts = await postModuleService.listPosts({}, { - order: { - name: "ASC", - }, -}) -``` - -### Parameters - -To sort records by one or more properties, pass to the second object parameter the `order` property. Its value is an object whose keys are the property names, and values can either be: - -- `ASC` to sort by this property in the ascending order. -- `DESC` to sort by this property in the descending order. - -### Returns - -The method returns an array of the first `15` records matching the filters. - - -# listAndCount Method - Service Factory Reference - -This method retrieves a list of records with the total count. - -## Retrieve List of Records - -```ts -const [posts, count] = await postModuleService.listAndCountPosts() -``` - -If no parameters are passed, the method returns an array with two items: - -1. The first is an array of the first `15` records retrieved. -2. The second is the total count of records. - -*** - -## Filter Records - -```ts -const [posts, count] = await postModuleService.listAndCountPosts({ - id: ["123", "321"], -}) -``` - -### Parameters - -To retrieve records matching a set of filters, pass an object of the filters as a first parameter. - -Learn more about accepted filters in [this documentation](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/service-factory-reference/tips/filtering/index.html.md). - -### Returns - -The method returns an array with two items: - -1. The first is an array of the first `15` records retrieved matching the specified filters. -2. The second is the total count of records matching the specified filters. - -*** - -## Retrieve Relations - -This applies to relations between data models of the same module. To retrieve linked records of different modules, use [Query](https://docs.medusajs.com/docs/learn/fundamentals/module-links/query/index.html.md). - -```ts -const [posts, count] = await postModuleService.listAndCountPosts({}, { - relations: ["author"], -}) -``` - -### Parameters - -To retrieve records with their relations, pass as a second parameter an object having a `relations` property. Its value is an array of relation names. - -### Returns - -The method returns an array with two items: - -1. The first is an array of the first `15` records retrieved. -2. The second is the total count of records. - -*** - -## Select Properties - -```ts -const [posts, count] = await postModuleService.listAndCountPosts({}, { - select: ["id", "name"], -}) -``` - -### Parameters - -By default, retrieved records have all their properties. To select specific properties to retrieve, pass in the second object parameter a `select` property. - -`select`'s value is an array of property names to retrieve. - -### Returns - -The method returns an array with two items: - -1. The first is an array of the first `15` records retrieved. -2. The second is the total count of records. - -*** - -## Paginate Relations - -```ts -const [posts, count] = await postModuleService.listAndCountPosts({}, { - take: 20, - skip: 10, -}) -``` - -### Parameters - -To paginate the returned records, the second object parameter accepts the following properties: - -- `take`: a number indicating how many records to retrieve. By default, it's `15`. -- `skip`: a number indicating how many records to skip before the retrieved records. By default, it's `0`. - -### Returns - -The method returns an array with two items: - -1. The first is an array of the records retrieved. The number of records is less than or equal to `take`'s value. -2. The second is the total count of records. - -*** - -## Sort Records - -```ts -const [posts, count] = await postModuleService.listAndCountPosts({}, { - order: { - name: "ASC", - }, -}) -``` - -### Parameters - -To sort records by one or more properties, pass to the second object parameter the `order` property. Its value is an object whose keys are the property names, and values can either be: - -- `ASC` to sort by this property in the ascending order. -- `DESC` to sort by this property in the descending order. - -### Returns - -The method returns an array with two items: - -1. The first is an array of the first `15` records retrieved. -2. The second is the total count of records. - - -# restore Method - Service Factory Reference - -This method restores one or more records of the data model that were [soft-deleted](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/service-factory-reference/methods/soft-delete/index.html.md). - -## Restore One Record - -```ts -const restoredPosts = await postModuleService.restorePosts("123") -``` - -### Parameters - -To restore one record, pass its ID as a parameter of the method. - -### Returns - -The method returns an object, whose keys are of the format `{camel_case_data_model_name}_id`, and their values are arrays of restored records' IDs. - -For example, the returned object of the above example is: - -```ts -restoredPosts = { - post_id: ["123"], -} -``` - -*** - -## Restore Multiple Records - -```ts -const restoredPosts = await postModuleService.restorePosts([ - "123", - "321", -]) -``` - -### Parameters - -To restore multiple records, pass an array of IDs as a parameter of the method. - -### Returns - -The method returns an object, whose keys are of the format `{camel_case_data_model_name}_id`, and their values are arrays of restored records' IDs. - -For example, the returned object of the above example is: - -```ts -restoredPosts = { - post_id: [ - "123", - "321", - ], -} -``` - -*** - -## Restore Records Matching Filters - -```ts -const restoredPosts = await postModuleService.restorePosts({ - name: "My Post", -}) -``` - -### Parameters - -To restore records matching a set of filters, pass an object of fitlers as a parameter of the method. - -Learn more about accepted filters in [this documentation](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/service-factory-reference/tips/filtering/index.html.md). - -### Returns - -The method returns an object, whose keys are of the format `{camel_case_data_model_name}_id`, and their values are arrays of restored records' IDs. - -For example, the returned object of the above example is: - -```ts -restoredPosts = { - post_id: [ - "123", - ], -} -``` - - -# retrieve Method - Service Factory Reference - -This method retrieves one record of the data model by its ID. - -## Retrieve a Record - -```ts -const post = await postModuleService.retrievePost("123") -``` - -### Parameters - -Pass the ID of the record to retrieve. - -### Returns - -The method returns the record as an object. - -*** - -## Retrieve a Record's Relations - -This applies to relations between data models of the same module. To retrieve linked records of different modules, use [Query](https://docs.medusajs.com/docs/learn/fundamentals/module-links/query/index.html.md). - -```ts -const post = await postModuleService.retrievePost("123", { - relations: ["author"], -}) -``` - -### Parameters - -To retrieve the data model with relations, pass as a second parameter of the method an object with the property `relations`. `relations`'s value is an array of relation names. - -### Returns - -The method returns the record as an object. - -*** - -## Select Properties to Retrieve - -```ts -const post = await postModuleService.retrievePost("123", { - select: ["id", "name"], -}) -``` - -### Parameters - -By default, all of the record's properties are retrieved. To select specific ones, pass in the second object parameter a `select` property. Its value is an array of property names. - -### Returns - -The method returns the record as an object. - - # softDelete Method - Service Factory Reference This method soft deletes one or more records of the data model. @@ -31563,168 +32061,92 @@ deletedPosts = { ``` -# delete Method - Service Factory Reference +# restore Method - Service Factory Reference -This method deletes one or more records. +This method restores one or more records of the data model that were [soft-deleted](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/service-factory-reference/methods/soft-delete/index.html.md). -## Delete One Record +## Restore One Record ```ts -await postModuleService.deletePosts("123") +const restoredPosts = await postModuleService.restorePosts("123") ``` -To delete one record, pass its ID as a parameter of the method. +### Parameters + +To restore one record, pass its ID as a parameter of the method. + +### Returns + +The method returns an object, whose keys are of the format `{camel_case_data_model_name}_id`, and their values are arrays of restored records' IDs. + +For example, the returned object of the above example is: + +```ts +restoredPosts = { + post_id: ["123"], +} +``` *** -## Delete Multiple Records +## Restore Multiple Records ```ts -await postModuleService.deletePosts([ +const restoredPosts = await postModuleService.restorePosts([ "123", "321", ]) ``` -To delete multiple records, pass an array of IDs as a parameter of the method. +### Parameters + +To restore multiple records, pass an array of IDs as a parameter of the method. + +### Returns + +The method returns an object, whose keys are of the format `{camel_case_data_model_name}_id`, and their values are arrays of restored records' IDs. + +For example, the returned object of the above example is: + +```ts +restoredPosts = { + post_id: [ + "123", + "321", + ], +} +``` *** -## Delete Records Matching Filters +## Restore Records Matching Filters ```ts -await postModuleService.deletePosts({ - name: "My Post", -}) -``` - -To delete records matching a set of filters, pass an object of filters as a parameter. - -Learn more about accepted filters in [this documentation](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/service-factory-reference/tips/filtering/index.html.md). - - -# update Method - Service Factory Reference - -This method updates one or more records of the data model. - -## Update One Record - -```ts -const post = await postModuleService.updatePosts({ - id: "123", +const restoredPosts = await postModuleService.restorePosts({ name: "My Post", }) ``` ### Parameters -To update one record, pass an object that at least has an `id` property, identifying the ID of the record to update. - -You can pass in the same object any other properties to update. - -### Returns - -The method returns the updated record as an object. - -*** - -## Update Multiple Records - -```ts -const posts = await postModuleService.updatePosts([ - { - id: "123", - name: "My Post", - }, - { - id: "321", - published_at: new Date(), - }, -]) -``` - -### Parameters - -To update multiple records, pass an array of objects. Each object has at least an `id` property, identifying the ID of the record to update. - -You can pass in each object any other properties to update. - -### Returns - -The method returns an array of objects of updated records. - -*** - -## Update Records Matching a Filter - -```ts -const posts = await postModuleService.updatePosts({ - selector: { - name: "My Post", - }, - data: { - published_at: new Date(), - }, -}) -``` - -### Parameters - -To update records that match specified filters, pass as a parameter an object having two properties: - -- `selector`: An object of filters that a record must match to be updated. -- `data`: An object of the properties to update in every record that match the filters in `selector`. - -In the example above, you update the `published_at` property of every post record whose name is `My Post`. +To restore records matching a set of filters, pass an object of fitlers as a parameter of the method. Learn more about accepted filters in [this documentation](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/service-factory-reference/tips/filtering/index.html.md). ### Returns -The method returns an array of objects of updated records. +The method returns an object, whose keys are of the format `{camel_case_data_model_name}_id`, and their values are arrays of restored records' IDs. -*** - -## Multiple Record Updates with Filters +For example, the returned object of the above example is: ```ts -const posts = await postModuleService.updatePosts([ - { - selector: { - name: "My Post", - }, - data: { - published_at: new Date(), - }, - }, - { - selector: { - name: "Another Post", - }, - data: { - metadata: { - external_id: "123", - }, - }, - }, -]) +restoredPosts = { + post_id: [ + "123", + ], +} ``` -### Parameters - -To update records matching different sets of filters, pass an array of objects, each having two properties: - -- `selector`: An object of filters that a record must match to be updated. -- `data`: An object of the properties to update in every record that match the filters in `selector`. - -In the example above, you update the `published_at` property of post records whose name is `My Post`, and update the `metadata` property of post records whose name is `Another Post`. - -Learn more about accepted filters in [this documentation](https://docs.medusajs.com/Users/shahednasser/medusa/www/apps/resources/app/service-factory-reference/tips/filtering/index.html.md). - -### Returns - -The method returns an array of objects of updated records. - @@ -32167,125 +32589,6 @@ How to install and setup Medusa UI. -# Medusa Admin Extension - -How to install and use Medusa UI for building Admin extensions. - -## Installation - -*** - -The `@medusajs/ui` package is a already installed as a dependency of the `@medusajs/admin` package. Due to this you can simply import the package and use it in your local Admin extensions. - -If you are building a Admin extension as part of a Medusa plugin, you can install the package as a dependency of your plugin. - -```bash -npm install @medusajs/ui -``` - -## Configuration - -*** - -The configuration of the UI package is handled by the `@medusajs/admin` package. Therefore, you do not need to any additional configuration to use the UI package in your Admin extensions. - - -# Standalone Project - -How to install and use Medusa UI in a standalone project. - -## Installation - -*** - -Medusa UI is a React UI library and while it's intended for usage within Medusa projects, it can also be used in any React project. - -### Install Medusa UI - -Install the React UI library with the following command: - -```bash -npm install @medusajs/ui -``` - -### Configuring Tailwind CSS - -The components are styled using Tailwind CSS, and in order to use them, you will need to install Tailwind CSS in your project as well. -For more information on how to install Tailwind CSS, please refer to the [Tailwind CSS documentation](https://tailwindcss.com/docs/installation). - -All of the classes used for Medusa UI are shipped as a Tailwind CSS customization. -You can install it with the following command: - -```bash -npm install @medusajs/ui-preset -``` - -After you have installed Tailwind CSS and the Medusa UI preset, you need to add the following to your `tailwind.config.js`file: - -```tsx -module.exports = { - presets: [require("@medusajs/ui-preset")], - // ... -} -``` - -In order for the styles to be applied correctly to the components, you will also need to ensure that -`@medusajs/ui` is included in the content field of your `tailwind.config.js` file: - -```tsx -module.exports = { - content: [ - // ... - "./node_modules/@medusajs/ui/dist/**/*.{js,jsx,ts,tsx}", - ], - // ... -} -``` - -If you are working within a monorepo, you may need to add the path to the `@medusajs/ui` package in your `tailwind.config.js` like so: - -```tsx -const path = require("path") - -const uiPath = path.resolve( - require.resolve("@medusajs/ui"), - "../..", - "\*_/_.{js,jsx,ts,tsx}" -) - -module.exports = { - content: [ - // ... - uiPath, - ], - // ... -} - -``` - -## Start building - -*** - -You are now ready to start building your application with Medusa UI. You can import the components like so: - -```tsx -import { Button, Drawer } from "@medusajs/ui" -``` - -## Updating UI Packages - -*** - -Medusa's design-system packages, including `@medusajs/ui`, `@medusajs/ui-preset`, and `@medusajs/ui-icons`, are versioned independently. However, they're still part of the latest Medusa release. So, you can browse the [release notes](https://github.com/medusajs/medusa/releases) to see if there are any breaking changes to these packages. - -To update these packages, update their version in your `package.json` file and re-install dependencies. For example: - -```bash -npm install @medusajs/ui -``` - - # Alert A component for displaying important messages. @@ -38681,6 +38984,125 @@ If you're using the `Tooltip` component in a project other than the Medusa Admin - disableHoverableContent: (boolean) When \`true\`, trying to hover the content will result in the tooltip closing as the pointer leaves the trigger. +# Medusa Admin Extension + +How to install and use Medusa UI for building Admin extensions. + +## Installation + +*** + +The `@medusajs/ui` package is a already installed as a dependency of the `@medusajs/admin` package. Due to this you can simply import the package and use it in your local Admin extensions. + +If you are building a Admin extension as part of a Medusa plugin, you can install the package as a dependency of your plugin. + +```bash +npm install @medusajs/ui +``` + +## Configuration + +*** + +The configuration of the UI package is handled by the `@medusajs/admin` package. Therefore, you do not need to any additional configuration to use the UI package in your Admin extensions. + + +# Standalone Project + +How to install and use Medusa UI in a standalone project. + +## Installation + +*** + +Medusa UI is a React UI library and while it's intended for usage within Medusa projects, it can also be used in any React project. + +### Install Medusa UI + +Install the React UI library with the following command: + +```bash +npm install @medusajs/ui +``` + +### Configuring Tailwind CSS + +The components are styled using Tailwind CSS, and in order to use them, you will need to install Tailwind CSS in your project as well. +For more information on how to install Tailwind CSS, please refer to the [Tailwind CSS documentation](https://tailwindcss.com/docs/installation). + +All of the classes used for Medusa UI are shipped as a Tailwind CSS customization. +You can install it with the following command: + +```bash +npm install @medusajs/ui-preset +``` + +After you have installed Tailwind CSS and the Medusa UI preset, you need to add the following to your `tailwind.config.js`file: + +```tsx +module.exports = { + presets: [require("@medusajs/ui-preset")], + // ... +} +``` + +In order for the styles to be applied correctly to the components, you will also need to ensure that +`@medusajs/ui` is included in the content field of your `tailwind.config.js` file: + +```tsx +module.exports = { + content: [ + // ... + "./node_modules/@medusajs/ui/dist/**/*.{js,jsx,ts,tsx}", + ], + // ... +} +``` + +If you are working within a monorepo, you may need to add the path to the `@medusajs/ui` package in your `tailwind.config.js` like so: + +```tsx +const path = require("path") + +const uiPath = path.resolve( + require.resolve("@medusajs/ui"), + "../..", + "\*_/_.{js,jsx,ts,tsx}" +) + +module.exports = { + content: [ + // ... + uiPath, + ], + // ... +} + +``` + +## Start building + +*** + +You are now ready to start building your application with Medusa UI. You can import the components like so: + +```tsx +import { Button, Drawer } from "@medusajs/ui" +``` + +## Updating UI Packages + +*** + +Medusa's design-system packages, including `@medusajs/ui`, `@medusajs/ui-preset`, and `@medusajs/ui-icons`, are versioned independently. However, they're still part of the latest Medusa release. So, you can browse the [release notes](https://github.com/medusajs/medusa/releases) to see if there are any breaking changes to these packages. + +To update these packages, update their version in your `package.json` file and re-install dependencies. For example: + +```bash +npm install @medusajs/ui +``` + + # clx Utility function for working with classNames. diff --git a/www/apps/book/scripts/prepare.mjs b/www/apps/book/scripts/prepare.mjs index 717be92b1b..5076ac0f27 100644 --- a/www/apps/book/scripts/prepare.mjs +++ b/www/apps/book/scripts/prepare.mjs @@ -1,6 +1,6 @@ import "dotenv/config" import path from "path" -import { sidebar } from "../sidebar.mjs" +import { sidebars } from "../sidebar.mjs" import { generateEditedDates, generateLlmsFull, @@ -15,7 +15,7 @@ import { async function main() { await generateEditedDates() - await generateSidebar(sidebar, { + await generateSidebar(sidebars, { addNumbering: true, }) const baseUrl = diff --git a/www/apps/book/sidebar.mjs b/www/apps/book/sidebar.mjs index a9ee2317f4..b934c4724b 100644 --- a/www/apps/book/sidebar.mjs +++ b/www/apps/book/sidebar.mjs @@ -1,456 +1,492 @@ -import { sidebarAttachHrefCommonOptions } from "./utils/sidebar-attach-common-options.mjs" - -/** @type {import('@/types').SidebarItem[]} */ -export const sidebar = sidebarAttachHrefCommonOptions([ +/** @type {import("types").Sidebar.Sidebar[]} */ +export const sidebars = [ { - type: "link", - path: "/learn", - title: "Introduction", - children: [ + sidebar_id: "docs", + title: "Get Started", + items: [ { - type: "link", - path: "/learn/installation", - title: "Installation", - }, - { - type: "link", - title: "Architecture", - path: "/learn/introduction/architecture", - }, - ], - }, - { - type: "category", - title: "Customize", - children: [ - { - type: "link", - title: "Build Custom Features", - path: "/learn/customization/custom-features", + type: "category", + title: "Get Started", children: [ { type: "link", - title: "Brand Module", - path: "/learn/customization/custom-features/module", + path: "/learn", + title: "Introduction", }, { type: "link", - title: "Brand Workflow", - path: "/learn/customization/custom-features/workflow", + path: "/learn/installation", + title: "Installation", }, { type: "link", - title: "Brand API Route", - path: "/learn/customization/custom-features/api-route", + title: "Architecture", + path: "/learn/introduction/architecture", }, ], }, { - type: "link", - title: "Extend Features", - path: "/learn/customization/extend-features", + type: "category", + title: "Customization Tutorial", children: [ { type: "link", - title: "Link Brands and Products", - path: "/learn/customization/extend-features/define-link", + title: "Build Custom Features", + path: "/learn/customization/custom-features", + children: [ + { + type: "link", + title: "Brand Module", + path: "/learn/customization/custom-features/module", + }, + { + type: "link", + title: "Brand Workflow", + path: "/learn/customization/custom-features/workflow", + }, + { + type: "link", + title: "Brand API Route", + path: "/learn/customization/custom-features/api-route", + }, + ], }, { type: "link", - title: "Extend Core Flow", - path: "/learn/customization/extend-features/extend-create-product", + title: "Extend Features", + path: "/learn/customization/extend-features", + children: [ + { + type: "link", + title: "Link Brands and Products", + path: "/learn/customization/extend-features/define-link", + }, + { + type: "link", + title: "Extend Core Flow", + path: "/learn/customization/extend-features/extend-create-product", + }, + { + type: "link", + title: "Query Linked Records", + path: "/learn/customization/extend-features/query-linked-records", + }, + ], }, { type: "link", - title: "Query Linked Records", - path: "/learn/customization/extend-features/query-linked-records", + title: "Customize Admin", + path: "/learn/customization/customize-admin", + children: [ + { + type: "link", + title: "Add Widget", + path: "/learn/customization/customize-admin/widget", + }, + { + type: "link", + title: "Add UI Route", + path: "/learn/customization/customize-admin/route", + }, + ], + }, + { + type: "link", + title: "Integrate Systems", + path: "/learn/customization/integrate-systems", + children: [ + { + type: "link", + title: "CMS Module", + path: "/learn/customization/integrate-systems/service", + }, + { + type: "link", + title: "Sync to CMS", + path: "/learn/customization/integrate-systems/handle-event", + }, + { + type: "link", + title: "Schedule Syncing", + path: "/learn/customization/integrate-systems/schedule-task", + }, + ], + }, + { + type: "link", + title: "Re-Use Customizations", + path: "/learn/customization/reuse-customizations", + }, + { + type: "link", + title: "Next Steps", + path: "/learn/customization/next-steps", }, ], }, { - type: "link", - title: "Customize Admin", - path: "/learn/customization/customize-admin", + type: "category", + title: "Framework", children: [ { type: "link", - title: "Add Widget", - path: "/learn/customization/customize-admin/widget", + path: "/learn/fundamentals/medusa-container", + title: "Medusa Container", }, { type: "link", - title: "Add UI Route", - path: "/learn/customization/customize-admin/route", + path: "/learn/fundamentals/modules", + title: "Modules", + children: [ + { + type: "link", + path: "/learn/fundamentals/modules/modules-directory-structure", + title: "Directory Structure", + }, + { + type: "link", + path: "/learn/fundamentals/modules/loaders", + title: "Loaders", + }, + { + type: "link", + path: "/learn/fundamentals/modules/isolation", + title: "Module Isolation", + }, + { + type: "link", + path: "/learn/fundamentals/modules/container", + title: "Module Container", + }, + { + type: "link", + path: "/learn/fundamentals/modules/options", + title: "Module Options", + }, + { + type: "link", + path: "/learn/fundamentals/modules/service-factory", + title: "Service Factory", + }, + { + type: "link", + path: "/learn/fundamentals/modules/service-constraints", + title: "Service Constraints", + }, + { + type: "link", + path: "/learn/fundamentals/modules/db-operations", + title: "Database Operations", + }, + { + type: "link", + path: "/learn/fundamentals/modules/multiple-services", + title: "Multiple Services", + }, + { + type: "link", + path: "/learn/fundamentals/modules/commerce-modules", + title: "Commerce Modules", + }, + { + type: "link", + path: "/learn/fundamentals/modules/architectural-modules", + title: "Architectural Modules", + }, + ], + }, + { + type: "link", + path: "/learn/fundamentals/module-links", + title: "Module Links", + children: [ + { + type: "link", + path: "/learn/fundamentals/module-links/directions", + title: "Module Link Direction", + }, + { + type: "link", + path: "/learn/fundamentals/module-links/link", + title: "Link", + }, + { + type: "link", + path: "/learn/fundamentals/module-links/query", + title: "Query", + }, + { + type: "link", + path: "/learn/fundamentals/module-links/custom-columns", + title: "Custom Columns", + }, + { + type: "link", + path: "/learn/fundamentals/module-links/query-context", + title: "Query Context", + }, + ], + }, + { + type: "link", + path: "/learn/fundamentals/data-models", + title: "Data Models", + children: [ + { + type: "link", + path: "/learn/fundamentals/data-models/infer-type", + title: "Infer Type", + }, + { + type: "link", + path: "/learn/fundamentals/data-models/property-types", + title: "Property Types", + }, + { + type: "link", + path: "/learn/fundamentals/data-models/primary-key", + title: "Primary Key", + }, + { + type: "link", + path: "/learn/fundamentals/data-models/default-properties", + title: "Default Properties", + }, + { + type: "link", + path: "/learn/fundamentals/data-models/configure-properties", + title: "Configure Properties", + }, + { + type: "link", + path: "/learn/fundamentals/data-models/relationships", + title: "Relationships", + }, + { + type: "link", + path: "/learn/fundamentals/data-models/manage-relationships", + title: "Manage Relationships", + }, + { + type: "link", + path: "/learn/fundamentals/data-models/index", + title: "Define Index", + }, + { + type: "link", + path: "/learn/fundamentals/data-models/check-constraints", + title: "Check Constraints", + }, + { + type: "link", + path: "/learn/fundamentals/data-models/searchable-property", + title: "Searchable Property", + }, + { + type: "link", + path: "/learn/fundamentals/data-models/write-migration", + title: "Write Migration", + }, + ], + }, + { + type: "link", + title: "API Routes", + path: "/learn/fundamentals/api-routes", + children: [ + { + type: "link", + path: "/learn/fundamentals/api-routes/http-methods", + title: "HTTP Methods", + }, + { + type: "link", + path: "/learn/fundamentals/api-routes/parameters", + title: "Parameters", + }, + { + type: "link", + path: "/learn/fundamentals/api-routes/responses", + title: "Response", + }, + { + type: "link", + path: "/learn/fundamentals/api-routes/middlewares", + title: "Middlewares", + }, + { + type: "link", + path: "/learn/fundamentals/api-routes/parse-body", + title: "Body Parsing", + }, + { + type: "link", + path: "/learn/fundamentals/api-routes/validation", + title: "Validation", + }, + { + type: "link", + path: "/learn/fundamentals/api-routes/protected-routes", + title: "Protected Routes", + }, + { + type: "link", + path: "/learn/fundamentals/api-routes/errors", + title: "Errors", + }, + { + type: "link", + path: "/learn/fundamentals/api-routes/cors", + title: "Handling CORS", + }, + { + type: "link", + path: "/learn/fundamentals/api-routes/additional-data", + title: "Additional Data", + }, + ], + }, + { + type: "link", + path: "/learn/fundamentals/workflows", + title: "Workflows", + children: [ + { + type: "link", + path: "/learn/fundamentals/workflows/constructor-constraints", + title: "Constructor Constraints", + }, + { + type: "link", + path: "/learn/fundamentals/workflows/variable-manipulation", + title: "Transform Variables", + }, + { + type: "link", + path: "/learn/fundamentals/workflows/conditions", + title: "When-Then Conditions", + }, + { + type: "link", + path: "/learn/fundamentals/workflows/compensation-function", + title: "Compensation Function", + }, + { + type: "link", + path: "/learn/fundamentals/workflows/workflow-hooks", + title: "Workflow Hooks", + }, + { + type: "link", + path: "/learn/fundamentals/workflows/add-workflow-hook", + title: "Expose a Hook", + }, + { + type: "link", + path: "/learn/fundamentals/workflows/access-workflow-errors", + title: "Access Workflow Errors", + }, + { + type: "link", + path: "/learn/fundamentals/workflows/retry-failed-steps", + title: "Retry Failed Steps", + }, + { + type: "link", + path: "/learn/fundamentals/workflows/parallel-steps", + title: "Run Steps in Parallel", + }, + { + type: "link", + path: "/learn/fundamentals/workflows/workflow-timeout", + title: "Workflow Timeout", + }, + { + type: "link", + path: "/learn/fundamentals/workflows/store-executions", + title: "Store Workflow Executions", + }, + { + type: "link", + path: "/learn/fundamentals/workflows/long-running-workflow", + title: "Long-Running Workflow", + }, + { + type: "link", + path: "/learn/fundamentals/workflows/execute-another-workflow", + title: "Execute Another Workflow", + }, + { + type: "link", + path: "/learn/fundamentals/workflows/multiple-step-usage", + title: "Multiple Step Usage", + }, + ], + }, + { + type: "link", + path: "/learn/fundamentals/events-and-subscribers", + title: "Events and Subscribers", + children: [ + { + type: "link", + path: "/learn/fundamentals/events-and-subscribers/data-payload", + title: "Events Data Payload", + }, + { + type: "link", + path: "/learn/fundamentals/events-and-subscribers/emit-event", + title: "Emit Event", + }, + ], + }, + { + type: "link", + path: "/learn/fundamentals/scheduled-jobs", + title: "Scheduled Jobs", + children: [ + { + type: "link", + path: "/learn/fundamentals/scheduled-jobs/execution-number", + title: "Execution Number", + }, + ], + }, + { + type: "link", + path: "/learn/fundamentals/plugins", + title: "Plugins", + children: [ + { + type: "link", + path: "/learn/fundamentals/plugins/create", + title: "Create Plugin", + }, + ], + }, + { + type: "link", + path: "/learn/fundamentals/custom-cli-scripts", + title: "Custom CLI Scripts", + children: [ + { + type: "link", + path: "/learn/fundamentals/custom-cli-scripts/seed-data", + title: "Seed Data", + }, + ], }, ], }, { - type: "link", - title: "Integrate Systems", - path: "/learn/customization/integrate-systems", - children: [ - { - type: "link", - title: "CMS Module", - path: "/learn/customization/integrate-systems/service", - }, - { - type: "link", - title: "Sync to CMS", - path: "/learn/customization/integrate-systems/handle-event", - }, - { - type: "link", - title: "Schedule Syncing", - path: "/learn/customization/integrate-systems/schedule-task", - }, - ], - }, - { - type: "link", - title: "Re-Use Customizations", - path: "/learn/customization/reuse-customizations", - }, - { - type: "link", - title: "Next Steps", - path: "/learn/customization/next-steps", - }, - ], - }, - { - type: "category", - title: "Fundamentals", - children: [ - { - type: "link", - path: "/learn/fundamentals/medusa-container", - title: "Medusa Container", - }, - { - type: "link", - path: "/learn/fundamentals/modules", - title: "Modules", - children: [ - { - type: "link", - path: "/learn/fundamentals/modules/modules-directory-structure", - title: "Directory Structure", - }, - { - type: "link", - path: "/learn/fundamentals/modules/loaders", - title: "Loaders", - }, - { - type: "link", - path: "/learn/fundamentals/modules/isolation", - title: "Module Isolation", - }, - { - type: "link", - path: "/learn/fundamentals/modules/container", - title: "Module Container", - }, - { - type: "link", - path: "/learn/fundamentals/modules/options", - title: "Module Options", - }, - { - type: "link", - path: "/learn/fundamentals/modules/service-factory", - title: "Service Factory", - }, - { - type: "link", - path: "/learn/fundamentals/modules/service-constraints", - title: "Service Constraints", - }, - { - type: "link", - path: "/learn/fundamentals/modules/db-operations", - title: "Database Operations", - }, - { - type: "link", - path: "/learn/fundamentals/modules/multiple-services", - title: "Multiple Services", - }, - { - type: "link", - path: "/learn/fundamentals/modules/commerce-modules", - title: "Commerce Modules", - }, - { - type: "link", - path: "/learn/fundamentals/modules/architectural-modules", - title: "Architectural Modules", - }, - ], - }, - { - type: "link", - path: "/learn/fundamentals/module-links", - title: "Module Links", - children: [ - { - type: "link", - path: "/learn/fundamentals/module-links/directions", - title: "Module Link Direction", - }, - { - type: "link", - path: "/learn/fundamentals/module-links/link", - title: "Link", - }, - { - type: "link", - path: "/learn/fundamentals/module-links/query", - title: "Query", - }, - { - type: "link", - path: "/learn/fundamentals/module-links/custom-columns", - title: "Custom Columns", - }, - { - type: "link", - path: "/learn/fundamentals/module-links/query-context", - title: "Query Context", - }, - ], - }, - { - type: "link", - path: "/learn/fundamentals/data-models", - title: "Data Models", - children: [ - { - type: "link", - path: "/learn/fundamentals/data-models/infer-type", - title: "Infer Type", - }, - { - type: "link", - path: "/learn/fundamentals/data-models/property-types", - title: "Property Types", - }, - { - type: "link", - path: "/learn/fundamentals/data-models/primary-key", - title: "Primary Key", - }, - { - type: "link", - path: "/learn/fundamentals/data-models/default-properties", - title: "Default Properties", - }, - { - type: "link", - path: "/learn/fundamentals/data-models/configure-properties", - title: "Configure Properties", - }, - { - type: "link", - path: "/learn/fundamentals/data-models/relationships", - title: "Relationships", - }, - { - type: "link", - path: "/learn/fundamentals/data-models/manage-relationships", - title: "Manage Relationships", - }, - { - type: "link", - path: "/learn/fundamentals/data-models/index", - title: "Define Index", - }, - { - type: "link", - path: "/learn/fundamentals/data-models/check-constraints", - title: "Check Constraints", - }, - { - type: "link", - path: "/learn/fundamentals/data-models/searchable-property", - title: "Searchable Property", - }, - { - type: "link", - path: "/learn/fundamentals/data-models/write-migration", - title: "Write Migration", - }, - ], - }, - { - type: "link", - title: "API Routes", - path: "/learn/fundamentals/api-routes", - children: [ - { - type: "link", - path: "/learn/fundamentals/api-routes/http-methods", - title: "HTTP Methods", - }, - { - type: "link", - path: "/learn/fundamentals/api-routes/parameters", - title: "Parameters", - }, - { - type: "link", - path: "/learn/fundamentals/api-routes/responses", - title: "Response", - }, - { - type: "link", - path: "/learn/fundamentals/api-routes/middlewares", - title: "Middlewares", - }, - { - type: "link", - path: "/learn/fundamentals/api-routes/parse-body", - title: "Body Parsing", - }, - { - type: "link", - path: "/learn/fundamentals/api-routes/validation", - title: "Validation", - }, - { - type: "link", - path: "/learn/fundamentals/api-routes/protected-routes", - title: "Protected Routes", - }, - { - type: "link", - path: "/learn/fundamentals/api-routes/errors", - title: "Errors", - }, - { - type: "link", - path: "/learn/fundamentals/api-routes/cors", - title: "Handling CORS", - }, - { - type: "link", - path: "/learn/fundamentals/api-routes/additional-data", - title: "Additional Data", - }, - ], - }, - { - type: "link", - path: "/learn/fundamentals/workflows", - title: "Workflows", - children: [ - { - type: "link", - path: "/learn/fundamentals/workflows/constructor-constraints", - title: "Constructor Constraints", - }, - { - type: "link", - path: "/learn/fundamentals/workflows/variable-manipulation", - title: "Transform Variables", - }, - { - type: "link", - path: "/learn/fundamentals/workflows/conditions", - title: "When-Then Conditions", - }, - { - type: "link", - path: "/learn/fundamentals/workflows/compensation-function", - title: "Compensation Function", - }, - { - type: "link", - path: "/learn/fundamentals/workflows/workflow-hooks", - title: "Workflow Hooks", - }, - { - type: "link", - path: "/learn/fundamentals/workflows/add-workflow-hook", - title: "Expose a Hook", - }, - { - type: "link", - path: "/learn/fundamentals/workflows/access-workflow-errors", - title: "Access Workflow Errors", - }, - { - type: "link", - path: "/learn/fundamentals/workflows/retry-failed-steps", - title: "Retry Failed Steps", - }, - { - type: "link", - path: "/learn/fundamentals/workflows/parallel-steps", - title: "Run Steps in Parallel", - }, - { - type: "link", - path: "/learn/fundamentals/workflows/workflow-timeout", - title: "Workflow Timeout", - }, - { - type: "link", - path: "/learn/fundamentals/workflows/store-executions", - title: "Store Workflow Executions", - }, - { - type: "link", - path: "/learn/fundamentals/workflows/long-running-workflow", - title: "Long-Running Workflow", - }, - { - type: "link", - path: "/learn/fundamentals/workflows/execute-another-workflow", - title: "Execute Another Workflow", - }, - { - type: "link", - path: "/learn/fundamentals/workflows/multiple-step-usage", - title: "Multiple Step Usage", - }, - ], - }, - { - type: "link", - path: "/learn/fundamentals/events-and-subscribers", - title: "Events and Subscribers", - children: [ - { - type: "link", - path: "/learn/fundamentals/events-and-subscribers/data-payload", - title: "Events Data Payload", - }, - { - type: "link", - path: "/learn/fundamentals/events-and-subscribers/emit-event", - title: "Emit Event", - }, - ], - }, - { - type: "link", - path: "/learn/fundamentals/scheduled-jobs", - title: "Scheduled Jobs", - children: [ - { - type: "link", - path: "/learn/fundamentals/scheduled-jobs/execution-number", - title: "Execution Number", - }, - ], - }, - { - type: "link", - path: "/learn/fundamentals/admin", + type: "category", title: "Admin Development", children: [ + { + type: "link", + path: "/learn/fundamentals/admin", + title: "Overview", + }, { type: "link", path: "/learn/fundamentals/admin/widgets", @@ -485,131 +521,137 @@ export const sidebar = sidebarAttachHrefCommonOptions([ }, { type: "link", - path: "/learn/fundamentals/plugins", - title: "Plugins", + path: "/learn/storefront-development", + title: "Storefront Development", + chapterTitle: "Storefront", + }, + { + type: "category", + title: "Configurations", children: [ { type: "link", - path: "/learn/fundamentals/plugins/create", - title: "Create Plugin", + title: "Environment Variables", + path: "/learn/fundamentals/environment-variables", + }, + { + type: "link", + title: "Type Aliases", + path: "/learn/conventions/ts-aliases", + }, + ], + }, + { + type: "category", + title: "Debugging & Testing", + children: [ + { + type: "link", + path: "/learn/debugging-and-testing/testing-tools", + title: "Testing Tools", + }, + { + type: "link", + path: "/learn/debugging-and-testing/testing-tools/integration-tests", + title: "Integration Tests", + children: [ + { + type: "link", + path: "/learn/debugging-and-testing/testing-tools/integration-tests/api-routes", + title: "Example: API Routes Tests", + }, + { + type: "link", + path: "/learn/debugging-and-testing/testing-tools/integration-tests/workflows", + title: "Example: Workflows Tests", + }, + ], + }, + { + type: "link", + path: "/learn/debugging-and-testing/testing-tools/modules-tests", + title: "Modules Tests", + children: [ + { + type: "link", + path: "/learn/debugging-and-testing/testing-tools/modules-tests/module-example", + title: "Example", + }, + ], + }, + { + type: "link", + path: "/learn/debugging-and-testing/instrumentation", + title: "Instrumentation", + }, + { + type: "link", + path: "/learn/debugging-and-testing/logging", + title: "Logging", }, ], }, { type: "link", - path: "/learn/fundamentals/custom-cli-scripts", - title: "Custom CLI Scripts", + path: "/learn/build", + title: "Build", + chapterTitle: "Production", children: [ { type: "link", - path: "/learn/fundamentals/custom-cli-scripts/seed-data", - title: "Seed Data", + path: "/learn/deployment", + title: "Deployment Overview", + }, + { + type: "link", + path: "/learn/deployment/general", + title: "General Deployment", }, ], }, { - type: "link", - title: "Environment Variables", - path: "/learn/fundamentals/environment-variables", - }, - ], - }, - { - type: "link", - path: "/learn/storefront-development", - title: "Storefront Development", - chapterTitle: "Storefront", - }, - { - type: "category", - title: "Conventions", - children: [ - { - type: "link", - title: "Type Aliases", - path: "/learn/conventions/ts-aliases", - }, - ], - }, - { - type: "link", - path: "/learn/debugging-and-testing", - title: "Debugging and Testing", - chapterTitle: "Debugging & Testing", - children: [ - { - type: "link", - path: "/learn/debugging-and-testing/testing-tools", - title: "Testing Tools", - }, - { - type: "link", - path: "/learn/debugging-and-testing/testing-tools/integration-tests", - title: "Integration Tests", + type: "category", + title: "Upgrade", children: [ { type: "link", - path: "/learn/debugging-and-testing/testing-tools/integration-tests/api-routes", - title: "Example: API Routes Tests", + path: "/learn/update", + title: "Update Medusa", }, { - type: "link", - path: "/learn/debugging-and-testing/testing-tools/integration-tests/workflows", - title: "Example: Workflows Tests", + type: "external", + path: "https://github.com/medusajs/medusa/releases", + title: "Release Notes", }, ], }, { - type: "link", - path: "/learn/debugging-and-testing/testing-tools/modules-tests", - title: "Modules Tests", + type: "category", + title: "Resources", children: [ + { + type: "sub-category", + title: "Contribution Guidelines", + children: [ + { + type: "link", + path: "/learn/resources/contribution-guidelines/docs", + title: "Docs", + }, + { + type: "link", + path: "/learn/resources//contribution-guidelines/admin-translations", + title: "Admin Translations", + }, + ], + }, { type: "link", - path: "/learn/debugging-and-testing/testing-tools/modules-tests/module-example", - title: "Example", + path: "/learn/resources/usage", + title: "Usage", }, ], }, - { - type: "link", - path: "/learn/debugging-and-testing/instrumentation", - title: "Instrumentation", - }, - { - type: "link", - path: "/learn/debugging-and-testing/logging", - title: "Logging", - }, ], }, - { - type: "link", - path: "/learn/build", - title: "Build", - chapterTitle: "Production", - children: [ - { - type: "link", - path: "/learn/deployment", - title: "Deployment Overview", - }, - { - type: "link", - path: "/learn/deployment/general", - title: "General Deployment", - }, - ], - }, - { - type: "link", - path: "/learn/update", - title: "Updating Medusa", - chapterTitle: "Updates", - }, - { - type: "link", - path: "/learn/more-resources", - title: "More Resources", - }, -]) +] diff --git a/www/apps/book/types/index.d.ts b/www/apps/book/types/index.d.ts deleted file mode 100644 index 3934655afd..0000000000 --- a/www/apps/book/types/index.d.ts +++ /dev/null @@ -1,8 +0,0 @@ -import { SidebarSectionItems, SidebarItem as SidebarItemType } from "types" - -export declare type SidebarItem = SidebarItemType & { - isSoon: boolean - number?: string -} - -export declare type SidebarConfig = SidebarSectionItems diff --git a/www/apps/book/utils/redirects.mjs b/www/apps/book/utils/redirects.mjs index 28d047f13a..d225d45b03 100644 --- a/www/apps/book/utils/redirects.mjs +++ b/www/apps/book/utils/redirects.mjs @@ -113,6 +113,16 @@ const redirects = async () => { destination: "/learn/fundamentals/module-links/link", permanent: true, }, + { + source: "/learn/debugging-and-testing", + destination: "/learn/debugging-and-testing/testing-tools", + permanent: true, + }, + { + source: "/learn/more-resources", + destination: "/learn/resources/contribution-guidelines/docs", + permanent: true, + }, ] } diff --git a/www/apps/book/utils/sidebar-attach-common-options.mjs b/www/apps/book/utils/sidebar-attach-common-options.mjs deleted file mode 100644 index 350a3f07bb..0000000000 --- a/www/apps/book/utils/sidebar-attach-common-options.mjs +++ /dev/null @@ -1,31 +0,0 @@ -/** @type {Partial} */ -const commonOptions = { - loaded: true, - isPathHref: true, -} - -/** - * - * @param {import("@/types").SidebarItem[]} sidebar - * @param {boolean} nested - * @returns {import("@/types").SidebarItem[]} - */ -export function sidebarAttachHrefCommonOptions(sidebar, nested = false) { - return sidebar.map((item) => { - if (item.type === "separator") { - return item - } - - const updatedItem = { - ...commonOptions, - ...item, - children: sidebarAttachHrefCommonOptions(item.children || [], true), - } - - if (updatedItem.type !== "category" && !nested) { - updatedItem.childrenSameLevel = true - } - - return updatedItem - }) -} diff --git a/www/apps/resources/app/admin-components/page.mdx b/www/apps/resources/app/admin-components/page.mdx index 57f0abde07..97dab89aff 100644 --- a/www/apps/resources/app/admin-components/page.mdx +++ b/www/apps/resources/app/admin-components/page.mdx @@ -16,7 +16,7 @@ Refer to the [Medusa UI documentation](!ui!) for a full list of components. Use these components to set the layout of your UI route. - + --- @@ -24,4 +24,4 @@ Use these components to set the layout of your UI route. Use these components in your widgets and UI routes. - + diff --git a/www/apps/resources/app/deployment/page.mdx b/www/apps/resources/app/deployment/page.mdx index c96aa53478..c0783a3211 100644 --- a/www/apps/resources/app/deployment/page.mdx +++ b/www/apps/resources/app/deployment/page.mdx @@ -24,7 +24,7 @@ With Medusa Cloud, you maintain full customization control as you deploy your ow - Preview environments for new PRs. - Test on production-like data. -[Sign up and learn more about Medusa Cloud](https://medusajs.com/contact) +[Sign up and learn more about Medusa Cloud](https://medusajs.com/pricing/) --- diff --git a/www/apps/resources/app/layout.tsx b/www/apps/resources/app/layout.tsx index 318f1f61e6..e3e4540776 100644 --- a/www/apps/resources/app/layout.tsx +++ b/www/apps/resources/app/layout.tsx @@ -63,13 +63,7 @@ export default function RootLayout({ htmlClassName={clsx(inter.variable, robotoMono.variable)} gaId={process.env.NEXT_PUBLIC_GA_ID} > - } - > + }> {children} diff --git a/www/apps/resources/app/recipes/page.mdx b/www/apps/resources/app/recipes/page.mdx index a0758ec215..c402998142 100644 --- a/www/apps/resources/app/recipes/page.mdx +++ b/www/apps/resources/app/recipes/page.mdx @@ -8,4 +8,4 @@ export const metadata = { This section of the documentation provides recipes for common use cases with example implementations. - \ No newline at end of file + \ No newline at end of file diff --git a/www/apps/resources/app/storefront-development/guides/express-checkout/page.mdx b/www/apps/resources/app/storefront-development/guides/express-checkout/page.mdx index f9bedc010d..65f89bd1c6 100644 --- a/www/apps/resources/app/storefront-development/guides/express-checkout/page.mdx +++ b/www/apps/resources/app/storefront-development/guides/express-checkout/page.mdx @@ -1,7 +1,6 @@ --- tags: - storefront - - js sdk - cart - product - payment diff --git a/www/apps/resources/app/storefront-development/page.mdx b/www/apps/resources/app/storefront-development/page.mdx index 37dee4d7c4..3d781174e6 100644 --- a/www/apps/resources/app/storefront-development/page.mdx +++ b/www/apps/resources/app/storefront-development/page.mdx @@ -20,4 +20,4 @@ You can build your storefront from scratch, or built it on top of the [Next.js S --- - + diff --git a/www/apps/resources/app/troubleshooting/page.mdx b/www/apps/resources/app/troubleshooting/page.mdx index 648bcc9973..5544804f56 100644 --- a/www/apps/resources/app/troubleshooting/page.mdx +++ b/www/apps/resources/app/troubleshooting/page.mdx @@ -12,4 +12,4 @@ The following troubleshooting guides are intended for technical users. If you're - \ No newline at end of file + \ No newline at end of file diff --git a/www/apps/resources/components/CommerceModuleSections/index.tsx b/www/apps/resources/components/CommerceModuleSections/index.tsx index f5381bef68..80fcb16333 100644 --- a/www/apps/resources/components/CommerceModuleSections/index.tsx +++ b/www/apps/resources/components/CommerceModuleSections/index.tsx @@ -12,7 +12,7 @@ export const CommerceModuleSections = () => { showItems: ["Server Guides"], defaultItemsPerRow: 2, }) - if (serverGuideItems?.default.length) { + if (serverGuideItems?.length) { guideComponents.push(serverGuidesComponent) } const { items: storefrontGuideItems, component: storefrontGuidesComponent } = @@ -20,7 +20,7 @@ export const CommerceModuleSections = () => { showItems: ["Storefront Guides"], defaultItemsPerRow: 2, }) - if (storefrontGuideItems?.default.length) { + if (storefrontGuideItems?.length) { guideComponents.push(storefrontGuidesComponent) } const { items: adminGuideItems, component: adminGuidesComponent } = @@ -28,7 +28,7 @@ export const CommerceModuleSections = () => { showItems: ["Admin Guides"], defaultItemsPerRow: 2, }) - if (adminGuideItems?.default.length) { + if (adminGuideItems?.length) { guideComponents.push(adminGuidesComponent) } const { items: userGuideItems, component: userGuidesComponent } = @@ -36,14 +36,14 @@ export const CommerceModuleSections = () => { showItems: ["User Guides"], defaultItemsPerRow: 2, }) - if (userGuideItems?.default.length) { + if (userGuideItems?.length) { guideComponents.push(userGuidesComponent) } const { items: jsSdkItems, component: jsSdkComponent } = useChildDocs({ showItems: ["JS SDK"], itemsPerRow: 2, }) - if (jsSdkItems?.default.length) { + if (jsSdkItems?.length) { referenceComponents.push(jsSdkComponent) } const { items: referenceItems, component: referencesComponent } = @@ -51,7 +51,7 @@ export const CommerceModuleSections = () => { showItems: ["References"], defaultItemsPerRow: 2, }) - if (referenceItems?.default.length) { + if (referenceItems?.length) { referenceComponents.push(referencesComponent) } diff --git a/www/apps/resources/config/index.ts b/www/apps/resources/config/index.ts index 6ae1ffbdcc..034d4eb79b 100644 --- a/www/apps/resources/config/index.ts +++ b/www/apps/resources/config/index.ts @@ -1,5 +1,5 @@ -import { DocsConfig, SidebarItem } from "types" -import { generatedSidebar } from "../generated/sidebar.mjs" +import { DocsConfig, Sidebar } from "types" +import { generatedSidebars } from "../generated/sidebar.mjs" import { globalConfig } from "docs-ui" const baseUrl = process.env.NEXT_PUBLIC_BASE_URL || "http://localhost:3000" @@ -9,16 +9,18 @@ export const config: DocsConfig = { titleSuffix: "Medusa Development Resources", baseUrl, basePath: process.env.NEXT_PUBLIC_BASE_PATH, - sidebar: { - default: generatedSidebar as SidebarItem[], - mobile: [], - }, + sidebars: generatedSidebars as Sidebar.Sidebar[], project: { title: "Development Resources", key: "resources", }, breadcrumbOptions: { - showCategories: true, + startItems: [ + { + title: "Documentation", + link: baseUrl, + }, + ], }, logo: `${process.env.NEXT_PUBLIC_BASE_PATH}/images/logo.png`, } diff --git a/www/apps/resources/generated/edit-dates.mjs b/www/apps/resources/generated/edit-dates.mjs index 1314145b64..1ad9d7d667 100644 --- a/www/apps/resources/generated/edit-dates.mjs +++ b/www/apps/resources/generated/edit-dates.mjs @@ -99,7 +99,6 @@ export const generatedEditDates = { "app/commerce-modules/user/user-creation-flows/page.mdx": "2025-02-26T11:35:54.685Z", "app/commerce-modules/user/page.mdx": "2025-02-26T11:18:00.382Z", "app/commerce-modules/page.mdx": "2024-12-23T14:38:21.064Z", - "app/contribution-guidelines/docs/page.mdx": "2024-12-12T11:06:12.250Z", "app/create-medusa-app/page.mdx": "2025-01-16T10:00:25.975Z", "app/deployment/admin/vercel/page.mdx": "2024-10-16T08:10:29.377Z", "app/deployment/medusa-application/railway/page.mdx": "2025-02-24T07:35:43.421Z", @@ -124,7 +123,7 @@ export const generatedEditDates = { "app/recipes/pos/page.mdx": "2025-02-26T12:42:52.949Z", "app/recipes/subscriptions/examples/standard/page.mdx": "2025-03-03T15:02:56.854Z", "app/recipes/subscriptions/page.mdx": "2025-02-26T12:31:49.933Z", - "app/recipes/page.mdx": "2024-07-11T15:56:41+00:00", + "app/recipes/page.mdx": "2025-03-07T07:48:28.203Z", "app/service-factory-reference/methods/create/page.mdx": "2024-07-31T17:01:33+03:00", "app/service-factory-reference/methods/delete/page.mdx": "2024-07-31T17:01:33+03:00", "app/service-factory-reference/methods/list/page.mdx": "2024-07-31T17:01:33+03:00", @@ -178,7 +177,7 @@ export const generatedEditDates = { "app/storefront-development/regions/store-retrieve-region/page.mdx": "2024-12-19T16:36:22.800Z", "app/storefront-development/regions/page.mdx": "2024-06-09T15:19:09+02:00", "app/storefront-development/tips/page.mdx": "2024-12-19T16:36:32.938Z", - "app/storefront-development/page.mdx": "2024-12-10T09:23:20.666Z", + "app/storefront-development/page.mdx": "2025-03-07T07:49:27.809Z", "app/troubleshooting/cors-errors/page.mdx": "2024-05-03T17:36:38+03:00", "app/troubleshooting/create-medusa-app-errors/page.mdx": "2024-07-11T10:29:13+03:00", "app/troubleshooting/database-errors/page.mdx": "2024-05-03T17:36:38+03:00", @@ -188,7 +187,6 @@ export const generatedEditDates = { "app/troubleshooting/general-errors/page.mdx": "2024-05-03T17:36:38+03:00", "app/troubleshooting/s3/page.mdx": "2025-01-24T13:47:24.994Z", "app/troubleshooting/page.mdx": "2025-02-26T11:40:54.162Z", - "app/usage/page.mdx": "2025-02-26T11:49:39.213Z", "app/page.mdx": "2025-02-26T10:23:58.440Z", "app/commerce-modules/auth/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00", "app/commerce-modules/auth/auth-flows/page.mdx": "2025-01-13T11:31:35.361Z", @@ -2103,7 +2101,7 @@ export const generatedEditDates = { "app/admin-components/components/json-view-section/page.mdx": "2024-10-07T11:15:58.833Z", "app/admin-components/components/section-row/page.mdx": "2024-10-07T11:15:58.832Z", "app/admin-components/components/table/page.mdx": "2025-03-03T14:53:37.952Z", - "app/admin-components/page.mdx": "2024-10-07T11:09:49.493Z", + "app/admin-components/page.mdx": "2025-03-07T08:00:46.960Z", "app/admin-components/layouts/single-column/page.mdx": "2024-10-07T11:16:06.435Z", "app/admin-components/layouts/two-column/page.mdx": "2024-10-07T11:16:10.092Z", "app/admin-components/components/forms/page.mdx": "2024-10-09T12:48:04.229Z", @@ -3144,7 +3142,6 @@ export const generatedEditDates = { "references/product/interfaces/product.FilterableProductProps/page.mdx": "2025-02-24T10:48:41.629Z", "references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchProductVariantRequest/page.mdx": "2024-12-09T13:21:34.309Z", "references/types/WorkflowTypes/ProductWorkflow/interfaces/types.WorkflowTypes.ProductWorkflow.ExportProductsDTO/page.mdx": "2025-02-11T11:36:51.281Z", - "app/contribution-guidelines/admin-translations/page.mdx": "2024-11-14T08:54:15.369Z", "app/integrations/guides/sanity/page.mdx": "2025-03-05T10:58:58.807Z", "references/api_key/types/api_key.FindConfigOrder/page.mdx": "2024-11-25T17:49:28.715Z", "references/auth/types/auth.FindConfigOrder/page.mdx": "2024-11-25T17:49:28.887Z", diff --git a/www/apps/resources/generated/files-map.mjs b/www/apps/resources/generated/files-map.mjs index 6106d44785..5a7b81c8f8 100644 --- a/www/apps/resources/generated/files-map.mjs +++ b/www/apps/resources/generated/files-map.mjs @@ -763,14 +763,6 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/commerce-modules/user/workflows/page.mdx", "pathname": "/commerce-modules/user/workflows" }, - { - "filePath": "/www/apps/resources/app/contribution-guidelines/admin-translations/page.mdx", - "pathname": "/contribution-guidelines/admin-translations" - }, - { - "filePath": "/www/apps/resources/app/contribution-guidelines/docs/page.mdx", - "pathname": "/contribution-guidelines/docs" - }, { "filePath": "/www/apps/resources/app/create-medusa-app/page.mdx", "pathname": "/create-medusa-app" @@ -1271,10 +1263,6 @@ export const filesMap = [ "filePath": "/www/apps/resources/app/troubleshooting/workflow-errors/page.mdx", "pathname": "/troubleshooting/workflow-errors" }, - { - "filePath": "/www/apps/resources/app/usage/page.mdx", - "pathname": "/usage" - }, { "filePath": "/www/apps/resources/references/api_key/IApiKeyModuleService/methods/api_key.IApiKeyModuleService.authenticate/page.mdx", "pathname": "/references/api_key/IApiKeyModuleService/methods/api_key.IApiKeyModuleService.authenticate" diff --git a/www/apps/resources/generated/sidebar.mjs b/www/apps/resources/generated/sidebar.mjs index 5cedb3d2ba..5777e9dfab 100644 --- a/www/apps/resources/generated/sidebar.mjs +++ b/www/apps/resources/generated/sidebar.mjs @@ -1,289 +1,88 @@ -export const generatedSidebar = [ +export const generatedSidebars = [ { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/", - "title": "Overview", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/examples", - "title": "Examples", - "isChildSidebar": true, - "children": [ + "sidebar_id": "resources", + "title": "Development Resources", + "items": [ { "loaded": true, "isPathHref": true, - "type": "ref", - "path": "/examples", - "title": "Example Snippets", + "type": "link", + "path": "/", + "title": "Overview", "children": [] }, { "loaded": true, "isPathHref": true, - "type": "ref", - "path": "/recipes", - "title": "Recipes", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "path": "/plugins", - "title": "Plugins", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "path": "/integrations", - "title": "Integrations", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Server Examples", - "autogenerate_tags": "example+server", - "autogenerate_as_ref": true, + "type": "sidebar", + "sidebar_id": "examples", + "title": "Examples", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "title": "Custom Item Price", - "path": "/examples/guides/custom-item-price", + "path": "/examples", + "title": "Example Snippets", "children": [] }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Quote Management", - "path": "/examples/guides/quote-management", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Storefront Examples", - "autogenerate_tags": "example+storefront", - "autogenerate_as_ref": true, - "children": [ { "loaded": true, "isPathHref": true, "type": "ref", - "title": "Implement Express Checkout with Medusa", - "path": "https://docs.medusajs.com/resources/storefront-development/guides/express-checkout", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes", - "title": "Recipes", - "isChildSidebar": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/marketplace", - "title": "Marketplace", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/marketplace/examples/vendors", - "title": "Example: Vendors", + "path": "/recipes", + "title": "Recipes", "children": [] }, { "loaded": true, "isPathHref": true, - "type": "link", - "path": "/recipes/marketplace/examples/restaurant-delivery", - "title": "Example: Restaurant-Delivery", + "type": "ref", + "path": "/plugins", + "title": "Plugins", "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "path": "/integrations", + "title": "Integrations", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Storefront Examples", + "autogenerate_tags": "example+storefront", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Implement Express Checkout with Medusa", + "path": "https://docs.medusajs.com/resources/storefront-development/guides/express-checkout", + "children": [] + } + ] } ] }, { "loaded": true, "isPathHref": true, - "type": "link", - "path": "/recipes/subscriptions", - "title": "Subscriptions", + "type": "sidebar", + "sidebar_id": "recipes", + "title": "Recipes", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "path": "/recipes/subscriptions/examples/standard", - "title": "Example", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/digital-products", - "title": "Digital Products", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/digital-products/examples/standard", - "title": "Example", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/erp", - "title": "Integrate ERP", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/erp/odoo", - "title": "Example: Odoo Integration", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/b2b", - "title": "B2B", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/examples/guides/quote-management", - "title": "Example: Quote Management", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/commerce-automation", - "title": "Commerce Automation", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/commerce-automation/restock-notification", - "title": "Example: Restock Notifications", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/ecommerce", - "title": "Ecommerce", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/multi-region-store", - "title": "Multi-Region Store", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/omnichannel", - "title": "Omnichannel Store", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/oms", - "title": "OMS", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/personalized-products", - "title": "Personalized Products", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/pos", - "title": "POS", - "children": [] - } - ] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules", - "title": "Commerce Modules", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "API Key Module", - "isChildSidebar": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/api-key", + "path": "/recipes", "title": "Overview", "children": [] }, @@ -293,24 +92,24 @@ export const generatedSidebar = [ { "loaded": true, "isPathHref": true, - "type": "category", - "title": "Concepts", - "initialOpen": false, + "type": "link", + "path": "/recipes/marketplace", + "title": "Marketplace", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "path": "/commerce-modules/api-key/concepts", - "title": "API Key Concepts", + "path": "/recipes/marketplace/examples/vendors", + "title": "Example: Vendors", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", - "path": "/commerce-modules/api-key/links-to-other-modules", - "title": "Link to Modules", + "path": "/recipes/marketplace/examples/restaurant-delivery", + "title": "Example: Restaurant-Delivery", "children": [] } ] @@ -318,105 +117,904 @@ export const generatedSidebar = [ { "loaded": true, "isPathHref": true, - "type": "category", - "title": "Storefront Guides", - "initialOpen": false, - "autogenerate_tags": "storefront+apiKey,-jsSdk", - "autogenerate_as_ref": true, - "description": "Learn how to integrate the API Key Module's features into your storefront.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Use a Publishable API Key in the Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/publishable-api-keys", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Admin User Guides", - "initialOpen": false, - "autogenerate_tags": "userGuide+apiKey", - "autogenerate_as_ref": true, - "description": "Learn how to utilize and manage API Key features in the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Publishable API Keys", - "path": "https://docs.medusajs.com/user-guide/settings/developer/publishable-api-keys", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Secret API Keys", - "path": "https://docs.medusajs.com/user-guide/settings/developer/secret-api-keys", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "initialOpen": false, - "description": "Find references for tools and resources related to the API Key Module, such as data models, methods, and more. These are useful for your customizations.", + "type": "link", + "path": "/recipes/subscriptions", + "title": "Subscriptions", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "path": "/commerce-modules/api-key/workflows", - "title": "Workflows", - "hideChildren": true, + "path": "/recipes/subscriptions/examples/standard", + "title": "Example", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/digital-products", + "title": "Digital Products", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/digital-products/examples/standard", + "title": "Example", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/erp", + "title": "Integrate ERP", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/erp/odoo", + "title": "Example: Odoo Integration", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/b2b", + "title": "B2B", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/commerce-automation", + "title": "Commerce Automation", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/commerce-automation/restock-notification", + "title": "Example: Restock Notifications", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/ecommerce", + "title": "Ecommerce", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/multi-region-store", + "title": "Multi-Region Store", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/omnichannel", + "title": "Omnichannel Store", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/oms", + "title": "OMS", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/personalized-products", + "title": "Personalized Products", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/pos", + "title": "POS", + "children": [] + } + ] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules", + "title": "Commerce Modules", + "hideChildren": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "api-key", + "title": "API Key Module", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/api-key", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Concepts", + "initialOpen": false, "children": [ { "loaded": true, "isPathHref": true, - "type": "category", + "type": "link", + "path": "/commerce-modules/api-key/concepts", + "title": "API Key Concepts", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/api-key/links-to-other-modules", + "title": "Link to Modules", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Storefront Guides", + "initialOpen": false, + "autogenerate_tags": "storefront+apiKey,-jsSdk", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to integrate the API Key Module's features into your storefront.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Use a Publishable API Key in the Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/publishable-api-keys", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin User Guides", + "initialOpen": false, + "autogenerate_tags": "userGuide+apiKey", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to utilize and manage API Key features in the Medusa Admin dashboard.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Publishable API Keys", + "path": "https://docs.medusajs.com/user-guide/settings/developer/publishable-api-keys", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Secret API Keys", + "path": "https://docs.medusajs.com/user-guide/settings/developer/secret-api-keys", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "References", + "initialOpen": false, + "description": "Find references for tools and resources related to the API Key Module, such as data models, methods, and more. These are useful for your customizations.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/api-key/workflows", "title": "Workflows", - "autogenerate_tags": "workflow+apiKey", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+apiKey", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createApiKeysWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createApiKeysWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteApiKeysWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteApiKeysWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "revokeApiKeysWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/revokeApiKeysWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateApiKeysWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateApiKeysWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+apiKey", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createApiKeysStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createApiKeysStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteApiKeysStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteApiKeysStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "revokeApiKeysStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/revokeApiKeysStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateApiKeysStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateApiKeysStep", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/api-key/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+apiKey", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the API Key Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "apiKey", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/apiKey", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/api-key/admin-widget-zones", + "title": "Admin Widget Zones", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "api-key-service-reference", + "title": "Main Service Reference", + "childSidebarTitle": "API Key Module's Main Service Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/api-key", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Methods", + "hasTitleStyling": true, + "autogenerate_path": "/references/api_key/IApiKeyModuleService/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/api-key/authenticate", + "title": "authenticate", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/api-key/createApiKeys", + "title": "createApiKeys", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/api-key/deleteApiKeys", + "title": "deleteApiKeys", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/api-key/listAndCountApiKeys", + "title": "listAndCountApiKeys", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/api-key/listApiKeys", + "title": "listApiKeys", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/api-key/retrieveApiKey", + "title": "retrieveApiKey", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/api-key/revoke", + "title": "revoke", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/api-key/updateApiKeys", + "title": "updateApiKeys", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/api-key/upsertApiKeys", + "title": "upsertApiKeys", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "api-key-models-reference", + "title": "Data Models Reference", + "childSidebarTitle": "API Key Module Data Models Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/api-key/models", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Data Models", + "hasTitleStyling": true, + "autogenerate_path": "/references/api_key_models/variables", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/api-key/models/ApiKey", + "title": "ApiKey", + "description": "", + "children": [] + } + ] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "auth", + "title": "Auth Module", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/auth", + "title": "Overview", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/auth/module-options", + "title": "Module Options", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Concepts", + "initialOpen": false, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/auth/auth-identity-and-actor-types", + "title": "Identity and Actor Types", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/auth/auth-providers", + "title": "Auth Providers", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/auth/auth-flows", + "title": "Auth Flow with Module", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/auth/authentication-route", + "title": "Auth Flow with Routes", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Server Guides", + "autogenerate_tags": "server+auth", + "initialOpen": false, + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to use the Auth Module in your customizations on the Medusa application server.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/auth/create-actor-type", + "title": "Create an Actor Type", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth/provider", + "title": "Create Auth Provider Module", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/auth/reset-password", + "title": "Handle Password Reset Event", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Storefront Guides", + "autogenerate_tags": "storefront+auth,-jsSdk", + "initialOpen": false, + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to integrate the Auth Module's features into your storefront.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Log-out Customer in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/customers/log-out", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Login Customer in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/customers/login", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Register Customer in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/customers/register", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Reset Customer Password in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/customers/reset-password", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Retrieve Logged-In Customer in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/customers/retrieve", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Third-Party or Social Login in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/customers/third-party-login", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin User Guides", + "autogenerate_tags": "userGuide+auth", + "initialOpen": false, + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to utilize and manage Auth features in the Medusa Admin dashboard.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Reset Password", + "path": "https://docs.medusajs.com/user-guide/reset-password", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Providers", + "initialOpen": false, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/auth/auth-providers/emailpass", + "title": "Emailpass Provider", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/auth/auth-providers/google", + "title": "Google Provider", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/auth/auth-providers/github", + "title": "GitHub Provider", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "References", + "initialOpen": false, + "description": "Find references for tools and resources related to the Auth Module, such as data models, methods, and more. These are useful for your customizations.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/auth/workflows", + "title": "Workflows", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+auth", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "acceptInviteWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/acceptInviteWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCustomerAccountWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCustomerAccountWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createUserAccountWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createUserAccountWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeCustomerAccountWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeCustomerAccountWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeUserAccountWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeUserAccountWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+auth", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "setAuthAppMetadataStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/setAuthAppMetadataStep", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/auth/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "autogenerate_tags": "jsSdk+auth", "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", "children": [ { "loaded": true, "isPathHref": true, "type": "ref", - "title": "createApiKeysWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createApiKeysWorkflow", + "title": "callback", + "path": "https://docs.medusajs.com/resources/references/js-sdk/auth/callback", "children": [] }, { "loaded": true, "isPathHref": true, "type": "ref", - "title": "deleteApiKeysWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteApiKeysWorkflow", + "title": "login", + "path": "https://docs.medusajs.com/resources/references/js-sdk/auth/login", "children": [] }, { "loaded": true, "isPathHref": true, "type": "ref", - "title": "revokeApiKeysWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/revokeApiKeysWorkflow", + "title": "logout", + "path": "https://docs.medusajs.com/resources/references/js-sdk/auth/logout", "children": [] }, { "loaded": true, "isPathHref": true, "type": "ref", - "title": "updateApiKeysWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateApiKeysWorkflow", + "title": "refresh", + "path": "https://docs.medusajs.com/resources/references/js-sdk/auth/refresh", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "register", + "path": "https://docs.medusajs.com/resources/references/js-sdk/auth/register", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "resetPassword", + "path": "https://docs.medusajs.com/resources/references/js-sdk/auth/resetPassword", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProvider", + "path": "https://docs.medusajs.com/resources/references/js-sdk/auth/updateProvider", "children": [] } ] @@ -424,211 +1022,16006 @@ export const generatedSidebar = [ { "loaded": true, "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+apiKey", - "autogenerate_as_ref": true, + "type": "link", + "path": "/commerce-modules/auth/events", + "title": "Events Reference", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/auth/admin-widget-zones", + "title": "Admin Widget Zones", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "auth-service-reference", + "title": "Main Service Reference", + "childSidebarTitle": "Auth Module's Main Service Reference", "children": [ { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "createApiKeysStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createApiKeysStep", + "type": "link", + "path": "/references/auth", + "title": "Reference Overview", "children": [] }, + { + "type": "separator" + }, { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "deleteApiKeysStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteApiKeysStep", + "type": "category", + "title": "Methods", + "autogenerate_path": "/references/auth/IAuthModuleService/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth/authenticate", + "title": "authenticate", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth/createAuthIdentities", + "title": "createAuthIdentities", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth/createProviderIdentities", + "title": "createProviderIdentities", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth/deleteAuthIdentities", + "title": "deleteAuthIdentities", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth/deleteProviderIdentities", + "title": "deleteProviderIdentities", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth/listAndCountAuthIdentities", + "title": "listAndCountAuthIdentities", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth/listAuthIdentities", + "title": "listAuthIdentities", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth/listProviderIdentities", + "title": "listProviderIdentities", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth/register", + "title": "register", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth/retrieveAuthIdentity", + "title": "retrieveAuthIdentity", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth/retrieveProviderIdentity", + "title": "retrieveProviderIdentity", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth/updateAuthIdentities", + "title": "updateAuthIdentities", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth/updateProvider", + "title": "updateProvider", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth/updateProviderIdentities", + "title": "updateProviderIdentities", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth/validateCallback", + "title": "validateCallback", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "auth-models-reference", + "title": "Data Models Reference", + "childSidebarTitle": "Auth Module Data Models Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth/models", + "title": "Reference Overview", "children": [] }, + { + "type": "separator" + }, { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "revokeApiKeysStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/revokeApiKeysStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateApiKeysStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateApiKeysStep", - "children": [] + "type": "category", + "title": "Data Models", + "autogenerate_path": "/references/auth_models/variables", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth/models/AuthIdentity", + "title": "AuthIdentity", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth/models/ProviderIdentity", + "title": "ProviderIdentity", + "description": "", + "children": [] + } + ] } ] } ] - }, + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "cart", + "title": "Cart Module", + "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "path": "/commerce-modules/api-key/js-sdk", - "title": "JS SDK", - "hideChildren": true, + "path": "/commerce-modules/cart", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Concepts", + "initialOpen": false, "children": [ { "loaded": true, "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+apiKey", - "description": "The following methods or properties are used to send requests to Admin API Routes related to the API Key Module.", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "apiKey", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/apiKey", - "children": [] - } - ] + "type": "link", + "path": "/commerce-modules/cart/concepts", + "title": "Cart Concepts", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/cart/promotions", + "title": "Promotion Adjustments", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/cart/tax-lines", + "title": "Tax Lines", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/cart/links-to-other-modules", + "title": "Links to Other Modules", + "children": [] } ] }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Server Guides", + "autogenerate_tags": "server+cart", + "initialOpen": false, + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to use the Cart Module in your customizations on the Medusa application server.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/cart/extend", + "title": "Extend Module", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Implement Custom Line Item Pricing in Medusa", + "path": "https://docs.medusajs.com/resources/examples/guides/custom-item-price", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Storefront Guides", + "autogenerate_tags": "storefront+cart,-jsSdk", + "initialOpen": false, + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to integrate the Cart Module's features into your storefront.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Checkout Step 1: Enter Email", + "path": "https://docs.medusajs.com/resources/storefront-development/checkout/email", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Checkout Step 2: Set Address", + "path": "https://docs.medusajs.com/resources/storefront-development/checkout/address", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Checkout Step 3: Choose Shipping Method", + "path": "https://docs.medusajs.com/resources/storefront-development/checkout/shipping", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Checkout Step 4: Choose Payment Provider", + "path": "https://docs.medusajs.com/resources/storefront-development/checkout/payment", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Checkout Step 5: Complete Cart", + "path": "https://docs.medusajs.com/resources/storefront-development/checkout/complete-cart", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Cart Context in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/cart/context", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Cart in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/cart/create", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Implement Express Checkout with Medusa", + "path": "https://docs.medusajs.com/resources/storefront-development/guides/express-checkout", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Cart's Items in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/cart/manage-items", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Payment with Stripe in React Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/checkout/payment/stripe", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Retrieve Cart in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/cart/retrieve", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Update Cart in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/cart/update", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "References", + "initialOpen": false, + "description": "Find references for tools and resources related to the Cart Module, such as data models, methods, and more. These are useful for your customizations.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/cart/workflows", + "title": "Workflows", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+cart", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addShippingMethodToCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addShippingMethodToCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addToCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addToCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "completeCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/completeCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteLineItemsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteLineItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refreshCartItemsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshCartItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refreshCartShippingMethodsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshCartShippingMethodsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "transferCartCustomerWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/transferCartCustomerWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCartPromotionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartPromotionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateLineItemInCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateLineItemInCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateTaxLinesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateTaxLinesWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+cart", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addShippingMethodToCartStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/addShippingMethodToCartStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCartsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createCartsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createLineItemAdjustmentsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createLineItemAdjustmentsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createLineItemsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createLineItemsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createShippingMethodAdjustmentsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createShippingMethodAdjustmentsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteLineItemsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteLineItemsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "getLineItemActionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/getLineItemActionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeLineItemAdjustmentsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/removeLineItemAdjustmentsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeShippingMethodAdjustmentsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/removeShippingMethodAdjustmentsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeShippingMethodFromCartStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/removeShippingMethodFromCartStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "setTaxLinesForItemsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/setTaxLinesForItemsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCartsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateCartsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateLineItemsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateLineItemsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateLineItemsStepWithSelector", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateLineItemsStepWithSelector", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateShippingMethodsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateShippingMethodsStep", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/cart/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Store", + "autogenerate_tags": "jsSdk+storefront+cart", + "description": "The following methods or properties are used to send requests to Store API Routes related to the Cart Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cart", + "path": "https://docs.medusajs.com/resources/references/js-sdk/store/cart", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/cart/events", + "title": "Events Reference", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "cart-service-reference", + "title": "Main Service Reference", + "childSidebarTitle": "Cart Module's Main Service Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Methods", + "autogenerate_path": "/references/cart/ICartModuleService/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/addLineItemAdjustments", + "title": "addLineItemAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/addLineItemTaxLines", + "title": "addLineItemTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/addLineItems", + "title": "addLineItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/addShippingMethodAdjustments", + "title": "addShippingMethodAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/addShippingMethodTaxLines", + "title": "addShippingMethodTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/addShippingMethods", + "title": "addShippingMethods", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/createAddresses", + "title": "createAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/createCarts", + "title": "createCarts", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/deleteAddresses", + "title": "deleteAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/deleteCarts", + "title": "deleteCarts", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/deleteLineItemAdjustments", + "title": "deleteLineItemAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/deleteLineItemTaxLines", + "title": "deleteLineItemTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/deleteLineItems", + "title": "deleteLineItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/deleteShippingMethodAdjustments", + "title": "deleteShippingMethodAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/deleteShippingMethodTaxLines", + "title": "deleteShippingMethodTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/deleteShippingMethods", + "title": "deleteShippingMethods", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/listAddresses", + "title": "listAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/listAndCountCarts", + "title": "listAndCountCarts", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/listCarts", + "title": "listCarts", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/listLineItemAdjustments", + "title": "listLineItemAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/listLineItemTaxLines", + "title": "listLineItemTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/listLineItems", + "title": "listLineItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/listShippingMethodAdjustments", + "title": "listShippingMethodAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/listShippingMethodTaxLines", + "title": "listShippingMethodTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/listShippingMethods", + "title": "listShippingMethods", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/restoreAddresses", + "title": "restoreAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/restoreCarts", + "title": "restoreCarts", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/restoreLineItemAdjustments", + "title": "restoreLineItemAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/restoreLineItemTaxLines", + "title": "restoreLineItemTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/restoreLineItems", + "title": "restoreLineItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/restoreShippingMethodAdjustments", + "title": "restoreShippingMethodAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/restoreShippingMethodTaxLines", + "title": "restoreShippingMethodTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/restoreShippingMethods", + "title": "restoreShippingMethods", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/retrieveCart", + "title": "retrieveCart", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/retrieveLineItem", + "title": "retrieveLineItem", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/setLineItemAdjustments", + "title": "setLineItemAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/setLineItemTaxLines", + "title": "setLineItemTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/setShippingMethodAdjustments", + "title": "setShippingMethodAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/setShippingMethodTaxLines", + "title": "setShippingMethodTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/softDeleteAddresses", + "title": "softDeleteAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/softDeleteCarts", + "title": "softDeleteCarts", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/softDeleteLineItemAdjustments", + "title": "softDeleteLineItemAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/softDeleteLineItemTaxLines", + "title": "softDeleteLineItemTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/softDeleteLineItems", + "title": "softDeleteLineItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/softDeleteShippingMethodAdjustments", + "title": "softDeleteShippingMethodAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/softDeleteShippingMethodTaxLines", + "title": "softDeleteShippingMethodTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/softDeleteShippingMethods", + "title": "softDeleteShippingMethods", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/updateAddresses", + "title": "updateAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/updateCarts", + "title": "updateCarts", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/updateLineItems", + "title": "updateLineItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/updateShippingMethods", + "title": "updateShippingMethods", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "cart-models-reference", + "title": "Data Models Reference", + "childSidebarTitle": "Cart Module Data Models Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/models", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Data Models", + "autogenerate_path": "/references/cart_models/variables", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/models/Address", + "title": "Address", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/models/Cart", + "title": "Cart", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/models/CreditLine", + "title": "CreditLine", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/models/LineItem", + "title": "LineItem", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/models/LineItemAdjustment", + "title": "LineItemAdjustment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/models/LineItemTaxLine", + "title": "LineItemTaxLine", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/models/ShippingMethod", + "title": "ShippingMethod", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/models/ShippingMethodAdjustment", + "title": "ShippingMethodAdjustment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/models/ShippingMethodTaxLine", + "title": "ShippingMethodTaxLine", + "description": "", + "children": [] + } + ] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "currency", + "title": "Currency Module", + "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "path": "/commerce-modules/api-key/admin-widget-zones", - "title": "Admin Widget Zones", + "path": "/commerce-modules/currency", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Concepts", + "initialOpen": false, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/currency/links-to-other-modules", + "title": "Link to Modules", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin User Guides", + "autogenerate_tags": "userGuide+currency", + "initialOpen": false, + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to utilize and manage Currency features in the Medusa Admin dashboard.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Store", + "path": "https://docs.medusajs.com/user-guide/settings/store", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "References", + "initialOpen": false, + "description": "Find references for tools and resources related to the Currency Module, such as data models, methods, and more. These are useful for your customizations.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/currency/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+currency", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Currency Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "currency", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/currency", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "currency-service-reference", + "title": "Main Service Reference", + "childSidebarTitle": "Currency Module's Main Service Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/currency", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Methods", + "autogenerate_path": "/references/currency/ICurrencyModuleService/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/currency/listAndCountCurrencies", + "title": "listAndCountCurrencies", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/currency/listCurrencies", + "title": "listCurrencies", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/currency/retrieveCurrency", + "title": "retrieveCurrency", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "currency-models-reference", + "title": "Data Models Reference", + "childSidebarTitle": "Currency Module Data Models Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/currency/models", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Data Models", + "autogenerate_path": "/references/currency_models/variables", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/currency/models/Currency", + "title": "Currency", + "description": "", + "children": [] + } + ] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "customer", + "title": "Customer Module", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/customer", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Concepts", + "initialOpen": false, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/customer/customer-accounts", + "title": "Customer Accounts", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/customer/links-to-other-modules", + "title": "Link to Modules", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Server Guides", + "autogenerate_tags": "server+customer", + "initialOpen": false, + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to use the Customer Module in your customizations on the Medusa application server.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/customer/extend", + "title": "Extend Module", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Storefront Guides", + "autogenerate_tags": "storefront+customer,-jsSdk", + "initialOpen": false, + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to integrate the Customer Module's features into your storefront.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Customer Context in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/customers/context", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Edit Customer Profile in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/customers/profile", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Log-out Customer in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/customers/log-out", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Login Customer in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/customers/login", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Customer Addresses in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/customers/addresses", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Register Customer in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/customers/register", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Reset Customer Password in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/customers/reset-password", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Retrieve Logged-In Customer in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/customers/retrieve", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Third-Party or Social Login in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/customers/third-party-login", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin User Guides", + "autogenerate_tags": "userGuide+customer", + "initialOpen": false, + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to utilize and manage Customer features in the Medusa Admin dashboard.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Customers Overview", + "path": "https://docs.medusajs.com/user-guide/customers", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Customer Groups", + "path": "https://docs.medusajs.com/user-guide/customers/groups", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Customers", + "path": "https://docs.medusajs.com/user-guide/customers/manage", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "References", + "initialOpen": false, + "description": "Find references for tools and resources related to the Customer Module, such as data models, methods, and more. These are useful for your customizations.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/customer/workflows", + "title": "Workflows", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+customer", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addOrderLineItemsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addOrderLineItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCustomerAccountWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCustomerAccountWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCustomerAddressesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCustomerAddressesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCustomerGroupsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCustomerGroupsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCustomersWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCustomersWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteCustomerAddressesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteCustomerAddressesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteCustomerGroupsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteCustomerGroupsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteCustomersWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteCustomersWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "linkCustomerGroupsToCustomerWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/linkCustomerGroupsToCustomerWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "linkCustomersToCustomerGroupWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/linkCustomersToCustomerGroupWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderClaimAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderEditAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderEditAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderExchangeAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderExchangeAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeCustomerAccountWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeCustomerAccountWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCustomerAddressesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCustomerAddressesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCustomerGroupsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCustomerGroupsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCustomersWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCustomersWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+customer", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCustomerAddressesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createCustomerAddressesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCustomerGroupsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createCustomerGroupsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCustomersStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createCustomersStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteCustomerAddressesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteCustomerAddressesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteCustomerGroupStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteCustomerGroupStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteCustomersStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteCustomersStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "findOrCreateCustomerStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/findOrCreateCustomerStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "linkCustomerGroupsToCustomerStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/linkCustomerGroupsToCustomerStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "linkCustomersToCustomerGroupStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/linkCustomersToCustomerGroupStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "maybeUnsetDefaultBillingAddressesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/maybeUnsetDefaultBillingAddressesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "maybeUnsetDefaultShippingAddressesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/maybeUnsetDefaultShippingAddressesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCustomerAddressesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateCustomerAddressesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCustomerGroupsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateCustomerGroupsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCustomersStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateCustomersStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "validateCustomerAccountCreation", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/validateCustomerAccountCreation", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/customer/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Store", + "autogenerate_tags": "jsSdk+storefront+customer", + "description": "The following methods or properties are used to send requests to Store API Routes related to the Customer Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "customer", + "path": "https://docs.medusajs.com/resources/references/js-sdk/store/customer", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+customer", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Customer Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "customer", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/customer", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "customerGroup", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/customerGroup", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/customer/events", + "title": "Events Reference", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/customer/admin-widget-zones", + "title": "Admin Widget Zones", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "customer-service-reference", + "title": "Main Service Reference", + "childSidebarTitle": "Customer Module's Main Service Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Methods", + "autogenerate_path": "/references/customer/ICustomerModuleService/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/addCustomerToGroup", + "title": "addCustomerToGroup", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/createCustomerAddresses", + "title": "createCustomerAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/createCustomerGroups", + "title": "createCustomerGroups", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/createCustomers", + "title": "createCustomers", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/deleteCustomerAddresses", + "title": "deleteCustomerAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/deleteCustomerGroups", + "title": "deleteCustomerGroups", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/deleteCustomers", + "title": "deleteCustomers", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/listAndCountCustomerAddresses", + "title": "listAndCountCustomerAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/listAndCountCustomerGroups", + "title": "listAndCountCustomerGroups", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/listAndCountCustomers", + "title": "listAndCountCustomers", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/listCustomerAddresses", + "title": "listCustomerAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/listCustomerGroupCustomers", + "title": "listCustomerGroupCustomers", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/listCustomerGroups", + "title": "listCustomerGroups", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/listCustomers", + "title": "listCustomers", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/removeCustomerFromGroup", + "title": "removeCustomerFromGroup", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/restoreCustomerGroups", + "title": "restoreCustomerGroups", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/restoreCustomers", + "title": "restoreCustomers", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/retrieveCustomer", + "title": "retrieveCustomer", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/retrieveCustomerGroup", + "title": "retrieveCustomerGroup", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/softDeleteCustomerGroups", + "title": "softDeleteCustomerGroups", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/softDeleteCustomers", + "title": "softDeleteCustomers", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/updateCustomerAddresses", + "title": "updateCustomerAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/updateCustomerGroups", + "title": "updateCustomerGroups", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/updateCustomers", + "title": "updateCustomers", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "customer-models-reference", + "title": "Data Models Reference", + "childSidebarTitle": "Customer Module Data Models Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/models", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Data Models", + "autogenerate_path": "/references/customer_models/variables", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/models/Customer", + "title": "Customer", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/models/CustomerAddress", + "title": "CustomerAddress", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/models/CustomerGroup", + "title": "CustomerGroup", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/models/CustomerGroupCustomer", + "title": "CustomerGroupCustomer", + "description": "", + "children": [] + } + ] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "fulfillment", + "title": "Fulfillment Module", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/fulfillment", + "title": "Overview", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", - "path": "/references/api-key", - "title": "Main Service Reference", - "isChildSidebar": true, - "childSidebarTitle": "API Key Module's Main Service Reference", + "path": "/commerce-modules/fulfillment/module-options", + "title": "Module Options", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Concepts", + "initialOpen": false, + "autogenerate_tags": "concept+fulfillment", + "autogenerate_as_ref": true, "children": [ { "loaded": true, "isPathHref": true, - "type": "category", - "title": "Methods", - "hasTitleStyling": true, - "autogenerate_path": "/references/api_key/IApiKeyModuleService/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/api-key/authenticate", - "title": "authenticate", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/api-key/createApiKeys", - "title": "createApiKeys", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/api-key/deleteApiKeys", - "title": "deleteApiKeys", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/api-key/listAndCountApiKeys", - "title": "listAndCountApiKeys", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/api-key/listApiKeys", - "title": "listApiKeys", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/api-key/retrieveApiKey", - "title": "retrieveApiKey", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/api-key/revoke", - "title": "revoke", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/api-key/updateApiKeys", - "title": "updateApiKeys", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/api-key/upsertApiKeys", - "title": "upsertApiKeys", - "description": "", - "children": [] - } - ] + "type": "link", + "path": "/commerce-modules/fulfillment/concepts", + "title": "Fulfillment Concepts", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/fulfillment/fulfillment-provider", + "title": "Fulfillment Provider", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/fulfillment/shipping-option", + "title": "Shipping Option", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/fulfillment/item-fulfillment", + "title": "Item Fulfillment", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/fulfillment/links-to-other-modules", + "title": "Links to Other Modules", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Product Shipping Requirement", + "path": "https://docs.medusajs.com/resources/commerce-modules/product/selling-products", + "children": [] } ] }, { "loaded": true, "isPathHref": true, - "type": "link", - "path": "/references/api-key/models", - "title": "Data Models Reference", - "isChildSidebar": true, - "childSidebarTitle": "API Key Module Data Models Reference", + "type": "category", + "title": "Server Guides", + "autogenerate_tags": "server+fulfillment", + "initialOpen": false, + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to use the Fulfillment Module in your customizations on the Medusa application server.", "children": [ { "loaded": true, "isPathHref": true, - "type": "category", - "title": "Data Models", - "hasTitleStyling": true, - "autogenerate_path": "/references/api_key_models/variables", + "type": "link", + "path": "/references/fulfillment/provider", + "title": "Create Fulfillment Provider Module", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "path": "/integrations/guides/shipstation", + "title": "Integrate ShipStation", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Storefront Guides", + "autogenerate_tags": "storefront+fulfillment,-jsSdk", + "initialOpen": false, + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to integrate the Fulfillment Module's features into your storefront.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Checkout Step 3: Choose Shipping Method", + "path": "https://docs.medusajs.com/resources/storefront-development/checkout/shipping", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Implement Express Checkout with Medusa", + "path": "https://docs.medusajs.com/resources/storefront-development/guides/express-checkout", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin User Guides", + "autogenerate_tags": "userGuide+fulfillment", + "initialOpen": false, + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to utilize and manage Fulfillment features in the Medusa Admin dashboard.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Locations & Shipping Overview", + "path": "https://docs.medusajs.com/user-guide/settings/locations-and-shipping", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Order Fulfillments", + "path": "https://docs.medusajs.com/user-guide/orders/fulfillments", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Shipping Profiles", + "path": "https://docs.medusajs.com/user-guide/settings/locations-and-shipping/shipping-profiles", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "References", + "initialOpen": false, + "description": "Find references for tools and resources related to the Fulfillment Module, such as data models, methods, and more. These are useful for your customizations.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/fulfillment/workflows", + "title": "Workflows", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+fulfillment", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addShippingMethodToCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addShippingMethodToCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addToCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addToCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchShippingOptionRulesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchShippingOptionRulesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "calculateShippingOptionsPricesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/calculateShippingOptionsPricesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelFulfillmentWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelFulfillmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderFulfillmentWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderFulfillmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmClaimRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmClaimRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmExchangeRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmExchangeRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmReturnRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmReturnRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createAndCompleteReturnOrderWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createAndCompleteReturnOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createFulfillmentWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createFulfillmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createLocationFulfillmentSetWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createLocationFulfillmentSetWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderFulfillmentWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderFulfillmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderShipmentWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderShipmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createReturnFulfillmentWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createReturnFulfillmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createServiceZonesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createServiceZonesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createShipmentWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createShipmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createShippingOptionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createShippingOptionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createShippingProfilesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createShippingProfilesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteFulfillmentSetsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteFulfillmentSetsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteLineItemsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteLineItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteServiceZonesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteServiceZonesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteShippingOptionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteShippingOptionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteShippingProfileWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteShippingProfileWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "importProductsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/importProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "listShippingOptionsForCartWithPricingWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/listShippingOptionsForCartWithPricingWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "markFulfillmentAsDeliveredWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/markFulfillmentAsDeliveredWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "markOrderFulfillmentAsDeliveredWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/markOrderFulfillmentAsDeliveredWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refreshCartItemsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshCartItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refreshCartShippingMethodsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshCartShippingMethodsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "transferCartCustomerWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/transferCartCustomerWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateFulfillmentWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateFulfillmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateLineItemInCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateLineItemInCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateServiceZonesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateServiceZonesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateShippingOptionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateShippingOptionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateShippingProfilesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateShippingProfilesWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+fulfillment", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "calculateShippingOptionsPricesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/calculateShippingOptionsPricesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelFulfillmentStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/cancelFulfillmentStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createFulfillmentSets", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createFulfillmentSets", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createFulfillmentStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createFulfillmentStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createReturnFulfillmentStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createReturnFulfillmentStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createServiceZonesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createServiceZonesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createShippingOptionRulesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createShippingOptionRulesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createShippingProfilesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createShippingProfilesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteFulfillmentSetsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteFulfillmentSetsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteServiceZonesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteServiceZonesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteShippingOptionRulesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteShippingOptionRulesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteShippingOptionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteShippingOptionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteShippingProfilesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteShippingProfilesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "parseProductCsvStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/parseProductCsvStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateFulfillmentStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateFulfillmentStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateServiceZonesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateServiceZonesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateShippingOptionRulesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateShippingOptionRulesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateShippingProfilesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateShippingProfilesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "upsertShippingOptionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/upsertShippingOptionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "validateAndReturnShippingMethodsDataStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/validateAndReturnShippingMethodsDataStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "validateCartShippingOptionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/validateCartShippingOptionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "validateShipmentStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/validateShipmentStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "validateShippingOptionPricesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/validateShippingOptionPricesStep", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/fulfillment/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Store", + "autogenerate_tags": "jsSdk+storefront+fulfillment", + "description": "The following methods or properties are used to send requests to Store API Routes related to the Fulfillment Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "fulfillment", + "path": "https://docs.medusajs.com/resources/references/js-sdk/store/fulfillment", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+fulfillment", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Fulfillment Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "fulfillment", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/fulfillment", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "fulfillmentProvider", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/fulfillmentProvider", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "fulfillmentSet", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/fulfillmentSet", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "shippingOption", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/shippingOption", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "shippingProfile", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/shippingProfile", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/fulfillment/events", + "title": "Events Reference", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/fulfillment/admin-widget-zones", + "title": "Admin Widget Zones", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "fulfillment-service-reference", + "title": "Main Service Reference", + "childSidebarTitle": "Fulfillment Module's Main Service Reference", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "path": "/references/api-key/models/ApiKey", - "title": "ApiKey", - "description": "", + "path": "/references/fulfillment", + "title": "Reference Overview", "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Methods", + "autogenerate_path": "/references/fulfillment/IFulfillmentModuleService/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/calculateShippingOptionsPrices", + "title": "calculateShippingOptionsPrices", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/cancelFulfillment", + "title": "cancelFulfillment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/createFulfillment", + "title": "createFulfillment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/createFulfillmentSets", + "title": "createFulfillmentSets", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/createGeoZones", + "title": "createGeoZones", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/createReturnFulfillment", + "title": "createReturnFulfillment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/createServiceZones", + "title": "createServiceZones", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/createShippingOptionRules", + "title": "createShippingOptionRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/createShippingOptions", + "title": "createShippingOptions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/createShippingProfiles", + "title": "createShippingProfiles", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/deleteFulfillment", + "title": "deleteFulfillment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/deleteFulfillmentSets", + "title": "deleteFulfillmentSets", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/deleteGeoZones", + "title": "deleteGeoZones", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/deleteServiceZones", + "title": "deleteServiceZones", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/deleteShippingOptionRules", + "title": "deleteShippingOptionRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/deleteShippingOptionTypes", + "title": "deleteShippingOptionTypes", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/deleteShippingOptions", + "title": "deleteShippingOptions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/deleteShippingProfiles", + "title": "deleteShippingProfiles", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/listAndCountFulfillmentSets", + "title": "listAndCountFulfillmentSets", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/listAndCountFulfillments", + "title": "listAndCountFulfillments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/listAndCountGeoZones", + "title": "listAndCountGeoZones", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/listAndCountServiceZones", + "title": "listAndCountServiceZones", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/listAndCountShippingOptionRules", + "title": "listAndCountShippingOptionRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/listAndCountShippingOptionTypes", + "title": "listAndCountShippingOptionTypes", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/listAndCountShippingOptions", + "title": "listAndCountShippingOptions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/listAndCountShippingProfiles", + "title": "listAndCountShippingProfiles", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/listFulfillmentProviders", + "title": "listFulfillmentProviders", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/listFulfillmentSets", + "title": "listFulfillmentSets", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/listFulfillments", + "title": "listFulfillments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/listGeoZones", + "title": "listGeoZones", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/listServiceZones", + "title": "listServiceZones", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/listShippingOptionRules", + "title": "listShippingOptionRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/listShippingOptionTypes", + "title": "listShippingOptionTypes", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/listShippingOptions", + "title": "listShippingOptions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/listShippingOptionsForContext", + "title": "listShippingOptionsForContext", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/listShippingProfiles", + "title": "listShippingProfiles", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/restoreFulfillmentSets", + "title": "restoreFulfillmentSets", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/restoreGeoZones", + "title": "restoreGeoZones", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/restoreServiceZones", + "title": "restoreServiceZones", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/restoreShippingOptions", + "title": "restoreShippingOptions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/restoreShippingProfiles", + "title": "restoreShippingProfiles", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/retrieveFulfillment", + "title": "retrieveFulfillment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/retrieveFulfillmentOptions", + "title": "retrieveFulfillmentOptions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/retrieveFulfillmentSet", + "title": "retrieveFulfillmentSet", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/retrieveGeoZone", + "title": "retrieveGeoZone", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/retrieveServiceZone", + "title": "retrieveServiceZone", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/retrieveShippingOption", + "title": "retrieveShippingOption", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/retrieveShippingOptionRule", + "title": "retrieveShippingOptionRule", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/retrieveShippingOptionType", + "title": "retrieveShippingOptionType", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/retrieveShippingProfile", + "title": "retrieveShippingProfile", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/softDeleteFulfillmentSets", + "title": "softDeleteFulfillmentSets", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/softDeleteGeoZones", + "title": "softDeleteGeoZones", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/softDeleteServiceZones", + "title": "softDeleteServiceZones", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/softDeleteShippingOptions", + "title": "softDeleteShippingOptions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/softDeleteShippingProfiles", + "title": "softDeleteShippingProfiles", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/updateFulfillment", + "title": "updateFulfillment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/updateFulfillmentSets", + "title": "updateFulfillmentSets", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/updateGeoZones", + "title": "updateGeoZones", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/updateServiceZones", + "title": "updateServiceZones", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/updateShippingOptionRules", + "title": "updateShippingOptionRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/updateShippingOptions", + "title": "updateShippingOptions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/updateShippingProfiles", + "title": "updateShippingProfiles", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/upsertServiceZones", + "title": "upsertServiceZones", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/upsertShippingOptions", + "title": "upsertShippingOptions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/upsertShippingProfiles", + "title": "upsertShippingProfiles", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/validateFulfillmentData", + "title": "validateFulfillmentData", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/validateFulfillmentOption", + "title": "validateFulfillmentOption", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/validateShippingOption", + "title": "validateShippingOption", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/validateShippingOptionsForPriceCalculation", + "title": "validateShippingOptionsForPriceCalculation", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "fulfillment-models-reference", + "title": "Data Models Reference", + "childSidebarTitle": "Fulfillment Module Data Models Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/models", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Data Models", + "hasTitleStyling": true, + "autogenerate_path": "/references/fulfillment_models/variables", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/models/Fulfillment", + "title": "Fulfillment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/models/FulfillmentAddress", + "title": "FulfillmentAddress", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/models/FulfillmentItem", + "title": "FulfillmentItem", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/models/FulfillmentLabel", + "title": "FulfillmentLabel", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/models/FulfillmentProvider", + "title": "FulfillmentProvider", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/models/FulfillmentSet", + "title": "FulfillmentSet", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/models/GeoZone", + "title": "GeoZone", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/models/ServiceZone", + "title": "ServiceZone", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/models/ShippingOption", + "title": "ShippingOption", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/models/ShippingOptionRule", + "title": "ShippingOptionRule", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/models/ShippingOptionType", + "title": "ShippingOptionType", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/models/ShippingProfile", + "title": "ShippingProfile", + "description": "", + "children": [] + } + ] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "inventory", + "title": "Inventory Module", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/inventory", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Concepts", + "initialOpen": false, + "autogenerate_tags": "concept+inventory", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/inventory/concepts", + "title": "Inventory Concepts", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/inventory/inventory-in-flows", + "title": "Inventory in Flows", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/inventory/inventory-kit", + "title": "Inventory Kit", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/inventory/links-to-other-modules", + "title": "Links to Modules", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Inventory Kits", + "path": "https://docs.medusajs.com/resources/commerce-modules/inventory/inventory-kit", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Product Variant Inventory", + "path": "https://docs.medusajs.com/resources/commerce-modules/product/variant-inventory", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Storefront Guides", + "autogenerate_tags": "storefront+inventory,-jsSdk", + "initialOpen": false, + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to integrate the Inventory Module's features into your storefront.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Retrieve Product Variant's Inventory in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/products/inventory", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin User Guides", + "autogenerate_tags": "userGuide+inventory", + "initialOpen": false, + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to utilize and manage Inventory features in the Medusa Admin dashboard.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Inventory Overview", + "path": "https://docs.medusajs.com/user-guide/inventory", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Inventory Items", + "path": "https://docs.medusajs.com/user-guide/inventory/inventory", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Reservations", + "path": "https://docs.medusajs.com/user-guide/inventory/reservations", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "References", + "initialOpen": false, + "description": "Find references for tools and resources related to the Inventory Module, such as data models, methods, and more. These are useful for your customizations.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/inventory/workflows", + "title": "Workflows", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+inventory", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addOrderLineItemsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addOrderLineItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addToCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addToCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchInventoryItemLevelsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchInventoryItemLevelsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchProductsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchProductVariantsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductVariantsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "bulkCreateDeleteLevelsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/bulkCreateDeleteLevelsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderClaimWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderClaimWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderExchangeWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderExchangeWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderFulfillmentWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderFulfillmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "completeCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/completeCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmClaimRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmClaimRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmExchangeRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmExchangeRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmOrderEditRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmOrderEditRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmReturnReceiveWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmReturnReceiveWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmVariantInventoryWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmVariantInventoryWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createInventoryItemsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createInventoryItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createInventoryLevelsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createInventoryLevelsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderFulfillmentWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderFulfillmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductVariantsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductVariantsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createReservationsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createReservationsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteInventoryItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteInventoryItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductVariantsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteProductVariantsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteReservationsByLineItemsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteReservationsByLineItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteReservationsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteReservationsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderClaimAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderEditAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderEditAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderExchangeAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderExchangeAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateInventoryItemsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateInventoryItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateInventoryLevelsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateInventoryLevelsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateLineItemInCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateLineItemInCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateReservationsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateReservationsWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+inventory", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "adjustInventoryLevelsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/adjustInventoryLevelsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmInventoryStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/confirmInventoryStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createInventoryItemsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createInventoryItemsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createInventoryLevelsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createInventoryLevelsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createReservationsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createReservationsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteInventoryItemStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteInventoryItemStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteReservationsByLineItemsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteReservationsByLineItemsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteReservationsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteReservationsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "reserveInventoryStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/reserveInventoryStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateInventoryItemsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateInventoryItemsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateInventoryLevelsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateInventoryLevelsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateReservationsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateReservationsStep", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/inventory/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+inventory", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Inventory Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "inventoryItem", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/inventoryItem", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "reservation", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/reservation", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/inventory/admin-widget-zones", + "title": "Admin Widget Zones", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "inventory-service-reference", + "title": "Main Service Reference", + "childSidebarTitle": "Inventory Module's Main Service Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Methods", + "autogenerate_path": "/references/inventory_next/IInventoryService/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/adjustInventory", + "title": "adjustInventory", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/confirmInventory", + "title": "confirmInventory", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/createInventoryItems", + "title": "createInventoryItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/createInventoryLevels", + "title": "createInventoryLevels", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/createReservationItems", + "title": "createReservationItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/deleteInventoryItemLevelByLocationId", + "title": "deleteInventoryItemLevelByLocationId", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/deleteInventoryItems", + "title": "deleteInventoryItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/deleteInventoryLevel", + "title": "deleteInventoryLevel", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/deleteInventoryLevels", + "title": "deleteInventoryLevels", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/deleteReservationItemByLocationId", + "title": "deleteReservationItemByLocationId", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/deleteReservationItems", + "title": "deleteReservationItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/deleteReservationItemsByLineItem", + "title": "deleteReservationItemsByLineItem", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/listAndCountInventoryItems", + "title": "listAndCountInventoryItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/listAndCountInventoryLevels", + "title": "listAndCountInventoryLevels", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/listAndCountReservationItems", + "title": "listAndCountReservationItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/listInventoryItems", + "title": "listInventoryItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/listInventoryLevels", + "title": "listInventoryLevels", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/listReservationItems", + "title": "listReservationItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/restoreInventoryItems", + "title": "restoreInventoryItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/restoreInventoryLevels", + "title": "restoreInventoryLevels", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/restoreReservationItems", + "title": "restoreReservationItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/restoreReservationItemsByLineItem", + "title": "restoreReservationItemsByLineItem", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/retrieveAvailableQuantity", + "title": "retrieveAvailableQuantity", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/retrieveInventoryItem", + "title": "retrieveInventoryItem", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/retrieveInventoryLevel", + "title": "retrieveInventoryLevel", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/retrieveInventoryLevelByItemAndLocation", + "title": "retrieveInventoryLevelByItemAndLocation", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/retrieveReservationItem", + "title": "retrieveReservationItem", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/retrieveReservedQuantity", + "title": "retrieveReservedQuantity", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/retrieveStockedQuantity", + "title": "retrieveStockedQuantity", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/softDeleteInventoryItems", + "title": "softDeleteInventoryItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/softDeleteInventoryLevels", + "title": "softDeleteInventoryLevels", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/softDeleteReservationItems", + "title": "softDeleteReservationItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/updateInventoryItems", + "title": "updateInventoryItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/updateInventoryLevels", + "title": "updateInventoryLevels", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/updateReservationItems", + "title": "updateReservationItems", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "inventory-models-reference", + "title": "Data Models Reference", + "childSidebarTitle": "Inventory Module Data Models Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/models", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Data Models", + "autogenerate_path": "/references/inventory_next_models/variables", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/models/InventoryItem", + "title": "InventoryItem", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/models/InventoryLevel", + "title": "InventoryLevel", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/models/ReservationItem", + "title": "ReservationItem", + "description": "", + "children": [] + } + ] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "order", + "title": "Order Module", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/order", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Concepts", + "initialOpen": false, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/order/concepts", + "title": "Order Concepts", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/order/promotion-adjustments", + "title": "Promotions Adjustments", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/order/tax-lines", + "title": "Tax Lines", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/order/transactions", + "title": "Transactions", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/order/order-versioning", + "title": "Order Versioning", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/order/return", + "title": "Return", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/order/exchange", + "title": "Exchange", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/order/claim", + "title": "Claim", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/order/edit", + "title": "Order Edit", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/order/order-change", + "title": "Order Change", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/order/links-to-other-modules", + "title": "Links to Other Modules", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Storefront Guides", + "autogenerate_tags": "storefront+order,-jsSdk", + "initialOpen": false, + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to integrate the Order Module's features into your storefront.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Checkout Step 5: Complete Cart", + "path": "https://docs.medusajs.com/resources/storefront-development/checkout/complete-cart", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Implement Express Checkout with Medusa", + "path": "https://docs.medusajs.com/resources/storefront-development/guides/express-checkout", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin User Guides", + "autogenerate_tags": "userGuide+order", + "initialOpen": false, + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to utilize and manage Order features in the Medusa Admin dashboard.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Edit Order Items", + "path": "https://docs.medusajs.com/user-guide/orders/edit", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Order Claims", + "path": "https://docs.medusajs.com/user-guide/orders/claims", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Order Details", + "path": "https://docs.medusajs.com/user-guide/orders/manage", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Order Exchanges", + "path": "https://docs.medusajs.com/user-guide/orders/exchanges", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Order Fulfillments", + "path": "https://docs.medusajs.com/user-guide/orders/fulfillments", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Order Payments", + "path": "https://docs.medusajs.com/user-guide/orders/payments", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Order Returns", + "path": "https://docs.medusajs.com/user-guide/orders/returns", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Return Reasons", + "path": "https://docs.medusajs.com/user-guide/settings/return-reasons", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Orders Overview", + "path": "https://docs.medusajs.com/user-guide/orders", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "References", + "initialOpen": false, + "description": "Find references for tools and resources related to the Order Module, such as data models, methods, and more. These are useful for your customizations.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/order/workflows", + "title": "Workflows", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+order", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "acceptOrderTransferWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/acceptOrderTransferWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addOrderLineItemsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addOrderLineItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "archiveOrderWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/archiveOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "beginClaimOrderWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/beginClaimOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "beginExchangeOrderWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/beginExchangeOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "beginOrderEditOrderWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/beginOrderEditOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "beginReceiveReturnWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/beginReceiveReturnWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "beginReturnOrderWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/beginReturnOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelBeginOrderClaimWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelBeginOrderClaimWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelBeginOrderEditWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelBeginOrderEditWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelBeginOrderExchangeWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelBeginOrderExchangeWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderChangeWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderChangeWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderClaimWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderClaimWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderExchangeWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderExchangeWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderFulfillmentWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderFulfillmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderTransferRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderTransferRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelReturnReceiveWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelReturnReceiveWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelReturnRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelReturnRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelReturnWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelReturnWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "capturePaymentWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/capturePaymentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "completeCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/completeCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "completeOrderWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/completeOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmClaimRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmClaimRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmExchangeRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmExchangeRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmOrderEditRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmOrderEditRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmReturnReceiveWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmReturnReceiveWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmReturnRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmReturnRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createAndCompleteReturnOrderWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createAndCompleteReturnOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createClaimShippingMethodWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createClaimShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createExchangeShippingMethodWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createExchangeShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderChangeWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderChangeWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderEditShippingMethodWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderEditShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderFulfillmentWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderFulfillmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderShipmentWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderShipmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createReturnReasonsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createReturnReasonsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createReturnShippingMethodWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createReturnShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "declineOrderChangeWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/declineOrderChangeWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "declineOrderTransferRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/declineOrderTransferRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteOrderChangeActionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteOrderChangeActionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteOrderChangeWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteOrderChangeWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteReturnReasonsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteReturnReasonsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "dismissItemReturnRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/dismissItemReturnRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "markPaymentCollectionAsPaid", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/markPaymentCollectionAsPaid", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderClaimAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderClaimItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderClaimRequestItemReturnWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimRequestItemReturnWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderEditAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderEditAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderEditUpdateItemQuantityWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderEditUpdateItemQuantityWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderExchangeAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderExchangeAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderExchangeRequestItemReturnWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderExchangeRequestItemReturnWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "processPaymentWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/processPaymentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "receiveItemReturnRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/receiveItemReturnRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refundPaymentsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refundPaymentsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refundPaymentWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refundPaymentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeAddItemClaimActionWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeAddItemClaimActionWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeClaimShippingMethodWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeClaimShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeExchangeShippingMethodWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeExchangeShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeItemClaimActionWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeItemClaimActionWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeItemExchangeActionWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeItemExchangeActionWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeItemOrderEditActionWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeItemOrderEditActionWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeItemReceiveReturnActionWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeItemReceiveReturnActionWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeItemReturnActionWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeItemReturnActionWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeOrderEditShippingMethodWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeOrderEditShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeReturnShippingMethodWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeReturnShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "requestItemReturnWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/requestItemReturnWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "requestOrderEditRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/requestOrderEditRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "requestOrderTransferWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/requestOrderTransferWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateClaimAddItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateClaimAddItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateClaimItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateClaimItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateClaimShippingMethodWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateClaimShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateExchangeAddItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateExchangeAddItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateExchangeShippingMethodWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateExchangeShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateOrderChangeActionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateOrderChangeActionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateOrderChangesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateOrderChangesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateOrderEditAddItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateOrderEditAddItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateOrderEditItemQuantityWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateOrderEditItemQuantityWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateOrderEditShippingMethodWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateOrderEditShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateOrderTaxLinesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateOrderTaxLinesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateOrderWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateReceiveItemReturnRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateReceiveItemReturnRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateRequestItemReturnWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateRequestItemReturnWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateReturnReasonsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateReturnReasonsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateReturnShippingMethodWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateReturnShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateReturnWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateReturnWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+order", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addOrderTransactionStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/addOrderTransactionStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "archiveOrdersStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/archiveOrdersStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderChangeStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/cancelOrderChangeStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderClaimStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/cancelOrderClaimStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderExchangeStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/cancelOrderExchangeStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderFulfillmentStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/cancelOrderFulfillmentStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderReturnStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/cancelOrderReturnStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrdersStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/cancelOrdersStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "completeOrdersStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/completeOrdersStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCompleteReturnStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createCompleteReturnStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderChangeStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createOrderChangeStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderClaimItemsFromActionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createOrderClaimItemsFromActionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderClaimsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createOrderClaimsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderExchangeItemsFromActionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createOrderExchangeItemsFromActionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderExchangesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createOrderExchangesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderLineItemsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createOrderLineItemsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrdersStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createOrdersStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createReturnReasonsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createReturnReasonsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createReturnsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createReturnsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "declineOrderChangeStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/declineOrderChangeStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteClaimsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteClaimsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteExchangesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteExchangesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteOrderChangeActionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteOrderChangeActionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteOrderChangesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteOrderChangesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteOrderShippingMethods", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteOrderShippingMethods", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteReturnReasonStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteReturnReasonStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteReturnsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteReturnsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "previewOrderChangeStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/previewOrderChangeStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "registerOrderChangesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/registerOrderChangesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "registerOrderFulfillmentStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/registerOrderFulfillmentStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "registerOrderShipmentStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/registerOrderShipmentStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "setOrderTaxLinesForItemsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/setOrderTaxLinesForItemsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateOrderChangeActionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateOrderChangeActionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateOrderChangesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateOrderChangesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateOrderShippingMethodsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateOrderShippingMethodsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateOrdersStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateOrdersStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateReturnReasonsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateReturnReasonsStep", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/order/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Store", + "autogenerate_tags": "jsSdk+storefront+order", + "description": "The following methods or properties are used to send requests to Store API Routes related to the Order Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "order", + "path": "https://docs.medusajs.com/resources/references/js-sdk/store/order", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+order", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Order Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "claim", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/claim", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "draftOrder", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/draftOrder", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "exchange", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/exchange", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "order", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/order", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderEdit", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/orderEdit", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refundReason", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/refundReason", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "return", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/return", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "returnReason", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/returnReason", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/order/events", + "title": "Events Reference", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/order/admin-widget-zones", + "title": "Admin Widget Zones", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "order-service-reference", + "title": "Main Service Reference", + "childSidebarTitle": "Order Module's Main Service Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Methods", + "autogenerate_path": "/references/order/IOrderModuleService/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/addOrderAction", + "title": "addOrderAction", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/addOrderTransactions", + "title": "addOrderTransactions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/applyPendingOrderActions", + "title": "applyPendingOrderActions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/archive", + "title": "archive", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/cancel", + "title": "cancel", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/cancelClaim", + "title": "cancelClaim", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/cancelExchange", + "title": "cancelExchange", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/cancelFulfillment", + "title": "cancelFulfillment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/cancelOrderChange", + "title": "cancelOrderChange", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/cancelReturn", + "title": "cancelReturn", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/completeOrder", + "title": "completeOrder", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/confirmOrderChange", + "title": "confirmOrderChange", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createClaim", + "title": "createClaim", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createExchange", + "title": "createExchange", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createOrderAddresses", + "title": "createOrderAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createOrderChange", + "title": "createOrderChange", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createOrderClaimItems", + "title": "createOrderClaimItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createOrderClaims", + "title": "createOrderClaims", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createOrderCreditLines", + "title": "createOrderCreditLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createOrderExchangeItems", + "title": "createOrderExchangeItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createOrderExchanges", + "title": "createOrderExchanges", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createOrderLineItemAdjustments", + "title": "createOrderLineItemAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createOrderLineItemTaxLines", + "title": "createOrderLineItemTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createOrderLineItems", + "title": "createOrderLineItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createOrderShippingMethodAdjustments", + "title": "createOrderShippingMethodAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createOrderShippingMethodTaxLines", + "title": "createOrderShippingMethodTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createOrderShippingMethods", + "title": "createOrderShippingMethods", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createOrders", + "title": "createOrders", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createReturn", + "title": "createReturn", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createReturnItems", + "title": "createReturnItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createReturnReasons", + "title": "createReturnReasons", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createReturns", + "title": "createReturns", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/declineOrderChange", + "title": "declineOrderChange", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/deleteOrderAddresses", + "title": "deleteOrderAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/deleteOrderChangeActions", + "title": "deleteOrderChangeActions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/deleteOrderChanges", + "title": "deleteOrderChanges", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/deleteOrderClaimItemImages", + "title": "deleteOrderClaimItemImages", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/deleteOrderClaimItems", + "title": "deleteOrderClaimItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/deleteOrderClaims", + "title": "deleteOrderClaims", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/deleteOrderExchangeItems", + "title": "deleteOrderExchangeItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/deleteOrderExchanges", + "title": "deleteOrderExchanges", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/deleteOrderLineItemAdjustments", + "title": "deleteOrderLineItemAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/deleteOrderLineItemTaxLines", + "title": "deleteOrderLineItemTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/deleteOrderLineItems", + "title": "deleteOrderLineItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/deleteOrderShippingMethodAdjustments", + "title": "deleteOrderShippingMethodAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/deleteOrderShippingMethodTaxLines", + "title": "deleteOrderShippingMethodTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/deleteOrderShippingMethods", + "title": "deleteOrderShippingMethods", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/deleteOrderTransactions", + "title": "deleteOrderTransactions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/deleteOrders", + "title": "deleteOrders", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/deleteReturnItems", + "title": "deleteReturnItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/deleteReturnReasons", + "title": "deleteReturnReasons", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/deleteReturns", + "title": "deleteReturns", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/listAndCountOrderClaims", + "title": "listAndCountOrderClaims", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/listAndCountOrderExchanges", + "title": "listAndCountOrderExchanges", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/listAndCountOrders", + "title": "listAndCountOrders", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/listAndCountReturns", + "title": "listAndCountReturns", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/listOrderAddresses", + "title": "listOrderAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/listOrderChangeActions", + "title": "listOrderChangeActions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/listOrderChanges", + "title": "listOrderChanges", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/listOrderClaims", + "title": "listOrderClaims", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/listOrderExchanges", + "title": "listOrderExchanges", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/listOrderLineItemAdjustments", + "title": "listOrderLineItemAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/listOrderLineItemTaxLines", + "title": "listOrderLineItemTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/listOrderLineItems", + "title": "listOrderLineItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/listOrderShippingMethodAdjustments", + "title": "listOrderShippingMethodAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/listOrderShippingMethodTaxLines", + "title": "listOrderShippingMethodTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/listOrderShippingMethods", + "title": "listOrderShippingMethods", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/listOrderTransactions", + "title": "listOrderTransactions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/listOrders", + "title": "listOrders", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/listReturnReasons", + "title": "listReturnReasons", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/listReturns", + "title": "listReturns", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/previewOrderChange", + "title": "previewOrderChange", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/receiveReturn", + "title": "receiveReturn", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/registerDelivery", + "title": "registerDelivery", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/registerFulfillment", + "title": "registerFulfillment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/registerOrderChange", + "title": "registerOrderChange", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/registerShipment", + "title": "registerShipment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/restoreOrderAddresses", + "title": "restoreOrderAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/restoreOrderChangeActions", + "title": "restoreOrderChangeActions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/restoreOrderChanges", + "title": "restoreOrderChanges", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/restoreOrderClaims", + "title": "restoreOrderClaims", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/restoreOrderExchanges", + "title": "restoreOrderExchanges", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/restoreOrderLineItemAdjustments", + "title": "restoreOrderLineItemAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/restoreOrderLineItemTaxLines", + "title": "restoreOrderLineItemTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/restoreOrderLineItems", + "title": "restoreOrderLineItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/restoreOrderShippingMethodAdjustments", + "title": "restoreOrderShippingMethodAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/restoreOrderShippingMethodTaxLines", + "title": "restoreOrderShippingMethodTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/restoreOrderShippingMethods", + "title": "restoreOrderShippingMethods", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/restoreOrderTransactions", + "title": "restoreOrderTransactions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/restoreOrders", + "title": "restoreOrders", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/restoreReturnReasons", + "title": "restoreReturnReasons", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/restoreReturns", + "title": "restoreReturns", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/retrieveOrder", + "title": "retrieveOrder", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/retrieveOrderChange", + "title": "retrieveOrderChange", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/retrieveOrderChangeAction", + "title": "retrieveOrderChangeAction", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/retrieveOrderClaim", + "title": "retrieveOrderClaim", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/retrieveOrderExchange", + "title": "retrieveOrderExchange", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/retrieveOrderLineItem", + "title": "retrieveOrderLineItem", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/retrieveReturn", + "title": "retrieveReturn", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/retrieveReturnReason", + "title": "retrieveReturnReason", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/revertLastVersion", + "title": "revertLastVersion", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/setOrderLineItemAdjustments", + "title": "setOrderLineItemAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/setOrderLineItemTaxLines", + "title": "setOrderLineItemTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/setOrderShippingMethodAdjustments", + "title": "setOrderShippingMethodAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/setOrderShippingMethodTaxLines", + "title": "setOrderShippingMethodTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/softDeleteOrderAddresses", + "title": "softDeleteOrderAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/softDeleteOrderChangeActions", + "title": "softDeleteOrderChangeActions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/softDeleteOrderChanges", + "title": "softDeleteOrderChanges", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/softDeleteOrderClaims", + "title": "softDeleteOrderClaims", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/softDeleteOrderExchanges", + "title": "softDeleteOrderExchanges", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/softDeleteOrderLineItemAdjustments", + "title": "softDeleteOrderLineItemAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/softDeleteOrderLineItemTaxLines", + "title": "softDeleteOrderLineItemTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/softDeleteOrderLineItems", + "title": "softDeleteOrderLineItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/softDeleteOrderShippingMethodAdjustments", + "title": "softDeleteOrderShippingMethodAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/softDeleteOrderShippingMethodTaxLines", + "title": "softDeleteOrderShippingMethodTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/softDeleteOrderShippingMethods", + "title": "softDeleteOrderShippingMethods", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/softDeleteOrderTransactions", + "title": "softDeleteOrderTransactions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/softDeleteOrders", + "title": "softDeleteOrders", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/softDeleteReturnReasons", + "title": "softDeleteReturnReasons", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/softDeleteReturns", + "title": "softDeleteReturns", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/undoLastChange", + "title": "undoLastChange", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/updateOrderAddresses", + "title": "updateOrderAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/updateOrderChangeActions", + "title": "updateOrderChangeActions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/updateOrderChanges", + "title": "updateOrderChanges", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/updateOrderClaims", + "title": "updateOrderClaims", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/updateOrderExchanges", + "title": "updateOrderExchanges", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/updateOrderItem", + "title": "updateOrderItem", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/updateOrderLineItems", + "title": "updateOrderLineItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/updateOrderShippingMethods", + "title": "updateOrderShippingMethods", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/updateOrders", + "title": "updateOrders", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/updateReturnReasons", + "title": "updateReturnReasons", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/updateReturns", + "title": "updateReturns", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/upsertOrderLineItemAdjustments", + "title": "upsertOrderLineItemAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/upsertOrderLineItemTaxLines", + "title": "upsertOrderLineItemTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/upsertOrderShippingMethodAdjustments", + "title": "upsertOrderShippingMethodAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/upsertOrderShippingMethodTaxLines", + "title": "upsertOrderShippingMethodTaxLines", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "order-models-reference", + "title": "Data Models Reference", + "childSidebarTitle": "Order Module Data Models Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Data Models", + "hasTitleStyling": true, + "autogenerate_path": "/references/order_models/variables", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/Order", + "title": "Order", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/OrderAddress", + "title": "OrderAddress", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/OrderChange", + "title": "OrderChange", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/OrderChangeAction", + "title": "OrderChangeAction", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/OrderClaim", + "title": "OrderClaim", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/OrderClaimItem", + "title": "OrderClaimItem", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/OrderClaimItemImage", + "title": "OrderClaimItemImage", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/OrderCreditLine", + "title": "OrderCreditLine", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/OrderExchange", + "title": "OrderExchange", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/OrderExchangeItem", + "title": "OrderExchangeItem", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/OrderItem", + "title": "OrderItem", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/OrderLineItem", + "title": "OrderLineItem", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/OrderLineItemAdjustment", + "title": "OrderLineItemAdjustment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/OrderLineItemTaxLine", + "title": "OrderLineItemTaxLine", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/OrderShipping", + "title": "OrderShipping", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/OrderShippingMethod", + "title": "OrderShippingMethod", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/OrderShippingMethodAdjustment", + "title": "OrderShippingMethodAdjustment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/OrderShippingMethodTaxLine", + "title": "OrderShippingMethodTaxLine", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/OrderSummary", + "title": "OrderSummary", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/OrderTransaction", + "title": "OrderTransaction", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/Return", + "title": "Return", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/ReturnItem", + "title": "ReturnItem", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/ReturnReason", + "title": "ReturnReason", + "description": "", + "children": [] + } + ] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "payment", + "title": "Payment Module", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/payment", + "title": "Overview", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/payment/module-options", + "title": "Module Options", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Concepts", + "initialOpen": false, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/payment/payment-collection", + "title": "Payment Collections", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/payment/payment-session", + "title": "Payment Session", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/payment/payment", + "title": "Payment", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/payment/payment-provider", + "title": "Payment Provider Module", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/payment/account-holder", + "title": "Account Holder", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/payment/webhook-events", + "title": "Webhook Events", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/payment/links-to-other-modules", + "title": "Links to Other Modules", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Server Guides", + "autogenerate_tags": "server+payment", + "initialOpen": false, + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to use the Payment Module in your customizations on the Medusa application server.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/payment/payment-flow", + "title": "Accept Payment Flow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/provider", + "title": "Create Payment Provider", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Storefront Guides", + "autogenerate_tags": "storefront+payment,-jsSdk", + "initialOpen": false, + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to integrate the Payment Module's features into your storefront.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Checkout Step 4: Choose Payment Provider", + "path": "https://docs.medusajs.com/resources/storefront-development/checkout/payment", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Checkout Step 5: Complete Cart", + "path": "https://docs.medusajs.com/resources/storefront-development/checkout/complete-cart", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Customize the Stripe Integration in the Next.js Starter", + "path": "https://docs.medusajs.com/resources/nextjs-starter/guides/customize-stripe", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Implement Express Checkout with Medusa", + "path": "https://docs.medusajs.com/resources/storefront-development/guides/express-checkout", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Payment with Stripe in React Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/checkout/payment/stripe", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin User Guides", + "autogenerate_tags": "userGuide+payment", + "initialOpen": false, + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to utilize and manage Payment features in the Medusa Admin dashboard.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Order Payments", + "path": "https://docs.medusajs.com/user-guide/orders/payments", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Providers", + "initialOpen": false, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/payment/payment-provider/stripe", + "title": "Stripe", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "References", + "initialOpen": false, + "description": "Find references for tools and resources related to the Payment Module, such as data models, methods, and more. These are useful for your customizations.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/payment/workflows", + "title": "Workflows", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+payment", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addShippingMethodToCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addShippingMethodToCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addToCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addToCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "capturePaymentWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/capturePaymentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "completeCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/completeCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmClaimRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmClaimRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmExchangeRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmExchangeRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmOrderEditRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmOrderEditRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmReturnRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmReturnRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderPaymentCollectionWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderPaymentCollectionWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrUpdateOrderPaymentCollectionWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrUpdateOrderPaymentCollectionWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPaymentCollectionForCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createPaymentCollectionForCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPaymentSessionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createPaymentSessionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createRefundReasonsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createRefundReasonsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createRegionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createRegionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteLineItemsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteLineItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deletePaymentSessionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deletePaymentSessionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteRefundReasonsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteRefundReasonsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "markPaymentCollectionAsPaid", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/markPaymentCollectionAsPaid", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "processPaymentWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/processPaymentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refreshCartItemsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshCartItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refreshPaymentCollectionForCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshPaymentCollectionForCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refundPaymentsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refundPaymentsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refundPaymentWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refundPaymentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "requestOrderEditRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/requestOrderEditRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "transferCartCustomerWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/transferCartCustomerWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateLineItemInCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateLineItemInCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateRefundReasonsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateRefundReasonsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateRegionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateRegionsWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+payment", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "authorizePaymentSessionStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/authorizePaymentSessionStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelPaymentStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/cancelPaymentStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "capturePaymentStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/capturePaymentStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPaymentAccountHolderStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createPaymentAccountHolderStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPaymentCollectionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createPaymentCollectionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPaymentSessionStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createPaymentSessionStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createRefundReasonStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createRefundReasonStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deletePaymentSessionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deletePaymentSessionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteRefundReasonsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteRefundReasonsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refundPaymentsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/refundPaymentsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refundPaymentStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/refundPaymentStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "setRegionsPaymentProvidersStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/setRegionsPaymentProvidersStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePaymentCollectionStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updatePaymentCollectionStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateRefundReasonsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateRefundReasonsStep", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/payment/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Store", + "autogenerate_tags": "jsSdk+storefront+payment", + "description": "The following methods or properties are used to send requests to Store API Routes related to the Payment Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "payment", + "path": "https://docs.medusajs.com/resources/references/js-sdk/store/payment", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+payment", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Payment Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "payment", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/payment", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "paymentCollection", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/paymentCollection", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/payment/events", + "title": "Events Reference", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "payment-service-reference", + "title": "Main Service Reference", + "childSidebarTitle": "Payment Module's Main Service Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Methods", + "autogenerate_path": "/references/payment/IPaymentModuleService/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/authorizePaymentSession", + "title": "authorizePaymentSession", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/cancelPayment", + "title": "cancelPayment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/capturePayment", + "title": "capturePayment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/completePaymentCollections", + "title": "completePaymentCollections", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/createAccountHolder", + "title": "createAccountHolder", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/createPaymentCollections", + "title": "createPaymentCollections", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/createPaymentMethods", + "title": "createPaymentMethods", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/createPaymentSession", + "title": "createPaymentSession", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/createRefundReasons", + "title": "createRefundReasons", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/deleteAccountHolder", + "title": "deleteAccountHolder", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/deleteCaptures", + "title": "deleteCaptures", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/deletePaymentCollections", + "title": "deletePaymentCollections", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/deletePaymentSession", + "title": "deletePaymentSession", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/deleteRefundReasons", + "title": "deleteRefundReasons", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/deleteRefunds", + "title": "deleteRefunds", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/getWebhookActionAndData", + "title": "getWebhookActionAndData", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/listAndCountPaymentCollections", + "title": "listAndCountPaymentCollections", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/listAndCountPaymentMethods", + "title": "listAndCountPaymentMethods", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/listAndCountPaymentProviders", + "title": "listAndCountPaymentProviders", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/listCaptures", + "title": "listCaptures", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/listPaymentCollections", + "title": "listPaymentCollections", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/listPaymentMethods", + "title": "listPaymentMethods", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/listPaymentProviders", + "title": "listPaymentProviders", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/listPaymentSessions", + "title": "listPaymentSessions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/listPayments", + "title": "listPayments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/listRefundReasons", + "title": "listRefundReasons", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/listRefunds", + "title": "listRefunds", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/refundPayment", + "title": "refundPayment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/restorePaymentCollections", + "title": "restorePaymentCollections", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/restoreRefundReasons", + "title": "restoreRefundReasons", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/retrievePaymentCollection", + "title": "retrievePaymentCollection", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/retrievePaymentSession", + "title": "retrievePaymentSession", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/softDeletePaymentCollections", + "title": "softDeletePaymentCollections", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/softDeleteRefundReasons", + "title": "softDeleteRefundReasons", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/updateAccountHolder", + "title": "updateAccountHolder", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/updatePayment", + "title": "updatePayment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/updatePaymentCollections", + "title": "updatePaymentCollections", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/updatePaymentSession", + "title": "updatePaymentSession", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/updateRefundReasons", + "title": "updateRefundReasons", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/upsertPaymentCollections", + "title": "upsertPaymentCollections", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "payment-models-reference", + "title": "Data Models Reference", + "childSidebarTitle": "Payment Module Data Models Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/models", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Data Models", + "autogenerate_path": "/references/payment_models/variables", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/models/AccountHolder", + "title": "AccountHolder", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/models/Capture", + "title": "Capture", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/models/Payment", + "title": "Payment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/models/PaymentCollection", + "title": "PaymentCollection", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/models/PaymentProvider", + "title": "PaymentProvider", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/models/PaymentSession", + "title": "PaymentSession", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/models/Refund", + "title": "Refund", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/models/RefundReason", + "title": "RefundReason", + "description": "", + "children": [] + } + ] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "pricing", + "title": "Pricing Module", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/pricing", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Concepts", + "initialOpen": false, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/pricing/concepts", + "title": "Pricing Concepts", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/pricing/price-rules", + "title": "Price Rules", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/pricing/price-calculation", + "title": "Prices Calculation", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/pricing/tax-inclusive-pricing", + "title": "Tax-Inclusive Pricing", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/pricing/links-to-other-modules", + "title": "Links to Other Modules", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Server Guides", + "autogenerate_tags": "server+pricing", + "initialOpen": false, + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to use the Pricing Module in your customizations on the Medusa application server.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Get Variant Price with Taxes", + "path": "https://docs.medusajs.com/resources/commerce-modules/product/guides/price-with-taxes", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Get Variant Prices", + "path": "https://docs.medusajs.com/resources/commerce-modules/product/guides/price", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Implement Custom Line Item Pricing in Medusa", + "path": "https://docs.medusajs.com/resources/examples/guides/custom-item-price", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Storefront Guides", + "autogenerate_tags": "storefront+pricing,-jsSdk", + "initialOpen": false, + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to integrate the Pricing Module's features into your storefront.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Example: Show Price with Taxes", + "path": "https://docs.medusajs.com/resources/storefront-development/products/price/examples/tax-price", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Example: Show Sale Price", + "path": "https://docs.medusajs.com/resources/storefront-development/products/price/examples/sale-price", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Example: Show Variant's Price", + "path": "https://docs.medusajs.com/resources/storefront-development/products/price/examples/show-price", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Retrieve Product Variant's Prices in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/products/price", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin User Guides", + "autogenerate_tags": "userGuide+pricing", + "initialOpen": false, + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to utilize and manage Pricing features in the Medusa Admin dashboard.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create a Price List", + "path": "https://docs.medusajs.com/user-guide/price-lists/create", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Price Lists", + "path": "https://docs.medusajs.com/user-guide/price-lists/manage", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Price Lists Overview", + "path": "https://docs.medusajs.com/user-guide/price-lists", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "References", + "initialOpen": false, + "description": "Find references for tools and resources related to the Pricing Module, such as data models, methods, and more. These are useful for your customizations.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/pricing/workflows", + "title": "Workflows", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+pricing", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchPriceListPricesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchPriceListPricesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchProductsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchProductVariantsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductVariantsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPriceListPricesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createPriceListPricesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPriceListsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createPriceListsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPricePreferencesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createPricePreferencesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductVariantsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductVariantsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createRegionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createRegionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createShippingOptionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createShippingOptionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createStoresWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createStoresWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deletePriceListsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deletePriceListsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deletePricePreferencesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deletePricePreferencesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removePriceListPricesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removePriceListPricesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePriceListPricesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updatePriceListPricesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePriceListsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updatePriceListsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePricePreferencesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updatePricePreferencesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductVariantsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateProductVariantsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateRegionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateRegionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateShippingOptionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateShippingOptionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateStoresWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateStoresWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "upsertVariantPricesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/upsertVariantPricesWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+pricing", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPriceListPricesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createPriceListPricesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPriceListsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createPriceListsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPricePreferencesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createPricePreferencesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPriceSetsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createPriceSetsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createShippingOptionsPriceSetsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createShippingOptionsPriceSetsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deletePriceListsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deletePriceListsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deletePricePreferencesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deletePricePreferencesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removePriceListPricesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/removePriceListPricesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "setShippingOptionsPricesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/setShippingOptionsPricesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePriceListPricesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updatePriceListPricesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePriceListsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updatePriceListsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePricePreferencesAsArrayStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updatePricePreferencesAsArrayStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePricePreferencesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updatePricePreferencesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePriceSetsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updatePriceSetsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "validatePriceListsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/validatePriceListsStep", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/pricing/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+pricing", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Pricing Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "priceList", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/priceList", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "pricePreference", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/pricePreference", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/pricing/admin-widget-zones", + "title": "Admin Widget Zones", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "pricing-service-reference", + "title": "Main Service Reference", + "childSidebarTitle": "Pricing Module's Main Service Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Methods", + "autogenerate_path": "/references/pricing/IPricingModuleService/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/addPriceListPrices", + "title": "addPriceListPrices", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/addPrices", + "title": "addPrices", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/calculatePrices", + "title": "calculatePrices", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/createPriceLists", + "title": "createPriceLists", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/createPricePreferences", + "title": "createPricePreferences", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/createPriceRules", + "title": "createPriceRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/createPriceSets", + "title": "createPriceSets", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/deletePriceListRules", + "title": "deletePriceListRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/deletePriceLists", + "title": "deletePriceLists", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/deletePricePreferences", + "title": "deletePricePreferences", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/deletePriceRules", + "title": "deletePriceRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/deletePriceSets", + "title": "deletePriceSets", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/listAndCountPriceListRules", + "title": "listAndCountPriceListRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/listAndCountPriceLists", + "title": "listAndCountPriceLists", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/listAndCountPriceRules", + "title": "listAndCountPriceRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/listAndCountPriceSets", + "title": "listAndCountPriceSets", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/listAndCountPrices", + "title": "listAndCountPrices", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/listPriceListRules", + "title": "listPriceListRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/listPriceLists", + "title": "listPriceLists", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/listPricePreferences", + "title": "listPricePreferences", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/listPriceRules", + "title": "listPriceRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/listPriceSets", + "title": "listPriceSets", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/listPrices", + "title": "listPrices", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/removePriceListRules", + "title": "removePriceListRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/removePrices", + "title": "removePrices", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/restorePriceLists", + "title": "restorePriceLists", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/restorePricePreferences", + "title": "restorePricePreferences", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/restorePrices", + "title": "restorePrices", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/retrievePriceList", + "title": "retrievePriceList", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/retrievePriceListRule", + "title": "retrievePriceListRule", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/retrievePricePreference", + "title": "retrievePricePreference", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/retrievePriceRule", + "title": "retrievePriceRule", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/retrievePriceSet", + "title": "retrievePriceSet", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/setPriceListRules", + "title": "setPriceListRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/softDeletePriceLists", + "title": "softDeletePriceLists", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/softDeletePricePreferences", + "title": "softDeletePricePreferences", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/softDeletePrices", + "title": "softDeletePrices", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/updatePriceListPrices", + "title": "updatePriceListPrices", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/updatePriceLists", + "title": "updatePriceLists", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/updatePricePreferences", + "title": "updatePricePreferences", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/updatePriceRules", + "title": "updatePriceRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/updatePriceSets", + "title": "updatePriceSets", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/upsertPricePreferences", + "title": "upsertPricePreferences", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/upsertPriceSets", + "title": "upsertPriceSets", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "pricing-models-reference", + "title": "Data Models Reference", + "childSidebarTitle": "Pricing Module Data Models Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/models", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Data Models", + "hasTitleStyling": true, + "autogenerate_path": "/references/pricing_models/variables", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/models/Price", + "title": "Price", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/models/PriceList", + "title": "PriceList", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/models/PriceListRule", + "title": "PriceListRule", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/models/PricePreference", + "title": "PricePreference", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/models/PriceRule", + "title": "PriceRule", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/models/PriceSet", + "title": "PriceSet", + "description": "", + "children": [] + } + ] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "product", + "title": "Product Module", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/product", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Concepts", + "initialOpen": false, + "autogenerate_tags": "concept+product", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/product/variant-inventory", + "title": "Variant Inventory", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/product/selling-products", + "title": "Selling Use Cases", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/product/links-to-other-modules", + "title": "Links to Other Modules", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Inventory Kits", + "path": "https://docs.medusajs.com/resources/commerce-modules/inventory/inventory-kit", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Server Guides", + "autogenerate_tags": "server+product", + "initialOpen": false, + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to use the Product Module in your customizations on the Medusa application server.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/product/extend", + "title": "Extend Module", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/product/guides/price-with-taxes", + "title": "Get Variant Price with Taxes", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Get Variant Price with Taxes", + "path": "https://docs.medusajs.com/resources/commerce-modules/product/guides/price-with-taxes", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/product/guides/price", + "title": "Get Variant Prices", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Get Variant Prices", + "path": "https://docs.medusajs.com/resources/commerce-modules/product/guides/price", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Storefront Guides", + "autogenerate_tags": "storefront+product,-jsSdk", + "initialOpen": false, + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to integrate the Product Module's features into your storefront.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Example: Show Price with Taxes", + "path": "https://docs.medusajs.com/resources/storefront-development/products/price/examples/tax-price", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Example: Show Sale Price", + "path": "https://docs.medusajs.com/resources/storefront-development/products/price/examples/sale-price", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Example: Show Variant's Price", + "path": "https://docs.medusajs.com/resources/storefront-development/products/price/examples/show-price", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Implement Express Checkout with Medusa", + "path": "https://docs.medusajs.com/resources/storefront-development/guides/express-checkout", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "List Product Categories in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/products/categories/list", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "List Product Collections in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/products/collections/list", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "List Products in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/products/list", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Retrieve a Category in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/products/categories/retrieve", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Retrieve a Category's Products in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/products/categories/products", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Retrieve a Collection in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/products/collections/retrieve", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Retrieve a Collection's Products in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/products/collections/products", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Retrieve a Product in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/products/retrieve", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Retrieve Nested Categories in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/products/categories/nested-categories", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Retrieve Product Variant's Inventory in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/products/inventory", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Retrieve Product Variant's Prices in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/products/price", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Select Product Variants in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/products/variants", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin User Guides", + "autogenerate_tags": "userGuide+product", + "initialOpen": false, + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to utilize and manage Product features in the Medusa Admin dashboard.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Bundle Product", + "path": "https://docs.medusajs.com/user-guide/products/create/bundle", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Multi-Part Product", + "path": "https://docs.medusajs.com/user-guide/products/create/multi-part", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Product", + "path": "https://docs.medusajs.com/user-guide/products/create", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Edit Product", + "path": "https://docs.medusajs.com/user-guide/products/edit", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Export Products", + "path": "https://docs.medusajs.com/user-guide/products/export", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Import Products", + "path": "https://docs.medusajs.com/user-guide/products/import", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Product Categories", + "path": "https://docs.medusajs.com/user-guide/products/categories", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Product Collections", + "path": "https://docs.medusajs.com/user-guide/products/collections", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Product Tags", + "path": "https://docs.medusajs.com/user-guide/settings/product-tags", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Product Types", + "path": "https://docs.medusajs.com/user-guide/settings/product-types", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Product Variants", + "path": "https://docs.medusajs.com/user-guide/products/variants", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Products Overview", + "path": "https://docs.medusajs.com/user-guide/products", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "References", + "initialOpen": false, + "description": "Find references for tools and resources related to the Product Module, such as data models, methods, and more. These are useful for your customizations.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/product/workflows", + "title": "Workflows", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+product", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchLinkProductsToCategoryWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchLinkProductsToCategoryWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchLinkProductsToCollectionWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchLinkProductsToCollectionWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchProductsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchProductVariantsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductVariantsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCollectionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCollectionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductCategoriesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductCategoriesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductOptionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductOptionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductTagsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductTagsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductTypesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductTypesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductVariantsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductVariantsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteCollectionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteCollectionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductCategoriesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteProductCategoriesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductOptionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteProductOptionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductTagsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteProductTagsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductTypesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteProductTypesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductVariantsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteProductVariantsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "importProductsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/importProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCollectionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCollectionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductCategoriesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateProductCategoriesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductOptionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateProductOptionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductTagsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateProductTagsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductTypesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateProductTypesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductVariantsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateProductVariantsWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+product", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchLinkProductsToCategoryStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/batchLinkProductsToCategoryStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchLinkProductsToCollectionStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/batchLinkProductsToCollectionStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCollectionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createCollectionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductCategoriesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createProductCategoriesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductOptionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createProductOptionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createProductsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductTagsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createProductTagsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductTypesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createProductTypesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductVariantsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createProductVariantsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteCollectionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteCollectionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductCategoriesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteProductCategoriesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductOptionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteProductOptionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteProductsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductTagsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteProductTagsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductTypesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteProductTypesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductVariantsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteProductVariantsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "getProductsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/getProductsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "groupProductsForBatchStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/groupProductsForBatchStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "parseProductCsvStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/parseProductCsvStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCollectionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateCollectionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductCategoriesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateProductCategoriesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductOptionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateProductOptionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateProductsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductTagsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateProductTagsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductTypesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateProductTypesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductVariantsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateProductVariantsStep", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/product/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Store", + "autogenerate_tags": "jsSdk+storefront+product", + "description": "The following methods or properties are used to send requests to Store API Routes related to the Product Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "category", + "path": "https://docs.medusajs.com/resources/references/js-sdk/store/category", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "collection", + "path": "https://docs.medusajs.com/resources/references/js-sdk/store/collection", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "product", + "path": "https://docs.medusajs.com/resources/references/js-sdk/store/product", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+product", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Product Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "product", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/product", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "productCategory", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/productCategory", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "productCollection", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/productCollection", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "productTag", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/productTag", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "productType", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/productType", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "productVariant", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/productVariant", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/product/events", + "title": "Events Reference", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/product/admin-widget-zones", + "title": "Admin Widget Zones", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "product-service-reference", + "title": "Main Service Reference", + "childSidebarTitle": "Product Module's Main Service Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Methods", + "autogenerate_path": "/references/product/IProductModuleService/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/createProductCategories", + "title": "createProductCategories", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/createProductCollections", + "title": "createProductCollections", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/createProductOptionValues", + "title": "createProductOptionValues", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/createProductOptions", + "title": "createProductOptions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/createProductTags", + "title": "createProductTags", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/createProductTypes", + "title": "createProductTypes", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/createProductVariants", + "title": "createProductVariants", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/createProducts", + "title": "createProducts", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/deleteProductCategories", + "title": "deleteProductCategories", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/deleteProductCollections", + "title": "deleteProductCollections", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/deleteProductOptionValues", + "title": "deleteProductOptionValues", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/deleteProductOptions", + "title": "deleteProductOptions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/deleteProductTags", + "title": "deleteProductTags", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/deleteProductTypes", + "title": "deleteProductTypes", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/deleteProductVariants", + "title": "deleteProductVariants", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/deleteProducts", + "title": "deleteProducts", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/listAndCountProductCategories", + "title": "listAndCountProductCategories", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/listAndCountProductCollections", + "title": "listAndCountProductCollections", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/listAndCountProductOptionValues", + "title": "listAndCountProductOptionValues", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/listAndCountProductOptions", + "title": "listAndCountProductOptions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/listAndCountProductTags", + "title": "listAndCountProductTags", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/listAndCountProductTypes", + "title": "listAndCountProductTypes", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/listAndCountProductVariants", + "title": "listAndCountProductVariants", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/listAndCountProducts", + "title": "listAndCountProducts", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/listProductCategories", + "title": "listProductCategories", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/listProductCollections", + "title": "listProductCollections", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/listProductOptionValues", + "title": "listProductOptionValues", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/listProductOptions", + "title": "listProductOptions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/listProductTags", + "title": "listProductTags", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/listProductTypes", + "title": "listProductTypes", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/listProductVariants", + "title": "listProductVariants", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/listProducts", + "title": "listProducts", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/restoreProductCategories", + "title": "restoreProductCategories", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/restoreProductCollections", + "title": "restoreProductCollections", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/restoreProductOptionValues", + "title": "restoreProductOptionValues", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/restoreProductOptions", + "title": "restoreProductOptions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/restoreProductTags", + "title": "restoreProductTags", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/restoreProductTypes", + "title": "restoreProductTypes", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/restoreProductVariants", + "title": "restoreProductVariants", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/restoreProducts", + "title": "restoreProducts", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/retrieveProduct", + "title": "retrieveProduct", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/retrieveProductCategory", + "title": "retrieveProductCategory", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/retrieveProductCollection", + "title": "retrieveProductCollection", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/retrieveProductOption", + "title": "retrieveProductOption", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/retrieveProductTag", + "title": "retrieveProductTag", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/retrieveProductType", + "title": "retrieveProductType", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/retrieveProductVariant", + "title": "retrieveProductVariant", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/softDeleteProductCategories", + "title": "softDeleteProductCategories", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/softDeleteProductCollections", + "title": "softDeleteProductCollections", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/softDeleteProductOptionValues", + "title": "softDeleteProductOptionValues", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/softDeleteProductOptions", + "title": "softDeleteProductOptions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/softDeleteProductTags", + "title": "softDeleteProductTags", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/softDeleteProductTypes", + "title": "softDeleteProductTypes", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/softDeleteProductVariants", + "title": "softDeleteProductVariants", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/softDeleteProducts", + "title": "softDeleteProducts", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/updateProductCategories", + "title": "updateProductCategories", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/updateProductCollections", + "title": "updateProductCollections", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/updateProductOptionValues", + "title": "updateProductOptionValues", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/updateProductOptions", + "title": "updateProductOptions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/updateProductTags", + "title": "updateProductTags", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/updateProductTypes", + "title": "updateProductTypes", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/updateProductVariants", + "title": "updateProductVariants", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/updateProducts", + "title": "updateProducts", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/upsertProductCategories", + "title": "upsertProductCategories", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/upsertProductCollections", + "title": "upsertProductCollections", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/upsertProductOptions", + "title": "upsertProductOptions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/upsertProductTags", + "title": "upsertProductTags", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/upsertProductTypes", + "title": "upsertProductTypes", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/upsertProductVariants", + "title": "upsertProductVariants", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/upsertProducts", + "title": "upsertProducts", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "product-models-reference", + "title": "Data Models Reference", + "childSidebarTitle": "Product Module Data Models Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/models", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Data Models", + "hasTitleStyling": true, + "autogenerate_path": "/references/product_models/variables", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/models/Product", + "title": "Product", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/models/ProductCategory", + "title": "ProductCategory", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/models/ProductCollection", + "title": "ProductCollection", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/models/ProductImage", + "title": "ProductImage", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/models/ProductOption", + "title": "ProductOption", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/models/ProductOptionValue", + "title": "ProductOptionValue", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/models/ProductTag", + "title": "ProductTag", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/models/ProductType", + "title": "ProductType", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/models/ProductVariant", + "title": "ProductVariant", + "description": "", + "children": [] + } + ] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "promotion", + "title": "Promotion Module", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/promotion", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Concepts", + "initialOpen": false, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/promotion/concepts", + "title": "Promotion", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/promotion/application-method", + "title": "Application Method", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/promotion/campaign", + "title": "Campaign", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/promotion/actions", + "title": "Promotion Actions", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/promotion/links-to-other-modules", + "title": "Links to Modules", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Server Guides", + "autogenerate_tags": "server+promotion", + "initialOpen": false, + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to use the Promotion Module in your customizations on the Medusa application server.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/promotion/extend", + "title": "Extend Module", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin User Guides", + "autogenerate_tags": "userGuide+promotion", + "initialOpen": false, + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to utilize and manage Promotion features in the Medusa Admin dashboard.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create a Promotion", + "path": "https://docs.medusajs.com/user-guide/promotions/create", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Campaigns", + "path": "https://docs.medusajs.com/user-guide/promotions/campaigns", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Promotions", + "path": "https://docs.medusajs.com/user-guide/promotions/manage", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Promotions Overview", + "path": "https://docs.medusajs.com/user-guide/promotions", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "References", + "initialOpen": false, + "description": "Find references for tools and resources related to the Promotion Module, such as data models, methods, and more. These are useful for your customizations.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/promotion/workflows", + "title": "Workflows", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+promotion", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addOrRemoveCampaignPromotionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addOrRemoveCampaignPromotionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addShippingMethodToCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addShippingMethodToCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addToCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addToCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchPromotionRulesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchPromotionRulesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCampaignsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCampaignsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPromotionRulesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createPromotionRulesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPromotionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createPromotionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteCampaignsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteCampaignsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteLineItemsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteLineItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deletePromotionRulesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deletePromotionRulesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deletePromotionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deletePromotionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refreshCartItemsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshCartItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "transferCartCustomerWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/transferCartCustomerWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCampaignsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCampaignsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCartPromotionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartPromotionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateLineItemInCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateLineItemInCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePromotionRulesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updatePromotionRulesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePromotionsStatusWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updatePromotionsStatusWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePromotionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updatePromotionsWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+promotion", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addCampaignPromotionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/addCampaignPromotionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addRulesToPromotionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/addRulesToPromotionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCampaignsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createCampaignsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPromotionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createPromotionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteCampaignsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteCampaignsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deletePromotionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deletePromotionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "getActionsToComputeFromPromotionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/getActionsToComputeFromPromotionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "getPromotionCodesToApply", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/getPromotionCodesToApply", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "prepareAdjustmentsFromPromotionActionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/prepareAdjustmentsFromPromotionActionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeCampaignPromotionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/removeCampaignPromotionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeRulesFromPromotionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/removeRulesFromPromotionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCampaignsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateCampaignsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCartPromotionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateCartPromotionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePromotionRulesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updatePromotionRulesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePromotionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updatePromotionsStep", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/promotion/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+promotion", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Promotion Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "campaign", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/campaign", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "promotion", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/promotion", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/promotion/admin-widget-zones", + "title": "Admin Widget Zones", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "promotion-service-reference", + "title": "Main Service Reference", + "childSidebarTitle": "Promotion Module's Main Service Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Methods", + "hasTitleStyling": true, + "autogenerate_path": "/references/promotion/IPromotionModuleService/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/addPromotionBuyRules", + "title": "addPromotionBuyRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/addPromotionRules", + "title": "addPromotionRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/addPromotionTargetRules", + "title": "addPromotionTargetRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/addPromotionsToCampaign", + "title": "addPromotionsToCampaign", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/computeActions", + "title": "computeActions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/createCampaigns", + "title": "createCampaigns", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/createPromotions", + "title": "createPromotions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/deleteCampaigns", + "title": "deleteCampaigns", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/deletePromotions", + "title": "deletePromotions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/listAndCountCampaigns", + "title": "listAndCountCampaigns", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/listAndCountPromotions", + "title": "listAndCountPromotions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/listCampaigns", + "title": "listCampaigns", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/listPromotionRules", + "title": "listPromotionRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/listPromotions", + "title": "listPromotions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/registerUsage", + "title": "registerUsage", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/removePromotionBuyRules", + "title": "removePromotionBuyRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/removePromotionRules", + "title": "removePromotionRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/removePromotionTargetRules", + "title": "removePromotionTargetRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/removePromotionsFromCampaign", + "title": "removePromotionsFromCampaign", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/restoreCampaigns", + "title": "restoreCampaigns", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/restorePromotions", + "title": "restorePromotions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/retrieveCampaign", + "title": "retrieveCampaign", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/retrievePromotion", + "title": "retrievePromotion", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/revertUsage", + "title": "revertUsage", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/softDeleteCampaigns", + "title": "softDeleteCampaigns", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/softDeletePromotions", + "title": "softDeletePromotions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/updateCampaigns", + "title": "updateCampaigns", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/updatePromotionRules", + "title": "updatePromotionRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/updatePromotions", + "title": "updatePromotions", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "promotion-models-reference", + "title": "Data Models Reference", + "childSidebarTitle": "Promotion Module Data Models Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/models", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Data Models", + "hasTitleStyling": true, + "autogenerate_path": "/references/promotion_models/variables", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/models/ApplicationMethod", + "title": "ApplicationMethod", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/models/Campaign", + "title": "Campaign", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/models/CampaignBudget", + "title": "CampaignBudget", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/models/Promotion", + "title": "Promotion", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/models/PromotionRule", + "title": "PromotionRule", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/models/PromotionRuleValue", + "title": "PromotionRuleValue", + "description": "", + "children": [] + } + ] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "region", + "title": "Region Module", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/region", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Concepts", + "initialOpen": false, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/region/links-to-other-modules", + "title": "Links to Modules", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Storefront Guides", + "autogenerate_tags": "storefront+region,-jsSdk", + "initialOpen": false, + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to integrate the Region Module's features into your storefront.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Implement Express Checkout with Medusa", + "path": "https://docs.medusajs.com/resources/storefront-development/guides/express-checkout", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "List Regions in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/regions/list", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Region Context in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/regions/context", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Store and Retrieve Region", + "path": "https://docs.medusajs.com/resources/storefront-development/regions/store-retrieve-region", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin User Guides", + "autogenerate_tags": "userGuide+region", + "initialOpen": false, + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to utilize and manage Region features in the Medusa Admin dashboard.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Regions", + "path": "https://docs.medusajs.com/user-guide/settings/regions", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "References", + "initialOpen": false, + "description": "Find references for tools and resources related to the Region Module, such as data models, methods, and more. These are useful for your customizations.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/region/workflows", + "title": "Workflows", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+region", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addOrderLineItemsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addOrderLineItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createRegionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createRegionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createShippingOptionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createShippingOptionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteRegionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteRegionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "exportProductsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/exportProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "importProductsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/importProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderClaimAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderEditAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderEditAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderExchangeAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderExchangeAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateRegionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateRegionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateShippingOptionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateShippingOptionsWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+region", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createRegionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createRegionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteRegionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteRegionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "findOneOrAnyRegionStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/findOneOrAnyRegionStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "generateProductCsvStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/generateProductCsvStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "parseProductCsvStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/parseProductCsvStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateRegionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateRegionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "validateShippingOptionPricesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/validateShippingOptionPricesStep", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/region/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Store", + "autogenerate_tags": "jsSdk+storefront+region", + "description": "The following methods or properties are used to send requests to Store API Routes related to the Region Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "region", + "path": "https://docs.medusajs.com/resources/references/js-sdk/store/region", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+region", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Region Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "region", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/region", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/region/events", + "title": "Events Reference", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/region/admin-widget-zones", + "title": "Admin Widget Zones", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "region-service-reference", + "title": "Main Service Reference", + "childSidebarTitle": "Region Module's Main Service Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/region", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Methods", + "autogenerate_path": "/references/region/IRegionModuleService/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/region/createRegions", + "title": "createRegions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/region/deleteRegions", + "title": "deleteRegions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/region/listAndCountCountries", + "title": "listAndCountCountries", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/region/listAndCountRegions", + "title": "listAndCountRegions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/region/listCountries", + "title": "listCountries", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/region/listRegions", + "title": "listRegions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/region/restoreRegions", + "title": "restoreRegions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/region/retrieveCountry", + "title": "retrieveCountry", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/region/retrieveRegion", + "title": "retrieveRegion", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/region/softDeleteRegions", + "title": "softDeleteRegions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/region/updateRegions", + "title": "updateRegions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/region/upsertRegions", + "title": "upsertRegions", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "region-models-reference", + "title": "Data Models Reference", + "childSidebarTitle": "Region Module Data Models Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/region/models", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Data Models", + "autogenerate_path": "/references/region_models/variables", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/region/models/Country", + "title": "Country", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/region/models/Region", + "title": "Region", + "description": "", + "children": [] + } + ] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "sales-channel", + "title": "Sales Channel Module", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/sales-channel", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Concepts", + "initialOpen": false, + "autogenerate_tags": "concept+salesChannel", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/sales-channel/publishable-api-keys", + "title": "Publishable API Keys", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/sales-channel/links-to-other-modules", + "title": "Links to Modules", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Product Variant Inventory", + "path": "https://docs.medusajs.com/resources/commerce-modules/product/variant-inventory", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Storefront Guides", + "autogenerate_tags": "storefront+salesChannel,-jsSdk", + "initialOpen": false, + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to integrate the Sales Channel Module's features into your storefront.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Use a Publishable API Key in the Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/publishable-api-keys", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin User Guides", + "autogenerate_tags": "userGuide+salesChannel", + "initialOpen": false, + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to utilize and manage Sales Channel features in the Medusa Admin dashboard.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Sales Channels", + "path": "https://docs.medusajs.com/user-guide/settings/sales-channels", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "References", + "initialOpen": false, + "description": "Find references for tools and resources related to the Sales Channel Module, such as data models, methods, and more. These are useful for your customizations.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/sales-channel/workflows", + "title": "Workflows", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+salesChannel", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addOrderLineItemsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addOrderLineItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createDefaultsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createDefaultsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createSalesChannelsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createSalesChannelsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteSalesChannelsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteSalesChannelsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "importProductsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/importProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "linkSalesChannelsToApiKeyWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/linkSalesChannelsToApiKeyWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderClaimAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderEditAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderEditAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderExchangeAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderExchangeAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateSalesChannelsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateSalesChannelsWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+salesChannel", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createDefaultSalesChannelStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createDefaultSalesChannelStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createSalesChannelsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createSalesChannelsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteSalesChannelsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteSalesChannelsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "findSalesChannelStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/findSalesChannelStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "parseProductCsvStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/parseProductCsvStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateSalesChannelsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateSalesChannelsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "validateSalesChannelsExistStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/validateSalesChannelsExistStep", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/sales-channel/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+salesChannel", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Sales Channel Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "salesChannel", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/salesChannel", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/sales-channel/events", + "title": "Events Reference", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/sales-channel/admin-widget-zones", + "title": "Admin Widget Zones", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "sales-channel-service-reference", + "title": "Main Service Reference", + "childSidebarTitle": "Sales Channel Module's Main Service Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/sales-channel", + "title": "Reference Overview", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Methods", + "autogenerate_path": "/references/sales_channel/ISalesChannelModuleService/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/sales-channel/createSalesChannels", + "title": "createSalesChannels", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/sales-channel/deleteSalesChannels", + "title": "deleteSalesChannels", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/sales-channel/listAndCountSalesChannels", + "title": "listAndCountSalesChannels", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/sales-channel/listSalesChannels", + "title": "listSalesChannels", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/sales-channel/restoreSalesChannels", + "title": "restoreSalesChannels", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/sales-channel/retrieveSalesChannel", + "title": "retrieveSalesChannel", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/sales-channel/softDeleteSalesChannels", + "title": "softDeleteSalesChannels", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/sales-channel/updateSalesChannels", + "title": "updateSalesChannels", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/sales-channel/upsertSalesChannels", + "title": "upsertSalesChannels", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "sales-channel-models-reference", + "title": "Data Models Reference", + "childSidebarTitle": "Sales Channel Module Data Models Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/sales-channel/models", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Data Models", + "autogenerate_path": "/references/sales_channel_models/variables", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/sales-channel/models/SalesChannel", + "title": "SalesChannel", + "description": "", + "children": [] + } + ] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "stock-location", + "title": "Stock Location Module", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/stock-location", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Concepts", + "initialOpen": false, + "autogenerate_tags": "concept+stockLocation", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/stock-location/concepts", + "title": "Stock Location Concepts", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/stock-location/links-to-other-modules", + "title": "Links to Modules", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Inventory Kits", + "path": "https://docs.medusajs.com/resources/commerce-modules/inventory/inventory-kit", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Product Variant Inventory", + "path": "https://docs.medusajs.com/resources/commerce-modules/product/variant-inventory", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin User Guides", + "autogenerate_tags": "userGuide+stockLocation", + "initialOpen": false, + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to utilize and manage Stock Location features in the Medusa Admin dashboard.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Locations & Shipping Overview", + "path": "https://docs.medusajs.com/user-guide/settings/locations-and-shipping", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Locations", + "path": "https://docs.medusajs.com/user-guide/settings/locations-and-shipping/locations", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "References", + "initialOpen": false, + "description": "Find references for tools and resources related to the Stock Location Module, such as data models, methods, and more. These are useful for your customizations.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/stock-location/workflows", + "title": "Workflows", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+stockLocation", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createStockLocationsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createStockLocationsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteStockLocationsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteStockLocationsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateStockLocationsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateStockLocationsWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+stockLocation", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createStockLocations", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createStockLocations", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteStockLocationsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteStockLocationsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateStockLocationsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateStockLocationsStep", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/stock-location/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+stockLocation", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Stock Location Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "stockLocation", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/stockLocation", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/stock-location/admin-widget-zones", + "title": "Admin Widget Zones", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "stock-location-service-reference", + "title": "Main Service Reference", + "childSidebarTitle": "Stock Location Module's Main Service Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/stock-location-next", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Methods", + "autogenerate_path": "/references/stock_location_next/IStockLocationService/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/stock-location-next/createStockLocations", + "title": "createStockLocations", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/stock-location-next/deleteStockLocationAddresses", + "title": "deleteStockLocationAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/stock-location-next/deleteStockLocations", + "title": "deleteStockLocations", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/stock-location-next/listAndCountStockLocations", + "title": "listAndCountStockLocations", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/stock-location-next/listStockLocationAddresses", + "title": "listStockLocationAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/stock-location-next/listStockLocations", + "title": "listStockLocations", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/stock-location-next/restoreStockLocations", + "title": "restoreStockLocations", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/stock-location-next/retrieveStockLocation", + "title": "retrieveStockLocation", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/stock-location-next/softDeleteStockLocations", + "title": "softDeleteStockLocations", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/stock-location-next/updateStockLocations", + "title": "updateStockLocations", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/stock-location-next/upsertStockLocationAddresses", + "title": "upsertStockLocationAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/stock-location-next/upsertStockLocations", + "title": "upsertStockLocations", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "stock-location-models-reference", + "title": "Data Models Reference", + "childSidebarTitle": "Stock Location Module Data Models Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/stock-location-next/models", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Data Models", + "autogenerate_path": "/references/stock_location_next_models/variables", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/stock-location-next/models/StockLocation", + "title": "StockLocation", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/stock-location-next/models/StockLocationAddress", + "title": "StockLocationAddress", + "description": "", + "children": [] + } + ] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "store", + "title": "Store Module", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/store", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Concepts", + "initialOpen": false, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/store/links-to-other-modules", + "title": "Link to Modules", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin User Guides", + "autogenerate_tags": "userGuide+store", + "initialOpen": false, + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to utilize and manage Store features in the Medusa Admin dashboard.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Store", + "path": "https://docs.medusajs.com/user-guide/settings/store", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "References", + "initialOpen": false, + "description": "Find references for tools and resources related to the Store Module, such as data models, methods, and more. These are useful for your customizations.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/store/workflows", + "title": "Workflows", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+store", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addOrderLineItemsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addOrderLineItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createDefaultsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createDefaultsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createStoresWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createStoresWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteStoresWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteStoresWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderClaimAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderEditAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderEditAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderExchangeAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderExchangeAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateStoresWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateStoresWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+store", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createDefaultStoreStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createDefaultStoreStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createStoresStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createStoresStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteStoresStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteStoresStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "findOneOrAnyRegionStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/findOneOrAnyRegionStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "findSalesChannelStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/findSalesChannelStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateStoresStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateStoresStep", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/store/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+store", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Store Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "store", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/store", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/store/admin-widget-zones", + "title": "Admin Widget Zones", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "store-service-reference", + "title": "Main Service Reference", + "childSidebarTitle": "Store Module's Main Service Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/store", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Methods", + "autogenerate_path": "/references/store/IStoreModuleService/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/store/createStores", + "title": "createStores", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/store/deleteStores", + "title": "deleteStores", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/store/listAndCountStores", + "title": "listAndCountStores", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/store/listStores", + "title": "listStores", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/store/restoreStores", + "title": "restoreStores", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/store/retrieveStore", + "title": "retrieveStore", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/store/softDeleteStores", + "title": "softDeleteStores", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/store/updateStores", + "title": "updateStores", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/store/upsertStores", + "title": "upsertStores", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "store-models-reference", + "title": "Data Models Reference", + "childSidebarTitle": "Store Module Data Models Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/store/models", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Data Models", + "autogenerate_path": "/references/store_models/variables", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/store/models/Store", + "title": "Store", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/store/models/StoreCurrency", + "title": "StoreCurrency", + "description": "", + "children": [] + } + ] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "tax", + "title": "Tax Module", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/tax", + "title": "Overview", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/tax/module-options", + "title": "Module Options", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Concepts", + "initialOpen": false, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/tax/tax-region", + "title": "Tax Region", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/tax/tax-rates-and-rules", + "title": "Tax Rates and Rules", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/tax/tax-calculation-with-provider", + "title": "Tax Calculation and Providers", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Server Guides", + "autogenerate_tags": "server+tax", + "initialOpen": false, + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to use the Tax Module in your customizations on the Medusa application server.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Get Variant Price with Taxes", + "path": "https://docs.medusajs.com/resources/commerce-modules/product/guides/price-with-taxes", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/provider", + "title": "Tax Provider Reference", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Storefront Guides", + "autogenerate_tags": "storefront+tax,-jsSdk", + "initialOpen": false, + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to integrate the Tax Module's features into your storefront.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Example: Show Price with Taxes", + "path": "https://docs.medusajs.com/resources/storefront-development/products/price/examples/tax-price", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin User Guides", + "autogenerate_tags": "userGuide+tax", + "initialOpen": false, + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to utilize and manage Tax features in the Medusa Admin dashboard.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Tax Regions", + "path": "https://docs.medusajs.com/user-guide/settings/tax-regions", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "References", + "initialOpen": false, + "description": "Find references for tools and resources related to the Tax Module, such as data models, methods, and more. These are useful for your customizations.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/tax/workflows", + "title": "Workflows", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+tax", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addShippingMethodToCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addShippingMethodToCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addToCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addToCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createClaimShippingMethodWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createClaimShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createExchangeShippingMethodWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createExchangeShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderEditShippingMethodWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderEditShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createReturnShippingMethodWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createReturnShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createTaxRateRulesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createTaxRateRulesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createTaxRatesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createTaxRatesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createTaxRegionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createTaxRegionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteLineItemsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteLineItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteTaxRateRulesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteTaxRateRulesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteTaxRatesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteTaxRatesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteTaxRegionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteTaxRegionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderClaimAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderEditAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderEditAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderExchangeAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderExchangeAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refreshCartItemsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshCartItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "setTaxRateRulesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/setTaxRateRulesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "transferCartCustomerWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/transferCartCustomerWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateLineItemInCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateLineItemInCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateOrderTaxLinesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateOrderTaxLinesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateTaxLinesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateTaxLinesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateTaxRatesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateTaxRatesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateTaxRegionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateTaxRegionsWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+tax", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createTaxRateRulesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createTaxRateRulesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createTaxRatesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createTaxRatesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createTaxRegionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createTaxRegionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteTaxRateRulesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteTaxRateRulesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteTaxRatesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteTaxRatesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteTaxRegionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteTaxRegionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "getItemTaxLinesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/getItemTaxLinesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "listTaxRateRuleIdsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/listTaxRateRuleIdsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateTaxRatesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateTaxRatesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateTaxRegionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateTaxRegionsStep", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/tax/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+tax", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Tax Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "taxRate", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/taxRate", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "taxRegion", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/taxRegion", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/tax/admin-widget-zones", + "title": "Admin Widget Zones", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "tax-service-reference", + "title": "Main Service Reference", + "childSidebarTitle": "Tax Module's Main Service Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Methods", + "autogenerate_path": "/references/tax/ITaxModuleService/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/createTaxRateRules", + "title": "createTaxRateRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/createTaxRates", + "title": "createTaxRates", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/createTaxRegions", + "title": "createTaxRegions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/deleteTaxRateRules", + "title": "deleteTaxRateRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/deleteTaxRates", + "title": "deleteTaxRates", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/deleteTaxRegions", + "title": "deleteTaxRegions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/getTaxLines", + "title": "getTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/listAndCountTaxRates", + "title": "listAndCountTaxRates", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/listTaxRateRules", + "title": "listTaxRateRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/listTaxRates", + "title": "listTaxRates", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/listTaxRegions", + "title": "listTaxRegions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/restoreTaxRateRules", + "title": "restoreTaxRateRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/restoreTaxRates", + "title": "restoreTaxRates", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/restoreTaxRegions", + "title": "restoreTaxRegions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/retrieveTaxRate", + "title": "retrieveTaxRate", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/softDeleteTaxRateRules", + "title": "softDeleteTaxRateRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/softDeleteTaxRates", + "title": "softDeleteTaxRates", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/softDeleteTaxRegions", + "title": "softDeleteTaxRegions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/updateTaxRates", + "title": "updateTaxRates", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/updateTaxRegions", + "title": "updateTaxRegions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/upsertTaxRates", + "title": "upsertTaxRates", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "tax-models-reference", + "title": "Data Models Reference", + "childSidebarTitle": "Tax Module Data Models Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/models", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Data Models", + "autogenerate_path": "/references/tax_models/variables", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/models/TaxProvider", + "title": "TaxProvider", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/models/TaxRate", + "title": "TaxRate", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/models/TaxRateRule", + "title": "TaxRateRule", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/models/TaxRegion", + "title": "TaxRegion", + "description": "", + "children": [] + } + ] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "user", + "title": "User Module", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/user", + "title": "Overview", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/user/module-options", + "title": "Module Options", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Server Guides", + "autogenerate_tags": "server+user", + "initialOpen": false, + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to use the User Module in your customizations on the Medusa application server.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/user/user-creation-flows", + "title": "User Creation Flows", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin User Guides", + "autogenerate_tags": "userGuide+user", + "initialOpen": false, + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to utilize and manage User features in the Medusa Admin dashboard.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Invites", + "path": "https://docs.medusajs.com/user-guide/settings/users/invites", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Profile", + "path": "https://docs.medusajs.com/user-guide/settings/profile", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Users", + "path": "https://docs.medusajs.com/user-guide/settings/users", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Reset Password", + "path": "https://docs.medusajs.com/user-guide/reset-password", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "References", + "initialOpen": false, + "description": "Find references for tools and resources related to the User Module, such as data models, methods, and more. These are useful for your customizations.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/user/workflows", + "title": "Workflows", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+user", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "acceptInviteWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/acceptInviteWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createInvitesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createInvitesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createUserAccountWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createUserAccountWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createUsersWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createUsersWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteInvitesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteInvitesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteUsersWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteUsersWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refreshInviteTokensWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshInviteTokensWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeUserAccountWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeUserAccountWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateUsersWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateUsersWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+user", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createInviteStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createInviteStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createUsersStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createUsersStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteInvitesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteInvitesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteUsersStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteUsersStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refreshInviteTokensStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/refreshInviteTokensStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateUsersStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateUsersStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "validateTokenStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/validateTokenStep", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/user/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+user", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the User Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "invite", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/invite", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "user", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/user", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/user/events", + "title": "Events Reference", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/user/admin-widget-zones", + "title": "Admin Widget Zones", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "user-service-reference", + "title": "Main Service Reference", + "childSidebarTitle": "User Module's Main Service Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Methods", + "autogenerate_path": "/references/user/IUserModuleService/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/createInvites", + "title": "createInvites", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/createUsers", + "title": "createUsers", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/deleteInvites", + "title": "deleteInvites", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/deleteUsers", + "title": "deleteUsers", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/listAndCountInvites", + "title": "listAndCountInvites", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/listAndCountUsers", + "title": "listAndCountUsers", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/listInvites", + "title": "listInvites", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/listUsers", + "title": "listUsers", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/refreshInviteTokens", + "title": "refreshInviteTokens", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/restoreInvites", + "title": "restoreInvites", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/restoreUsers", + "title": "restoreUsers", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/retrieveInvite", + "title": "retrieveInvite", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/retrieveUser", + "title": "retrieveUser", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/softDeleteInvites", + "title": "softDeleteInvites", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/softDeleteUsers", + "title": "softDeleteUsers", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/updateInvites", + "title": "updateInvites", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/updateUsers", + "title": "updateUsers", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/validateInviteToken", + "title": "validateInviteToken", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "user-models-reference", + "title": "Data Models Reference", + "childSidebarTitle": "User Module Data Models Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/models", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Data Models", + "hasTitleStyling": true, + "autogenerate_path": "/references/user_models/variables", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/models/Invite", + "title": "Invite", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/models/User", + "title": "User", + "description": "", + "children": [] + } + ] } ] } @@ -641,26 +17034,18 @@ export const generatedSidebar = [ { "loaded": true, "isPathHref": true, - "type": "category", - "title": "Auth Module", - "isChildSidebar": true, + "type": "sidebar", + "sidebar_id": "architectural-modules", + "title": "Architectural Modules", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "path": "/commerce-modules/auth", + "path": "/architectural-modules", "title": "Overview", "children": [] }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/auth/module-options", - "title": "Module Options", - "children": [] - }, { "type": "separator" }, @@ -668,40 +17053,47 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "category", - "title": "Concepts", - "initialOpen": false, + "title": "Cache Modules", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "path": "/commerce-modules/auth/auth-identity-and-actor-types", - "title": "Identity and Actor Types", + "path": "/architectural-modules/cache", + "title": "Overview", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", - "path": "/commerce-modules/auth/auth-providers", - "title": "Auth Providers", + "path": "/architectural-modules/cache/in-memory", + "title": "In-Memory", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", - "path": "/commerce-modules/auth/auth-flows", - "title": "Auth Flow with Module", + "path": "/architectural-modules/cache/redis", + "title": "Redis", "children": [] }, { "loaded": true, "isPathHref": true, - "type": "link", - "path": "/commerce-modules/auth/authentication-route", - "title": "Auth Flow with Routes", - "children": [] + "type": "sub-category", + "title": "Guides", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/architectural-modules/cache/create", + "title": "Create Cache Module", + "children": [] + } + ] } ] }, @@ -709,35 +17101,47 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "category", - "title": "Server Guides", - "autogenerate_tags": "server+auth", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to use the Auth Module in your customizations on the Medusa application server.", + "title": "Event Modules", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "path": "/commerce-modules/auth/create-actor-type", - "title": "Create an Actor Type", + "path": "/architectural-modules/event", + "title": "Overview", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", - "path": "/commerce-modules/auth/reset-password", - "title": "Handle Password Reset Event", + "path": "/architectural-modules/event/local", + "title": "Local", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", - "path": "/references/auth/provider", - "title": "Create Auth Provider Module", + "path": "/architectural-modules/event/redis", + "title": "Redis", "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Guides", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/architectural-modules/event/create", + "title": "Create Event Module", + "children": [] + } + ] } ] }, @@ -745,103 +17149,178 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "category", - "title": "Storefront Guides", - "autogenerate_tags": "storefront+auth,-jsSdk", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to integrate the Auth Module's features into your storefront.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Log-out Customer in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/customers/log-out", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Login Customer in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/customers/login", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Register Customer in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/customers/register", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Reset Customer Password in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/customers/reset-password", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Retrieve Logged-In Customer in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/customers/retrieve", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Third-Party or Social Login in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/customers/third-party-login", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Admin User Guides", - "autogenerate_tags": "userGuide+auth", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to utilize and manage Auth features in the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Reset Password", - "path": "https://docs.medusajs.com/user-guide/reset-password", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Providers", - "initialOpen": false, + "title": "File Module Providers", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "path": "/commerce-modules/auth/auth-providers/emailpass", - "title": "Emailpass Provider", + "path": "/architectural-modules/file", + "title": "Overview", "children": [] }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/architectural-modules/file/local", + "title": "Local", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/architectural-modules/file/s3", + "title": "AWS S3 (and Compatible APIs)", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Guides", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/file-provider-module", + "title": "Create File Provider", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Notification Module Providers", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/architectural-modules/notification", + "title": "Overview", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/architectural-modules/notification/local", + "title": "Local", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/architectural-modules/notification/sendgrid", + "title": "SendGrid", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Guides", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/notification-provider-module", + "title": "Create Notification Provider", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/integrations/guides/resend", + "title": "Integrate Resend", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/architectural-modules/notification/send-notification", + "title": "Send Notification", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflow Engine Modules", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/architectural-modules/workflow-engine", + "title": "Overview", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/architectural-modules/workflow-engine/in-memory", + "title": "In-Memory", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/architectural-modules/workflow-engine/redis", + "title": "Redis", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "integrations", + "title": "Integrations", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/integrations", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Auth", + "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/commerce-modules/auth/auth-providers/google", - "title": "Google Provider", + "title": "Google", "children": [] }, { @@ -849,7 +17328,7 @@ export const generatedSidebar = [ "isPathHref": true, "type": "link", "path": "/commerce-modules/auth/auth-providers/github", - "title": "GitHub Provider", + "title": "GitHub", "children": [] } ] @@ -858,424 +17337,14 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "category", - "title": "References", - "initialOpen": false, - "description": "Find references for tools and resources related to the Auth Module, such as data models, methods, and more. These are useful for your customizations.", + "title": "CMS", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "path": "/commerce-modules/auth/workflows", - "title": "Workflows", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+auth", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCustomerAccountWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCustomerAccountWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeCustomerAccountWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeCustomerAccountWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "acceptInviteWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/acceptInviteWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createUserAccountWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createUserAccountWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeUserAccountWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeUserAccountWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+auth", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "setAuthAppMetadataStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/setAuthAppMetadataStep", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/auth/js-sdk", - "title": "JS SDK", - "hideChildren": true, - "autogenerate_tags": "jsSdk+auth", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "callback", - "path": "https://docs.medusajs.com/resources/references/js-sdk/auth/callback", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "login", - "path": "https://docs.medusajs.com/resources/references/js-sdk/auth/login", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "logout", - "path": "https://docs.medusajs.com/resources/references/js-sdk/auth/logout", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refresh", - "path": "https://docs.medusajs.com/resources/references/js-sdk/auth/refresh", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "register", - "path": "https://docs.medusajs.com/resources/references/js-sdk/auth/register", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "resetPassword", - "path": "https://docs.medusajs.com/resources/references/js-sdk/auth/resetPassword", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProvider", - "path": "https://docs.medusajs.com/resources/references/js-sdk/auth/updateProvider", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/auth/events", - "title": "Events Reference", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/auth/admin-widget-zones", - "title": "Admin Widget Zones", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth", - "title": "Main Service Reference", - "isChildSidebar": true, - "childSidebarTitle": "Auth Module's Main Service Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Methods", - "autogenerate_path": "/references/auth/IAuthModuleService/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth/authenticate", - "title": "authenticate", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth/createAuthIdentities", - "title": "createAuthIdentities", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth/createProviderIdentities", - "title": "createProviderIdentities", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth/deleteAuthIdentities", - "title": "deleteAuthIdentities", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth/deleteProviderIdentities", - "title": "deleteProviderIdentities", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth/listAndCountAuthIdentities", - "title": "listAndCountAuthIdentities", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth/listAuthIdentities", - "title": "listAuthIdentities", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth/listProviderIdentities", - "title": "listProviderIdentities", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth/register", - "title": "register", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth/retrieveAuthIdentity", - "title": "retrieveAuthIdentity", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth/retrieveProviderIdentity", - "title": "retrieveProviderIdentity", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth/updateAuthIdentities", - "title": "updateAuthIdentities", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth/updateProvider", - "title": "updateProvider", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth/updateProviderIdentities", - "title": "updateProviderIdentities", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth/validateCallback", - "title": "validateCallback", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth/models", - "title": "Data Models Reference", - "isChildSidebar": true, - "childSidebarTitle": "Auth Module Data Models Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Data Models", - "autogenerate_path": "/references/auth_models/variables", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth/models/AuthIdentity", - "title": "AuthIdentity", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth/models/ProviderIdentity", - "title": "ProviderIdentity", - "description": "", - "children": [] - } - ] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Cart Module", - "isChildSidebar": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/cart", - "title": "Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Concepts", - "initialOpen": false, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/cart/concepts", - "title": "Cart Concepts", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/cart/promotions", - "title": "Promotion Adjustments", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/cart/tax-lines", - "title": "Tax Lines", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/cart/links-to-other-modules", - "title": "Links to Other Modules", + "path": "/integrations/guides/sanity", + "title": "Sanity", "children": [] } ] @@ -1284,26 +17353,14 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "category", - "title": "Server Guides", - "autogenerate_tags": "server+cart", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to use the Cart Module in your customizations on the Medusa application server.", + "title": "File", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "path": "/commerce-modules/cart/extend", - "title": "Extend Module", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Implement Custom Line Item Pricing in Medusa", - "path": "https://docs.medusajs.com/resources/examples/guides/custom-item-price", + "path": "/architectural-modules/file/s3", + "title": "AWS", "children": [] }, { @@ -1320,2135 +17377,14 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "category", - "title": "Storefront Guides", - "autogenerate_tags": "storefront+cart,-jsSdk", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to integrate the Cart Module's features into your storefront.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Create Cart Context in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/cart/context", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Create Cart in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/cart/create", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Cart's Items in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/cart/manage-items", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Retrieve Cart in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/cart/retrieve", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Update Cart in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/cart/update", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Checkout Step 2: Set Address", - "path": "https://docs.medusajs.com/resources/storefront-development/checkout/address", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Checkout Step 5: Complete Cart", - "path": "https://docs.medusajs.com/resources/storefront-development/checkout/complete-cart", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Checkout Step 1: Enter Email", - "path": "https://docs.medusajs.com/resources/storefront-development/checkout/email", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Checkout Step 4: Choose Payment Provider", - "path": "https://docs.medusajs.com/resources/storefront-development/checkout/payment", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Payment with Stripe in React Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/checkout/payment/stripe", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Checkout Step 3: Choose Shipping Method", - "path": "https://docs.medusajs.com/resources/storefront-development/checkout/shipping", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "initialOpen": false, - "description": "Find references for tools and resources related to the Cart Module, such as data models, methods, and more. These are useful for your customizations.", + "title": "Fulfillment", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "path": "/commerce-modules/cart/workflows", - "title": "Workflows", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+cart", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addShippingMethodToCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addShippingMethodToCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addToCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addToCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "completeCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/completeCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refreshCartItemsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshCartItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refreshCartShippingMethodsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshCartShippingMethodsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "transferCartCustomerWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/transferCartCustomerWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCartPromotionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartPromotionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateLineItemInCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateLineItemInCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateTaxLinesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateTaxLinesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteLineItemsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteLineItemsWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+cart", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addShippingMethodToCartStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/addShippingMethodToCartStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCartsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createCartsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createLineItemAdjustmentsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createLineItemAdjustmentsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createLineItemsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createLineItemsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createShippingMethodAdjustmentsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createShippingMethodAdjustmentsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "getLineItemActionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/getLineItemActionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeLineItemAdjustmentsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/removeLineItemAdjustmentsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeShippingMethodAdjustmentsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/removeShippingMethodAdjustmentsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeShippingMethodFromCartStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/removeShippingMethodFromCartStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "setTaxLinesForItemsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/setTaxLinesForItemsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCartsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateCartsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateLineItemsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateLineItemsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateShippingMethodsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateShippingMethodsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteLineItemsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteLineItemsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateLineItemsStepWithSelector", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateLineItemsStepWithSelector", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/cart/js-sdk", - "title": "JS SDK", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Store", - "autogenerate_tags": "jsSdk+storefront+cart", - "description": "The following methods or properties are used to send requests to Store API Routes related to the Cart Module.", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Implement Express Checkout with Medusa", - "path": "https://docs.medusajs.com/resources/storefront-development/guides/express-checkout", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cart", - "path": "https://docs.medusajs.com/resources/references/js-sdk/store/cart", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/cart/events", - "title": "Events Reference", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart", - "title": "Main Service Reference", - "isChildSidebar": true, - "childSidebarTitle": "Cart Module's Main Service Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Methods", - "autogenerate_path": "/references/cart/ICartModuleService/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/addLineItemAdjustments", - "title": "addLineItemAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/addLineItemTaxLines", - "title": "addLineItemTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/addLineItems", - "title": "addLineItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/addShippingMethodAdjustments", - "title": "addShippingMethodAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/addShippingMethodTaxLines", - "title": "addShippingMethodTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/addShippingMethods", - "title": "addShippingMethods", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/createAddresses", - "title": "createAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/createCarts", - "title": "createCarts", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/deleteAddresses", - "title": "deleteAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/deleteCarts", - "title": "deleteCarts", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/deleteLineItemAdjustments", - "title": "deleteLineItemAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/deleteLineItemTaxLines", - "title": "deleteLineItemTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/deleteLineItems", - "title": "deleteLineItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/deleteShippingMethodAdjustments", - "title": "deleteShippingMethodAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/deleteShippingMethodTaxLines", - "title": "deleteShippingMethodTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/deleteShippingMethods", - "title": "deleteShippingMethods", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/listAddresses", - "title": "listAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/listAndCountCarts", - "title": "listAndCountCarts", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/listCarts", - "title": "listCarts", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/listLineItemAdjustments", - "title": "listLineItemAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/listLineItemTaxLines", - "title": "listLineItemTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/listLineItems", - "title": "listLineItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/listShippingMethodAdjustments", - "title": "listShippingMethodAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/listShippingMethodTaxLines", - "title": "listShippingMethodTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/listShippingMethods", - "title": "listShippingMethods", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/restoreAddresses", - "title": "restoreAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/restoreCarts", - "title": "restoreCarts", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/restoreLineItemAdjustments", - "title": "restoreLineItemAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/restoreLineItemTaxLines", - "title": "restoreLineItemTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/restoreLineItems", - "title": "restoreLineItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/restoreShippingMethodAdjustments", - "title": "restoreShippingMethodAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/restoreShippingMethodTaxLines", - "title": "restoreShippingMethodTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/restoreShippingMethods", - "title": "restoreShippingMethods", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/retrieveCart", - "title": "retrieveCart", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/retrieveLineItem", - "title": "retrieveLineItem", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/setLineItemAdjustments", - "title": "setLineItemAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/setLineItemTaxLines", - "title": "setLineItemTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/setShippingMethodAdjustments", - "title": "setShippingMethodAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/setShippingMethodTaxLines", - "title": "setShippingMethodTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/softDeleteAddresses", - "title": "softDeleteAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/softDeleteCarts", - "title": "softDeleteCarts", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/softDeleteLineItemAdjustments", - "title": "softDeleteLineItemAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/softDeleteLineItemTaxLines", - "title": "softDeleteLineItemTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/softDeleteLineItems", - "title": "softDeleteLineItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/softDeleteShippingMethodAdjustments", - "title": "softDeleteShippingMethodAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/softDeleteShippingMethodTaxLines", - "title": "softDeleteShippingMethodTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/softDeleteShippingMethods", - "title": "softDeleteShippingMethods", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/updateAddresses", - "title": "updateAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/updateCarts", - "title": "updateCarts", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/updateLineItems", - "title": "updateLineItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/updateShippingMethods", - "title": "updateShippingMethods", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/models", - "title": "Data Models Reference", - "isChildSidebar": true, - "childSidebarTitle": "Cart Module Data Models Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Data Models", - "autogenerate_path": "/references/cart_models/variables", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/models/Address", - "title": "Address", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/models/Cart", - "title": "Cart", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/models/CreditLine", - "title": "CreditLine", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/models/LineItem", - "title": "LineItem", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/models/LineItemAdjustment", - "title": "LineItemAdjustment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/models/LineItemTaxLine", - "title": "LineItemTaxLine", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/models/ShippingMethod", - "title": "ShippingMethod", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/models/ShippingMethodAdjustment", - "title": "ShippingMethodAdjustment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/models/ShippingMethodTaxLine", - "title": "ShippingMethodTaxLine", - "description": "", - "children": [] - } - ] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Currency Module", - "isChildSidebar": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/currency", - "title": "Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Concepts", - "initialOpen": false, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/currency/links-to-other-modules", - "title": "Link to Modules", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Admin User Guides", - "autogenerate_tags": "userGuide+currency", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to utilize and manage Currency features in the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Store", - "path": "https://docs.medusajs.com/user-guide/settings/store", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "References", - "initialOpen": false, - "description": "Find references for tools and resources related to the Currency Module, such as data models, methods, and more. These are useful for your customizations.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/currency/js-sdk", - "title": "JS SDK", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+currency", - "description": "The following methods or properties are used to send requests to Admin API Routes related to the Currency Module.", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "currency", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/currency", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/currency", - "title": "Main Service Reference", - "isChildSidebar": true, - "childSidebarTitle": "Currency Module's Main Service Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Methods", - "autogenerate_path": "/references/currency/ICurrencyModuleService/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/currency/listAndCountCurrencies", - "title": "listAndCountCurrencies", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/currency/listCurrencies", - "title": "listCurrencies", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/currency/retrieveCurrency", - "title": "retrieveCurrency", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/currency/models", - "title": "Data Models Reference", - "isChildSidebar": true, - "childSidebarTitle": "Currency Module Data Models Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Data Models", - "autogenerate_path": "/references/currency_models/variables", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/currency/models/Currency", - "title": "Currency", - "description": "", - "children": [] - } - ] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Customer Module", - "isChildSidebar": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/customer", - "title": "Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Concepts", - "initialOpen": false, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/customer/customer-accounts", - "title": "Customer Accounts", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/customer/links-to-other-modules", - "title": "Link to Modules", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Server Guides", - "autogenerate_tags": "server+customer", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to use the Customer Module in your customizations on the Medusa application server.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/customer/extend", - "title": "Extend Module", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Storefront Guides", - "autogenerate_tags": "storefront+customer,-jsSdk", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to integrate the Customer Module's features into your storefront.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Customer Addresses in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/customers/addresses", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Customer Context in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/customers/context", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Log-out Customer in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/customers/log-out", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Login Customer in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/customers/login", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Edit Customer Profile in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/customers/profile", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Register Customer in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/customers/register", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Reset Customer Password in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/customers/reset-password", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Retrieve Logged-In Customer in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/customers/retrieve", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Third-Party or Social Login in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/customers/third-party-login", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Admin User Guides", - "autogenerate_tags": "userGuide+customer", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to utilize and manage Customer features in the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Customer Groups", - "path": "https://docs.medusajs.com/user-guide/customers/groups", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Customers", - "path": "https://docs.medusajs.com/user-guide/customers/manage", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Customers Overview", - "path": "https://docs.medusajs.com/user-guide/customers", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "initialOpen": false, - "description": "Find references for tools and resources related to the Customer Module, such as data models, methods, and more. These are useful for your customizations.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/customer/workflows", - "title": "Workflows", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+customer", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCustomerAccountWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCustomerAccountWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCustomerAddressesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCustomerAddressesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCustomersWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCustomersWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteCustomerAddressesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteCustomerAddressesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteCustomersWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteCustomersWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeCustomerAccountWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeCustomerAccountWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCustomerAddressesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCustomerAddressesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCustomersWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCustomersWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCustomerGroupsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCustomerGroupsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteCustomerGroupsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteCustomerGroupsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "linkCustomerGroupsToCustomerWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/linkCustomerGroupsToCustomerWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "linkCustomersToCustomerGroupWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/linkCustomersToCustomerGroupWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCustomerGroupsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCustomerGroupsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addOrderLineItemsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addOrderLineItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderClaimAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderEditAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderEditAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderExchangeAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderExchangeAddNewItemWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+customer", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "findOrCreateCustomerStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/findOrCreateCustomerStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCustomerAddressesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createCustomerAddressesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCustomersStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createCustomersStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteCustomerAddressesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteCustomerAddressesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteCustomersStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteCustomersStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "maybeUnsetDefaultBillingAddressesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/maybeUnsetDefaultBillingAddressesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "maybeUnsetDefaultShippingAddressesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/maybeUnsetDefaultShippingAddressesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCustomerAddressesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateCustomerAddressesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCustomersStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateCustomersStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "validateCustomerAccountCreation", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/validateCustomerAccountCreation", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCustomerGroupsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createCustomerGroupsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteCustomerGroupStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteCustomerGroupStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "linkCustomerGroupsToCustomerStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/linkCustomerGroupsToCustomerStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "linkCustomersToCustomerGroupStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/linkCustomersToCustomerGroupStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCustomerGroupsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateCustomerGroupsStep", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/customer/js-sdk", - "title": "JS SDK", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Store", - "autogenerate_tags": "jsSdk+storefront+customer", - "description": "The following methods or properties are used to send requests to Store API Routes related to the Customer Module.", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "customer", - "path": "https://docs.medusajs.com/resources/references/js-sdk/store/customer", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+customer", - "description": "The following methods or properties are used to send requests to Admin API Routes related to the Customer Module.", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "customer", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/customer", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "customerGroup", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/customerGroup", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/customer/events", - "title": "Events Reference", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/customer/admin-widget-zones", - "title": "Admin Widget Zones", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer", - "title": "Main Service Reference", - "isChildSidebar": true, - "childSidebarTitle": "Customer Module's Main Service Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Methods", - "autogenerate_path": "/references/customer/ICustomerModuleService/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/addCustomerToGroup", - "title": "addCustomerToGroup", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/createCustomerAddresses", - "title": "createCustomerAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/createCustomerGroups", - "title": "createCustomerGroups", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/createCustomers", - "title": "createCustomers", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/deleteCustomerAddresses", - "title": "deleteCustomerAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/deleteCustomerGroups", - "title": "deleteCustomerGroups", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/deleteCustomers", - "title": "deleteCustomers", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/listAndCountCustomerAddresses", - "title": "listAndCountCustomerAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/listAndCountCustomerGroups", - "title": "listAndCountCustomerGroups", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/listAndCountCustomers", - "title": "listAndCountCustomers", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/listCustomerAddresses", - "title": "listCustomerAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/listCustomerGroupCustomers", - "title": "listCustomerGroupCustomers", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/listCustomerGroups", - "title": "listCustomerGroups", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/listCustomers", - "title": "listCustomers", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/removeCustomerFromGroup", - "title": "removeCustomerFromGroup", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/restoreCustomerGroups", - "title": "restoreCustomerGroups", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/restoreCustomers", - "title": "restoreCustomers", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/retrieveCustomer", - "title": "retrieveCustomer", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/retrieveCustomerGroup", - "title": "retrieveCustomerGroup", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/softDeleteCustomerGroups", - "title": "softDeleteCustomerGroups", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/softDeleteCustomers", - "title": "softDeleteCustomers", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/updateCustomerAddresses", - "title": "updateCustomerAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/updateCustomerGroups", - "title": "updateCustomerGroups", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/updateCustomers", - "title": "updateCustomers", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/models", - "title": "Data Models Reference", - "isChildSidebar": true, - "childSidebarTitle": "Customer Module Data Models Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Data Models", - "autogenerate_path": "/references/customer_models/variables", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/models/Customer", - "title": "Customer", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/models/CustomerAddress", - "title": "CustomerAddress", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/models/CustomerGroup", - "title": "CustomerGroup", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/models/CustomerGroupCustomer", - "title": "CustomerGroupCustomer", - "description": "", - "children": [] - } - ] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Fulfillment Module", - "isChildSidebar": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/fulfillment", - "title": "Overview", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/fulfillment/module-options", - "title": "Module Options", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Concepts", - "initialOpen": false, - "autogenerate_tags": "concept+fulfillment", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/fulfillment/concepts", - "title": "Fulfillment Concepts", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/fulfillment/fulfillment-provider", - "title": "Fulfillment Provider", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/fulfillment/shipping-option", - "title": "Shipping Option", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/fulfillment/item-fulfillment", - "title": "Item Fulfillment", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/fulfillment/links-to-other-modules", - "title": "Links to Other Modules", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Product Shipping Requirement", - "path": "https://docs.medusajs.com/resources/commerce-modules/product/selling-products", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Server Guides", - "autogenerate_tags": "server+fulfillment", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to use the Fulfillment Module in your customizations on the Medusa application server.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/provider", - "title": "Create Fulfillment Provider Module", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", "path": "/integrations/guides/shipstation", - "title": "Integrate ShipStation", + "title": "ShipStation", "children": [] } ] @@ -3457,1527 +17393,22 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "category", - "title": "Storefront Guides", - "autogenerate_tags": "storefront+fulfillment,-jsSdk", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to integrate the Fulfillment Module's features into your storefront.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Checkout Step 3: Choose Shipping Method", - "path": "https://docs.medusajs.com/resources/storefront-development/checkout/shipping", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Admin User Guides", - "autogenerate_tags": "userGuide+fulfillment", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to utilize and manage Fulfillment features in the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Order Fulfillments", - "path": "https://docs.medusajs.com/user-guide/orders/fulfillments", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Locations & Shipping Overview", - "path": "https://docs.medusajs.com/user-guide/settings/locations-and-shipping", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Shipping Profiles", - "path": "https://docs.medusajs.com/user-guide/settings/locations-and-shipping/shipping-profiles", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "initialOpen": false, - "description": "Find references for tools and resources related to the Fulfillment Module, such as data models, methods, and more. These are useful for your customizations.", + "title": "Notification", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "path": "/commerce-modules/fulfillment/workflows", - "title": "Workflows", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+fulfillment", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addShippingMethodToCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addShippingMethodToCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addToCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addToCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "listShippingOptionsForCartWithPricingWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/listShippingOptionsForCartWithPricingWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refreshCartItemsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshCartItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refreshCartShippingMethodsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshCartShippingMethodsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "transferCartCustomerWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/transferCartCustomerWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateLineItemInCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateLineItemInCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchShippingOptionRulesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchShippingOptionRulesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "calculateShippingOptionsPricesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/calculateShippingOptionsPricesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelFulfillmentWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelFulfillmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createFulfillmentWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createFulfillmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createReturnFulfillmentWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createReturnFulfillmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createServiceZonesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createServiceZonesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createShipmentWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createShipmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createShippingOptionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createShippingOptionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createShippingProfilesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createShippingProfilesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteFulfillmentSetsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteFulfillmentSetsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteServiceZonesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteServiceZonesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteShippingOptionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteShippingOptionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "markFulfillmentAsDeliveredWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/markFulfillmentAsDeliveredWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateFulfillmentWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateFulfillmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateServiceZonesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateServiceZonesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateShippingOptionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateShippingOptionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateShippingProfilesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateShippingProfilesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteLineItemsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteLineItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderFulfillmentWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderFulfillmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmClaimRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmClaimRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmExchangeRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmExchangeRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmReturnRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmReturnRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createAndCompleteReturnOrderWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createAndCompleteReturnOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderFulfillmentWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderFulfillmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderShipmentWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderShipmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "markOrderFulfillmentAsDeliveredWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/markOrderFulfillmentAsDeliveredWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "importProductsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/importProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteShippingProfileWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteShippingProfileWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createLocationFulfillmentSetWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createLocationFulfillmentSetWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+fulfillment", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "validateAndReturnShippingMethodsDataStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/validateAndReturnShippingMethodsDataStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "validateCartShippingOptionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/validateCartShippingOptionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "calculateShippingOptionsPricesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/calculateShippingOptionsPricesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelFulfillmentStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/cancelFulfillmentStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createFulfillmentSets", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createFulfillmentSets", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createFulfillmentStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createFulfillmentStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createReturnFulfillmentStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createReturnFulfillmentStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createServiceZonesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createServiceZonesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createShippingOptionRulesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createShippingOptionRulesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createShippingProfilesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createShippingProfilesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteFulfillmentSetsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteFulfillmentSetsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteServiceZonesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteServiceZonesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteShippingOptionRulesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteShippingOptionRulesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteShippingOptionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteShippingOptionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateFulfillmentStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateFulfillmentStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateServiceZonesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateServiceZonesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateShippingOptionRulesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateShippingOptionRulesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateShippingProfilesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateShippingProfilesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "upsertShippingOptionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/upsertShippingOptionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "validateShipmentStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/validateShipmentStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "validateShippingOptionPricesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/validateShippingOptionPricesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "parseProductCsvStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/parseProductCsvStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteShippingProfilesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteShippingProfilesStep", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/fulfillment/js-sdk", - "title": "JS SDK", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Store", - "autogenerate_tags": "jsSdk+storefront+fulfillment", - "description": "The following methods or properties are used to send requests to Store API Routes related to the Fulfillment Module.", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Implement Express Checkout with Medusa", - "path": "https://docs.medusajs.com/resources/storefront-development/guides/express-checkout", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "fulfillment", - "path": "https://docs.medusajs.com/resources/references/js-sdk/store/fulfillment", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+fulfillment", - "description": "The following methods or properties are used to send requests to Admin API Routes related to the Fulfillment Module.", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "fulfillment", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/fulfillment", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "fulfillmentProvider", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/fulfillmentProvider", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "fulfillmentSet", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/fulfillmentSet", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "shippingOption", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/shippingOption", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "shippingProfile", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/shippingProfile", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/fulfillment/events", - "title": "Events Reference", + "path": "/architectural-modules/notification/sendgrid", + "title": "SendGrid", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", - "path": "/commerce-modules/fulfillment/admin-widget-zones", - "title": "Admin Widget Zones", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment", - "title": "Main Service Reference", - "isChildSidebar": true, - "childSidebarTitle": "Fulfillment Module's Main Service Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Methods", - "autogenerate_path": "/references/fulfillment/IFulfillmentModuleService/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/calculateShippingOptionsPrices", - "title": "calculateShippingOptionsPrices", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/cancelFulfillment", - "title": "cancelFulfillment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/createFulfillment", - "title": "createFulfillment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/createFulfillmentSets", - "title": "createFulfillmentSets", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/createGeoZones", - "title": "createGeoZones", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/createReturnFulfillment", - "title": "createReturnFulfillment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/createServiceZones", - "title": "createServiceZones", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/createShippingOptionRules", - "title": "createShippingOptionRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/createShippingOptions", - "title": "createShippingOptions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/createShippingProfiles", - "title": "createShippingProfiles", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/deleteFulfillment", - "title": "deleteFulfillment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/deleteFulfillmentSets", - "title": "deleteFulfillmentSets", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/deleteGeoZones", - "title": "deleteGeoZones", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/deleteServiceZones", - "title": "deleteServiceZones", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/deleteShippingOptionRules", - "title": "deleteShippingOptionRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/deleteShippingOptionTypes", - "title": "deleteShippingOptionTypes", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/deleteShippingOptions", - "title": "deleteShippingOptions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/deleteShippingProfiles", - "title": "deleteShippingProfiles", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/listAndCountFulfillmentSets", - "title": "listAndCountFulfillmentSets", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/listAndCountFulfillments", - "title": "listAndCountFulfillments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/listAndCountGeoZones", - "title": "listAndCountGeoZones", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/listAndCountServiceZones", - "title": "listAndCountServiceZones", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/listAndCountShippingOptionRules", - "title": "listAndCountShippingOptionRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/listAndCountShippingOptionTypes", - "title": "listAndCountShippingOptionTypes", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/listAndCountShippingOptions", - "title": "listAndCountShippingOptions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/listAndCountShippingProfiles", - "title": "listAndCountShippingProfiles", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/listFulfillmentProviders", - "title": "listFulfillmentProviders", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/listFulfillmentSets", - "title": "listFulfillmentSets", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/listFulfillments", - "title": "listFulfillments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/listGeoZones", - "title": "listGeoZones", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/listServiceZones", - "title": "listServiceZones", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/listShippingOptionRules", - "title": "listShippingOptionRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/listShippingOptionTypes", - "title": "listShippingOptionTypes", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/listShippingOptions", - "title": "listShippingOptions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/listShippingOptionsForContext", - "title": "listShippingOptionsForContext", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/listShippingProfiles", - "title": "listShippingProfiles", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/restoreFulfillmentSets", - "title": "restoreFulfillmentSets", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/restoreGeoZones", - "title": "restoreGeoZones", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/restoreServiceZones", - "title": "restoreServiceZones", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/restoreShippingOptions", - "title": "restoreShippingOptions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/restoreShippingProfiles", - "title": "restoreShippingProfiles", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/retrieveFulfillment", - "title": "retrieveFulfillment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/retrieveFulfillmentOptions", - "title": "retrieveFulfillmentOptions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/retrieveFulfillmentSet", - "title": "retrieveFulfillmentSet", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/retrieveGeoZone", - "title": "retrieveGeoZone", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/retrieveServiceZone", - "title": "retrieveServiceZone", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/retrieveShippingOption", - "title": "retrieveShippingOption", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/retrieveShippingOptionRule", - "title": "retrieveShippingOptionRule", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/retrieveShippingOptionType", - "title": "retrieveShippingOptionType", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/retrieveShippingProfile", - "title": "retrieveShippingProfile", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/softDeleteFulfillmentSets", - "title": "softDeleteFulfillmentSets", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/softDeleteGeoZones", - "title": "softDeleteGeoZones", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/softDeleteServiceZones", - "title": "softDeleteServiceZones", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/softDeleteShippingOptions", - "title": "softDeleteShippingOptions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/softDeleteShippingProfiles", - "title": "softDeleteShippingProfiles", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/updateFulfillment", - "title": "updateFulfillment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/updateFulfillmentSets", - "title": "updateFulfillmentSets", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/updateGeoZones", - "title": "updateGeoZones", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/updateServiceZones", - "title": "updateServiceZones", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/updateShippingOptionRules", - "title": "updateShippingOptionRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/updateShippingOptions", - "title": "updateShippingOptions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/updateShippingProfiles", - "title": "updateShippingProfiles", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/upsertServiceZones", - "title": "upsertServiceZones", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/upsertShippingOptions", - "title": "upsertShippingOptions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/upsertShippingProfiles", - "title": "upsertShippingProfiles", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/validateFulfillmentData", - "title": "validateFulfillmentData", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/validateFulfillmentOption", - "title": "validateFulfillmentOption", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/validateShippingOption", - "title": "validateShippingOption", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/validateShippingOptionsForPriceCalculation", - "title": "validateShippingOptionsForPriceCalculation", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/models", - "title": "Data Models Reference", - "isChildSidebar": true, - "childSidebarTitle": "Fulfillment Module Data Models Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Data Models", - "hasTitleStyling": true, - "autogenerate_path": "/references/fulfillment_models/variables", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/models/Fulfillment", - "title": "Fulfillment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/models/FulfillmentAddress", - "title": "FulfillmentAddress", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/models/FulfillmentItem", - "title": "FulfillmentItem", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/models/FulfillmentLabel", - "title": "FulfillmentLabel", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/models/FulfillmentProvider", - "title": "FulfillmentProvider", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/models/FulfillmentSet", - "title": "FulfillmentSet", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/models/GeoZone", - "title": "GeoZone", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/models/ServiceZone", - "title": "ServiceZone", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/models/ShippingOption", - "title": "ShippingOption", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/models/ShippingOptionRule", - "title": "ShippingOptionRule", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/models/ShippingOptionType", - "title": "ShippingOptionType", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/models/ShippingProfile", - "title": "ShippingProfile", - "description": "", - "children": [] - } - ] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Inventory Module", - "isChildSidebar": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/inventory", - "title": "Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Concepts", - "initialOpen": false, - "autogenerate_tags": "concept+inventory", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/inventory/concepts", - "title": "Inventory Concepts", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/inventory/inventory-in-flows", - "title": "Inventory in Flows", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/inventory/inventory-kit", - "title": "Inventory Kit", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/inventory/links-to-other-modules", - "title": "Links to Modules", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Inventory Kits", - "path": "https://docs.medusajs.com/resources/commerce-modules/inventory/inventory-kit", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Product Variant Inventory", - "path": "https://docs.medusajs.com/resources/commerce-modules/product/variant-inventory", + "path": "/integrations/guides/resend", + "title": "Resend", "children": [] } ] @@ -4986,3957 +17417,7 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "category", - "title": "Storefront Guides", - "autogenerate_tags": "storefront+inventory,-jsSdk", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to integrate the Inventory Module's features into your storefront.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Retrieve Product Variant's Inventory in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/products/inventory", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Admin User Guides", - "autogenerate_tags": "userGuide+inventory", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to utilize and manage Inventory features in the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Inventory Items", - "path": "https://docs.medusajs.com/user-guide/inventory/inventory", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Inventory Overview", - "path": "https://docs.medusajs.com/user-guide/inventory", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Reservations", - "path": "https://docs.medusajs.com/user-guide/inventory/reservations", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "initialOpen": false, - "description": "Find references for tools and resources related to the Inventory Module, such as data models, methods, and more. These are useful for your customizations.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/inventory/workflows", - "title": "Workflows", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+inventory", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addToCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addToCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "completeCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/completeCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmVariantInventoryWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmVariantInventoryWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateLineItemInCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateLineItemInCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchInventoryItemLevelsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchInventoryItemLevelsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "bulkCreateDeleteLevelsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/bulkCreateDeleteLevelsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createInventoryItemsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createInventoryItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createInventoryLevelsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createInventoryLevelsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteInventoryItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteInventoryItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateInventoryItemsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateInventoryItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateInventoryLevelsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateInventoryLevelsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addOrderLineItemsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addOrderLineItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderClaimWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderClaimWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderExchangeWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderExchangeWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderFulfillmentWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderFulfillmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmClaimRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmClaimRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmExchangeRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmExchangeRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmOrderEditRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmOrderEditRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmReturnReceiveWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmReturnReceiveWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderFulfillmentWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderFulfillmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderClaimAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderEditAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderEditAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderExchangeAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderExchangeAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchProductVariantsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductVariantsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchProductsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductVariantsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductVariantsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductVariantsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteProductVariantsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createReservationsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createReservationsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteReservationsByLineItemsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteReservationsByLineItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteReservationsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteReservationsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateReservationsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateReservationsWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+inventory", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmInventoryStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/confirmInventoryStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "reserveInventoryStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/reserveInventoryStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "adjustInventoryLevelsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/adjustInventoryLevelsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createInventoryItemsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createInventoryItemsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createInventoryLevelsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createInventoryLevelsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteInventoryItemStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteInventoryItemStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateInventoryItemsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateInventoryItemsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateInventoryLevelsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateInventoryLevelsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createReservationsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createReservationsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteReservationsByLineItemsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteReservationsByLineItemsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteReservationsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteReservationsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateReservationsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateReservationsStep", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/inventory/js-sdk", - "title": "JS SDK", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+inventory", - "description": "The following methods or properties are used to send requests to Admin API Routes related to the Inventory Module.", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "inventoryItem", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/inventoryItem", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "reservation", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/reservation", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/inventory/admin-widget-zones", - "title": "Admin Widget Zones", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next", - "title": "Main Service Reference", - "isChildSidebar": true, - "childSidebarTitle": "Inventory Module's Main Service Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Methods", - "autogenerate_path": "/references/inventory_next/IInventoryService/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/adjustInventory", - "title": "adjustInventory", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/confirmInventory", - "title": "confirmInventory", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/createInventoryItems", - "title": "createInventoryItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/createInventoryLevels", - "title": "createInventoryLevels", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/createReservationItems", - "title": "createReservationItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/deleteInventoryItemLevelByLocationId", - "title": "deleteInventoryItemLevelByLocationId", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/deleteInventoryItems", - "title": "deleteInventoryItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/deleteInventoryLevel", - "title": "deleteInventoryLevel", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/deleteInventoryLevels", - "title": "deleteInventoryLevels", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/deleteReservationItemByLocationId", - "title": "deleteReservationItemByLocationId", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/deleteReservationItems", - "title": "deleteReservationItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/deleteReservationItemsByLineItem", - "title": "deleteReservationItemsByLineItem", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/listAndCountInventoryItems", - "title": "listAndCountInventoryItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/listAndCountInventoryLevels", - "title": "listAndCountInventoryLevels", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/listAndCountReservationItems", - "title": "listAndCountReservationItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/listInventoryItems", - "title": "listInventoryItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/listInventoryLevels", - "title": "listInventoryLevels", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/listReservationItems", - "title": "listReservationItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/restoreInventoryItems", - "title": "restoreInventoryItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/restoreInventoryLevels", - "title": "restoreInventoryLevels", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/restoreReservationItems", - "title": "restoreReservationItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/restoreReservationItemsByLineItem", - "title": "restoreReservationItemsByLineItem", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/retrieveAvailableQuantity", - "title": "retrieveAvailableQuantity", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/retrieveInventoryItem", - "title": "retrieveInventoryItem", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/retrieveInventoryLevel", - "title": "retrieveInventoryLevel", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/retrieveInventoryLevelByItemAndLocation", - "title": "retrieveInventoryLevelByItemAndLocation", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/retrieveReservationItem", - "title": "retrieveReservationItem", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/retrieveReservedQuantity", - "title": "retrieveReservedQuantity", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/retrieveStockedQuantity", - "title": "retrieveStockedQuantity", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/softDeleteInventoryItems", - "title": "softDeleteInventoryItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/softDeleteInventoryLevels", - "title": "softDeleteInventoryLevels", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/softDeleteReservationItems", - "title": "softDeleteReservationItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/updateInventoryItems", - "title": "updateInventoryItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/updateInventoryLevels", - "title": "updateInventoryLevels", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/updateReservationItems", - "title": "updateReservationItems", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/models", - "title": "Data Models Reference", - "isChildSidebar": true, - "childSidebarTitle": "Inventory Module Data Models Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Data Models", - "autogenerate_path": "/references/inventory_next_models/variables", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/models/InventoryItem", - "title": "InventoryItem", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/models/InventoryLevel", - "title": "InventoryLevel", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/models/ReservationItem", - "title": "ReservationItem", - "description": "", - "children": [] - } - ] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Order Module", - "isChildSidebar": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/order", - "title": "Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Concepts", - "initialOpen": false, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/order/concepts", - "title": "Order Concepts", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/order/promotion-adjustments", - "title": "Promotions Adjustments", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/order/tax-lines", - "title": "Tax Lines", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/order/transactions", - "title": "Transactions", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/order/order-versioning", - "title": "Order Versioning", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/order/return", - "title": "Return", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/order/exchange", - "title": "Exchange", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/order/claim", - "title": "Claim", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/order/edit", - "title": "Order Edit", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/order/order-change", - "title": "Order Change", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/order/links-to-other-modules", - "title": "Links to Other Modules", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Server Guides", - "autogenerate_tags": "server+order", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to use the Order Module in your customizations on the Medusa application server.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Implement Quote Management", - "path": "https://docs.medusajs.com/resources/examples/guides/quote-management", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Storefront Guides", - "autogenerate_tags": "storefront+order,-jsSdk", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to integrate the Order Module's features into your storefront.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Checkout Step 5: Complete Cart", - "path": "https://docs.medusajs.com/resources/storefront-development/checkout/complete-cart", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Admin User Guides", - "autogenerate_tags": "userGuide+order", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to utilize and manage Order features in the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Order Claims", - "path": "https://docs.medusajs.com/user-guide/orders/claims", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Edit Order Items", - "path": "https://docs.medusajs.com/user-guide/orders/edit", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Order Exchanges", - "path": "https://docs.medusajs.com/user-guide/orders/exchanges", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Order Fulfillments", - "path": "https://docs.medusajs.com/user-guide/orders/fulfillments", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Order Details", - "path": "https://docs.medusajs.com/user-guide/orders/manage", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Orders Overview", - "path": "https://docs.medusajs.com/user-guide/orders", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Order Payments", - "path": "https://docs.medusajs.com/user-guide/orders/payments", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Order Returns", - "path": "https://docs.medusajs.com/user-guide/orders/returns", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Return Reasons", - "path": "https://docs.medusajs.com/user-guide/settings/return-reasons", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "initialOpen": false, - "description": "Find references for tools and resources related to the Order Module, such as data models, methods, and more. These are useful for your customizations.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/order/workflows", - "title": "Workflows", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+order", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "completeCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/completeCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "acceptOrderTransferWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/acceptOrderTransferWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addOrderLineItemsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addOrderLineItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "archiveOrderWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/archiveOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "beginClaimOrderWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/beginClaimOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "beginExchangeOrderWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/beginExchangeOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "beginOrderEditOrderWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/beginOrderEditOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "beginReceiveReturnWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/beginReceiveReturnWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "beginReturnOrderWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/beginReturnOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelBeginOrderClaimWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelBeginOrderClaimWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelBeginOrderEditWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelBeginOrderEditWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelBeginOrderExchangeWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelBeginOrderExchangeWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderChangeWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderChangeWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderClaimWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderClaimWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderExchangeWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderExchangeWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderFulfillmentWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderFulfillmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderTransferRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderTransferRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelReturnReceiveWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelReturnReceiveWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelReturnRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelReturnRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelReturnWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelReturnWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "completeOrderWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/completeOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmClaimRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmClaimRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmExchangeRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmExchangeRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmOrderEditRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmOrderEditRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmReturnReceiveWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmReturnReceiveWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmReturnRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmReturnRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createAndCompleteReturnOrderWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createAndCompleteReturnOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createClaimShippingMethodWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createClaimShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createExchangeShippingMethodWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createExchangeShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderChangeWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderChangeWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderEditShippingMethodWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderEditShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderFulfillmentWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderFulfillmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderShipmentWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderShipmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createReturnShippingMethodWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createReturnShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "declineOrderChangeWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/declineOrderChangeWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "declineOrderTransferRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/declineOrderTransferRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteOrderChangeActionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteOrderChangeActionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteOrderChangeWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteOrderChangeWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "dismissItemReturnRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/dismissItemReturnRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "markPaymentCollectionAsPaid", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/markPaymentCollectionAsPaid", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderClaimAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderClaimItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderClaimRequestItemReturnWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimRequestItemReturnWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderEditAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderEditAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderEditUpdateItemQuantityWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderEditUpdateItemQuantityWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderExchangeAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderExchangeAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderExchangeRequestItemReturnWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderExchangeRequestItemReturnWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "receiveItemReturnRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/receiveItemReturnRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeAddItemClaimActionWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeAddItemClaimActionWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeClaimShippingMethodWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeClaimShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeExchangeShippingMethodWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeExchangeShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeItemClaimActionWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeItemClaimActionWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeItemExchangeActionWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeItemExchangeActionWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeItemOrderEditActionWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeItemOrderEditActionWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeItemReceiveReturnActionWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeItemReceiveReturnActionWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeItemReturnActionWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeItemReturnActionWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeOrderEditShippingMethodWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeOrderEditShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeReturnShippingMethodWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeReturnShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "requestItemReturnWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/requestItemReturnWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "requestOrderEditRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/requestOrderEditRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "requestOrderTransferWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/requestOrderTransferWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateClaimAddItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateClaimAddItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateClaimItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateClaimItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateClaimShippingMethodWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateClaimShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateExchangeAddItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateExchangeAddItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateExchangeShippingMethodWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateExchangeShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateOrderChangeActionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateOrderChangeActionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateOrderChangesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateOrderChangesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateOrderEditAddItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateOrderEditAddItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateOrderEditItemQuantityWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateOrderEditItemQuantityWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateOrderEditShippingMethodWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateOrderEditShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateOrderTaxLinesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateOrderTaxLinesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateOrderWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateReceiveItemReturnRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateReceiveItemReturnRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateRequestItemReturnWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateRequestItemReturnWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateReturnShippingMethodWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateReturnShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateReturnWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateReturnWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "capturePaymentWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/capturePaymentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "processPaymentWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/processPaymentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refundPaymentWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refundPaymentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refundPaymentsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refundPaymentsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createReturnReasonsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createReturnReasonsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteReturnReasonsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteReturnReasonsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateReturnReasonsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateReturnReasonsWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+order", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addOrderTransactionStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/addOrderTransactionStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "archiveOrdersStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/archiveOrdersStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderChangeStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/cancelOrderChangeStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderClaimStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/cancelOrderClaimStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderExchangeStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/cancelOrderExchangeStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderFulfillmentStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/cancelOrderFulfillmentStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderReturnStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/cancelOrderReturnStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrdersStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/cancelOrdersStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "completeOrdersStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/completeOrdersStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCompleteReturnStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createCompleteReturnStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderChangeStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createOrderChangeStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderClaimItemsFromActionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createOrderClaimItemsFromActionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderClaimsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createOrderClaimsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderExchangeItemsFromActionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createOrderExchangeItemsFromActionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderExchangesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createOrderExchangesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderLineItemsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createOrderLineItemsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrdersStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createOrdersStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createReturnsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createReturnsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "declineOrderChangeStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/declineOrderChangeStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteClaimsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteClaimsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteExchangesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteExchangesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteOrderChangeActionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteOrderChangeActionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteOrderChangesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteOrderChangesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteOrderShippingMethods", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteOrderShippingMethods", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteReturnsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteReturnsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "previewOrderChangeStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/previewOrderChangeStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "registerOrderChangesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/registerOrderChangesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "registerOrderFulfillmentStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/registerOrderFulfillmentStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "registerOrderShipmentStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/registerOrderShipmentStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "setOrderTaxLinesForItemsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/setOrderTaxLinesForItemsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateOrderChangeActionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateOrderChangeActionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateOrderChangesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateOrderChangesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateOrderShippingMethodsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateOrderShippingMethodsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateOrdersStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateOrdersStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createReturnReasonsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createReturnReasonsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteReturnReasonStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteReturnReasonStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateReturnReasonsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateReturnReasonsStep", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/order/js-sdk", - "title": "JS SDK", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Store", - "autogenerate_tags": "jsSdk+storefront+order", - "description": "The following methods or properties are used to send requests to Store API Routes related to the Order Module.", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Implement Express Checkout with Medusa", - "path": "https://docs.medusajs.com/resources/storefront-development/guides/express-checkout", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "order", - "path": "https://docs.medusajs.com/resources/references/js-sdk/store/order", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+order", - "description": "The following methods or properties are used to send requests to Admin API Routes related to the Order Module.", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "claim", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/claim", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "exchange", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/exchange", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "order", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/order", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderEdit", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/orderEdit", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refundReason", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/refundReason", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "return", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/return", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "returnReason", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/returnReason", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/order/events", - "title": "Events Reference", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/order/admin-widget-zones", - "title": "Admin Widget Zones", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order", - "title": "Main Service Reference", - "isChildSidebar": true, - "childSidebarTitle": "Order Module's Main Service Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Methods", - "autogenerate_path": "/references/order/IOrderModuleService/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/addOrderAction", - "title": "addOrderAction", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/addOrderTransactions", - "title": "addOrderTransactions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/applyPendingOrderActions", - "title": "applyPendingOrderActions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/archive", - "title": "archive", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/cancel", - "title": "cancel", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/cancelClaim", - "title": "cancelClaim", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/cancelExchange", - "title": "cancelExchange", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/cancelFulfillment", - "title": "cancelFulfillment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/cancelOrderChange", - "title": "cancelOrderChange", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/cancelReturn", - "title": "cancelReturn", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/completeOrder", - "title": "completeOrder", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/confirmOrderChange", - "title": "confirmOrderChange", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createClaim", - "title": "createClaim", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createExchange", - "title": "createExchange", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createOrderAddresses", - "title": "createOrderAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createOrderChange", - "title": "createOrderChange", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createOrderClaimItems", - "title": "createOrderClaimItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createOrderClaims", - "title": "createOrderClaims", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createOrderCreditLines", - "title": "createOrderCreditLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createOrderExchangeItems", - "title": "createOrderExchangeItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createOrderExchanges", - "title": "createOrderExchanges", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createOrderLineItemAdjustments", - "title": "createOrderLineItemAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createOrderLineItemTaxLines", - "title": "createOrderLineItemTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createOrderLineItems", - "title": "createOrderLineItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createOrderShippingMethodAdjustments", - "title": "createOrderShippingMethodAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createOrderShippingMethodTaxLines", - "title": "createOrderShippingMethodTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createOrderShippingMethods", - "title": "createOrderShippingMethods", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createOrders", - "title": "createOrders", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createReturn", - "title": "createReturn", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createReturnItems", - "title": "createReturnItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createReturnReasons", - "title": "createReturnReasons", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createReturns", - "title": "createReturns", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/declineOrderChange", - "title": "declineOrderChange", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/deleteOrderAddresses", - "title": "deleteOrderAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/deleteOrderChangeActions", - "title": "deleteOrderChangeActions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/deleteOrderChanges", - "title": "deleteOrderChanges", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/deleteOrderClaimItemImages", - "title": "deleteOrderClaimItemImages", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/deleteOrderClaimItems", - "title": "deleteOrderClaimItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/deleteOrderClaims", - "title": "deleteOrderClaims", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/deleteOrderExchangeItems", - "title": "deleteOrderExchangeItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/deleteOrderExchanges", - "title": "deleteOrderExchanges", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/deleteOrderLineItemAdjustments", - "title": "deleteOrderLineItemAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/deleteOrderLineItemTaxLines", - "title": "deleteOrderLineItemTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/deleteOrderLineItems", - "title": "deleteOrderLineItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/deleteOrderShippingMethodAdjustments", - "title": "deleteOrderShippingMethodAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/deleteOrderShippingMethodTaxLines", - "title": "deleteOrderShippingMethodTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/deleteOrderShippingMethods", - "title": "deleteOrderShippingMethods", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/deleteOrderTransactions", - "title": "deleteOrderTransactions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/deleteOrders", - "title": "deleteOrders", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/deleteReturnItems", - "title": "deleteReturnItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/deleteReturnReasons", - "title": "deleteReturnReasons", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/deleteReturns", - "title": "deleteReturns", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/listAndCountOrderClaims", - "title": "listAndCountOrderClaims", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/listAndCountOrderExchanges", - "title": "listAndCountOrderExchanges", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/listAndCountOrders", - "title": "listAndCountOrders", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/listAndCountReturns", - "title": "listAndCountReturns", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/listOrderAddresses", - "title": "listOrderAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/listOrderChangeActions", - "title": "listOrderChangeActions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/listOrderChanges", - "title": "listOrderChanges", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/listOrderClaims", - "title": "listOrderClaims", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/listOrderExchanges", - "title": "listOrderExchanges", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/listOrderLineItemAdjustments", - "title": "listOrderLineItemAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/listOrderLineItemTaxLines", - "title": "listOrderLineItemTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/listOrderLineItems", - "title": "listOrderLineItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/listOrderShippingMethodAdjustments", - "title": "listOrderShippingMethodAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/listOrderShippingMethodTaxLines", - "title": "listOrderShippingMethodTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/listOrderShippingMethods", - "title": "listOrderShippingMethods", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/listOrderTransactions", - "title": "listOrderTransactions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/listOrders", - "title": "listOrders", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/listReturnReasons", - "title": "listReturnReasons", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/listReturns", - "title": "listReturns", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/previewOrderChange", - "title": "previewOrderChange", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/receiveReturn", - "title": "receiveReturn", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/registerDelivery", - "title": "registerDelivery", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/registerFulfillment", - "title": "registerFulfillment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/registerOrderChange", - "title": "registerOrderChange", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/registerShipment", - "title": "registerShipment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/restoreOrderAddresses", - "title": "restoreOrderAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/restoreOrderChangeActions", - "title": "restoreOrderChangeActions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/restoreOrderChanges", - "title": "restoreOrderChanges", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/restoreOrderClaims", - "title": "restoreOrderClaims", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/restoreOrderExchanges", - "title": "restoreOrderExchanges", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/restoreOrderLineItemAdjustments", - "title": "restoreOrderLineItemAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/restoreOrderLineItemTaxLines", - "title": "restoreOrderLineItemTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/restoreOrderLineItems", - "title": "restoreOrderLineItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/restoreOrderShippingMethodAdjustments", - "title": "restoreOrderShippingMethodAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/restoreOrderShippingMethodTaxLines", - "title": "restoreOrderShippingMethodTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/restoreOrderShippingMethods", - "title": "restoreOrderShippingMethods", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/restoreOrderTransactions", - "title": "restoreOrderTransactions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/restoreOrders", - "title": "restoreOrders", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/restoreReturnReasons", - "title": "restoreReturnReasons", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/restoreReturns", - "title": "restoreReturns", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/retrieveOrder", - "title": "retrieveOrder", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/retrieveOrderChange", - "title": "retrieveOrderChange", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/retrieveOrderChangeAction", - "title": "retrieveOrderChangeAction", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/retrieveOrderClaim", - "title": "retrieveOrderClaim", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/retrieveOrderExchange", - "title": "retrieveOrderExchange", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/retrieveOrderLineItem", - "title": "retrieveOrderLineItem", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/retrieveReturn", - "title": "retrieveReturn", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/retrieveReturnReason", - "title": "retrieveReturnReason", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/revertLastVersion", - "title": "revertLastVersion", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/setOrderLineItemAdjustments", - "title": "setOrderLineItemAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/setOrderLineItemTaxLines", - "title": "setOrderLineItemTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/setOrderShippingMethodAdjustments", - "title": "setOrderShippingMethodAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/setOrderShippingMethodTaxLines", - "title": "setOrderShippingMethodTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/softDeleteOrderAddresses", - "title": "softDeleteOrderAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/softDeleteOrderChangeActions", - "title": "softDeleteOrderChangeActions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/softDeleteOrderChanges", - "title": "softDeleteOrderChanges", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/softDeleteOrderClaims", - "title": "softDeleteOrderClaims", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/softDeleteOrderExchanges", - "title": "softDeleteOrderExchanges", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/softDeleteOrderLineItemAdjustments", - "title": "softDeleteOrderLineItemAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/softDeleteOrderLineItemTaxLines", - "title": "softDeleteOrderLineItemTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/softDeleteOrderLineItems", - "title": "softDeleteOrderLineItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/softDeleteOrderShippingMethodAdjustments", - "title": "softDeleteOrderShippingMethodAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/softDeleteOrderShippingMethodTaxLines", - "title": "softDeleteOrderShippingMethodTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/softDeleteOrderShippingMethods", - "title": "softDeleteOrderShippingMethods", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/softDeleteOrderTransactions", - "title": "softDeleteOrderTransactions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/softDeleteOrders", - "title": "softDeleteOrders", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/softDeleteReturnReasons", - "title": "softDeleteReturnReasons", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/softDeleteReturns", - "title": "softDeleteReturns", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/undoLastChange", - "title": "undoLastChange", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/updateOrderAddresses", - "title": "updateOrderAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/updateOrderChangeActions", - "title": "updateOrderChangeActions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/updateOrderChanges", - "title": "updateOrderChanges", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/updateOrderClaims", - "title": "updateOrderClaims", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/updateOrderExchanges", - "title": "updateOrderExchanges", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/updateOrderItem", - "title": "updateOrderItem", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/updateOrderLineItems", - "title": "updateOrderLineItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/updateOrderShippingMethods", - "title": "updateOrderShippingMethods", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/updateOrders", - "title": "updateOrders", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/updateReturnReasons", - "title": "updateReturnReasons", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/updateReturns", - "title": "updateReturns", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/upsertOrderLineItemAdjustments", - "title": "upsertOrderLineItemAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/upsertOrderLineItemTaxLines", - "title": "upsertOrderLineItemTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/upsertOrderShippingMethodAdjustments", - "title": "upsertOrderShippingMethodAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/upsertOrderShippingMethodTaxLines", - "title": "upsertOrderShippingMethodTaxLines", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models", - "title": "Data Models Reference", - "isChildSidebar": true, - "childSidebarTitle": "Order Module Data Models Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Data Models", - "hasTitleStyling": true, - "autogenerate_path": "/references/order_models/variables", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/Order", - "title": "Order", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/OrderAddress", - "title": "OrderAddress", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/OrderChange", - "title": "OrderChange", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/OrderChangeAction", - "title": "OrderChangeAction", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/OrderClaim", - "title": "OrderClaim", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/OrderClaimItem", - "title": "OrderClaimItem", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/OrderClaimItemImage", - "title": "OrderClaimItemImage", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/OrderCreditLine", - "title": "OrderCreditLine", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/OrderExchange", - "title": "OrderExchange", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/OrderExchangeItem", - "title": "OrderExchangeItem", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/OrderItem", - "title": "OrderItem", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/OrderLineItem", - "title": "OrderLineItem", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/OrderLineItemAdjustment", - "title": "OrderLineItemAdjustment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/OrderLineItemTaxLine", - "title": "OrderLineItemTaxLine", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/OrderShipping", - "title": "OrderShipping", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/OrderShippingMethod", - "title": "OrderShippingMethod", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/OrderShippingMethodAdjustment", - "title": "OrderShippingMethodAdjustment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/OrderShippingMethodTaxLine", - "title": "OrderShippingMethodTaxLine", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/OrderSummary", - "title": "OrderSummary", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/OrderTransaction", - "title": "OrderTransaction", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/Return", - "title": "Return", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/ReturnItem", - "title": "ReturnItem", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/ReturnReason", - "title": "ReturnReason", - "description": "", - "children": [] - } - ] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Payment Module", - "isChildSidebar": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/payment", - "title": "Overview", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/payment/module-options", - "title": "Module Options", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Concepts", - "initialOpen": false, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/payment/payment-collection", - "title": "Payment Collections", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/payment/payment-session", - "title": "Payment Session", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/payment/payment", - "title": "Payment", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/payment/payment-provider", - "title": "Payment Provider Module", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/payment/account-holder", - "title": "Account Holder", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/payment/webhook-events", - "title": "Webhook Events", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/payment/links-to-other-modules", - "title": "Links to Other Modules", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Server Guides", - "autogenerate_tags": "server+payment", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to use the Payment Module in your customizations on the Medusa application server.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/payment/payment-flow", - "title": "Accept Payment Flow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/provider", - "title": "Create Payment Provider", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Storefront Guides", - "autogenerate_tags": "storefront+payment,-jsSdk", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to integrate the Payment Module's features into your storefront.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Customize the Stripe Integration in the Next.js Starter", - "path": "https://docs.medusajs.com/resources/nextjs-starter/guides/customize-stripe", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Checkout Step 5: Complete Cart", - "path": "https://docs.medusajs.com/resources/storefront-development/checkout/complete-cart", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Checkout Step 4: Choose Payment Provider", - "path": "https://docs.medusajs.com/resources/storefront-development/checkout/payment", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Payment with Stripe in React Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/checkout/payment/stripe", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Admin User Guides", - "autogenerate_tags": "userGuide+payment", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to utilize and manage Payment features in the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Order Payments", - "path": "https://docs.medusajs.com/user-guide/orders/payments", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Providers", - "initialOpen": false, + "title": "Payment", "children": [ { "loaded": true, @@ -8947,948 +17428,38 @@ export const generatedSidebar = [ "children": [] } ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "plugins", + "title": "Plugins", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Overview", + "path": "/plugins", + "children": [] }, { "loaded": true, "isPathHref": true, "type": "category", - "title": "References", - "initialOpen": false, - "description": "Find references for tools and resources related to the Payment Module, such as data models, methods, and more. These are useful for your customizations.", + "title": "Guides", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "path": "/commerce-modules/payment/workflows", - "title": "Workflows", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+payment", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addShippingMethodToCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addShippingMethodToCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addToCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addToCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "completeCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/completeCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPaymentCollectionForCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createPaymentCollectionForCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refreshCartItemsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshCartItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refreshPaymentCollectionForCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshPaymentCollectionForCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "transferCartCustomerWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/transferCartCustomerWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateLineItemInCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateLineItemInCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteLineItemsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteLineItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmClaimRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmClaimRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmExchangeRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmExchangeRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmOrderEditRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmOrderEditRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmReturnRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmReturnRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrUpdateOrderPaymentCollectionWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrUpdateOrderPaymentCollectionWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderPaymentCollectionWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderPaymentCollectionWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "markPaymentCollectionAsPaid", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/markPaymentCollectionAsPaid", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "requestOrderEditRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/requestOrderEditRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "capturePaymentWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/capturePaymentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "processPaymentWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/processPaymentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refundPaymentWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refundPaymentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refundPaymentsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refundPaymentsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPaymentSessionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createPaymentSessionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createRefundReasonsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createRefundReasonsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deletePaymentSessionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deletePaymentSessionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteRefundReasonsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteRefundReasonsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateRefundReasonsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateRefundReasonsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createRegionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createRegionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateRegionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateRegionsWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+payment", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPaymentCollectionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createPaymentCollectionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "authorizePaymentSessionStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/authorizePaymentSessionStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelPaymentStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/cancelPaymentStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "capturePaymentStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/capturePaymentStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refundPaymentStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/refundPaymentStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refundPaymentsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/refundPaymentsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPaymentAccountHolderStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createPaymentAccountHolderStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPaymentSessionStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createPaymentSessionStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createRefundReasonStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createRefundReasonStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deletePaymentSessionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deletePaymentSessionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteRefundReasonsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteRefundReasonsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePaymentCollectionStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updatePaymentCollectionStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateRefundReasonsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateRefundReasonsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "setRegionsPaymentProvidersStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/setRegionsPaymentProvidersStep", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/payment/js-sdk", - "title": "JS SDK", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Store", - "autogenerate_tags": "jsSdk+storefront+payment", - "description": "The following methods or properties are used to send requests to Store API Routes related to the Payment Module.", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Implement Express Checkout with Medusa", - "path": "https://docs.medusajs.com/resources/storefront-development/guides/express-checkout", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "payment", - "path": "https://docs.medusajs.com/resources/references/js-sdk/store/payment", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+payment", - "description": "The following methods or properties are used to send requests to Admin API Routes related to the Payment Module.", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "payment", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/payment", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "paymentCollection", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/paymentCollection", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/payment/events", - "title": "Events Reference", + "title": "Wishlist", + "path": "/plugins/guides/wishlist", + "description": "Learn how to build a wishlist plugin.", "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment", - "title": "Main Service Reference", - "isChildSidebar": true, - "childSidebarTitle": "Payment Module's Main Service Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Methods", - "autogenerate_path": "/references/payment/IPaymentModuleService/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/authorizePaymentSession", - "title": "authorizePaymentSession", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/cancelPayment", - "title": "cancelPayment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/capturePayment", - "title": "capturePayment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/completePaymentCollections", - "title": "completePaymentCollections", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/createAccountHolder", - "title": "createAccountHolder", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/createPaymentCollections", - "title": "createPaymentCollections", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/createPaymentMethods", - "title": "createPaymentMethods", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/createPaymentSession", - "title": "createPaymentSession", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/createRefundReasons", - "title": "createRefundReasons", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/deleteAccountHolder", - "title": "deleteAccountHolder", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/deleteCaptures", - "title": "deleteCaptures", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/deletePaymentCollections", - "title": "deletePaymentCollections", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/deletePaymentSession", - "title": "deletePaymentSession", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/deleteRefundReasons", - "title": "deleteRefundReasons", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/deleteRefunds", - "title": "deleteRefunds", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/getWebhookActionAndData", - "title": "getWebhookActionAndData", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/listAndCountPaymentCollections", - "title": "listAndCountPaymentCollections", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/listAndCountPaymentMethods", - "title": "listAndCountPaymentMethods", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/listAndCountPaymentProviders", - "title": "listAndCountPaymentProviders", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/listCaptures", - "title": "listCaptures", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/listPaymentCollections", - "title": "listPaymentCollections", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/listPaymentMethods", - "title": "listPaymentMethods", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/listPaymentProviders", - "title": "listPaymentProviders", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/listPaymentSessions", - "title": "listPaymentSessions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/listPayments", - "title": "listPayments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/listRefundReasons", - "title": "listRefundReasons", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/listRefunds", - "title": "listRefunds", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/refundPayment", - "title": "refundPayment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/restorePaymentCollections", - "title": "restorePaymentCollections", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/restoreRefundReasons", - "title": "restoreRefundReasons", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/retrievePaymentCollection", - "title": "retrievePaymentCollection", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/retrievePaymentSession", - "title": "retrievePaymentSession", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/softDeletePaymentCollections", - "title": "softDeletePaymentCollections", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/softDeleteRefundReasons", - "title": "softDeleteRefundReasons", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/updateAccountHolder", - "title": "updateAccountHolder", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/updatePayment", - "title": "updatePayment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/updatePaymentCollections", - "title": "updatePaymentCollections", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/updatePaymentSession", - "title": "updatePaymentSession", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/updateRefundReasons", - "title": "updateRefundReasons", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/upsertPaymentCollections", - "title": "upsertPaymentCollections", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/models", - "title": "Data Models Reference", - "isChildSidebar": true, - "childSidebarTitle": "Payment Module Data Models Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Data Models", - "autogenerate_path": "/references/payment_models/variables", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/models/AccountHolder", - "title": "AccountHolder", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/models/Capture", - "title": "Capture", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/models/Payment", - "title": "Payment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/models/PaymentCollection", - "title": "PaymentCollection", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/models/PaymentProvider", - "title": "PaymentProvider", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/models/PaymentSession", - "title": "PaymentSession", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/models/Refund", - "title": "Refund", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/models/RefundReason", - "title": "RefundReason", - "description": "", - "children": [] - } - ] - } - ] } ] } @@ -9897,15 +17468,15 @@ export const generatedSidebar = [ { "loaded": true, "isPathHref": true, - "type": "category", - "title": "Pricing Module", - "isChildSidebar": true, + "type": "sidebar", + "sidebar_id": "storefront-development", + "title": "Storefront Development", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "path": "/commerce-modules/pricing", + "path": "/storefront-development", "title": "Overview", "children": [] }, @@ -9916,47 +17487,22 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "category", - "title": "Concepts", - "initialOpen": false, + "title": "General", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "path": "/commerce-modules/pricing/concepts", - "title": "Pricing Concepts", + "path": "/storefront-development/tips", + "title": "Tips", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", - "path": "/commerce-modules/pricing/price-rules", - "title": "Price Rules", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/pricing/price-calculation", - "title": "Prices Calculation", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/pricing/tax-inclusive-pricing", - "title": "Tax-Inclusive Pricing", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/pricing/links-to-other-modules", - "title": "Links to Other Modules", + "path": "/storefront-development/publishable-api-keys", + "title": "Publishable API Key", "children": [] } ] @@ -9965,1804 +17511,122 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "category", - "title": "Server Guides", - "autogenerate_tags": "server+pricing", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to use the Pricing Module in your customizations on the Medusa application server.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Get Variant Prices", - "path": "https://docs.medusajs.com/resources/commerce-modules/product/guides/price", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Get Variant Price with Taxes", - "path": "https://docs.medusajs.com/resources/commerce-modules/product/guides/price-with-taxes", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Implement Custom Line Item Pricing in Medusa", - "path": "https://docs.medusajs.com/resources/examples/guides/custom-item-price", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Storefront Guides", - "autogenerate_tags": "storefront+pricing,-jsSdk", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to integrate the Pricing Module's features into your storefront.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Example: Show Sale Price", - "path": "https://docs.medusajs.com/resources/storefront-development/products/price/examples/sale-price", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Example: Show Variant's Price", - "path": "https://docs.medusajs.com/resources/storefront-development/products/price/examples/show-price", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Example: Show Price with Taxes", - "path": "https://docs.medusajs.com/resources/storefront-development/products/price/examples/tax-price", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Retrieve Product Variant's Prices in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/products/price", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Admin User Guides", - "autogenerate_tags": "userGuide+pricing", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to utilize and manage Pricing features in the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Create a Price List", - "path": "https://docs.medusajs.com/user-guide/price-lists/create", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Price Lists", - "path": "https://docs.medusajs.com/user-guide/price-lists/manage", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Price Lists Overview", - "path": "https://docs.medusajs.com/user-guide/price-lists", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "initialOpen": false, - "description": "Find references for tools and resources related to the Pricing Module, such as data models, methods, and more. These are useful for your customizations.", + "title": "Examples", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "path": "/commerce-modules/pricing/workflows", - "title": "Workflows", - "hideChildren": true, + "path": "/storefront-development/guides/express-checkout", + "title": "Express Checkout Storefront", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Regions", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/regions", + "title": "Overview", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/regions/list", + "title": "List Regions", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/regions/store-retrieve-region", + "title": "Store and Retrieve Regions", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/regions/context", + "title": "Region React Context", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Products", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/products/list", + "title": "List Products", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/products/retrieve", + "title": "Retrieve a Product", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/products/variants", + "title": "Select a Variant", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/products/price", + "title": "Retrieve Variant Prices", + "autogenerate_path": "storefront-development/products/price/examples", "children": [ { "loaded": true, "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+pricing", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createShippingOptionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createShippingOptionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateShippingOptionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateShippingOptionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchPriceListPricesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchPriceListPricesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPriceListPricesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createPriceListPricesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPriceListsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createPriceListsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deletePriceListsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deletePriceListsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removePriceListPricesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removePriceListPricesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePriceListPricesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updatePriceListPricesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePriceListsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updatePriceListsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPricePreferencesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createPricePreferencesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deletePricePreferencesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deletePricePreferencesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePricePreferencesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updatePricePreferencesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchProductVariantsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductVariantsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchProductsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductVariantsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductVariantsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductVariantsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateProductVariantsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "upsertVariantPricesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/upsertVariantPricesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createRegionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createRegionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateRegionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateRegionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createStoresWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createStoresWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateStoresWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateStoresWorkflow", - "children": [] - } - ] + "type": "link", + "path": "/storefront-development/products/price/examples/show-price", + "title": "Example: Show Variant's Price", + "description": "", + "children": [] }, { "loaded": true, "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+pricing", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createShippingOptionsPriceSetsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createShippingOptionsPriceSetsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "setShippingOptionsPricesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/setShippingOptionsPricesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPriceListPricesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createPriceListPricesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPriceListsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createPriceListsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deletePriceListsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deletePriceListsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removePriceListPricesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/removePriceListPricesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePriceListPricesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updatePriceListPricesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePriceListsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updatePriceListsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "validatePriceListsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/validatePriceListsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPricePreferencesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createPricePreferencesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPriceSetsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createPriceSetsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deletePricePreferencesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deletePricePreferencesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePricePreferencesAsArrayStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updatePricePreferencesAsArrayStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePricePreferencesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updatePricePreferencesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePriceSetsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updatePriceSetsStep", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/pricing/js-sdk", - "title": "JS SDK", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+pricing", - "description": "The following methods or properties are used to send requests to Admin API Routes related to the Pricing Module.", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "priceList", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/priceList", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "pricePreference", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/pricePreference", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/pricing/admin-widget-zones", - "title": "Admin Widget Zones", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing", - "title": "Main Service Reference", - "isChildSidebar": true, - "childSidebarTitle": "Pricing Module's Main Service Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Methods", - "autogenerate_path": "/references/pricing/IPricingModuleService/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/addPriceListPrices", - "title": "addPriceListPrices", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/addPrices", - "title": "addPrices", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/calculatePrices", - "title": "calculatePrices", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/createPriceLists", - "title": "createPriceLists", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/createPricePreferences", - "title": "createPricePreferences", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/createPriceRules", - "title": "createPriceRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/createPriceSets", - "title": "createPriceSets", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/deletePriceListRules", - "title": "deletePriceListRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/deletePriceLists", - "title": "deletePriceLists", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/deletePricePreferences", - "title": "deletePricePreferences", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/deletePriceRules", - "title": "deletePriceRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/deletePriceSets", - "title": "deletePriceSets", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/listAndCountPriceListRules", - "title": "listAndCountPriceListRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/listAndCountPriceLists", - "title": "listAndCountPriceLists", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/listAndCountPriceRules", - "title": "listAndCountPriceRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/listAndCountPriceSets", - "title": "listAndCountPriceSets", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/listAndCountPrices", - "title": "listAndCountPrices", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/listPriceListRules", - "title": "listPriceListRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/listPriceLists", - "title": "listPriceLists", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/listPricePreferences", - "title": "listPricePreferences", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/listPriceRules", - "title": "listPriceRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/listPriceSets", - "title": "listPriceSets", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/listPrices", - "title": "listPrices", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/removePriceListRules", - "title": "removePriceListRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/removePrices", - "title": "removePrices", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/restorePriceLists", - "title": "restorePriceLists", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/restorePricePreferences", - "title": "restorePricePreferences", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/restorePrices", - "title": "restorePrices", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/retrievePriceList", - "title": "retrievePriceList", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/retrievePriceListRule", - "title": "retrievePriceListRule", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/retrievePricePreference", - "title": "retrievePricePreference", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/retrievePriceRule", - "title": "retrievePriceRule", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/retrievePriceSet", - "title": "retrievePriceSet", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/setPriceListRules", - "title": "setPriceListRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/softDeletePriceLists", - "title": "softDeletePriceLists", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/softDeletePricePreferences", - "title": "softDeletePricePreferences", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/softDeletePrices", - "title": "softDeletePrices", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/updatePriceListPrices", - "title": "updatePriceListPrices", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/updatePriceLists", - "title": "updatePriceLists", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/updatePricePreferences", - "title": "updatePricePreferences", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/updatePriceRules", - "title": "updatePriceRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/updatePriceSets", - "title": "updatePriceSets", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/upsertPricePreferences", - "title": "upsertPricePreferences", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/upsertPriceSets", - "title": "upsertPriceSets", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/models", - "title": "Data Models Reference", - "isChildSidebar": true, - "childSidebarTitle": "Pricing Module Data Models Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Data Models", - "hasTitleStyling": true, - "autogenerate_path": "/references/pricing_models/variables", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/models/Price", - "title": "Price", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/models/PriceList", - "title": "PriceList", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/models/PriceListRule", - "title": "PriceListRule", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/models/PricePreference", - "title": "PricePreference", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/models/PriceRule", - "title": "PriceRule", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/models/PriceSet", - "title": "PriceSet", - "description": "", - "children": [] - } - ] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Product Module", - "isChildSidebar": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/product", - "title": "Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Concepts", - "initialOpen": false, - "autogenerate_tags": "concept+product", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/product/variant-inventory", - "title": "Variant Inventory", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/product/selling-products", - "title": "Selling Use Cases", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/product/links-to-other-modules", - "title": "Links to Other Modules", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Inventory Kits", - "path": "https://docs.medusajs.com/resources/commerce-modules/inventory/inventory-kit", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Server Guides", - "autogenerate_tags": "server+product", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to use the Product Module in your customizations on the Medusa application server.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/product/extend", - "title": "Extend Module", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/product/guides/price", - "title": "Get Variant Prices", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/product/guides/price-with-taxes", - "title": "Get Variant Price with Taxes", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Get Variant Prices", - "path": "https://docs.medusajs.com/resources/commerce-modules/product/guides/price", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Get Variant Price with Taxes", - "path": "https://docs.medusajs.com/resources/commerce-modules/product/guides/price-with-taxes", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Storefront Guides", - "autogenerate_tags": "storefront+product,-jsSdk", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to integrate the Product Module's features into your storefront.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "List Product Categories in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/products/categories/list", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Retrieve Nested Categories in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/products/categories/nested-categories", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Retrieve a Category's Products in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/products/categories/products", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Retrieve a Category in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/products/categories/retrieve", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "List Product Collections in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/products/collections/list", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Retrieve a Collection's Products in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/products/collections/products", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Retrieve a Collection in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/products/collections/retrieve", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Retrieve Product Variant's Inventory in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/products/inventory", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "List Products in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/products/list", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Example: Show Sale Price", - "path": "https://docs.medusajs.com/resources/storefront-development/products/price/examples/sale-price", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Example: Show Variant's Price", - "path": "https://docs.medusajs.com/resources/storefront-development/products/price/examples/show-price", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Example: Show Price with Taxes", - "path": "https://docs.medusajs.com/resources/storefront-development/products/price/examples/tax-price", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Retrieve Product Variant's Prices in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/products/price", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Retrieve a Product in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/products/retrieve", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Select Product Variants in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/products/variants", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Admin User Guides", - "autogenerate_tags": "userGuide+product", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to utilize and manage Product features in the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Product Categories", - "path": "https://docs.medusajs.com/user-guide/products/categories", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Product Collections", - "path": "https://docs.medusajs.com/user-guide/products/collections", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Create Bundle Product", - "path": "https://docs.medusajs.com/user-guide/products/create/bundle", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Create Multi-Part Product", - "path": "https://docs.medusajs.com/user-guide/products/create/multi-part", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Create Product", - "path": "https://docs.medusajs.com/user-guide/products/create", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Edit Product", - "path": "https://docs.medusajs.com/user-guide/products/edit", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Export Products", - "path": "https://docs.medusajs.com/user-guide/products/export", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Import Products", - "path": "https://docs.medusajs.com/user-guide/products/import", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Products Overview", - "path": "https://docs.medusajs.com/user-guide/products", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Product Variants", - "path": "https://docs.medusajs.com/user-guide/products/variants", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Product Tags", - "path": "https://docs.medusajs.com/user-guide/settings/product-tags", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Product Types", - "path": "https://docs.medusajs.com/user-guide/settings/product-types", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "initialOpen": false, - "description": "Find references for tools and resources related to the Product Module, such as data models, methods, and more. These are useful for your customizations.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/product/workflows", - "title": "Workflows", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+product", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchLinkProductsToCategoryWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchLinkProductsToCategoryWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchLinkProductsToCollectionWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchLinkProductsToCollectionWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchProductVariantsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductVariantsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchProductsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCollectionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCollectionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductOptionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductOptionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductTagsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductTagsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductTypesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductTypesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductVariantsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductVariantsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteCollectionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteCollectionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductOptionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteProductOptionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductTagsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteProductTagsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductTypesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteProductTypesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductVariantsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteProductVariantsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "importProductsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/importProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCollectionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCollectionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductOptionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateProductOptionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductTagsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateProductTagsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductTypesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateProductTypesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductVariantsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateProductVariantsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductCategoriesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductCategoriesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductCategoriesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteProductCategoriesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductCategoriesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateProductCategoriesWorkflow", - "children": [] - } - ] + "type": "link", + "path": "/storefront-development/products/price/examples/sale-price", + "title": "Example: Show Sale Price", + "description": "", + "children": [] }, { "loaded": true, "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+product", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchLinkProductsToCategoryStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/batchLinkProductsToCategoryStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchLinkProductsToCollectionStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/batchLinkProductsToCollectionStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCollectionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createCollectionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductOptionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createProductOptionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductTagsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createProductTagsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductTypesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createProductTypesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductVariantsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createProductVariantsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createProductsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteCollectionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteCollectionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductOptionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteProductOptionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductTagsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteProductTagsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductTypesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteProductTypesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductVariantsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteProductVariantsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteProductsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "getProductsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/getProductsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "groupProductsForBatchStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/groupProductsForBatchStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "parseProductCsvStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/parseProductCsvStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCollectionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateCollectionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductOptionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateProductOptionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductTagsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateProductTagsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductTypesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateProductTypesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductVariantsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateProductVariantsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateProductsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductCategoriesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createProductCategoriesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductCategoriesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteProductCategoriesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductCategoriesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateProductCategoriesStep", - "children": [] - } - ] + "type": "link", + "path": "/storefront-development/products/price/examples/tax-price", + "title": "Example: Show Price with Taxes", + "description": "", + "children": [] } ] }, @@ -11770,949 +17634,8 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "link", - "path": "/commerce-modules/product/js-sdk", - "title": "JS SDK", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Store", - "autogenerate_tags": "jsSdk+storefront+product", - "description": "The following methods or properties are used to send requests to Store API Routes related to the Product Module.", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Implement Express Checkout with Medusa", - "path": "https://docs.medusajs.com/resources/storefront-development/guides/express-checkout", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "category", - "path": "https://docs.medusajs.com/resources/references/js-sdk/store/category", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "collection", - "path": "https://docs.medusajs.com/resources/references/js-sdk/store/collection", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "product", - "path": "https://docs.medusajs.com/resources/references/js-sdk/store/product", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+product", - "description": "The following methods or properties are used to send requests to Admin API Routes related to the Product Module.", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "product", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/product", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "productCategory", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/productCategory", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "productCollection", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/productCollection", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "productTag", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/productTag", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "productType", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/productType", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "productVariant", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/productVariant", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/product/events", - "title": "Events Reference", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/product/admin-widget-zones", - "title": "Admin Widget Zones", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product", - "title": "Main Service Reference", - "isChildSidebar": true, - "childSidebarTitle": "Product Module's Main Service Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Methods", - "autogenerate_path": "/references/product/IProductModuleService/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/createProductCategories", - "title": "createProductCategories", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/createProductCollections", - "title": "createProductCollections", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/createProductOptionValues", - "title": "createProductOptionValues", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/createProductOptions", - "title": "createProductOptions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/createProductTags", - "title": "createProductTags", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/createProductTypes", - "title": "createProductTypes", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/createProductVariants", - "title": "createProductVariants", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/createProducts", - "title": "createProducts", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/deleteProductCategories", - "title": "deleteProductCategories", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/deleteProductCollections", - "title": "deleteProductCollections", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/deleteProductOptionValues", - "title": "deleteProductOptionValues", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/deleteProductOptions", - "title": "deleteProductOptions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/deleteProductTags", - "title": "deleteProductTags", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/deleteProductTypes", - "title": "deleteProductTypes", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/deleteProductVariants", - "title": "deleteProductVariants", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/deleteProducts", - "title": "deleteProducts", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/listAndCountProductCategories", - "title": "listAndCountProductCategories", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/listAndCountProductCollections", - "title": "listAndCountProductCollections", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/listAndCountProductOptionValues", - "title": "listAndCountProductOptionValues", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/listAndCountProductOptions", - "title": "listAndCountProductOptions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/listAndCountProductTags", - "title": "listAndCountProductTags", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/listAndCountProductTypes", - "title": "listAndCountProductTypes", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/listAndCountProductVariants", - "title": "listAndCountProductVariants", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/listAndCountProducts", - "title": "listAndCountProducts", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/listProductCategories", - "title": "listProductCategories", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/listProductCollections", - "title": "listProductCollections", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/listProductOptionValues", - "title": "listProductOptionValues", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/listProductOptions", - "title": "listProductOptions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/listProductTags", - "title": "listProductTags", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/listProductTypes", - "title": "listProductTypes", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/listProductVariants", - "title": "listProductVariants", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/listProducts", - "title": "listProducts", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/restoreProductCategories", - "title": "restoreProductCategories", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/restoreProductCollections", - "title": "restoreProductCollections", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/restoreProductOptionValues", - "title": "restoreProductOptionValues", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/restoreProductOptions", - "title": "restoreProductOptions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/restoreProductTags", - "title": "restoreProductTags", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/restoreProductTypes", - "title": "restoreProductTypes", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/restoreProductVariants", - "title": "restoreProductVariants", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/restoreProducts", - "title": "restoreProducts", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/retrieveProduct", - "title": "retrieveProduct", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/retrieveProductCategory", - "title": "retrieveProductCategory", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/retrieveProductCollection", - "title": "retrieveProductCollection", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/retrieveProductOption", - "title": "retrieveProductOption", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/retrieveProductTag", - "title": "retrieveProductTag", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/retrieveProductType", - "title": "retrieveProductType", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/retrieveProductVariant", - "title": "retrieveProductVariant", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/softDeleteProductCategories", - "title": "softDeleteProductCategories", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/softDeleteProductCollections", - "title": "softDeleteProductCollections", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/softDeleteProductOptionValues", - "title": "softDeleteProductOptionValues", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/softDeleteProductOptions", - "title": "softDeleteProductOptions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/softDeleteProductTags", - "title": "softDeleteProductTags", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/softDeleteProductTypes", - "title": "softDeleteProductTypes", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/softDeleteProductVariants", - "title": "softDeleteProductVariants", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/softDeleteProducts", - "title": "softDeleteProducts", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/updateProductCategories", - "title": "updateProductCategories", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/updateProductCollections", - "title": "updateProductCollections", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/updateProductOptionValues", - "title": "updateProductOptionValues", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/updateProductOptions", - "title": "updateProductOptions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/updateProductTags", - "title": "updateProductTags", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/updateProductTypes", - "title": "updateProductTypes", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/updateProductVariants", - "title": "updateProductVariants", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/updateProducts", - "title": "updateProducts", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/upsertProductCategories", - "title": "upsertProductCategories", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/upsertProductCollections", - "title": "upsertProductCollections", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/upsertProductOptions", - "title": "upsertProductOptions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/upsertProductTags", - "title": "upsertProductTags", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/upsertProductTypes", - "title": "upsertProductTypes", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/upsertProductVariants", - "title": "upsertProductVariants", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/upsertProducts", - "title": "upsertProducts", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/models", - "title": "Data Models Reference", - "isChildSidebar": true, - "childSidebarTitle": "Product Module Data Models Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Data Models", - "hasTitleStyling": true, - "autogenerate_path": "/references/product_models/variables", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/models/Product", - "title": "Product", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/models/ProductCategory", - "title": "ProductCategory", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/models/ProductCollection", - "title": "ProductCollection", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/models/ProductImage", - "title": "ProductImage", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/models/ProductOption", - "title": "ProductOption", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/models/ProductOptionValue", - "title": "ProductOptionValue", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/models/ProductTag", - "title": "ProductTag", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/models/ProductType", - "title": "ProductType", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/models/ProductVariant", - "title": "ProductVariant", - "description": "", - "children": [] - } - ] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Promotion Module", - "isChildSidebar": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/promotion", - "title": "Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Concepts", - "initialOpen": false, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/promotion/concepts", - "title": "Promotion", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/promotion/application-method", - "title": "Application Method", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/promotion/campaign", - "title": "Campaign", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/promotion/actions", - "title": "Promotion Actions", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/promotion/links-to-other-modules", - "title": "Links to Modules", + "path": "/storefront-development/products/inventory", + "title": "Retrieve Variant Inventory", "children": [] } ] @@ -12721,18 +17644,38 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "category", - "title": "Server Guides", - "autogenerate_tags": "server+promotion", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to use the Promotion Module in your customizations on the Medusa application server.", + "title": "Product Categories", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "path": "/commerce-modules/promotion/extend", - "title": "Extend Module", + "path": "/storefront-development/products/categories/list", + "title": "List Categories", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/products/categories/retrieve", + "title": "Retrieve a Category", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/products/categories/products", + "title": "Retrieve a Category's Products", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/products/categories/nested-categories", + "title": "Retrieve Nested Categories", "children": [] } ] @@ -12741,42 +17684,30 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "category", - "title": "Admin User Guides", - "autogenerate_tags": "userGuide+promotion", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to utilize and manage Promotion features in the Medusa Admin dashboard.", + "title": "Product Collections", "children": [ { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "Manage Campaigns", - "path": "https://docs.medusajs.com/user-guide/promotions/campaigns", + "type": "link", + "path": "/storefront-development/products/collections/list", + "title": "List Collections", "children": [] }, { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "Create a Promotion", - "path": "https://docs.medusajs.com/user-guide/promotions/create", + "type": "link", + "path": "/storefront-development/products/collections/retrieve", + "title": "Retrieve a Collection", "children": [] }, { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "Manage Promotions", - "path": "https://docs.medusajs.com/user-guide/promotions/manage", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Promotions Overview", - "path": "https://docs.medusajs.com/user-guide/promotions", + "type": "link", + "path": "/storefront-development/products/collections/products", + "title": "Retrieve a Collection's Products", "children": [] } ] @@ -12785,765 +17716,46 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "category", - "title": "References", - "initialOpen": false, - "description": "Find references for tools and resources related to the Promotion Module, such as data models, methods, and more. These are useful for your customizations.", + "title": "Carts", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "path": "/commerce-modules/promotion/workflows", - "title": "Workflows", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+promotion", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addShippingMethodToCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addShippingMethodToCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addToCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addToCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refreshCartItemsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshCartItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "transferCartCustomerWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/transferCartCustomerWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCartPromotionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartPromotionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateLineItemInCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateLineItemInCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteLineItemsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteLineItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addOrRemoveCampaignPromotionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addOrRemoveCampaignPromotionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchPromotionRulesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchPromotionRulesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCampaignsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCampaignsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPromotionRulesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createPromotionRulesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPromotionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createPromotionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteCampaignsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteCampaignsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deletePromotionRulesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deletePromotionRulesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deletePromotionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deletePromotionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCampaignsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCampaignsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePromotionRulesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updatePromotionRulesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePromotionsStatusWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updatePromotionsStatusWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePromotionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updatePromotionsWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+promotion", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "getActionsToComputeFromPromotionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/getActionsToComputeFromPromotionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "getPromotionCodesToApply", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/getPromotionCodesToApply", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "prepareAdjustmentsFromPromotionActionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/prepareAdjustmentsFromPromotionActionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCartPromotionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateCartPromotionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addCampaignPromotionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/addCampaignPromotionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addRulesToPromotionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/addRulesToPromotionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCampaignsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createCampaignsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPromotionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createPromotionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteCampaignsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteCampaignsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deletePromotionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deletePromotionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeCampaignPromotionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/removeCampaignPromotionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeRulesFromPromotionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/removeRulesFromPromotionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCampaignsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateCampaignsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePromotionRulesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updatePromotionRulesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePromotionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updatePromotionsStep", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/promotion/js-sdk", - "title": "JS SDK", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+promotion", - "description": "The following methods or properties are used to send requests to Admin API Routes related to the Promotion Module.", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "campaign", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/campaign", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "promotion", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/promotion", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/promotion/admin-widget-zones", - "title": "Admin Widget Zones", + "path": "/storefront-development/cart/create", + "title": "Create Cart", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", - "path": "/references/promotion", - "title": "Main Service Reference", - "isChildSidebar": true, - "childSidebarTitle": "Promotion Module's Main Service Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Methods", - "hasTitleStyling": true, - "autogenerate_path": "/references/promotion/IPromotionModuleService/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/addPromotionBuyRules", - "title": "addPromotionBuyRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/addPromotionRules", - "title": "addPromotionRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/addPromotionTargetRules", - "title": "addPromotionTargetRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/addPromotionsToCampaign", - "title": "addPromotionsToCampaign", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/computeActions", - "title": "computeActions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/createCampaigns", - "title": "createCampaigns", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/createPromotions", - "title": "createPromotions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/deleteCampaigns", - "title": "deleteCampaigns", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/deletePromotions", - "title": "deletePromotions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/listAndCountCampaigns", - "title": "listAndCountCampaigns", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/listAndCountPromotions", - "title": "listAndCountPromotions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/listCampaigns", - "title": "listCampaigns", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/listPromotionRules", - "title": "listPromotionRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/listPromotions", - "title": "listPromotions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/registerUsage", - "title": "registerUsage", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/removePromotionBuyRules", - "title": "removePromotionBuyRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/removePromotionRules", - "title": "removePromotionRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/removePromotionTargetRules", - "title": "removePromotionTargetRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/removePromotionsFromCampaign", - "title": "removePromotionsFromCampaign", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/restoreCampaigns", - "title": "restoreCampaigns", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/restorePromotions", - "title": "restorePromotions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/retrieveCampaign", - "title": "retrieveCampaign", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/retrievePromotion", - "title": "retrievePromotion", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/revertUsage", - "title": "revertUsage", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/softDeleteCampaigns", - "title": "softDeleteCampaigns", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/softDeletePromotions", - "title": "softDeletePromotions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/updateCampaigns", - "title": "updateCampaigns", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/updatePromotionRules", - "title": "updatePromotionRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/updatePromotions", - "title": "updatePromotions", - "description": "", - "children": [] - } - ] - } - ] + "path": "/storefront-development/cart/retrieve", + "title": "Retrieve Cart", + "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", - "path": "/references/promotion/models", - "title": "Data Models Reference", - "isChildSidebar": true, - "childSidebarTitle": "Promotion Module Data Models Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Data Models", - "hasTitleStyling": true, - "autogenerate_path": "/references/promotion_models/variables", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/models/ApplicationMethod", - "title": "ApplicationMethod", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/models/Campaign", - "title": "Campaign", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/models/CampaignBudget", - "title": "CampaignBudget", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/models/Promotion", - "title": "Promotion", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/models/PromotionRule", - "title": "PromotionRule", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/models/PromotionRuleValue", - "title": "PromotionRuleValue", - "description": "", - "children": [] - } - ] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Region Module", - "isChildSidebar": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/region", - "title": "Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Concepts", - "initialOpen": false, - "children": [ + "path": "/storefront-development/cart/context", + "title": "Cart React Context", + "children": [] + }, { "loaded": true, "isPathHref": true, "type": "link", - "path": "/commerce-modules/region/links-to-other-modules", - "title": "Links to Modules", + "path": "/storefront-development/cart/update", + "title": "Update Cart", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/cart/manage-items", + "title": "Manage Line Items", "children": [] } ] @@ -13552,34 +17764,63 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "category", - "title": "Storefront Guides", - "autogenerate_tags": "storefront+region,-jsSdk", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to integrate the Region Module's features into your storefront.", + "title": "Checkout", "children": [ { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "Region Context in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/regions/context", + "type": "link", + "path": "/storefront-development/checkout", + "title": "Overview", "children": [] }, { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "List Regions in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/regions/list", + "type": "link", + "path": "/storefront-development/checkout/email", + "title": "1. Enter Email", "children": [] }, { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "Store and Retrieve Region", - "path": "https://docs.medusajs.com/resources/storefront-development/regions/store-retrieve-region", + "type": "link", + "path": "/storefront-development/checkout/address", + "title": "2. Set Address", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/checkout/shipping", + "title": "3. Choose Shipping Method", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/checkout/payment", + "title": "4. Choose Payment Provider", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/checkout/payment/stripe", + "title": "Example: Stripe", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/checkout/complete-cart", + "title": "5. Complete Cart", "children": [] } ] @@ -13588,3449 +17829,829 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "category", - "title": "Admin User Guides", - "autogenerate_tags": "userGuide+region", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to utilize and manage Region features in the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Regions", - "path": "https://docs.medusajs.com/user-guide/settings/regions", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "initialOpen": false, - "description": "Find references for tools and resources related to the Region Module, such as data models, methods, and more. These are useful for your customizations.", + "title": "Customers", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "path": "/commerce-modules/region/workflows", - "title": "Workflows", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+region", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createShippingOptionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createShippingOptionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateShippingOptionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateShippingOptionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addOrderLineItemsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addOrderLineItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderClaimAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderEditAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderEditAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderExchangeAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderExchangeAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "exportProductsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/exportProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "importProductsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/importProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createRegionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createRegionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteRegionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteRegionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateRegionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateRegionsWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+region", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "findOneOrAnyRegionStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/findOneOrAnyRegionStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "validateShippingOptionPricesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/validateShippingOptionPricesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "generateProductCsvStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/generateProductCsvStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "parseProductCsvStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/parseProductCsvStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createRegionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createRegionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteRegionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteRegionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateRegionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateRegionsStep", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/region/js-sdk", - "title": "JS SDK", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Store", - "autogenerate_tags": "jsSdk+storefront+region", - "description": "The following methods or properties are used to send requests to Store API Routes related to the Region Module.", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Implement Express Checkout with Medusa", - "path": "https://docs.medusajs.com/resources/storefront-development/guides/express-checkout", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "region", - "path": "https://docs.medusajs.com/resources/references/js-sdk/store/region", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+region", - "description": "The following methods or properties are used to send requests to Admin API Routes related to the Region Module.", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "region", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/region", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/region/events", - "title": "Events Reference", + "path": "/storefront-development/customers/register", + "title": "Register Customer", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", - "path": "/commerce-modules/region/admin-widget-zones", - "title": "Admin Widget Zones", + "path": "/storefront-development/customers/login", + "title": "Login Customer", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", - "path": "/references/region", - "title": "Main Service Reference", - "isChildSidebar": true, - "childSidebarTitle": "Region Module's Main Service Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Methods", - "autogenerate_path": "/references/region/IRegionModuleService/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/region/createRegions", - "title": "createRegions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/region/deleteRegions", - "title": "deleteRegions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/region/listAndCountCountries", - "title": "listAndCountCountries", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/region/listAndCountRegions", - "title": "listAndCountRegions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/region/listCountries", - "title": "listCountries", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/region/listRegions", - "title": "listRegions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/region/restoreRegions", - "title": "restoreRegions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/region/retrieveCountry", - "title": "retrieveCountry", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/region/retrieveRegion", - "title": "retrieveRegion", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/region/softDeleteRegions", - "title": "softDeleteRegions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/region/updateRegions", - "title": "updateRegions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/region/upsertRegions", - "title": "upsertRegions", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/region/models", - "title": "Data Models Reference", - "isChildSidebar": true, - "childSidebarTitle": "Region Module Data Models Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Data Models", - "autogenerate_path": "/references/region_models/variables", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/region/models/Country", - "title": "Country", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/region/models/Region", - "title": "Region", - "description": "", - "children": [] - } - ] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Sales Channel Module", - "isChildSidebar": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/sales-channel", - "title": "Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Concepts", - "initialOpen": false, - "autogenerate_tags": "concept+salesChannel", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/sales-channel/publishable-api-keys", - "title": "Publishable API Keys", + "path": "/storefront-development/customers/third-party-login", + "title": "Third-Party (Social) Login", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", - "path": "/commerce-modules/sales-channel/links-to-other-modules", - "title": "Links to Modules", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Product Variant Inventory", - "path": "https://docs.medusajs.com/resources/commerce-modules/product/variant-inventory", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Storefront Guides", - "autogenerate_tags": "storefront+salesChannel,-jsSdk", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to integrate the Sales Channel Module's features into your storefront.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Use a Publishable API Key in the Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/publishable-api-keys", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Admin User Guides", - "autogenerate_tags": "userGuide+salesChannel", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to utilize and manage Sales Channel features in the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Sales Channels", - "path": "https://docs.medusajs.com/user-guide/settings/sales-channels", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "initialOpen": false, - "description": "Find references for tools and resources related to the Sales Channel Module, such as data models, methods, and more. These are useful for your customizations.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/sales-channel/workflows", - "title": "Workflows", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+salesChannel", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "linkSalesChannelsToApiKeyWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/linkSalesChannelsToApiKeyWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createDefaultsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createDefaultsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addOrderLineItemsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addOrderLineItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderClaimAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderEditAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderEditAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderExchangeAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderExchangeAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "importProductsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/importProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createSalesChannelsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createSalesChannelsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteSalesChannelsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteSalesChannelsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateSalesChannelsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateSalesChannelsWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+salesChannel", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "validateSalesChannelsExistStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/validateSalesChannelsExistStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "findSalesChannelStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/findSalesChannelStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "parseProductCsvStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/parseProductCsvStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createDefaultSalesChannelStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createDefaultSalesChannelStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createSalesChannelsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createSalesChannelsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteSalesChannelsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteSalesChannelsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateSalesChannelsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateSalesChannelsStep", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/sales-channel/js-sdk", - "title": "JS SDK", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+salesChannel", - "description": "The following methods or properties are used to send requests to Admin API Routes related to the Sales Channel Module.", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "salesChannel", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/salesChannel", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/sales-channel/events", - "title": "Events Reference", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/sales-channel/admin-widget-zones", - "title": "Admin Widget Zones", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/sales-channel", - "title": "Main Service Reference", - "isChildSidebar": true, - "childSidebarTitle": "Sales Channel Module's Main Service Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Methods", - "autogenerate_path": "/references/sales_channel/ISalesChannelModuleService/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/sales-channel/createSalesChannels", - "title": "createSalesChannels", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/sales-channel/deleteSalesChannels", - "title": "deleteSalesChannels", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/sales-channel/listAndCountSalesChannels", - "title": "listAndCountSalesChannels", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/sales-channel/listSalesChannels", - "title": "listSalesChannels", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/sales-channel/restoreSalesChannels", - "title": "restoreSalesChannels", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/sales-channel/retrieveSalesChannel", - "title": "retrieveSalesChannel", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/sales-channel/softDeleteSalesChannels", - "title": "softDeleteSalesChannels", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/sales-channel/updateSalesChannels", - "title": "updateSalesChannels", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/sales-channel/upsertSalesChannels", - "title": "upsertSalesChannels", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/sales-channel/models", - "title": "Data Models Reference", - "isChildSidebar": true, - "childSidebarTitle": "Sales Channel Module Data Models Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Data Models", - "autogenerate_path": "/references/sales_channel_models/variables", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/sales-channel/models/SalesChannel", - "title": "SalesChannel", - "description": "", - "children": [] - } - ] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Stock Location Module", - "isChildSidebar": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/stock-location", - "title": "Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Concepts", - "initialOpen": false, - "autogenerate_tags": "concept+stockLocation", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/stock-location/concepts", - "title": "Stock Location Concepts", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/stock-location/links-to-other-modules", - "title": "Links to Modules", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Inventory Kits", - "path": "https://docs.medusajs.com/resources/commerce-modules/inventory/inventory-kit", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Product Variant Inventory", - "path": "https://docs.medusajs.com/resources/commerce-modules/product/variant-inventory", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Admin User Guides", - "autogenerate_tags": "userGuide+stockLocation", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to utilize and manage Stock Location features in the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Locations", - "path": "https://docs.medusajs.com/user-guide/settings/locations-and-shipping/locations", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Locations & Shipping Overview", - "path": "https://docs.medusajs.com/user-guide/settings/locations-and-shipping", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "initialOpen": false, - "description": "Find references for tools and resources related to the Stock Location Module, such as data models, methods, and more. These are useful for your customizations.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/stock-location/workflows", - "title": "Workflows", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+stockLocation", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createStockLocationsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createStockLocationsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteStockLocationsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteStockLocationsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateStockLocationsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateStockLocationsWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+stockLocation", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createStockLocations", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createStockLocations", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteStockLocationsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteStockLocationsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateStockLocationsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateStockLocationsStep", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/stock-location/js-sdk", - "title": "JS SDK", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+stockLocation", - "description": "The following methods or properties are used to send requests to Admin API Routes related to the Stock Location Module.", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "stockLocation", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/stockLocation", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/stock-location/admin-widget-zones", - "title": "Admin Widget Zones", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/stock-location-next", - "title": "Main Service Reference", - "isChildSidebar": true, - "childSidebarTitle": "Stock Location Module's Main Service Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Methods", - "autogenerate_path": "/references/stock_location_next/IStockLocationService/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/stock-location-next/createStockLocations", - "title": "createStockLocations", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/stock-location-next/deleteStockLocationAddresses", - "title": "deleteStockLocationAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/stock-location-next/deleteStockLocations", - "title": "deleteStockLocations", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/stock-location-next/listAndCountStockLocations", - "title": "listAndCountStockLocations", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/stock-location-next/listStockLocationAddresses", - "title": "listStockLocationAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/stock-location-next/listStockLocations", - "title": "listStockLocations", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/stock-location-next/restoreStockLocations", - "title": "restoreStockLocations", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/stock-location-next/retrieveStockLocation", - "title": "retrieveStockLocation", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/stock-location-next/softDeleteStockLocations", - "title": "softDeleteStockLocations", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/stock-location-next/updateStockLocations", - "title": "updateStockLocations", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/stock-location-next/upsertStockLocationAddresses", - "title": "upsertStockLocationAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/stock-location-next/upsertStockLocations", - "title": "upsertStockLocations", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/stock-location-next/models", - "title": "Data Models Reference", - "isChildSidebar": true, - "childSidebarTitle": "Stock Location Module Data Models Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Data Models", - "autogenerate_path": "/references/stock_location_next_models/variables", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/stock-location-next/models/StockLocation", - "title": "StockLocation", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/stock-location-next/models/StockLocationAddress", - "title": "StockLocationAddress", - "description": "", - "children": [] - } - ] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Store Module", - "isChildSidebar": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/store", - "title": "Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Concepts", - "initialOpen": false, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/store/links-to-other-modules", - "title": "Link to Modules", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Admin User Guides", - "autogenerate_tags": "userGuide+store", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to utilize and manage Store features in the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Store", - "path": "https://docs.medusajs.com/user-guide/settings/store", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "initialOpen": false, - "description": "Find references for tools and resources related to the Store Module, such as data models, methods, and more. These are useful for your customizations.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/store/workflows", - "title": "Workflows", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+store", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createDefaultsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createDefaultsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addOrderLineItemsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addOrderLineItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderClaimAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderEditAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderEditAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderExchangeAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderExchangeAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createStoresWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createStoresWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteStoresWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteStoresWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateStoresWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateStoresWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+store", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "findOneOrAnyRegionStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/findOneOrAnyRegionStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "findSalesChannelStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/findSalesChannelStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createDefaultStoreStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createDefaultStoreStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createStoresStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createStoresStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteStoresStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteStoresStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateStoresStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateStoresStep", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/store/js-sdk", - "title": "JS SDK", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+store", - "description": "The following methods or properties are used to send requests to Admin API Routes related to the Store Module.", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "store", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/store", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/store/admin-widget-zones", - "title": "Admin Widget Zones", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/store", - "title": "Main Service Reference", - "isChildSidebar": true, - "childSidebarTitle": "Store Module's Main Service Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Methods", - "autogenerate_path": "/references/store/IStoreModuleService/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/store/createStores", - "title": "createStores", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/store/deleteStores", - "title": "deleteStores", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/store/listAndCountStores", - "title": "listAndCountStores", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/store/listStores", - "title": "listStores", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/store/restoreStores", - "title": "restoreStores", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/store/retrieveStore", - "title": "retrieveStore", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/store/softDeleteStores", - "title": "softDeleteStores", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/store/updateStores", - "title": "updateStores", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/store/upsertStores", - "title": "upsertStores", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/store/models", - "title": "Data Models Reference", - "isChildSidebar": true, - "childSidebarTitle": "Store Module Data Models Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Data Models", - "autogenerate_path": "/references/store_models/variables", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/store/models/Store", - "title": "Store", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/store/models/StoreCurrency", - "title": "StoreCurrency", - "description": "", - "children": [] - } - ] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Tax Module", - "isChildSidebar": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/tax", - "title": "Overview", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/tax/module-options", - "title": "Module Options", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Concepts", - "initialOpen": false, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/tax/tax-region", - "title": "Tax Region", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/tax/tax-rates-and-rules", - "title": "Tax Rates and Rules", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/tax/tax-calculation-with-provider", - "title": "Tax Calculation and Providers", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Server Guides", - "autogenerate_tags": "server+tax", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to use the Tax Module in your customizations on the Medusa application server.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/provider", - "title": "Tax Provider Reference", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Get Variant Price with Taxes", - "path": "https://docs.medusajs.com/resources/commerce-modules/product/guides/price-with-taxes", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Storefront Guides", - "autogenerate_tags": "storefront+tax,-jsSdk", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to integrate the Tax Module's features into your storefront.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Example: Show Price with Taxes", - "path": "https://docs.medusajs.com/resources/storefront-development/products/price/examples/tax-price", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Admin User Guides", - "autogenerate_tags": "userGuide+tax", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to utilize and manage Tax features in the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Tax Regions", - "path": "https://docs.medusajs.com/user-guide/settings/tax-regions", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "initialOpen": false, - "description": "Find references for tools and resources related to the Tax Module, such as data models, methods, and more. These are useful for your customizations.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/tax/workflows", - "title": "Workflows", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+tax", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addShippingMethodToCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addShippingMethodToCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addToCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addToCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refreshCartItemsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshCartItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "transferCartCustomerWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/transferCartCustomerWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateLineItemInCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateLineItemInCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateTaxLinesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateTaxLinesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteLineItemsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteLineItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createClaimShippingMethodWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createClaimShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createExchangeShippingMethodWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createExchangeShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderEditShippingMethodWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderEditShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createReturnShippingMethodWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createReturnShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderClaimAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderEditAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderEditAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderExchangeAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderExchangeAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateOrderTaxLinesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateOrderTaxLinesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createTaxRateRulesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createTaxRateRulesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createTaxRatesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createTaxRatesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createTaxRegionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createTaxRegionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteTaxRateRulesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteTaxRateRulesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteTaxRatesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteTaxRatesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteTaxRegionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteTaxRegionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "setTaxRateRulesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/setTaxRateRulesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateTaxRatesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateTaxRatesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateTaxRegionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateTaxRegionsWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+tax", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createTaxRateRulesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createTaxRateRulesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createTaxRatesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createTaxRatesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createTaxRegionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createTaxRegionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteTaxRateRulesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteTaxRateRulesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteTaxRatesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteTaxRatesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteTaxRegionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteTaxRegionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "getItemTaxLinesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/getItemTaxLinesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "listTaxRateRuleIdsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/listTaxRateRuleIdsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateTaxRatesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateTaxRatesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateTaxRegionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateTaxRegionsStep", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/tax/js-sdk", - "title": "JS SDK", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+tax", - "description": "The following methods or properties are used to send requests to Admin API Routes related to the Tax Module.", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "taxRate", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/taxRate", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "taxRegion", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/taxRegion", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/tax/admin-widget-zones", - "title": "Admin Widget Zones", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax", - "title": "Main Service Reference", - "isChildSidebar": true, - "childSidebarTitle": "Tax Module's Main Service Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Methods", - "autogenerate_path": "/references/tax/ITaxModuleService/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/createTaxRateRules", - "title": "createTaxRateRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/createTaxRates", - "title": "createTaxRates", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/createTaxRegions", - "title": "createTaxRegions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/deleteTaxRateRules", - "title": "deleteTaxRateRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/deleteTaxRates", - "title": "deleteTaxRates", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/deleteTaxRegions", - "title": "deleteTaxRegions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/getTaxLines", - "title": "getTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/listAndCountTaxRates", - "title": "listAndCountTaxRates", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/listTaxRateRules", - "title": "listTaxRateRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/listTaxRates", - "title": "listTaxRates", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/listTaxRegions", - "title": "listTaxRegions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/restoreTaxRateRules", - "title": "restoreTaxRateRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/restoreTaxRates", - "title": "restoreTaxRates", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/restoreTaxRegions", - "title": "restoreTaxRegions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/retrieveTaxRate", - "title": "retrieveTaxRate", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/softDeleteTaxRateRules", - "title": "softDeleteTaxRateRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/softDeleteTaxRates", - "title": "softDeleteTaxRates", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/softDeleteTaxRegions", - "title": "softDeleteTaxRegions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/updateTaxRates", - "title": "updateTaxRates", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/updateTaxRegions", - "title": "updateTaxRegions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/upsertTaxRates", - "title": "upsertTaxRates", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/models", - "title": "Data Models Reference", - "isChildSidebar": true, - "childSidebarTitle": "Tax Module Data Models Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Data Models", - "autogenerate_path": "/references/tax_models/variables", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/models/TaxProvider", - "title": "TaxProvider", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/models/TaxRate", - "title": "TaxRate", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/models/TaxRateRule", - "title": "TaxRateRule", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/models/TaxRegion", - "title": "TaxRegion", - "description": "", - "children": [] - } - ] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "User Module", - "isChildSidebar": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/user", - "title": "Overview", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/user/module-options", - "title": "Module Options", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Server Guides", - "autogenerate_tags": "server+user", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to use the User Module in your customizations on the Medusa application server.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/user/user-creation-flows", - "title": "User Creation Flows", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Admin User Guides", - "autogenerate_tags": "userGuide+user", - "initialOpen": false, - "autogenerate_as_ref": true, - "description": "Learn how to utilize and manage User features in the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", + "path": "/storefront-development/customers/reset-password", "title": "Reset Password", - "path": "https://docs.medusajs.com/user-guide/reset-password", "children": [] }, { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "Manage Profile", - "path": "https://docs.medusajs.com/user-guide/settings/profile", + "type": "link", + "path": "/storefront-development/customers/retrieve", + "title": "Retrieve Customer", "children": [] }, { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "Manage Invites", - "path": "https://docs.medusajs.com/user-guide/settings/users/invites", + "type": "link", + "path": "/storefront-development/customers/context", + "title": "Customer React Context", "children": [] }, { "loaded": true, "isPathHref": true, - "type": "ref", - "title": "Manage Users", - "path": "https://docs.medusajs.com/user-guide/settings/users", + "type": "link", + "path": "/storefront-development/customers/profile", + "title": "Edit Customer Profile", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/customers/addresses", + "title": "Manage Customer Addresses", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/customers/log-out", + "title": "Log-out Customer", "children": [] } ] + } + ] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "SDKs and Tools", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/create-medusa-app", + "title": "create-medusa-app", + "children": [] }, { "loaded": true, "isPathHref": true, - "type": "category", - "title": "References", - "initialOpen": false, - "description": "Find references for tools and resources related to the User Module, such as data models, methods, and more. These are useful for your customizations.", + "type": "sidebar", + "sidebar_id": "medusa-cli", + "title": "Medusa CLI", + "childSidebarTitle": "Medusa CLI Reference", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "path": "/commerce-modules/user/workflows", - "title": "Workflows", - "hideChildren": true, + "path": "/medusa-cli", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Commands", + "autogenerate_path": "medusa-cli/commands", "children": [ { "loaded": true, "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+user", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "acceptInviteWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/acceptInviteWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createInvitesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createInvitesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteInvitesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteInvitesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refreshInviteTokensWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshInviteTokensWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createUserAccountWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createUserAccountWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createUsersWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createUsersWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteUsersWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteUsersWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeUserAccountWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeUserAccountWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateUsersWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateUsersWorkflow", - "children": [] - } - ] + "type": "link", + "path": "/medusa-cli/commands/new", + "title": "new", + "description": "", + "children": [] }, { "loaded": true, "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+user", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createInviteStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createInviteStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteInvitesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteInvitesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refreshInviteTokensStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/refreshInviteTokensStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "validateTokenStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/validateTokenStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createUsersStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createUsersStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteUsersStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteUsersStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateUsersStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateUsersStep", - "children": [] - } - ] + "type": "link", + "path": "/medusa-cli/commands/develop", + "title": "develop", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/medusa-cli/commands/start", + "title": "start", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/medusa-cli/commands/user", + "title": "user", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/medusa-cli/commands/build", + "title": "build", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/medusa-cli/commands/db", + "title": "db", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/medusa-cli/commands/plugin", + "title": "plugin", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/medusa-cli/commands/exec", + "title": "exec", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/medusa-cli/commands/start-cluster", + "title": "start-cluster", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/medusa-cli/commands/telemtry", + "title": "telemetry", + "description": "", + "children": [] } ] - }, + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "js-sdk", + "title": "JS SDK", + "childSidebarTitle": "JS SDK Reference", + "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "path": "/commerce-modules/user/js-sdk", - "title": "JS SDK", - "hideChildren": true, + "path": "/js-sdk", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Auth", + "autogenerate_path": "/references/js_sdk/auth/Auth/methods", + "initialOpen": true, "children": [ { "loaded": true, "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+user", - "description": "The following methods or properties are used to send requests to Admin API Routes related to the User Module.", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "invite", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/invite", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "user", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/user", - "children": [] - } - ] + "type": "link", + "path": "/references/js-sdk/auth/callback", + "title": "callback", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/auth/login", + "title": "login", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/auth/logout", + "title": "logout", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/auth/refresh", + "title": "refresh", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/auth/register", + "title": "register", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/auth/resetPassword", + "title": "resetPassword", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/auth/updateProvider", + "title": "updateProvider", + "description": "", + "children": [] } ] }, { "loaded": true, "isPathHref": true, - "type": "link", - "path": "/commerce-modules/user/events", - "title": "Events Reference", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/user/admin-widget-zones", - "title": "Admin Widget Zones", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user", - "title": "Main Service Reference", - "isChildSidebar": true, - "childSidebarTitle": "User Module's Main Service Reference", + "type": "category", + "title": "Store", + "autogenerate_path": "/references/js_sdk/store/Store/properties", + "initialOpen": true, "children": [ { "loaded": true, "isPathHref": true, - "type": "category", - "title": "Methods", - "autogenerate_path": "/references/user/IUserModuleService/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/createInvites", - "title": "createInvites", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/createUsers", - "title": "createUsers", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/deleteInvites", - "title": "deleteInvites", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/deleteUsers", - "title": "deleteUsers", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/listAndCountInvites", - "title": "listAndCountInvites", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/listAndCountUsers", - "title": "listAndCountUsers", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/listInvites", - "title": "listInvites", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/listUsers", - "title": "listUsers", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/refreshInviteTokens", - "title": "refreshInviteTokens", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/restoreInvites", - "title": "restoreInvites", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/restoreUsers", - "title": "restoreUsers", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/retrieveInvite", - "title": "retrieveInvite", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/retrieveUser", - "title": "retrieveUser", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/softDeleteInvites", - "title": "softDeleteInvites", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/softDeleteUsers", - "title": "softDeleteUsers", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/updateInvites", - "title": "updateInvites", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/updateUsers", - "title": "updateUsers", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/validateInviteToken", - "title": "validateInviteToken", - "description": "", - "children": [] - } - ] + "type": "link", + "path": "/references/js-sdk/store/cart", + "title": "cart", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/store/category", + "title": "category", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/store/collection", + "title": "collection", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/store/customer", + "title": "customer", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/store/fulfillment", + "title": "fulfillment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/store/order", + "title": "order", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/store/payment", + "title": "payment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/store/product", + "title": "product", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/store/region", + "title": "region", + "description": "", + "children": [] } ] }, { "loaded": true, "isPathHref": true, - "type": "link", - "path": "/references/user/models", - "title": "Data Models Reference", - "isChildSidebar": true, - "childSidebarTitle": "User Module Data Models Reference", + "type": "category", + "title": "Admin", + "autogenerate_path": "/references/js_sdk/admin/Admin/properties", + "initialOpen": true, "children": [ { "loaded": true, "isPathHref": true, - "type": "category", - "title": "Data Models", - "hasTitleStyling": true, - "autogenerate_path": "/references/user_models/variables", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/models/Invite", - "title": "Invite", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/models/User", - "title": "User", - "description": "", - "children": [] - } - ] + "type": "link", + "path": "/references/js-sdk/admin/apiKey", + "title": "apiKey", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/campaign", + "title": "campaign", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/claim", + "title": "claim", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/currency", + "title": "currency", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/customer", + "title": "customer", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/customerGroup", + "title": "customerGroup", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/draftOrder", + "title": "draftOrder", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/exchange", + "title": "exchange", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/fulfillment", + "title": "fulfillment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/fulfillmentProvider", + "title": "fulfillmentProvider", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/fulfillmentSet", + "title": "fulfillmentSet", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/inventoryItem", + "title": "inventoryItem", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/invite", + "title": "invite", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/notification", + "title": "notification", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/order", + "title": "order", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/orderEdit", + "title": "orderEdit", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/payment", + "title": "payment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/paymentCollection", + "title": "paymentCollection", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/priceList", + "title": "priceList", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/pricePreference", + "title": "pricePreference", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/product", + "title": "product", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/productCategory", + "title": "productCategory", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/productCollection", + "title": "productCollection", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/productTag", + "title": "productTag", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/productType", + "title": "productType", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/productVariant", + "title": "productVariant", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/promotion", + "title": "promotion", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/refundReason", + "title": "refundReason", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/region", + "title": "region", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/reservation", + "title": "reservation", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/return", + "title": "return", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/returnReason", + "title": "returnReason", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/salesChannel", + "title": "salesChannel", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/shippingOption", + "title": "shippingOption", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/shippingProfile", + "title": "shippingProfile", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/stockLocation", + "title": "stockLocation", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/store", + "title": "store", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/taxRate", + "title": "taxRate", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/taxRegion", + "title": "taxRegion", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/upload", + "title": "upload", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/user", + "title": "user", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/workflowExecution", + "title": "workflowExecution", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "nextjs-starter", + "title": "Next.js Starter Storefront", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/nextjs-starter", + "title": "Overview", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Payment", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/nextjs-starter/guides/customize-stripe", + "title": "Customize Stripe Integration", + "children": [] } ] } ] } ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules", - "title": "Architectural Modules", - "isChildSidebar": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Cache Modules", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/cache", - "title": "Overview", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/cache/in-memory", - "title": "In-Memory", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/cache/redis", - "title": "Redis", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Guides", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/cache/create", - "title": "Create Cache Module", - "children": [] - } - ] - } - ] }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Event Modules", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/event", - "title": "Overview", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/event/local", - "title": "Local", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/event/redis", - "title": "Redis", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Guides", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/event/create", - "title": "Create Event Module", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "File Module Providers", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/file", - "title": "Overview", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/file/local", - "title": "Local", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/file/s3", - "title": "AWS S3 (and Compatible APIs)", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Guides", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/file-provider-module", - "title": "Create File Provider", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Notification Module Providers", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/notification", - "title": "Overview", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/notification/local", - "title": "Local", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/notification/sendgrid", - "title": "SendGrid", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Guides", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/notification/send-notification", - "title": "Send Notification", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/notification-provider-module", - "title": "Create Notification Provider", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/integrations/guides/resend", - "title": "Integrate Resend", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflow Engine Modules", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/workflow-engine", - "title": "Overview", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/workflow-engine/in-memory", - "title": "In-Memory", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/workflow-engine/redis", - "title": "Redis", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/integrations", - "title": "Integrations", - "isChildSidebar": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Auth", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/auth/auth-providers/google", - "title": "Google", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/auth/auth-providers/github", - "title": "GitHub", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "CMS", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/integrations/guides/sanity", - "title": "Sanity", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "File", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/file/s3", - "title": "AWS", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Fulfillment", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/integrations/guides/shipstation", - "title": "ShipStation", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Notification", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/notification/sendgrid", - "title": "SendGrid", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/integrations/guides/resend", - "title": "Resend", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Payment", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/payment/payment-provider/stripe", - "title": "Stripe", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "path": "/plugins", - "title": "Plugins", - "isChildSidebar": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Overview", - "path": "/plugins", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Guides", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Wishlist", - "path": "/plugins/guides/wishlist", - "description": "Learn how to build a wishlist plugin.", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development", - "title": "Storefront Development", - "isChildSidebar": true, - "children": [ { "loaded": true, "isPathHref": true, @@ -17040,2795 +18661,898 @@ export const generatedSidebar = [ { "loaded": true, "isPathHref": true, - "type": "link", - "path": "/storefront-development/tips", - "title": "Tips", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/publishable-api-keys", - "title": "Publishable API Key", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Examples", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/guides/express-checkout", - "title": "Express Checkout Storefront", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Regions", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/regions", - "title": "Overview", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/regions/list", - "title": "List Regions", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/regions/store-retrieve-region", - "title": "Store and Retrieve Regions", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/regions/context", - "title": "Region React Context", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Products", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/products/list", - "title": "List Products", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/products/retrieve", - "title": "Retrieve a Product", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/products/variants", - "title": "Select a Variant", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/products/price", - "title": "Retrieve Variant Prices", - "autogenerate_path": "storefront-development/products/price/examples", + "type": "sidebar", + "sidebar_id": "deployment-guides", + "title": "Deployment Guides", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "path": "/storefront-development/products/price/examples/show-price", - "title": "Example: Show Variant's Price", - "description": "", + "path": "/deployment", + "title": "Overview", "children": [] }, { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/products/price/examples/sale-price", - "title": "Example: Show Sale Price", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/products/price/examples/tax-price", - "title": "Example: Show Price with Taxes", - "description": "", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/products/inventory", - "title": "Retrieve Variant Inventory", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Product Categories", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/products/categories/list", - "title": "List Categories", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/products/categories/retrieve", - "title": "Retrieve a Category", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/products/categories/products", - "title": "Retrieve a Category's Products", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/products/categories/nested-categories", - "title": "Retrieve Nested Categories", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Product Collections", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/products/collections/list", - "title": "List Collections", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/products/collections/retrieve", - "title": "Retrieve a Collection", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/products/collections/products", - "title": "Retrieve a Collection's Products", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Carts", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/cart/create", - "title": "Create Cart", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/cart/retrieve", - "title": "Retrieve Cart", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/cart/context", - "title": "Cart React Context", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/cart/update", - "title": "Update Cart", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/cart/manage-items", - "title": "Manage Line Items", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Checkout", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/checkout", - "title": "Overview", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/checkout/email", - "title": "1. Enter Email", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/checkout/address", - "title": "2. Set Address", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/checkout/shipping", - "title": "3. Choose Shipping Method", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/checkout/payment", - "title": "4. Choose Payment Provider", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/checkout/payment/stripe", - "title": "Example: Stripe", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/checkout/complete-cart", - "title": "5. Complete Cart", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Customers", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/customers/register", - "title": "Register Customer", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/customers/login", - "title": "Login Customer", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/customers/third-party-login", - "title": "Third-Party (Social) Login", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/customers/reset-password", - "title": "Reset Password", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/customers/retrieve", - "title": "Retrieve Customer", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/customers/context", - "title": "Customer React Context", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/customers/profile", - "title": "Edit Customer Profile", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/customers/addresses", - "title": "Manage Customer Addresses", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/customers/log-out", - "title": "Log-out Customer", - "children": [] - } - ] - } - ] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "SDKs and Tools", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/create-medusa-app", - "title": "create-medusa-app", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/medusa-cli", - "title": "Medusa CLI", - "isChildSidebar": true, - "childSidebarTitle": "Medusa CLI Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/medusa-cli", - "title": "Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Commands", - "autogenerate_path": "medusa-cli/commands", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/medusa-cli/commands/new", - "title": "new", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/medusa-cli/commands/develop", - "title": "develop", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/medusa-cli/commands/start", - "title": "start", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/medusa-cli/commands/user", - "title": "user", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/medusa-cli/commands/build", - "title": "build", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/medusa-cli/commands/db", - "title": "db", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/medusa-cli/commands/plugin", - "title": "plugin", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/medusa-cli/commands/exec", - "title": "exec", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/medusa-cli/commands/start-cluster", - "title": "start-cluster", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/medusa-cli/commands/telemtry", - "title": "telemetry", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/js-sdk", - "title": "JS SDK", - "isChildSidebar": true, - "childSidebarTitle": "JS SDK Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Auth", - "autogenerate_path": "/references/js_sdk/auth/Auth/methods", - "initialOpen": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/auth/callback", - "title": "callback", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/auth/login", - "title": "login", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/auth/logout", - "title": "logout", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/auth/refresh", - "title": "refresh", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/auth/register", - "title": "register", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/auth/resetPassword", - "title": "resetPassword", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/auth/updateProvider", - "title": "updateProvider", - "description": "", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Store", - "autogenerate_path": "/references/js_sdk/store/Store/properties", - "initialOpen": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/store/cart", - "title": "cart", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/store/category", - "title": "category", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/store/collection", - "title": "collection", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/store/customer", - "title": "customer", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/store/fulfillment", - "title": "fulfillment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/store/order", - "title": "order", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/store/payment", - "title": "payment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/store/product", - "title": "product", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/store/region", - "title": "region", - "description": "", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Admin", - "autogenerate_path": "/references/js_sdk/admin/Admin/properties", - "initialOpen": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/apiKey", - "title": "apiKey", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/campaign", - "title": "campaign", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/claim", - "title": "claim", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/currency", - "title": "currency", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/customer", - "title": "customer", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/customerGroup", - "title": "customerGroup", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/draftOrder", - "title": "draftOrder", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/exchange", - "title": "exchange", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/fulfillment", - "title": "fulfillment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/fulfillmentProvider", - "title": "fulfillmentProvider", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/fulfillmentSet", - "title": "fulfillmentSet", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/inventoryItem", - "title": "inventoryItem", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/invite", - "title": "invite", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/notification", - "title": "notification", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/order", - "title": "order", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/orderEdit", - "title": "orderEdit", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/payment", - "title": "payment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/paymentCollection", - "title": "paymentCollection", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/priceList", - "title": "priceList", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/pricePreference", - "title": "pricePreference", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/product", - "title": "product", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/productCategory", - "title": "productCategory", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/productCollection", - "title": "productCollection", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/productTag", - "title": "productTag", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/productType", - "title": "productType", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/productVariant", - "title": "productVariant", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/promotion", - "title": "promotion", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/refundReason", - "title": "refundReason", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/region", - "title": "region", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/reservation", - "title": "reservation", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/return", - "title": "return", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/returnReason", - "title": "returnReason", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/salesChannel", - "title": "salesChannel", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/shippingOption", - "title": "shippingOption", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/shippingProfile", - "title": "shippingProfile", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/stockLocation", - "title": "stockLocation", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/store", - "title": "store", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/taxRate", - "title": "taxRate", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/taxRegion", - "title": "taxRegion", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/upload", - "title": "upload", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/user", - "title": "user", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/workflowExecution", - "title": "workflowExecution", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/nextjs-starter", - "title": "Next.js Starter Storefront", - "isChildSidebar": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/nextjs-starter", - "title": "Overview", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Payment", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/nextjs-starter/guides/customize-stripe", - "title": "Customize Stripe Integration", - "children": [] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "General", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-config", - "title": "Medusa Configurations", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/deployment", - "title": "Deployment Guides", - "isChildSidebar": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Medusa Cloud", - "path": "https://medusajs.com/contact", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Self-Hosting", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "https://docs.medusajs.com/learn/deployment/general", - "title": "General", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/deployment/medusa-application/railway", - "title": "Railway", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Next.js Starter", - "autogenerate_path": "/deployment/storefront", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/deployment/storefront/vercel", - "title": "Vercel", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/troubleshooting", - "title": "Troubleshooting Guides", - "isChildSidebar": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Installation", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/troubleshooting/create-medusa-app-errors", - "title": "Create Medusa App Errors", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/troubleshooting/errors-installing-cli", - "title": "Errors Installing CLI", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/troubleshooting/general-errors", - "title": "General Errors", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Medusa Application", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/troubleshooting/eaddrinuse", - "title": "EADDRINUSE Error", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/troubleshooting/database-errors", - "title": "Database Errors", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/troubleshooting/dist-imports", - "title": "Importing from /dist", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/troubleshooting/workflow-errors", - "title": "Workflow Errors", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/troubleshooting/test-errors", - "title": "Test Errors", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Admin Development", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/troubleshooting/medusa-admin/no-widget-route", - "title": "Widget or Route not Showing", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Upgrade", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/troubleshooting/errors-after-upgrading", - "title": "Errors After Upgrading", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Frontend", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/troubleshooting/cors-errors", - "title": "CORS Errors", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Integrations", - "hasTitleStyling": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/troubleshooting/s3", - "title": "S3 Module Provider Errors", - "children": [] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Admin", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/admin-widget-injection-zones", - "title": "Admin Widget Injection Zones", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/admin-components", - "title": "Admin Components", - "isChildSidebar": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Layouts", - "autogenerate_path": "/admin-components/layouts", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/admin-components/layouts/single-column", - "title": "Single Column", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/admin-components/layouts/two-column", - "title": "Two Column", - "description": "", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Components", - "autogenerate_path": "/admin-components/components", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/admin-components/components/action-menu", - "title": "Action Menu", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/admin-components/components/container", - "title": "Container", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/admin-components/components/data-table", - "title": "Data Table", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/admin-components/components/forms", - "title": "Forms", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/admin-components/components/header", - "title": "Header", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/admin-components/components/json-view-section", - "title": "JSON View", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/admin-components/components/section-row", - "title": "Section Row", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/admin-components/components/table", - "title": "Table", - "description": "", - "children": [] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Lists", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/medusa-container-resources", - "title": "Container Dependencies", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/events-reference", - "title": "Events List", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/workflows", - "title": "Workflows SDK", - "childSidebarTitle": "Workflows SDK Reference", - "isChildSidebar": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Functions", - "autogenerate_path": "/references/workflows/functions", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/workflows/createHook", - "title": "createHook", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/workflows/createStep", - "title": "createStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/workflows/createWorkflow", - "title": "createWorkflow", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/workflows/parallelize", - "title": "parallelize", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/workflows/transform", - "title": "transform", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model", - "title": "Data Model Language", - "childSidebarTitle": "Data Model Language Reference", - "isChildSidebar": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/define", - "title": "Define Method", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Property Types", - "autogenerate_path": "/references/dml/Property_Types/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/property-types/array", - "title": "array", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/property-types/bignumber", - "title": "bigNumber", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/property-types/boolean", - "title": "boolean", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/property-types/datetime", - "title": "dateTime", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/property-types/enum", - "title": "enum", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/property-types/float", - "title": "float", - "description": "", - "children": [] + "type": "separator" }, { "loaded": true, "isPathHref": true, "type": "link", - "path": "/references/data-model/property-types/id", - "title": "id", - "description": "", + "title": "Medusa Cloud", + "path": "https://medusajs.com/pricing", "children": [] }, { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/property-types/json", - "title": "json", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/property-types/number", - "title": "number", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/property-types/text", - "title": "text", - "description": "", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Relationship Methods", - "autogenerate_path": "/references/dml/Relationship_Methods/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/relationship-methods/belongsto", - "title": "belongsTo", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/relationship-methods/hasmany", - "title": "hasMany", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/relationship-methods/hasone", - "title": "hasOne", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/relationship-methods/manytomany", - "title": "manyToMany", - "description": "", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Model Methods", - "autogenerate_path": "/references/dml/Model_Methods/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/model-methods/cascades", - "title": "cascades", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/model-methods/indexes", - "title": "indexes", - "description": "", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Property Configuration Methods", - "autogenerate_path": "/references/dml/Property_Configuration_Methods/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/property-configuration/computed", - "title": "computed", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/property-configuration/default", - "title": "default", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/property-configuration/index", - "title": "index", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/property-configuration/nullable", - "title": "nullable", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/property-configuration/unique", - "title": "unique", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/service-factory-reference", - "title": "Service Factory", - "isChildSidebar": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Methods", - "autogenerate_path": "/service-factory-reference/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/service-factory-reference/methods/create", - "title": "create", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/service-factory-reference/methods/delete", - "title": "delete", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/service-factory-reference/methods/list", - "title": "list", - "description": "", - "children": [] + "type": "separator" }, { "loaded": true, "isPathHref": true, - "type": "link", - "path": "/service-factory-reference/methods/listAndCount", - "title": "listAndCount", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/service-factory-reference/methods/restore", - "title": "restore", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/service-factory-reference/methods/retrieve", - "title": "retrieve", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/service-factory-reference/methods/soft-delete", - "title": "softDelete", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/service-factory-reference/methods/update", - "title": "update", - "description": "", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Tips", - "autogenerate_path": "/service-factory-reference/tips", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/service-factory-reference/tips/filtering", - "title": "Filtering", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/helper-steps", - "title": "Helper Steps", - "isChildSidebar": true, - "autogenerate_path": "/references/helper_steps/functions", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/helper-steps/createRemoteLinkStep", - "title": "createRemoteLinkStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/helper-steps/dismissRemoteLinkStep", - "title": "dismissRemoteLinkStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/helper-steps/emitEventStep", - "title": "emitEventStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/helper-steps/removeRemoteLinkStep", - "title": "removeRemoteLinkStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/helper-steps/updateRemoteLinksStep", - "title": "updateRemoteLinksStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/helper-steps/useQueryGraphStep", - "title": "useQueryGraphStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/helper-steps/useRemoteQueryStep", - "title": "useRemoteQueryStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/helper-steps/validatePresenceOfStep", - "title": "validatePresenceOfStep", - "description": "", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Core Workflows", - "path": "/medusa-workflows-reference", - "isChildSidebar": true, - "custom_autogenerate": "core-flows", - "children": [ - { - "type": "link", - "title": "Overview", - "path": "/medusa-workflows-reference", - "loaded": true, - "isPathHref": true - }, - { - "type": "separator" - }, - { - "type": "category", - "title": "Api Key", - "children": [ - { - "type": "sub-category", - "title": "Workflows", + "type": "category", + "title": "Self-Hosting", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "path": "/references/medusa-workflows/createApiKeysWorkflow", - "title": "createApiKeysWorkflow", - "description": "Create secret or publishable API keys.", + "path": "https://docs.medusajs.com/learn/deployment/general", + "title": "General", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", - "path": "/references/medusa-workflows/deleteApiKeysWorkflow", - "title": "deleteApiKeysWorkflow", - "description": "Delete secret or publishable API keys.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/linkSalesChannelsToApiKeyWorkflow", - "title": "linkSalesChannelsToApiKeyWorkflow", - "description": "Manage the sales channels of a publishable API key.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/revokeApiKeysWorkflow", - "title": "revokeApiKeysWorkflow", - "description": "Revoke secret or publishable API keys.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateApiKeysWorkflow", - "title": "updateApiKeysWorkflow", - "description": "Update secret or publishable API keys.", + "path": "/deployment/medusa-application/railway", + "title": "Railway", "children": [] } - ], - "loaded": true + ] }, { - "type": "sub-category", + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Next.js Starter", + "autogenerate_path": "/deployment/storefront", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/deployment/storefront/vercel", + "title": "Vercel", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "troubleshooting", + "title": "Troubleshooting", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/troubleshooting", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Installation", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/troubleshooting/create-medusa-app-errors", + "title": "Create Medusa App Errors", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/troubleshooting/errors-installing-cli", + "title": "Errors Installing CLI", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/troubleshooting/general-errors", + "title": "General Errors", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Medusa Application", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/troubleshooting/eaddrinuse", + "title": "EADDRINUSE Error", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/troubleshooting/database-errors", + "title": "Database Errors", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/troubleshooting/dist-imports", + "title": "Importing from /dist", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/troubleshooting/workflow-errors", + "title": "Workflow Errors", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/troubleshooting/test-errors", + "title": "Test Errors", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin Development", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/troubleshooting/medusa-admin/no-widget-route", + "title": "Widget or Route not Showing", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Upgrade", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/troubleshooting/errors-after-upgrading", + "title": "Errors After Upgrading", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Frontend", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/troubleshooting/cors-errors", + "title": "CORS Errors", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Integrations", + "hasTitleStyling": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/troubleshooting/s3", + "title": "S3 Module Provider Errors", + "children": [] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/admin-widget-injection-zones", + "title": "Admin Widget Injection Zones", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "admin-components", + "title": "Admin Components", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/admin-components", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Layouts", + "autogenerate_path": "/admin-components/layouts", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/admin-components/layouts/single-column", + "title": "Single Column", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/admin-components/layouts/two-column", + "title": "Two Column", + "description": "", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Components", + "autogenerate_path": "/admin-components/components", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/admin-components/components/action-menu", + "title": "Action Menu", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/admin-components/components/container", + "title": "Container", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/admin-components/components/data-table", + "title": "Data Table", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/admin-components/components/forms", + "title": "Forms", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/admin-components/components/header", + "title": "Header", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/admin-components/components/json-view-section", + "title": "JSON View", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/admin-components/components/section-row", + "title": "Section Row", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/admin-components/components/table", + "title": "Table", + "description": "", + "children": [] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Lists", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/medusa-container-resources", + "title": "Container Dependencies", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/events-reference", + "title": "Events List", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "References", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "workflows-sdk-reference", + "title": "Workflows SDK", + "childSidebarTitle": "Workflows SDK Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/workflows", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Functions", + "autogenerate_path": "/references/workflows/functions", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/workflows/createHook", + "title": "createHook", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/workflows/createStep", + "title": "createStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/workflows/createWorkflow", + "title": "createWorkflow", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/workflows/parallelize", + "title": "parallelize", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/workflows/transform", + "title": "transform", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "dml-reference", + "title": "Data Model Language", + "childSidebarTitle": "Data Model Language Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/define", + "title": "Define Method", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Property Types", + "autogenerate_path": "/references/dml/Property_Types/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/property-types/array", + "title": "array", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/property-types/bignumber", + "title": "bigNumber", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/property-types/boolean", + "title": "boolean", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/property-types/datetime", + "title": "dateTime", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/property-types/enum", + "title": "enum", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/property-types/float", + "title": "float", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/property-types/id", + "title": "id", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/property-types/json", + "title": "json", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/property-types/number", + "title": "number", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/property-types/text", + "title": "text", + "description": "", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Relationship Methods", + "autogenerate_path": "/references/dml/Relationship_Methods/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/relationship-methods/belongsto", + "title": "belongsTo", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/relationship-methods/hasmany", + "title": "hasMany", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/relationship-methods/hasone", + "title": "hasOne", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/relationship-methods/manytomany", + "title": "manyToMany", + "description": "", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Model Methods", + "autogenerate_path": "/references/dml/Model_Methods/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/model-methods/cascades", + "title": "cascades", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/model-methods/indexes", + "title": "indexes", + "description": "", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Property Configuration Methods", + "autogenerate_path": "/references/dml/Property_Configuration_Methods/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/property-configuration/computed", + "title": "computed", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/property-configuration/default", + "title": "default", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/property-configuration/index", + "title": "index", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/property-configuration/nullable", + "title": "nullable", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/property-configuration/unique", + "title": "unique", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "service-factory-reference", + "title": "Service Factory", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/service-factory-reference", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Methods", + "autogenerate_path": "/service-factory-reference/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/service-factory-reference/methods/create", + "title": "create", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/service-factory-reference/methods/delete", + "title": "delete", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/service-factory-reference/methods/list", + "title": "list", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/service-factory-reference/methods/listAndCount", + "title": "listAndCount", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/service-factory-reference/methods/restore", + "title": "restore", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/service-factory-reference/methods/retrieve", + "title": "retrieve", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/service-factory-reference/methods/soft-delete", + "title": "softDelete", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/service-factory-reference/methods/update", + "title": "update", + "description": "", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Tips", + "autogenerate_path": "/service-factory-reference/tips", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/service-factory-reference/tips/filtering", + "title": "Filtering", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "helper-steps-reference", + "title": "Helper Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/helper-steps", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", "title": "Steps", + "autogenerate_path": "/references/helper_steps/functions", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "path": "/references/medusa-workflows/steps/createApiKeysStep", - "title": "createApiKeysStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteApiKeysStep", - "title": "deleteApiKeysStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/linkSalesChannelsToApiKeyStep", - "title": "linkSalesChannelsToApiKeyStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/revokeApiKeysStep", - "title": "revokeApiKeysStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateApiKeysStep", - "title": "updateApiKeysStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validateSalesChannelsExistStep", - "title": "validateSalesChannelsExistStep", - "description": "", - "children": [] - } - ], - "loaded": true - } - ], - "loaded": true, - "initialOpen": false - }, - { - "type": "category", - "title": "Auth", - "children": [ - { - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/generateResetPasswordTokenWorkflow", - "title": "generateResetPasswordTokenWorkflow", - "description": "Generate a reset password token for a user or customer.", - "children": [] - } - ], - "loaded": true - }, - { - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/setAuthAppMetadataStep", - "title": "setAuthAppMetadataStep", - "description": "", - "children": [] - } - ], - "loaded": true - } - ], - "loaded": true, - "initialOpen": false - }, - { - "type": "category", - "title": "Cart", - "children": [ - { - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/addShippingMethodToCartWorkflow", - "title": "addShippingMethodToCartWorkflow", - "description": "Add a shipping method to a cart.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/addToCartWorkflow", - "title": "addToCartWorkflow", - "description": "Add a line item to a cart.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/completeCartWorkflow", - "title": "completeCartWorkflow", - "description": "Complete a cart and place an order.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/confirmVariantInventoryWorkflow", - "title": "confirmVariantInventoryWorkflow", - "description": "Validate that a variant is in-stock before adding to the cart.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createCartCreditLinesWorkflow", - "title": "createCartCreditLinesWorkflow", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createCartWorkflow", - "title": "createCartWorkflow", - "description": "Create a cart specifying region, items, and more.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createPaymentCollectionForCartWorkflow", - "title": "createPaymentCollectionForCartWorkflow", - "description": "Create payment collection for cart.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteCartCreditLinesWorkflow", - "title": "deleteCartCreditLinesWorkflow", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/listShippingOptionsForCartWithPricingWorkflow", - "title": "listShippingOptionsForCartWithPricingWorkflow", - "description": "List a cart's shipping options with prices.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/listShippingOptionsForCartWorkflow", - "title": "listShippingOptionsForCartWorkflow", - "description": "List a cart's shipping options.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/refreshCartItemsWorkflow", - "title": "refreshCartItemsWorkflow", - "description": "Refresh a cart's details after an update.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/refreshCartShippingMethodsWorkflow", - "title": "refreshCartShippingMethodsWorkflow", - "description": "Refresh a cart's shipping methods after an update.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/refreshPaymentCollectionForCartWorkflow", - "title": "refreshPaymentCollectionForCartWorkflow", - "description": "Refresh a cart's payment collection details.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/transferCartCustomerWorkflow", - "title": "transferCartCustomerWorkflow", - "description": "Refresh a cart's payment collection details.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateCartPromotionsWorkflow", - "title": "updateCartPromotionsWorkflow", - "description": "Update a cart's applied promotions to add, replace, or remove them.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateCartWorkflow", - "title": "updateCartWorkflow", - "description": "Update a cart's details, such as region, address, and more.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateLineItemInCartWorkflow", - "title": "updateLineItemInCartWorkflow", - "description": "Update a cart's line item.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateTaxLinesWorkflow", - "title": "updateTaxLinesWorkflow", - "description": "Update a cart's tax lines.", - "children": [] - } - ], - "loaded": true - }, - { - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/addShippingMethodToCartStep", - "title": "addShippingMethodToCartStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/confirmInventoryStep", - "title": "confirmInventoryStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createCartsStep", - "title": "createCartsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createLineItemAdjustmentsStep", - "title": "createLineItemAdjustmentsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createLineItemsStep", - "title": "createLineItemsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createPaymentCollectionsStep", - "title": "createPaymentCollectionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createShippingMethodAdjustmentsStep", - "title": "createShippingMethodAdjustmentsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/findOneOrAnyRegionStep", - "title": "findOneOrAnyRegionStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/findOrCreateCustomerStep", - "title": "findOrCreateCustomerStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/findSalesChannelStep", - "title": "findSalesChannelStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/getActionsToComputeFromPromotionsStep", - "title": "getActionsToComputeFromPromotionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/getLineItemActionsStep", - "title": "getLineItemActionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/getPromotionCodesToApply", - "title": "getPromotionCodesToApply", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/getVariantPriceSetsStep", - "title": "getVariantPriceSetsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/getVariantsStep", - "title": "getVariantsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/prepareAdjustmentsFromPromotionActionsStep", - "title": "prepareAdjustmentsFromPromotionActionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/removeLineItemAdjustmentsStep", - "title": "removeLineItemAdjustmentsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/removeShippingMethodAdjustmentsStep", - "title": "removeShippingMethodAdjustmentsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/removeShippingMethodFromCartStep", - "title": "removeShippingMethodFromCartStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/reserveInventoryStep", - "title": "reserveInventoryStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/retrieveCartStep", - "title": "retrieveCartStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/setTaxLinesForItemsStep", - "title": "setTaxLinesForItemsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateCartPromotionsStep", - "title": "updateCartPromotionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateCartsStep", - "title": "updateCartsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateLineItemsStep", - "title": "updateLineItemsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateShippingMethodsStep", - "title": "updateShippingMethodsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validateAndReturnShippingMethodsDataStep", - "title": "validateAndReturnShippingMethodsDataStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validateCartPaymentsStep", - "title": "validateCartPaymentsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validateCartShippingOptionsPriceStep", - "title": "validateCartShippingOptionsPriceStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validateCartShippingOptionsStep", - "title": "validateCartShippingOptionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validateCartStep", - "title": "validateCartStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validateLineItemPricesStep", - "title": "validateLineItemPricesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validateShippingStep", - "title": "validateShippingStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validateVariantPricesStep", - "title": "validateVariantPricesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/validateExistingPaymentCollectionStep", - "title": "validateExistingPaymentCollectionStep", - "description": "", - "children": [] - } - ], - "loaded": true - } - ], - "loaded": true, - "initialOpen": false - }, - { - "type": "category", - "title": "Common", - "children": [ - { - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/batchLinksWorkflow", - "title": "batchLinksWorkflow", - "description": "Manage links between two records of linked data models.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createLinksWorkflow", - "title": "createLinksWorkflow", - "description": "Create links between two records of linked data models.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/dismissLinksWorkflow", - "title": "dismissLinksWorkflow", - "description": "Dismiss links between two records of linked data models.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateLinksWorkflow", - "title": "updateLinksWorkflow", - "description": "Update links between two records of linked data models.", - "children": [] - } - ], - "loaded": true - }, - { - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createRemoteLinkStep", + "path": "/references/helper-steps/createRemoteLinkStep", "title": "createRemoteLinkStep", "description": "", "children": [] @@ -19837,7 +19561,7 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "link", - "path": "/references/medusa-workflows/steps/dismissRemoteLinkStep", + "path": "/references/helper-steps/dismissRemoteLinkStep", "title": "dismissRemoteLinkStep", "description": "", "children": [] @@ -19846,7 +19570,7 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "link", - "path": "/references/medusa-workflows/steps/emitEventStep", + "path": "/references/helper-steps/emitEventStep", "title": "emitEventStep", "description": "", "children": [] @@ -19855,7 +19579,7 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "link", - "path": "/references/medusa-workflows/steps/removeRemoteLinkStep", + "path": "/references/helper-steps/removeRemoteLinkStep", "title": "removeRemoteLinkStep", "description": "", "children": [] @@ -19864,7 +19588,7 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "link", - "path": "/references/medusa-workflows/steps/updateRemoteLinksStep", + "path": "/references/helper-steps/updateRemoteLinksStep", "title": "updateRemoteLinksStep", "description": "", "children": [] @@ -19873,7 +19597,7 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "link", - "path": "/references/medusa-workflows/steps/useQueryGraphStep", + "path": "/references/helper-steps/useQueryGraphStep", "title": "useQueryGraphStep", "description": "", "children": [] @@ -19882,7 +19606,7 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "link", - "path": "/references/medusa-workflows/steps/useRemoteQueryStep", + "path": "/references/helper-steps/useRemoteQueryStep", "title": "useRemoteQueryStep", "description": "", "children": [] @@ -19891,5300 +19615,6169 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "link", - "path": "/references/medusa-workflows/steps/validatePresenceOfStep", + "path": "/references/helper-steps/validatePresenceOfStep", "title": "validatePresenceOfStep", "description": "", "children": [] } - ], - "loaded": true + ] } - ], - "loaded": true, - "initialOpen": false + ] }, - { - "type": "category", - "title": "Customer", - "children": [ - { - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createCustomerAccountWorkflow", - "title": "createCustomerAccountWorkflow", - "description": "Create or register a customer account.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createCustomerAddressesWorkflow", - "title": "createCustomerAddressesWorkflow", - "description": "Create one or more customer addresses.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createCustomersWorkflow", - "title": "createCustomersWorkflow", - "description": "Create one or more customers.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteCustomerAddressesWorkflow", - "title": "deleteCustomerAddressesWorkflow", - "description": "Delete one or more customer addresses.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteCustomersWorkflow", - "title": "deleteCustomersWorkflow", - "description": "Delete one or more customers.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeCustomerAccountWorkflow", - "title": "removeCustomerAccountWorkflow", - "description": "Delete a customer account and its auth identity association.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateCustomerAddressesWorkflow", - "title": "updateCustomerAddressesWorkflow", - "description": "Update one or more customer addresses.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateCustomersWorkflow", - "title": "updateCustomersWorkflow", - "description": "Update one or more customers.", - "children": [] - } - ], - "loaded": true - }, - { - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createCustomerAddressesStep", - "title": "createCustomerAddressesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createCustomersStep", - "title": "createCustomersStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteCustomerAddressesStep", - "title": "deleteCustomerAddressesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteCustomersStep", - "title": "deleteCustomersStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/maybeUnsetDefaultBillingAddressesStep", - "title": "maybeUnsetDefaultBillingAddressesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/maybeUnsetDefaultShippingAddressesStep", - "title": "maybeUnsetDefaultShippingAddressesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateCustomerAddressesStep", - "title": "updateCustomerAddressesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateCustomersStep", - "title": "updateCustomersStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validateCustomerAccountCreation", - "title": "validateCustomerAccountCreation", - "description": "", - "children": [] - } - ], - "loaded": true - } - ], - "loaded": true, - "initialOpen": false - }, - { - "type": "category", - "title": "Customer Group", - "children": [ - { - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createCustomerGroupsWorkflow", - "title": "createCustomerGroupsWorkflow", - "description": "Create one or more customer groups.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteCustomerGroupsWorkflow", - "title": "deleteCustomerGroupsWorkflow", - "description": "Delete one or more customer groups.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/linkCustomerGroupsToCustomerWorkflow", - "title": "linkCustomerGroupsToCustomerWorkflow", - "description": "Manage groups of a customer.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/linkCustomersToCustomerGroupWorkflow", - "title": "linkCustomersToCustomerGroupWorkflow", - "description": "Manage the customers of a customer group.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateCustomerGroupsWorkflow", - "title": "updateCustomerGroupsWorkflow", - "description": "Update one or more customer groups.", - "children": [] - } - ], - "loaded": true - }, - { - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createCustomerGroupsStep", - "title": "createCustomerGroupsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteCustomerGroupStep", - "title": "deleteCustomerGroupStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/linkCustomerGroupsToCustomerStep", - "title": "linkCustomerGroupsToCustomerStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/linkCustomersToCustomerGroupStep", - "title": "linkCustomersToCustomerGroupStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateCustomerGroupsStep", - "title": "updateCustomerGroupsStep", - "description": "", - "children": [] - } - ], - "loaded": true - } - ], - "loaded": true, - "initialOpen": false - }, - { - "type": "category", - "title": "Defaults", - "children": [ - { - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createDefaultsWorkflow", - "title": "createDefaultsWorkflow", - "description": "Create default data for a Medusa application.", - "children": [] - } - ], - "loaded": true - }, - { - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createDefaultStoreStep", - "title": "createDefaultStoreStep", - "description": "", - "children": [] - } - ], - "loaded": true - } - ], - "loaded": true, - "initialOpen": false - }, - { - "type": "category", - "title": "File", - "children": [ - { - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteFilesWorkflow", - "title": "deleteFilesWorkflow", - "description": "Delete files from the database and storage.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/uploadFilesWorkflow", - "title": "uploadFilesWorkflow", - "description": "Upload files using the installed File Module Provider.", - "children": [] - } - ], - "loaded": true - }, - { - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteFilesStep", - "title": "deleteFilesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/uploadFilesStep", - "title": "uploadFilesStep", - "description": "", - "children": [] - } - ], - "loaded": true - } - ], - "loaded": true, - "initialOpen": false - }, - { - "type": "category", - "title": "Fulfillment", - "children": [ - { - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/batchShippingOptionRulesWorkflow", - "title": "batchShippingOptionRulesWorkflow", - "description": "Manage shipping option rules.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/calculateShippingOptionsPricesWorkflow", - "title": "calculateShippingOptionsPricesWorkflow", - "description": "Calculate shipping option prices in a cart.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelFulfillmentWorkflow", - "title": "cancelFulfillmentWorkflow", - "description": "Cancel a fulfillment.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createFulfillmentWorkflow", - "title": "createFulfillmentWorkflow", - "description": "Create a fulfillment.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createReturnFulfillmentWorkflow", - "title": "createReturnFulfillmentWorkflow", - "description": "Create a fulfillment for a return.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createServiceZonesWorkflow", - "title": "createServiceZonesWorkflow", - "description": "Create one or more service zones.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createShipmentWorkflow", - "title": "createShipmentWorkflow", - "description": "Create a shipment for a fulfillment.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createShippingOptionsWorkflow", - "title": "createShippingOptionsWorkflow", - "description": "Create shipping options.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createShippingProfilesWorkflow", - "title": "createShippingProfilesWorkflow", - "description": "Create one or more shipping profiles.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteFulfillmentSetsWorkflow", - "title": "deleteFulfillmentSetsWorkflow", - "description": "Delete one or more fulfillment sets.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteServiceZonesWorkflow", - "title": "deleteServiceZonesWorkflow", - "description": "Delete one or more service zones.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteShippingOptionsWorkflow", - "title": "deleteShippingOptionsWorkflow", - "description": "Delete one or more shipping options.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/markFulfillmentAsDeliveredWorkflow", - "title": "markFulfillmentAsDeliveredWorkflow", - "description": "Mark a fulfillment as delivered.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateFulfillmentWorkflow", - "title": "updateFulfillmentWorkflow", - "description": "Update a fulfillment.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateServiceZonesWorkflow", - "title": "updateServiceZonesWorkflow", - "description": "Update one or more service zones.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateShippingOptionsWorkflow", - "title": "updateShippingOptionsWorkflow", - "description": "Update one or more shipping options.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateShippingProfilesWorkflow", - "title": "updateShippingProfilesWorkflow", - "description": "Update one or more shipping profiles.", - "children": [] - } - ], - "loaded": true - }, - { - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/buildPriceSet", - "title": "buildPriceSet", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/calculateShippingOptionsPricesStep", - "title": "calculateShippingOptionsPricesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/cancelFulfillmentStep", - "title": "cancelFulfillmentStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createFulfillmentSets", - "title": "createFulfillmentSets", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createFulfillmentStep", - "title": "createFulfillmentStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createReturnFulfillmentStep", - "title": "createReturnFulfillmentStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createServiceZonesStep", - "title": "createServiceZonesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createShippingOptionRulesStep", - "title": "createShippingOptionRulesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createShippingOptionsPriceSetsStep", - "title": "createShippingOptionsPriceSetsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createShippingProfilesStep", - "title": "createShippingProfilesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteFulfillmentSetsStep", - "title": "deleteFulfillmentSetsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteServiceZonesStep", - "title": "deleteServiceZonesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteShippingOptionRulesStep", - "title": "deleteShippingOptionRulesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteShippingOptionsStep", - "title": "deleteShippingOptionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/setShippingOptionsPricesStep", - "title": "setShippingOptionsPricesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateFulfillmentStep", - "title": "updateFulfillmentStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateServiceZonesStep", - "title": "updateServiceZonesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateShippingOptionRulesStep", - "title": "updateShippingOptionRulesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateShippingProfilesStep", - "title": "updateShippingProfilesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/upsertShippingOptionsStep", - "title": "upsertShippingOptionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validateShipmentStep", - "title": "validateShipmentStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validateShippingOptionPricesStep", - "title": "validateShippingOptionPricesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/validateFulfillmentDeliverabilityStep", - "title": "validateFulfillmentDeliverabilityStep", - "description": "", - "children": [] - } - ], - "loaded": true - } - ], - "loaded": true, - "initialOpen": false - }, - { - "type": "category", - "title": "Inventory", - "children": [ - { - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/batchInventoryItemLevelsWorkflow", - "title": "batchInventoryItemLevelsWorkflow", - "description": "Manage inventory levels in bulk.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/bulkCreateDeleteLevelsWorkflow", - "title": "bulkCreateDeleteLevelsWorkflow", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createInventoryItemsWorkflow", - "title": "createInventoryItemsWorkflow", - "description": "Create one or more inventory items.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createInventoryLevelsWorkflow", - "title": "createInventoryLevelsWorkflow", - "description": "Create one or more inventory levels.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteInventoryItemWorkflow", - "title": "deleteInventoryItemWorkflow", - "description": "Delete one or more inventory items.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteInventoryLevelsWorkflow", - "title": "deleteInventoryLevelsWorkflow", - "description": "Delete one or more inventory levels.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateInventoryItemsWorkflow", - "title": "updateInventoryItemsWorkflow", - "description": "Update one or more inventory items.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateInventoryLevelsWorkflow", - "title": "updateInventoryLevelsWorkflow", - "description": "Update one or more inventory levels.", - "children": [] - } - ], - "loaded": true - }, - { - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/adjustInventoryLevelsStep", - "title": "adjustInventoryLevelsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/attachInventoryItemToVariants", - "title": "attachInventoryItemToVariants", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createInventoryItemsStep", - "title": "createInventoryItemsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createInventoryLevelsStep", - "title": "createInventoryLevelsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteInventoryItemStep", - "title": "deleteInventoryItemStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteInventoryLevelsStep", - "title": "deleteInventoryLevelsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateInventoryItemsStep", - "title": "updateInventoryItemsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateInventoryLevelsStep", - "title": "updateInventoryLevelsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validateInventoryDeleteStep", - "title": "validateInventoryDeleteStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validateInventoryItemsForCreate", - "title": "validateInventoryItemsForCreate", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validateInventoryLocationsStep", - "title": "validateInventoryLocationsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/validateInventoryLevelsDelete", - "title": "validateInventoryLevelsDelete", - "description": "", - "children": [] - } - ], - "loaded": true - } - ], - "loaded": true, - "initialOpen": false - }, - { - "type": "category", - "title": "Invite", - "children": [ - { - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/acceptInviteWorkflow", - "title": "acceptInviteWorkflow", - "description": "Accept invite and create user.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createInvitesWorkflow", - "title": "createInvitesWorkflow", - "description": "Create one or more user invites.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteInvitesWorkflow", - "title": "deleteInvitesWorkflow", - "description": "Delete one or more user invites.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/refreshInviteTokensWorkflow", - "title": "refreshInviteTokensWorkflow", - "description": "Refresh user invite tokens.", - "children": [] - } - ], - "loaded": true - }, - { - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createInviteStep", - "title": "createInviteStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteInvitesStep", - "title": "deleteInvitesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/refreshInviteTokensStep", - "title": "refreshInviteTokensStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validateTokenStep", - "title": "validateTokenStep", - "description": "", - "children": [] - } - ], - "loaded": true - } - ], - "loaded": true, - "initialOpen": false - }, - { - "type": "category", - "title": "Line Item", - "children": [ - { - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteLineItemsWorkflow", - "title": "deleteLineItemsWorkflow", - "description": "Delete line items from a cart.", - "children": [] - } - ], - "loaded": true - }, - { - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteLineItemsStep", - "title": "deleteLineItemsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/listLineItemsStep", - "title": "listLineItemsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateLineItemsStepWithSelector", - "title": "updateLineItemsStepWithSelector", - "description": "", - "children": [] - } - ], - "loaded": true - } - ], - "loaded": true, - "initialOpen": false - }, - { - "type": "category", - "title": "Notification", - "children": [ - { - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/notifyOnFailureStep", - "title": "notifyOnFailureStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/sendNotificationsStep", - "title": "sendNotificationsStep", - "description": "", - "children": [] - } - ], - "loaded": true - } - ], - "loaded": true, - "initialOpen": false - }, - { - "type": "category", - "title": "Order", - "children": [ - { - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/acceptOrderTransferWorkflow", - "title": "acceptOrderTransferWorkflow", - "description": "Accept an order transfer request.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/addOrderLineItemsWorkflow", - "title": "addOrderLineItemsWorkflow", - "description": "Add line items to an order.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/archiveOrderWorkflow", - "title": "archiveOrderWorkflow", - "description": "Archive one or more orders.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/beginClaimOrderWorkflow", - "title": "beginClaimOrderWorkflow", - "description": "Create an order claim in requested state.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/beginExchangeOrderWorkflow", - "title": "beginExchangeOrderWorkflow", - "description": "Request an order exchange.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/beginOrderEditOrderWorkflow", - "title": "beginOrderEditOrderWorkflow", - "description": "Create an order edit request.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/beginReceiveReturnWorkflow", - "title": "beginReceiveReturnWorkflow", - "description": "Request a return receival.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/beginReturnOrderWorkflow", - "title": "beginReturnOrderWorkflow", - "description": "Create a return for an order.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelBeginOrderClaimWorkflow", - "title": "cancelBeginOrderClaimWorkflow", - "description": "Cancel a requested order claim.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelBeginOrderEditWorkflow", - "title": "cancelBeginOrderEditWorkflow", - "description": "Cancel a requested order edit.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelBeginOrderExchangeWorkflow", - "title": "cancelBeginOrderExchangeWorkflow", - "description": "Cancel a requested order exchange.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelOrderChangeWorkflow", - "title": "cancelOrderChangeWorkflow", - "description": "Cancel an order change.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelOrderClaimWorkflow", - "title": "cancelOrderClaimWorkflow", - "description": "Cancel a confirmed order claim.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelOrderExchangeWorkflow", - "title": "cancelOrderExchangeWorkflow", - "description": "Cancel an exchange for an order.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelOrderFulfillmentWorkflow", - "title": "cancelOrderFulfillmentWorkflow", - "description": "Cancel an order's fulfillment.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelOrderTransferRequestWorkflow", - "title": "cancelOrderTransferRequestWorkflow", - "description": "Cancel an order transfer request.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelOrderWorkflow", - "title": "cancelOrderWorkflow", - "description": "Cancel an order.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelReturnReceiveWorkflow", - "title": "cancelReturnReceiveWorkflow", - "description": "Cancel a return receival.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelReturnRequestWorkflow", - "title": "cancelReturnRequestWorkflow", - "description": "Cancel a requested return.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelReturnWorkflow", - "title": "cancelReturnWorkflow", - "description": "Cancel a return.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/completeOrderWorkflow", - "title": "completeOrderWorkflow", - "description": "Complete one or more orders.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/confirmClaimRequestWorkflow", - "title": "confirmClaimRequestWorkflow", - "description": "Confirm a requested claim.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/confirmExchangeRequestWorkflow", - "title": "confirmExchangeRequestWorkflow", - "description": "Confirm an exchange request.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/confirmOrderEditRequestWorkflow", - "title": "confirmOrderEditRequestWorkflow", - "description": "Confirm an order edit request.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/confirmReturnReceiveWorkflow", - "title": "confirmReturnReceiveWorkflow", - "description": "Confirm a return receival request.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/confirmReturnRequestWorkflow", - "title": "confirmReturnRequestWorkflow", - "description": "Confirm a return request.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createAndCompleteReturnOrderWorkflow", - "title": "createAndCompleteReturnOrderWorkflow", - "description": "Create and complete a return for an order.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createClaimShippingMethodWorkflow", - "title": "createClaimShippingMethodWorkflow", - "description": "Create an inbound or outbound shipping method for a claim.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createExchangeShippingMethodWorkflow", - "title": "createExchangeShippingMethodWorkflow", - "description": "Create an inbound or outbound shipping method for an exchange.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createOrUpdateOrderPaymentCollectionWorkflow", - "title": "createOrUpdateOrderPaymentCollectionWorkflow", - "description": "Create or update payment collection for an order.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createOrderChangeActionsWorkflow", - "title": "createOrderChangeActionsWorkflow", - "description": "Create an order change action.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createOrderChangeWorkflow", - "title": "createOrderChangeWorkflow", - "description": "Create an order change.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createOrderEditShippingMethodWorkflow", - "title": "createOrderEditShippingMethodWorkflow", - "description": "Create a shipping method for an order edit.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createOrderFulfillmentWorkflow", - "title": "createOrderFulfillmentWorkflow", - "description": "Creates a fulfillment for an order.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createOrderPaymentCollectionWorkflow", - "title": "createOrderPaymentCollectionWorkflow", - "description": "Create a payment collection for an order.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createOrderShipmentWorkflow", - "title": "createOrderShipmentWorkflow", - "description": "Creates a shipment for an order.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createOrderWorkflow", - "title": "createOrderWorkflow", - "description": "Create an order.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createOrdersWorkflow", - "title": "createOrdersWorkflow", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createReturnShippingMethodWorkflow", - "title": "createReturnShippingMethodWorkflow", - "description": "Create a shipping method for a return.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/declineOrderChangeWorkflow", - "title": "declineOrderChangeWorkflow", - "description": "Decline an order change.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/declineOrderTransferRequestWorkflow", - "title": "declineOrderTransferRequestWorkflow", - "description": "Decline a requested order transfer.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteOrderChangeActionsWorkflow", - "title": "deleteOrderChangeActionsWorkflow", - "description": "Delete one or more order change actions.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteOrderChangeWorkflow", - "title": "deleteOrderChangeWorkflow", - "description": "Delete one or more order changes.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/dismissItemReturnRequestWorkflow", - "title": "dismissItemReturnRequestWorkflow", - "description": "Dismiss items from a return request.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/getOrderDetailWorkflow", - "title": "getOrderDetailWorkflow", - "description": "Retrieve an order's details.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/getOrdersListWorkflow", - "title": "getOrdersListWorkflow", - "description": "Retrieve a list of orders.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/markOrderFulfillmentAsDeliveredWorkflow", - "title": "markOrderFulfillmentAsDeliveredWorkflow", - "description": "Mark a fulfillment in an order as delivered.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/orderClaimAddNewItemWorkflow", - "title": "orderClaimAddNewItemWorkflow", - "description": "Add outbound or new items to a claim.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/orderClaimItemWorkflow", - "title": "orderClaimItemWorkflow", - "description": "Add order items to a claim as claim items.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/orderClaimRequestItemReturnWorkflow", - "title": "orderClaimRequestItemReturnWorkflow", - "description": "Request one or more items to be returned as part of a claim.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/orderEditAddNewItemWorkflow", - "title": "orderEditAddNewItemWorkflow", - "description": "Add new items to an order edit.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/orderEditUpdateItemQuantityWorkflow", - "title": "orderEditUpdateItemQuantityWorkflow", - "description": "Update the quantity of an existing order item in the order's edit.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/orderExchangeAddNewItemWorkflow", - "title": "orderExchangeAddNewItemWorkflow", - "description": "Add new or outbound items to an exchange.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/orderExchangeRequestItemReturnWorkflow", - "title": "orderExchangeRequestItemReturnWorkflow", - "description": "Add inbound items to be returned as part of the exchange.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/receiveAndCompleteReturnOrderWorkflow", - "title": "receiveAndCompleteReturnOrderWorkflow", - "description": "Receive and complete a return.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/receiveItemReturnRequestWorkflow", - "title": "receiveItemReturnRequestWorkflow", - "description": "Mark return items as received.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeAddItemClaimActionWorkflow", - "title": "removeAddItemClaimActionWorkflow", - "description": "Remove outbound (new) items from a claim.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeClaimShippingMethodWorkflow", - "title": "removeClaimShippingMethodWorkflow", - "description": "Remove an inbound or outbound shipping method from a claim.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeExchangeShippingMethodWorkflow", - "title": "removeExchangeShippingMethodWorkflow", - "description": "Remove an inbound or outbound shipping method from an exchange.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeItemClaimActionWorkflow", - "title": "removeItemClaimActionWorkflow", - "description": "Remove order items from a claim.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeItemExchangeActionWorkflow", - "title": "removeItemExchangeActionWorkflow", - "description": "Remove an outbound or new item from an exchange.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeItemOrderEditActionWorkflow", - "title": "removeItemOrderEditActionWorkflow", - "description": "Remove an item that was added to an order edit.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeItemReceiveReturnActionWorkflow", - "title": "removeItemReceiveReturnActionWorkflow", - "description": "Remove an item from a return receival.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeItemReturnActionWorkflow", - "title": "removeItemReturnActionWorkflow", - "description": "Remove an item from a return.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeOrderEditShippingMethodWorkflow", - "title": "removeOrderEditShippingMethodWorkflow", - "description": "Remove a shipping method from an order edit.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeReturnShippingMethodWorkflow", - "title": "removeReturnShippingMethodWorkflow", - "description": "Remove a shipping method from a return.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/requestItemReturnWorkflow", - "title": "requestItemReturnWorkflow", - "description": "Add items to a return.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/requestOrderEditRequestWorkflow", - "title": "requestOrderEditRequestWorkflow", - "description": "Request an order edit.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/requestOrderTransferWorkflow", - "title": "requestOrderTransferWorkflow", - "description": "Request a transfer of an order to a customer.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateClaimAddItemWorkflow", - "title": "updateClaimAddItemWorkflow", - "description": "Update a claim's new or outbound item.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateClaimItemWorkflow", - "title": "updateClaimItemWorkflow", - "description": "Update a claim item, added to the claim from an order item.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateClaimShippingMethodWorkflow", - "title": "updateClaimShippingMethodWorkflow", - "description": "Update an inbound or outbound shipping method of a claim.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateExchangeAddItemWorkflow", - "title": "updateExchangeAddItemWorkflow", - "description": "Update an outbound or new item in an exchange.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateExchangeShippingMethodWorkflow", - "title": "updateExchangeShippingMethodWorkflow", - "description": "Update an exchange's inbound or outbound shipping method.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateOrderChangeActionsWorkflow", - "title": "updateOrderChangeActionsWorkflow", - "description": "Update one or more order change actions.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateOrderChangesWorkflow", - "title": "updateOrderChangesWorkflow", - "description": "Update one or more order changes.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateOrderEditAddItemWorkflow", - "title": "updateOrderEditAddItemWorkflow", - "description": "Update a new item in an order edit.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateOrderEditItemQuantityWorkflow", - "title": "updateOrderEditItemQuantityWorkflow", - "description": "Update an existing order item previously added to an order edit.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateOrderEditShippingMethodWorkflow", - "title": "updateOrderEditShippingMethodWorkflow", - "description": "Update a shipping method of an order edit.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateOrderTaxLinesWorkflow", - "title": "updateOrderTaxLinesWorkflow", - "description": "Update the tax lines of items and shipping methods in an order.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateOrderWorkflow", - "title": "updateOrderWorkflow", - "description": "Update an order's details.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateReceiveItemReturnRequestWorkflow", - "title": "updateReceiveItemReturnRequestWorkflow", - "description": "Update an item in a return receival request.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateRequestItemReturnWorkflow", - "title": "updateRequestItemReturnWorkflow", - "description": "Update a requested item in a return.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateReturnShippingMethodWorkflow", - "title": "updateReturnShippingMethodWorkflow", - "description": "Update the shipping method of a return.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateReturnWorkflow", - "title": "updateReturnWorkflow", - "description": "Update a return's details.", - "children": [] - } - ], - "loaded": true - }, - { - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/addOrderTransactionStep", - "title": "addOrderTransactionStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/archiveOrdersStep", - "title": "archiveOrdersStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/cancelOrderChangeStep", - "title": "cancelOrderChangeStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/cancelOrderClaimStep", - "title": "cancelOrderClaimStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/cancelOrderExchangeStep", - "title": "cancelOrderExchangeStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/cancelOrderFulfillmentStep", - "title": "cancelOrderFulfillmentStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/cancelOrderReturnStep", - "title": "cancelOrderReturnStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/cancelOrdersStep", - "title": "cancelOrdersStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/completeOrdersStep", - "title": "completeOrdersStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createCompleteReturnStep", - "title": "createCompleteReturnStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createOrderChangeStep", - "title": "createOrderChangeStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createOrderClaimItemsFromActionsStep", - "title": "createOrderClaimItemsFromActionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createOrderClaimsStep", - "title": "createOrderClaimsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createOrderExchangeItemsFromActionsStep", - "title": "createOrderExchangeItemsFromActionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createOrderExchangesStep", - "title": "createOrderExchangesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createOrderLineItemsStep", - "title": "createOrderLineItemsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createOrdersStep", - "title": "createOrdersStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createReturnsStep", - "title": "createReturnsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/declineOrderChangeStep", - "title": "declineOrderChangeStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteClaimsStep", - "title": "deleteClaimsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteExchangesStep", - "title": "deleteExchangesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteOrderChangeActionsStep", - "title": "deleteOrderChangeActionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteOrderChangesStep", - "title": "deleteOrderChangesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteOrderLineItems", - "title": "deleteOrderLineItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteOrderShippingMethods", - "title": "deleteOrderShippingMethods", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteReturnsStep", - "title": "deleteReturnsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/previewOrderChangeStep", - "title": "previewOrderChangeStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/registerOrderChangesStep", - "title": "registerOrderChangesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/registerOrderFulfillmentStep", - "title": "registerOrderFulfillmentStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/registerOrderShipmentStep", - "title": "registerOrderShipmentStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/setOrderTaxLinesForItemsStep", - "title": "setOrderTaxLinesForItemsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateOrderChangeActionsStep", - "title": "updateOrderChangeActionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateOrderChangesStep", - "title": "updateOrderChangesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateOrderShippingMethodsStep", - "title": "updateOrderShippingMethodsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateOrdersStep", - "title": "updateOrdersStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateReturnItemsStep", - "title": "updateReturnItemsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateReturnsStep", - "title": "updateReturnsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/acceptOrderTransferValidationStep", - "title": "acceptOrderTransferValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/beginClaimOrderValidationStep", - "title": "beginClaimOrderValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/beginOrderEditValidationStep", - "title": "beginOrderEditValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/beginOrderExchangeValidationStep", - "title": "beginOrderExchangeValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/beginReceiveReturnValidationStep", - "title": "beginReceiveReturnValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/beginReturnOrderValidationStep", - "title": "beginReturnOrderValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelBeginOrderClaimValidationStep", - "title": "cancelBeginOrderClaimValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelBeginOrderEditValidationStep", - "title": "cancelBeginOrderEditValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelBeginOrderExchangeValidationStep", - "title": "cancelBeginOrderExchangeValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelClaimValidateOrderStep", - "title": "cancelClaimValidateOrderStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelExchangeValidateOrder", - "title": "cancelExchangeValidateOrder", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelOrderFulfillmentValidateOrder", - "title": "cancelOrderFulfillmentValidateOrder", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelReceiveReturnValidationStep", - "title": "cancelReceiveReturnValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelRequestReturnValidationStep", - "title": "cancelRequestReturnValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelReturnValidateOrder", - "title": "cancelReturnValidateOrder", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelTransferOrderRequestValidationStep", - "title": "cancelTransferOrderRequestValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelValidateOrder", - "title": "cancelValidateOrder", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/confirmClaimRequestValidationStep", - "title": "confirmClaimRequestValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/confirmExchangeRequestValidationStep", - "title": "confirmExchangeRequestValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/confirmOrderEditRequestValidationStep", - "title": "confirmOrderEditRequestValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/confirmReceiveReturnValidationStep", - "title": "confirmReceiveReturnValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/confirmReturnRequestValidationStep", - "title": "confirmReturnRequestValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createClaimShippingMethodValidationStep", - "title": "createClaimShippingMethodValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createCompleteReturnValidationStep", - "title": "createCompleteReturnValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createExchangeShippingMethodValidationStep", - "title": "createExchangeShippingMethodValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createFulfillmentValidateOrder", - "title": "createFulfillmentValidateOrder", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createOrderEditShippingMethodValidationStep", - "title": "createOrderEditShippingMethodValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createReturnShippingMethodValidationStep", - "title": "createReturnShippingMethodValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createShipmentValidateOrder", - "title": "createShipmentValidateOrder", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/declineTransferOrderRequestValidationStep", - "title": "declineTransferOrderRequestValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteOrderPaymentCollections", - "title": "deleteOrderPaymentCollections", - "description": "Delete a payment collection of an order.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/dismissItemReturnRequestValidationStep", - "title": "dismissItemReturnRequestValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/exchangeAddNewItemValidationStep", - "title": "exchangeAddNewItemValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/exchangeRequestItemReturnValidationStep", - "title": "exchangeRequestItemReturnValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/markPaymentCollectionAsPaid", - "title": "markPaymentCollectionAsPaid", - "description": "Mark a payment collection for an order as paid.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/orderClaimAddNewItemValidationStep", - "title": "orderClaimAddNewItemValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/orderClaimItemValidationStep", - "title": "orderClaimItemValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/orderClaimRequestItemReturnValidationStep", - "title": "orderClaimRequestItemReturnValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/orderEditAddNewItemValidationStep", - "title": "orderEditAddNewItemValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/orderEditUpdateItemQuantityValidationStep", - "title": "orderEditUpdateItemQuantityValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/orderFulfillmentDeliverablilityValidationStep", - "title": "orderFulfillmentDeliverablilityValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/receiveCompleteReturnValidationStep", - "title": "receiveCompleteReturnValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/receiveItemReturnRequestValidationStep", - "title": "receiveItemReturnRequestValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeClaimAddItemActionValidationStep", - "title": "removeClaimAddItemActionValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeClaimItemActionValidationStep", - "title": "removeClaimItemActionValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeClaimShippingMethodValidationStep", - "title": "removeClaimShippingMethodValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeExchangeItemActionValidationStep", - "title": "removeExchangeItemActionValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeExchangeShippingMethodValidationStep", - "title": "removeExchangeShippingMethodValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeItemReceiveReturnActionValidationStep", - "title": "removeItemReceiveReturnActionValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeOrderEditItemActionValidationStep", - "title": "removeOrderEditItemActionValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeOrderEditShippingMethodValidationStep", - "title": "removeOrderEditShippingMethodValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeReturnItemActionValidationStep", - "title": "removeReturnItemActionValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeReturnShippingMethodValidationStep", - "title": "removeReturnShippingMethodValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/requestItemReturnValidationStep", - "title": "requestItemReturnValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/requestOrderEditRequestValidationStep", - "title": "requestOrderEditRequestValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/requestOrderTransferValidationStep", - "title": "requestOrderTransferValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/throwUnlessPaymentCollectionNotPaid", - "title": "throwUnlessPaymentCollectionNotPaid", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/throwUnlessStatusIsNotPaid", - "title": "throwUnlessStatusIsNotPaid", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateClaimAddItemValidationStep", - "title": "updateClaimAddItemValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateClaimItemValidationStep", - "title": "updateClaimItemValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateClaimShippingMethodValidationStep", - "title": "updateClaimShippingMethodValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateExchangeAddItemValidationStep", - "title": "updateExchangeAddItemValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateExchangeShippingMethodValidationStep", - "title": "updateExchangeShippingMethodValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateOrderEditAddItemValidationStep", - "title": "updateOrderEditAddItemValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateOrderEditItemQuantityValidationStep", - "title": "updateOrderEditItemQuantityValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateOrderEditShippingMethodValidationStep", - "title": "updateOrderEditShippingMethodValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateOrderValidationStep", - "title": "updateOrderValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateReceiveItemReturnRequestValidationStep", - "title": "updateReceiveItemReturnRequestValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateRequestItemReturnValidationStep", - "title": "updateRequestItemReturnValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateReturnShippingMethodValidationStep", - "title": "updateReturnShippingMethodValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateReturnValidationStep", - "title": "updateReturnValidationStep", - "description": "", - "children": [] - } - ], - "loaded": true - } - ], - "loaded": true, - "initialOpen": false - }, - { - "type": "category", - "title": "Payment", - "children": [ - { - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/capturePaymentWorkflow", - "title": "capturePaymentWorkflow", - "description": "Capture a payment.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/processPaymentWorkflow", - "title": "processPaymentWorkflow", - "description": "Process a payment based on a webhook event.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/refundPaymentWorkflow", - "title": "refundPaymentWorkflow", - "description": "Refund a payment.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/refundPaymentsWorkflow", - "title": "refundPaymentsWorkflow", - "description": "Refund one or more payments.", - "children": [] - } - ], - "loaded": true - }, - { - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/authorizePaymentSessionStep", - "title": "authorizePaymentSessionStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/cancelPaymentStep", - "title": "cancelPaymentStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/capturePaymentStep", - "title": "capturePaymentStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/refundPaymentStep", - "title": "refundPaymentStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/refundPaymentsStep", - "title": "refundPaymentsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/validatePaymentsRefundStep", - "title": "validatePaymentsRefundStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/validateRefundStep", - "title": "validateRefundStep", - "description": "", - "children": [] - } - ], - "loaded": true - } - ], - "loaded": true, - "initialOpen": false - }, - { - "type": "category", - "title": "Payment Collection", - "children": [ - { - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createPaymentSessionsWorkflow", - "title": "createPaymentSessionsWorkflow", - "description": "Create payment sessions.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createRefundReasonsWorkflow", - "title": "createRefundReasonsWorkflow", - "description": "Create refund reasons.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deletePaymentSessionsWorkflow", - "title": "deletePaymentSessionsWorkflow", - "description": "Delete payment sessions.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteRefundReasonsWorkflow", - "title": "deleteRefundReasonsWorkflow", - "description": "Delete refund reasons.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateRefundReasonsWorkflow", - "title": "updateRefundReasonsWorkflow", - "description": "Update refund reasons.", - "children": [] - } - ], - "loaded": true - }, - { - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createPaymentAccountHolderStep", - "title": "createPaymentAccountHolderStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createPaymentSessionStep", - "title": "createPaymentSessionStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createRefundReasonStep", - "title": "createRefundReasonStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deletePaymentSessionsStep", - "title": "deletePaymentSessionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteRefundReasonsStep", - "title": "deleteRefundReasonsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updatePaymentCollectionStep", - "title": "updatePaymentCollectionStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateRefundReasonsStep", - "title": "updateRefundReasonsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validateDeletedPaymentSessionsStep", - "title": "validateDeletedPaymentSessionsStep", - "description": "", - "children": [] - } - ], - "loaded": true - } - ], - "loaded": true, - "initialOpen": false - }, - { - "type": "category", - "title": "Price List", - "children": [ - { - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/batchPriceListPricesWorkflow", - "title": "batchPriceListPricesWorkflow", - "description": "Manage a price list's prices.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createPriceListPricesWorkflow", - "title": "createPriceListPricesWorkflow", - "description": "Create prices in price lists.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createPriceListsWorkflow", - "title": "createPriceListsWorkflow", - "description": "Create one or more price lists.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deletePriceListsWorkflow", - "title": "deletePriceListsWorkflow", - "description": "Delete one or more price lists.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removePriceListPricesWorkflow", - "title": "removePriceListPricesWorkflow", - "description": "Remove prices in price lists.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updatePriceListPricesWorkflow", - "title": "updatePriceListPricesWorkflow", - "description": "Update price lists' prices.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updatePriceListsWorkflow", - "title": "updatePriceListsWorkflow", - "description": "Update one or more price lists.", - "children": [] - } - ], - "loaded": true - }, - { - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createPriceListPricesStep", - "title": "createPriceListPricesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createPriceListsStep", - "title": "createPriceListsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deletePriceListsStep", - "title": "deletePriceListsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/getExistingPriceListsPriceIdsStep", - "title": "getExistingPriceListsPriceIdsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/removePriceListPricesStep", - "title": "removePriceListPricesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updatePriceListPricesStep", - "title": "updatePriceListPricesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updatePriceListsStep", - "title": "updatePriceListsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validatePriceListsStep", - "title": "validatePriceListsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validateVariantPriceLinksStep", - "title": "validateVariantPriceLinksStep", - "description": "", - "children": [] - } - ], - "loaded": true - } - ], - "loaded": true, - "initialOpen": false - }, - { - "type": "category", - "title": "Pricing", - "children": [ - { - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createPricePreferencesWorkflow", - "title": "createPricePreferencesWorkflow", - "description": "Create one or more price preferences.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deletePricePreferencesWorkflow", - "title": "deletePricePreferencesWorkflow", - "description": "Delete one or more price preferences.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updatePricePreferencesWorkflow", - "title": "updatePricePreferencesWorkflow", - "description": "Update one or more price preferences.", - "children": [] - } - ], - "loaded": true - }, - { - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createPricePreferencesStep", - "title": "createPricePreferencesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createPriceSetsStep", - "title": "createPriceSetsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deletePricePreferencesStep", - "title": "deletePricePreferencesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updatePricePreferencesAsArrayStep", - "title": "updatePricePreferencesAsArrayStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updatePricePreferencesStep", - "title": "updatePricePreferencesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updatePriceSetsStep", - "title": "updatePriceSetsStep", - "description": "", - "children": [] - } - ], - "loaded": true - } - ], - "loaded": true, - "initialOpen": false - }, - { - "type": "category", - "title": "Product", - "children": [ - { - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/batchLinkProductsToCategoryWorkflow", - "title": "batchLinkProductsToCategoryWorkflow", - "description": "Manage the links between a collection and products.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/batchLinkProductsToCollectionWorkflow", - "title": "batchLinkProductsToCollectionWorkflow", - "description": "Manage the links between a collection and products.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/batchProductVariantsWorkflow", - "title": "batchProductVariantsWorkflow", - "description": "Create, update, and delete product variants.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/batchProductsWorkflow", - "title": "batchProductsWorkflow", - "description": "Manage products in bulk.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createCollectionsWorkflow", - "title": "createCollectionsWorkflow", - "description": "Create one or more product collections.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createProductOptionsWorkflow", - "title": "createProductOptionsWorkflow", - "description": "Create one or more product options.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createProductTagsWorkflow", - "title": "createProductTagsWorkflow", - "description": "Create one or more product tags.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createProductTypesWorkflow", - "title": "createProductTypesWorkflow", - "description": "Create one or more product types.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createProductVariantsWorkflow", - "title": "createProductVariantsWorkflow", - "description": "Create one or more product variants.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createProductsWorkflow", - "title": "createProductsWorkflow", - "description": "Create one or more products with options and variants.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteCollectionsWorkflow", - "title": "deleteCollectionsWorkflow", - "description": "Delete one or more product collection.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteProductOptionsWorkflow", - "title": "deleteProductOptionsWorkflow", - "description": "Delete one or more product option.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteProductTagsWorkflow", - "title": "deleteProductTagsWorkflow", - "description": "Delete one or more product tags.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteProductTypesWorkflow", - "title": "deleteProductTypesWorkflow", - "description": "Delete one or more product types.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteProductVariantsWorkflow", - "title": "deleteProductVariantsWorkflow", - "description": "Delete one or more product variants.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteProductsWorkflow", - "title": "deleteProductsWorkflow", - "description": "Delete one or more products.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/exportProductsWorkflow", - "title": "exportProductsWorkflow", - "description": "Export products with filtering capabilities.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/importProductsWorkflow", - "title": "importProductsWorkflow", - "description": "Import products from a CSV file.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateCollectionsWorkflow", - "title": "updateCollectionsWorkflow", - "description": "Update one or more product collections.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateProductOptionsWorkflow", - "title": "updateProductOptionsWorkflow", - "description": "Update one or more product options.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateProductTagsWorkflow", - "title": "updateProductTagsWorkflow", - "description": "Update one or more product tags.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateProductTypesWorkflow", - "title": "updateProductTypesWorkflow", - "description": "Update one or more product types.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateProductVariantsWorkflow", - "title": "updateProductVariantsWorkflow", - "description": "Update one or more product variants.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateProductsWorkflow", - "title": "updateProductsWorkflow", - "description": "Update one or more products with options and variants.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/upsertVariantPricesWorkflow", - "title": "upsertVariantPricesWorkflow", - "description": "Create, update, or remove variants' prices.", - "children": [] - } - ], - "loaded": true - }, - { - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/batchLinkProductsToCategoryStep", - "title": "batchLinkProductsToCategoryStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/batchLinkProductsToCollectionStep", - "title": "batchLinkProductsToCollectionStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createCollectionsStep", - "title": "createCollectionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createProductOptionsStep", - "title": "createProductOptionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createProductTagsStep", - "title": "createProductTagsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createProductTypesStep", - "title": "createProductTypesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createProductVariantsStep", - "title": "createProductVariantsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createProductsStep", - "title": "createProductsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createVariantPricingLinkStep", - "title": "createVariantPricingLinkStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteCollectionsStep", - "title": "deleteCollectionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteProductOptionsStep", - "title": "deleteProductOptionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteProductTagsStep", - "title": "deleteProductTagsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteProductTypesStep", - "title": "deleteProductTypesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteProductVariantsStep", - "title": "deleteProductVariantsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteProductsStep", - "title": "deleteProductsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/generateProductCsvStep", - "title": "generateProductCsvStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/getAllProductsStep", - "title": "getAllProductsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/getProductsStep", - "title": "getProductsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/getVariantAvailabilityStep", - "title": "getVariantAvailabilityStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/groupProductsForBatchStep", - "title": "groupProductsForBatchStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/parseProductCsvStep", - "title": "parseProductCsvStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateCollectionsStep", - "title": "updateCollectionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateProductOptionsStep", - "title": "updateProductOptionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateProductTagsStep", - "title": "updateProductTagsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateProductTypesStep", - "title": "updateProductTypesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateProductVariantsStep", - "title": "updateProductVariantsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateProductsStep", - "title": "updateProductsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/waitConfirmationProductImportStep", - "title": "waitConfirmationProductImportStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/validateProductInputStep", - "title": "validateProductInputStep", - "description": "", - "children": [] - } - ], - "loaded": true - } - ], - "loaded": true, - "initialOpen": false - }, - { - "type": "category", - "title": "Product Category", - "children": [ - { - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createProductCategoriesWorkflow", - "title": "createProductCategoriesWorkflow", - "description": "Create product categories.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteProductCategoriesWorkflow", - "title": "deleteProductCategoriesWorkflow", - "description": "Delete product categories.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateProductCategoriesWorkflow", - "title": "updateProductCategoriesWorkflow", - "description": "Update product categories.", - "children": [] - } - ], - "loaded": true - }, - { - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createProductCategoriesStep", - "title": "createProductCategoriesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteProductCategoriesStep", - "title": "deleteProductCategoriesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateProductCategoriesStep", - "title": "updateProductCategoriesStep", - "description": "", - "children": [] - } - ], - "loaded": true - } - ], - "loaded": true, - "initialOpen": false - }, - { - "type": "category", - "title": "Promotion", - "children": [ - { - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/addOrRemoveCampaignPromotionsWorkflow", - "title": "addOrRemoveCampaignPromotionsWorkflow", - "description": "Manage the promotions of a campaign.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/batchPromotionRulesWorkflow", - "title": "batchPromotionRulesWorkflow", - "description": "Manage the rules of a promotion.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createCampaignsWorkflow", - "title": "createCampaignsWorkflow", - "description": "Create one or more campaigns.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createPromotionRulesWorkflow", - "title": "createPromotionRulesWorkflow", - "description": "Create one or more promotion rules.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createPromotionsWorkflow", - "title": "createPromotionsWorkflow", - "description": "Create one or more promotions.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteCampaignsWorkflow", - "title": "deleteCampaignsWorkflow", - "description": "Delete one or more campaigns.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deletePromotionRulesWorkflow", - "title": "deletePromotionRulesWorkflow", - "description": "Delete one or more promotion rules.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deletePromotionsWorkflow", - "title": "deletePromotionsWorkflow", - "description": "Delete one or more promotions.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateCampaignsWorkflow", - "title": "updateCampaignsWorkflow", - "description": "Update one or more campaigns.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updatePromotionRulesWorkflow", - "title": "updatePromotionRulesWorkflow", - "description": "Update one or more promotion rules.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updatePromotionsStatusWorkflow", - "title": "updatePromotionsStatusWorkflow", - "description": "Update the status of one or more promotions.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updatePromotionsWorkflow", - "title": "updatePromotionsWorkflow", - "description": "Update one or more promotions.", - "children": [] - } - ], - "loaded": true - }, - { - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/addCampaignPromotionsStep", - "title": "addCampaignPromotionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/addRulesToPromotionsStep", - "title": "addRulesToPromotionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createCampaignsStep", - "title": "createCampaignsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createPromotionsStep", - "title": "createPromotionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteCampaignsStep", - "title": "deleteCampaignsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deletePromotionsStep", - "title": "deletePromotionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/removeCampaignPromotionsStep", - "title": "removeCampaignPromotionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/removeRulesFromPromotionsStep", - "title": "removeRulesFromPromotionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateCampaignsStep", - "title": "updateCampaignsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updatePromotionRulesStep", - "title": "updatePromotionRulesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updatePromotionsStep", - "title": "updatePromotionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updatePromotionsValidationStep", - "title": "updatePromotionsValidationStep", - "description": "", - "children": [] - } - ], - "loaded": true - } - ], - "loaded": true, - "initialOpen": false - }, - { - "type": "category", - "title": "Region", - "children": [ - { - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createRegionsWorkflow", - "title": "createRegionsWorkflow", - "description": "Create one or more regions.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteRegionsWorkflow", - "title": "deleteRegionsWorkflow", - "description": "Delete one or more regions.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateRegionsWorkflow", - "title": "updateRegionsWorkflow", - "description": "Update regions.", - "children": [] - } - ], - "loaded": true - }, - { - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createRegionsStep", - "title": "createRegionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteRegionsStep", - "title": "deleteRegionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/setRegionsPaymentProvidersStep", - "title": "setRegionsPaymentProvidersStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateRegionsStep", - "title": "updateRegionsStep", - "description": "", - "children": [] - } - ], - "loaded": true - } - ], - "loaded": true, - "initialOpen": false - }, - { - "type": "category", - "title": "Reservation", - "children": [ - { - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createReservationsWorkflow", - "title": "createReservationsWorkflow", - "description": "Create one or more reservations.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteReservationsByLineItemsWorkflow", - "title": "deleteReservationsByLineItemsWorkflow", - "description": "Delete reservations by their associated line items.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteReservationsWorkflow", - "title": "deleteReservationsWorkflow", - "description": "Delete one or more reservations.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateReservationsWorkflow", - "title": "updateReservationsWorkflow", - "description": "Update one or more reservations.", - "children": [] - } - ], - "loaded": true - }, - { - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createReservationsStep", - "title": "createReservationsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteReservationsByLineItemsStep", - "title": "deleteReservationsByLineItemsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteReservationsStep", - "title": "deleteReservationsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateReservationsStep", - "title": "updateReservationsStep", - "description": "", - "children": [] - } - ], - "loaded": true - } - ], - "loaded": true, - "initialOpen": false - }, - { - "type": "category", - "title": "Return Reason", - "children": [ - { - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createReturnReasonsWorkflow", - "title": "createReturnReasonsWorkflow", - "description": "Create return reasons.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteReturnReasonsWorkflow", - "title": "deleteReturnReasonsWorkflow", - "description": "Delete return reasons.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateReturnReasonsWorkflow", - "title": "updateReturnReasonsWorkflow", - "description": "Update return reasons.", - "children": [] - } - ], - "loaded": true - }, - { - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createReturnReasonsStep", - "title": "createReturnReasonsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteReturnReasonStep", - "title": "deleteReturnReasonStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateReturnReasonsStep", - "title": "updateReturnReasonsStep", - "description": "", - "children": [] - } - ], - "loaded": true - } - ], - "loaded": true, - "initialOpen": false - }, - { - "type": "category", - "title": "Sales Channel", - "children": [ - { - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createSalesChannelsWorkflow", - "title": "createSalesChannelsWorkflow", - "description": "Create sales channels.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteSalesChannelsWorkflow", - "title": "deleteSalesChannelsWorkflow", - "description": "Delete sales channels.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/linkProductsToSalesChannelWorkflow", - "title": "linkProductsToSalesChannelWorkflow", - "description": "Manage the products available in a sales channel.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateSalesChannelsWorkflow", - "title": "updateSalesChannelsWorkflow", - "description": "Update sales channels.", - "children": [] - } - ], - "loaded": true - }, - { - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/associateLocationsWithSalesChannelsStep", - "title": "associateLocationsWithSalesChannelsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/associateProductsWithSalesChannelsStep", - "title": "associateProductsWithSalesChannelsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/canDeleteSalesChannelsOrThrowStep", - "title": "canDeleteSalesChannelsOrThrowStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createDefaultSalesChannelStep", - "title": "createDefaultSalesChannelStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createSalesChannelsStep", - "title": "createSalesChannelsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteSalesChannelsStep", - "title": "deleteSalesChannelsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/detachLocationsFromSalesChannelsStep", - "title": "detachLocationsFromSalesChannelsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/detachProductsFromSalesChannelsStep", - "title": "detachProductsFromSalesChannelsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateSalesChannelsStep", - "title": "updateSalesChannelsStep", - "description": "", - "children": [] - } - ], - "loaded": true - } - ], - "loaded": true, - "initialOpen": false - }, - { - "type": "category", - "title": "Shipping Options", - "children": [ - { - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/listShippingOptionsForContextStep", - "title": "listShippingOptionsForContextStep", - "description": "", - "children": [] - } - ], - "loaded": true - } - ], - "loaded": true, - "initialOpen": false - }, - { - "type": "category", - "title": "Shipping Profile", - "children": [ - { - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteShippingProfileWorkflow", - "title": "deleteShippingProfileWorkflow", - "description": "Delete shipping profiles.", - "children": [] - } - ], - "loaded": true - }, - { - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteShippingProfilesStep", - "title": "deleteShippingProfilesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/validateStepShippingProfileDelete", - "title": "validateStepShippingProfileDelete", - "description": "", - "children": [] - } - ], - "loaded": true - } - ], - "loaded": true, - "initialOpen": false - }, - { - "type": "category", - "title": "Stock Location", - "children": [ - { - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createLocationFulfillmentSetWorkflow", - "title": "createLocationFulfillmentSetWorkflow", - "description": "Add fulfillment set to a stock location.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createStockLocationsWorkflow", - "title": "createStockLocationsWorkflow", - "description": "Create one or more stock locations.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteStockLocationsWorkflow", - "title": "deleteStockLocationsWorkflow", - "description": "Delete one or more stock locations.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/linkSalesChannelsToStockLocationWorkflow", - "title": "linkSalesChannelsToStockLocationWorkflow", - "description": "Manage the sales channels of a stock location.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateStockLocationsWorkflow", - "title": "updateStockLocationsWorkflow", - "description": "Update stock locations.", - "children": [] - } - ], - "loaded": true - }, - { - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createStockLocations", - "title": "createStockLocations", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteStockLocationsStep", - "title": "deleteStockLocationsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateStockLocationsStep", - "title": "updateStockLocationsStep", - "description": "", - "children": [] - } - ], - "loaded": true - } - ], - "loaded": true, - "initialOpen": false - }, - { - "type": "category", - "title": "Store", - "children": [ - { - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createStoresWorkflow", - "title": "createStoresWorkflow", - "description": "Create one or more stores.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteStoresWorkflow", - "title": "deleteStoresWorkflow", - "description": "Delete one or more stores.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateStoresWorkflow", - "title": "updateStoresWorkflow", - "description": "Update stores.", - "children": [] - } - ], - "loaded": true - }, - { - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createStoresStep", - "title": "createStoresStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteStoresStep", - "title": "deleteStoresStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateStoresStep", - "title": "updateStoresStep", - "description": "", - "children": [] - } - ], - "loaded": true - } - ], - "loaded": true, - "initialOpen": false - }, - { - "type": "category", - "title": "Tax", - "children": [ - { - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createTaxRateRulesWorkflow", - "title": "createTaxRateRulesWorkflow", - "description": "Create one or more tax rules for rates.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createTaxRatesWorkflow", - "title": "createTaxRatesWorkflow", - "description": "Create one or more tax rates.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createTaxRegionsWorkflow", - "title": "createTaxRegionsWorkflow", - "description": "Create one or more tax regions.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteTaxRateRulesWorkflow", - "title": "deleteTaxRateRulesWorkflow", - "description": "Delete one or more tax rate rules.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteTaxRatesWorkflow", - "title": "deleteTaxRatesWorkflow", - "description": "Delete one or more tax rates.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteTaxRegionsWorkflow", - "title": "deleteTaxRegionsWorkflow", - "description": "Delete one or more tax regions.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/setTaxRateRulesWorkflow", - "title": "setTaxRateRulesWorkflow", - "description": "Set the rules of tax rates.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateTaxRatesWorkflow", - "title": "updateTaxRatesWorkflow", - "description": "Update tax rates.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateTaxRegionsWorkflow", - "title": "updateTaxRegionsWorkflow", - "description": "Update one or more tax regions.", - "children": [] - } - ], - "loaded": true - }, - { - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createTaxRateRulesStep", - "title": "createTaxRateRulesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createTaxRatesStep", - "title": "createTaxRatesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createTaxRegionsStep", - "title": "createTaxRegionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteTaxRateRulesStep", - "title": "deleteTaxRateRulesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteTaxRatesStep", - "title": "deleteTaxRatesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteTaxRegionsStep", - "title": "deleteTaxRegionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/getItemTaxLinesStep", - "title": "getItemTaxLinesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/listTaxRateIdsStep", - "title": "listTaxRateIdsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/listTaxRateRuleIdsStep", - "title": "listTaxRateRuleIdsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateTaxRatesStep", - "title": "updateTaxRatesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateTaxRegionsStep", - "title": "updateTaxRegionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/maybeListTaxRateRuleIdsStep", - "title": "maybeListTaxRateRuleIdsStep", - "description": "", - "children": [] - } - ], - "loaded": true - } - ], - "loaded": true, - "initialOpen": false - }, - { - "type": "category", - "title": "User", - "children": [ - { - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createUserAccountWorkflow", - "title": "createUserAccountWorkflow", - "description": "Create a user account and attach an auth identity.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createUsersWorkflow", - "title": "createUsersWorkflow", - "description": "Create one or more users.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteUsersWorkflow", - "title": "deleteUsersWorkflow", - "description": "Delete one or more users.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeUserAccountWorkflow", - "title": "removeUserAccountWorkflow", - "description": "Delete a user and remove the association to its auth identity.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateUsersWorkflow", - "title": "updateUsersWorkflow", - "description": "Update one or more users.", - "children": [] - } - ], - "loaded": true - }, - { - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createUsersStep", - "title": "createUsersStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteUsersStep", - "title": "deleteUsersStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateUsersStep", - "title": "updateUsersStep", - "description": "", - "children": [] - } - ], - "loaded": true - } - ], - "loaded": true, - "initialOpen": false - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Testing Framework", - "path": "/test-tools-reference", - "isChildSidebar": true, - "children": [ { "loaded": true, "isPathHref": true, - "type": "category", - "title": "Functions", + "type": "sidebar", + "sidebar_id": "core-flows", + "title": "Core Workflows", + "custom_autogenerate": "core-flows", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "title": "medusaIntegrationTestRunner", - "path": "/test-tools-reference/medusaIntegrationTestRunner", + "title": "Overview", + "path": "/medusa-workflows-reference", "children": [] }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Api Key", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createApiKeysWorkflow", + "title": "createApiKeysWorkflow", + "description": "Create secret or publishable API keys.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteApiKeysWorkflow", + "title": "deleteApiKeysWorkflow", + "description": "Delete secret or publishable API keys.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/linkSalesChannelsToApiKeyWorkflow", + "title": "linkSalesChannelsToApiKeyWorkflow", + "description": "Manage the sales channels of a publishable API key.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/revokeApiKeysWorkflow", + "title": "revokeApiKeysWorkflow", + "description": "Revoke secret or publishable API keys.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateApiKeysWorkflow", + "title": "updateApiKeysWorkflow", + "description": "Update secret or publishable API keys.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createApiKeysStep", + "title": "createApiKeysStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteApiKeysStep", + "title": "deleteApiKeysStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/linkSalesChannelsToApiKeyStep", + "title": "linkSalesChannelsToApiKeyStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/revokeApiKeysStep", + "title": "revokeApiKeysStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateApiKeysStep", + "title": "updateApiKeysStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validateSalesChannelsExistStep", + "title": "validateSalesChannelsExistStep", + "description": "", + "children": [] + } + ] + } + ], + "initialOpen": false + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Auth", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/generateResetPasswordTokenWorkflow", + "title": "generateResetPasswordTokenWorkflow", + "description": "Generate a reset password token for a user or customer.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/setAuthAppMetadataStep", + "title": "setAuthAppMetadataStep", + "description": "", + "children": [] + } + ] + } + ], + "initialOpen": false + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Cart", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/addShippingMethodToCartWorkflow", + "title": "addShippingMethodToCartWorkflow", + "description": "Add a shipping method to a cart.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/addToCartWorkflow", + "title": "addToCartWorkflow", + "description": "Add a line item to a cart.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/completeCartWorkflow", + "title": "completeCartWorkflow", + "description": "Complete a cart and place an order.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/confirmVariantInventoryWorkflow", + "title": "confirmVariantInventoryWorkflow", + "description": "Validate that a variant is in-stock before adding to the cart.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createCartCreditLinesWorkflow", + "title": "createCartCreditLinesWorkflow", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createCartWorkflow", + "title": "createCartWorkflow", + "description": "Create a cart specifying region, items, and more.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createPaymentCollectionForCartWorkflow", + "title": "createPaymentCollectionForCartWorkflow", + "description": "Create payment collection for cart.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteCartCreditLinesWorkflow", + "title": "deleteCartCreditLinesWorkflow", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/listShippingOptionsForCartWithPricingWorkflow", + "title": "listShippingOptionsForCartWithPricingWorkflow", + "description": "List a cart's shipping options with prices.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/listShippingOptionsForCartWorkflow", + "title": "listShippingOptionsForCartWorkflow", + "description": "List a cart's shipping options.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/refreshCartItemsWorkflow", + "title": "refreshCartItemsWorkflow", + "description": "Refresh a cart's details after an update.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/refreshCartShippingMethodsWorkflow", + "title": "refreshCartShippingMethodsWorkflow", + "description": "Refresh a cart's shipping methods after an update.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/refreshPaymentCollectionForCartWorkflow", + "title": "refreshPaymentCollectionForCartWorkflow", + "description": "Refresh a cart's payment collection details.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/transferCartCustomerWorkflow", + "title": "transferCartCustomerWorkflow", + "description": "Refresh a cart's payment collection details.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateCartPromotionsWorkflow", + "title": "updateCartPromotionsWorkflow", + "description": "Update a cart's applied promotions to add, replace, or remove them.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateCartWorkflow", + "title": "updateCartWorkflow", + "description": "Update a cart's details, such as region, address, and more.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateLineItemInCartWorkflow", + "title": "updateLineItemInCartWorkflow", + "description": "Update a cart's line item.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateTaxLinesWorkflow", + "title": "updateTaxLinesWorkflow", + "description": "Update a cart's tax lines.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/addShippingMethodToCartStep", + "title": "addShippingMethodToCartStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/confirmInventoryStep", + "title": "confirmInventoryStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createCartsStep", + "title": "createCartsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createLineItemAdjustmentsStep", + "title": "createLineItemAdjustmentsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createLineItemsStep", + "title": "createLineItemsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createPaymentCollectionsStep", + "title": "createPaymentCollectionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createShippingMethodAdjustmentsStep", + "title": "createShippingMethodAdjustmentsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/findOneOrAnyRegionStep", + "title": "findOneOrAnyRegionStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/findOrCreateCustomerStep", + "title": "findOrCreateCustomerStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/findSalesChannelStep", + "title": "findSalesChannelStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/getActionsToComputeFromPromotionsStep", + "title": "getActionsToComputeFromPromotionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/getLineItemActionsStep", + "title": "getLineItemActionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/getPromotionCodesToApply", + "title": "getPromotionCodesToApply", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/getVariantPriceSetsStep", + "title": "getVariantPriceSetsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/getVariantsStep", + "title": "getVariantsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/prepareAdjustmentsFromPromotionActionsStep", + "title": "prepareAdjustmentsFromPromotionActionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/removeLineItemAdjustmentsStep", + "title": "removeLineItemAdjustmentsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/removeShippingMethodAdjustmentsStep", + "title": "removeShippingMethodAdjustmentsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/removeShippingMethodFromCartStep", + "title": "removeShippingMethodFromCartStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/reserveInventoryStep", + "title": "reserveInventoryStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/retrieveCartStep", + "title": "retrieveCartStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/setTaxLinesForItemsStep", + "title": "setTaxLinesForItemsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateCartPromotionsStep", + "title": "updateCartPromotionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateCartsStep", + "title": "updateCartsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateLineItemsStep", + "title": "updateLineItemsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateShippingMethodsStep", + "title": "updateShippingMethodsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validateAndReturnShippingMethodsDataStep", + "title": "validateAndReturnShippingMethodsDataStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validateCartPaymentsStep", + "title": "validateCartPaymentsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validateCartShippingOptionsPriceStep", + "title": "validateCartShippingOptionsPriceStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validateCartShippingOptionsStep", + "title": "validateCartShippingOptionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validateCartStep", + "title": "validateCartStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validateLineItemPricesStep", + "title": "validateLineItemPricesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validateShippingStep", + "title": "validateShippingStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validateVariantPricesStep", + "title": "validateVariantPricesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/validateExistingPaymentCollectionStep", + "title": "validateExistingPaymentCollectionStep", + "description": "", + "children": [] + } + ] + } + ], + "initialOpen": false + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Common", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/batchLinksWorkflow", + "title": "batchLinksWorkflow", + "description": "Manage links between two records of linked data models.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createLinksWorkflow", + "title": "createLinksWorkflow", + "description": "Create links between two records of linked data models.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/dismissLinksWorkflow", + "title": "dismissLinksWorkflow", + "description": "Dismiss links between two records of linked data models.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateLinksWorkflow", + "title": "updateLinksWorkflow", + "description": "Update links between two records of linked data models.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createRemoteLinkStep", + "title": "createRemoteLinkStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/dismissRemoteLinkStep", + "title": "dismissRemoteLinkStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/emitEventStep", + "title": "emitEventStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/removeRemoteLinkStep", + "title": "removeRemoteLinkStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateRemoteLinksStep", + "title": "updateRemoteLinksStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/useQueryGraphStep", + "title": "useQueryGraphStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/useRemoteQueryStep", + "title": "useRemoteQueryStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validatePresenceOfStep", + "title": "validatePresenceOfStep", + "description": "", + "children": [] + } + ] + } + ], + "initialOpen": false + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Customer", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createCustomerAccountWorkflow", + "title": "createCustomerAccountWorkflow", + "description": "Create or register a customer account.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createCustomerAddressesWorkflow", + "title": "createCustomerAddressesWorkflow", + "description": "Create one or more customer addresses.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createCustomersWorkflow", + "title": "createCustomersWorkflow", + "description": "Create one or more customers.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteCustomerAddressesWorkflow", + "title": "deleteCustomerAddressesWorkflow", + "description": "Delete one or more customer addresses.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteCustomersWorkflow", + "title": "deleteCustomersWorkflow", + "description": "Delete one or more customers.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeCustomerAccountWorkflow", + "title": "removeCustomerAccountWorkflow", + "description": "Delete a customer account and its auth identity association.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateCustomerAddressesWorkflow", + "title": "updateCustomerAddressesWorkflow", + "description": "Update one or more customer addresses.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateCustomersWorkflow", + "title": "updateCustomersWorkflow", + "description": "Update one or more customers.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createCustomerAddressesStep", + "title": "createCustomerAddressesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createCustomersStep", + "title": "createCustomersStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteCustomerAddressesStep", + "title": "deleteCustomerAddressesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteCustomersStep", + "title": "deleteCustomersStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/maybeUnsetDefaultBillingAddressesStep", + "title": "maybeUnsetDefaultBillingAddressesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/maybeUnsetDefaultShippingAddressesStep", + "title": "maybeUnsetDefaultShippingAddressesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateCustomerAddressesStep", + "title": "updateCustomerAddressesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateCustomersStep", + "title": "updateCustomersStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validateCustomerAccountCreation", + "title": "validateCustomerAccountCreation", + "description": "", + "children": [] + } + ] + } + ], + "initialOpen": false + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Customer Group", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createCustomerGroupsWorkflow", + "title": "createCustomerGroupsWorkflow", + "description": "Create one or more customer groups.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteCustomerGroupsWorkflow", + "title": "deleteCustomerGroupsWorkflow", + "description": "Delete one or more customer groups.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/linkCustomerGroupsToCustomerWorkflow", + "title": "linkCustomerGroupsToCustomerWorkflow", + "description": "Manage groups of a customer.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/linkCustomersToCustomerGroupWorkflow", + "title": "linkCustomersToCustomerGroupWorkflow", + "description": "Manage the customers of a customer group.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateCustomerGroupsWorkflow", + "title": "updateCustomerGroupsWorkflow", + "description": "Update one or more customer groups.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createCustomerGroupsStep", + "title": "createCustomerGroupsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteCustomerGroupStep", + "title": "deleteCustomerGroupStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/linkCustomerGroupsToCustomerStep", + "title": "linkCustomerGroupsToCustomerStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/linkCustomersToCustomerGroupStep", + "title": "linkCustomersToCustomerGroupStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateCustomerGroupsStep", + "title": "updateCustomerGroupsStep", + "description": "", + "children": [] + } + ] + } + ], + "initialOpen": false + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Defaults", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createDefaultsWorkflow", + "title": "createDefaultsWorkflow", + "description": "Create default data for a Medusa application.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createDefaultStoreStep", + "title": "createDefaultStoreStep", + "description": "", + "children": [] + } + ] + } + ], + "initialOpen": false + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "File", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteFilesWorkflow", + "title": "deleteFilesWorkflow", + "description": "Delete files from the database and storage.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/uploadFilesWorkflow", + "title": "uploadFilesWorkflow", + "description": "Upload files using the installed File Module Provider.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteFilesStep", + "title": "deleteFilesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/uploadFilesStep", + "title": "uploadFilesStep", + "description": "", + "children": [] + } + ] + } + ], + "initialOpen": false + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Fulfillment", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/batchShippingOptionRulesWorkflow", + "title": "batchShippingOptionRulesWorkflow", + "description": "Manage shipping option rules.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/calculateShippingOptionsPricesWorkflow", + "title": "calculateShippingOptionsPricesWorkflow", + "description": "Calculate shipping option prices in a cart.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelFulfillmentWorkflow", + "title": "cancelFulfillmentWorkflow", + "description": "Cancel a fulfillment.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createFulfillmentWorkflow", + "title": "createFulfillmentWorkflow", + "description": "Create a fulfillment.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createReturnFulfillmentWorkflow", + "title": "createReturnFulfillmentWorkflow", + "description": "Create a fulfillment for a return.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createServiceZonesWorkflow", + "title": "createServiceZonesWorkflow", + "description": "Create one or more service zones.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createShipmentWorkflow", + "title": "createShipmentWorkflow", + "description": "Create a shipment for a fulfillment.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createShippingOptionsWorkflow", + "title": "createShippingOptionsWorkflow", + "description": "Create shipping options.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createShippingProfilesWorkflow", + "title": "createShippingProfilesWorkflow", + "description": "Create one or more shipping profiles.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteFulfillmentSetsWorkflow", + "title": "deleteFulfillmentSetsWorkflow", + "description": "Delete one or more fulfillment sets.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteServiceZonesWorkflow", + "title": "deleteServiceZonesWorkflow", + "description": "Delete one or more service zones.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteShippingOptionsWorkflow", + "title": "deleteShippingOptionsWorkflow", + "description": "Delete one or more shipping options.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/markFulfillmentAsDeliveredWorkflow", + "title": "markFulfillmentAsDeliveredWorkflow", + "description": "Mark a fulfillment as delivered.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateFulfillmentWorkflow", + "title": "updateFulfillmentWorkflow", + "description": "Update a fulfillment.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateServiceZonesWorkflow", + "title": "updateServiceZonesWorkflow", + "description": "Update one or more service zones.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateShippingOptionsWorkflow", + "title": "updateShippingOptionsWorkflow", + "description": "Update one or more shipping options.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateShippingProfilesWorkflow", + "title": "updateShippingProfilesWorkflow", + "description": "Update one or more shipping profiles.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/buildPriceSet", + "title": "buildPriceSet", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/calculateShippingOptionsPricesStep", + "title": "calculateShippingOptionsPricesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/cancelFulfillmentStep", + "title": "cancelFulfillmentStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createFulfillmentSets", + "title": "createFulfillmentSets", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createFulfillmentStep", + "title": "createFulfillmentStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createReturnFulfillmentStep", + "title": "createReturnFulfillmentStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createServiceZonesStep", + "title": "createServiceZonesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createShippingOptionRulesStep", + "title": "createShippingOptionRulesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createShippingOptionsPriceSetsStep", + "title": "createShippingOptionsPriceSetsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createShippingProfilesStep", + "title": "createShippingProfilesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteFulfillmentSetsStep", + "title": "deleteFulfillmentSetsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteServiceZonesStep", + "title": "deleteServiceZonesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteShippingOptionRulesStep", + "title": "deleteShippingOptionRulesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteShippingOptionsStep", + "title": "deleteShippingOptionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/setShippingOptionsPricesStep", + "title": "setShippingOptionsPricesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateFulfillmentStep", + "title": "updateFulfillmentStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateServiceZonesStep", + "title": "updateServiceZonesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateShippingOptionRulesStep", + "title": "updateShippingOptionRulesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateShippingProfilesStep", + "title": "updateShippingProfilesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/upsertShippingOptionsStep", + "title": "upsertShippingOptionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validateShipmentStep", + "title": "validateShipmentStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validateShippingOptionPricesStep", + "title": "validateShippingOptionPricesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/validateFulfillmentDeliverabilityStep", + "title": "validateFulfillmentDeliverabilityStep", + "description": "", + "children": [] + } + ] + } + ], + "initialOpen": false + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Inventory", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/batchInventoryItemLevelsWorkflow", + "title": "batchInventoryItemLevelsWorkflow", + "description": "Manage inventory levels in bulk.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/bulkCreateDeleteLevelsWorkflow", + "title": "bulkCreateDeleteLevelsWorkflow", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createInventoryItemsWorkflow", + "title": "createInventoryItemsWorkflow", + "description": "Create one or more inventory items.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createInventoryLevelsWorkflow", + "title": "createInventoryLevelsWorkflow", + "description": "Create one or more inventory levels.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteInventoryItemWorkflow", + "title": "deleteInventoryItemWorkflow", + "description": "Delete one or more inventory items.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteInventoryLevelsWorkflow", + "title": "deleteInventoryLevelsWorkflow", + "description": "Delete one or more inventory levels.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateInventoryItemsWorkflow", + "title": "updateInventoryItemsWorkflow", + "description": "Update one or more inventory items.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateInventoryLevelsWorkflow", + "title": "updateInventoryLevelsWorkflow", + "description": "Update one or more inventory levels.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/adjustInventoryLevelsStep", + "title": "adjustInventoryLevelsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/attachInventoryItemToVariants", + "title": "attachInventoryItemToVariants", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createInventoryItemsStep", + "title": "createInventoryItemsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createInventoryLevelsStep", + "title": "createInventoryLevelsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteInventoryItemStep", + "title": "deleteInventoryItemStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteInventoryLevelsStep", + "title": "deleteInventoryLevelsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateInventoryItemsStep", + "title": "updateInventoryItemsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateInventoryLevelsStep", + "title": "updateInventoryLevelsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validateInventoryDeleteStep", + "title": "validateInventoryDeleteStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validateInventoryItemsForCreate", + "title": "validateInventoryItemsForCreate", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validateInventoryLocationsStep", + "title": "validateInventoryLocationsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/validateInventoryLevelsDelete", + "title": "validateInventoryLevelsDelete", + "description": "", + "children": [] + } + ] + } + ], + "initialOpen": false + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Invite", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/acceptInviteWorkflow", + "title": "acceptInviteWorkflow", + "description": "Accept invite and create user.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createInvitesWorkflow", + "title": "createInvitesWorkflow", + "description": "Create one or more user invites.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteInvitesWorkflow", + "title": "deleteInvitesWorkflow", + "description": "Delete one or more user invites.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/refreshInviteTokensWorkflow", + "title": "refreshInviteTokensWorkflow", + "description": "Refresh user invite tokens.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createInviteStep", + "title": "createInviteStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteInvitesStep", + "title": "deleteInvitesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/refreshInviteTokensStep", + "title": "refreshInviteTokensStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validateTokenStep", + "title": "validateTokenStep", + "description": "", + "children": [] + } + ] + } + ], + "initialOpen": false + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Line Item", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteLineItemsWorkflow", + "title": "deleteLineItemsWorkflow", + "description": "Delete line items from a cart.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteLineItemsStep", + "title": "deleteLineItemsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/listLineItemsStep", + "title": "listLineItemsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateLineItemsStepWithSelector", + "title": "updateLineItemsStepWithSelector", + "description": "", + "children": [] + } + ] + } + ], + "initialOpen": false + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Notification", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/notifyOnFailureStep", + "title": "notifyOnFailureStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/sendNotificationsStep", + "title": "sendNotificationsStep", + "description": "", + "children": [] + } + ] + } + ], + "initialOpen": false + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Order", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/acceptOrderTransferWorkflow", + "title": "acceptOrderTransferWorkflow", + "description": "Accept an order transfer request.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/addOrderLineItemsWorkflow", + "title": "addOrderLineItemsWorkflow", + "description": "Add line items to an order.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/archiveOrderWorkflow", + "title": "archiveOrderWorkflow", + "description": "Archive one or more orders.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/beginClaimOrderWorkflow", + "title": "beginClaimOrderWorkflow", + "description": "Create an order claim in requested state.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/beginExchangeOrderWorkflow", + "title": "beginExchangeOrderWorkflow", + "description": "Request an order exchange.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/beginOrderEditOrderWorkflow", + "title": "beginOrderEditOrderWorkflow", + "description": "Create an order edit request.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/beginReceiveReturnWorkflow", + "title": "beginReceiveReturnWorkflow", + "description": "Request a return receival.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/beginReturnOrderWorkflow", + "title": "beginReturnOrderWorkflow", + "description": "Create a return for an order.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelBeginOrderClaimWorkflow", + "title": "cancelBeginOrderClaimWorkflow", + "description": "Cancel a requested order claim.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelBeginOrderEditWorkflow", + "title": "cancelBeginOrderEditWorkflow", + "description": "Cancel a requested order edit.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelBeginOrderExchangeWorkflow", + "title": "cancelBeginOrderExchangeWorkflow", + "description": "Cancel a requested order exchange.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelOrderChangeWorkflow", + "title": "cancelOrderChangeWorkflow", + "description": "Cancel an order change.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelOrderClaimWorkflow", + "title": "cancelOrderClaimWorkflow", + "description": "Cancel a confirmed order claim.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelOrderExchangeWorkflow", + "title": "cancelOrderExchangeWorkflow", + "description": "Cancel an exchange for an order.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelOrderFulfillmentWorkflow", + "title": "cancelOrderFulfillmentWorkflow", + "description": "Cancel an order's fulfillment.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelOrderTransferRequestWorkflow", + "title": "cancelOrderTransferRequestWorkflow", + "description": "Cancel an order transfer request.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelOrderWorkflow", + "title": "cancelOrderWorkflow", + "description": "Cancel an order.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelReturnReceiveWorkflow", + "title": "cancelReturnReceiveWorkflow", + "description": "Cancel a return receival.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelReturnRequestWorkflow", + "title": "cancelReturnRequestWorkflow", + "description": "Cancel a requested return.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelReturnWorkflow", + "title": "cancelReturnWorkflow", + "description": "Cancel a return.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/completeOrderWorkflow", + "title": "completeOrderWorkflow", + "description": "Complete one or more orders.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/confirmClaimRequestWorkflow", + "title": "confirmClaimRequestWorkflow", + "description": "Confirm a requested claim.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/confirmExchangeRequestWorkflow", + "title": "confirmExchangeRequestWorkflow", + "description": "Confirm an exchange request.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/confirmOrderEditRequestWorkflow", + "title": "confirmOrderEditRequestWorkflow", + "description": "Confirm an order edit request.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/confirmReturnReceiveWorkflow", + "title": "confirmReturnReceiveWorkflow", + "description": "Confirm a return receival request.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/confirmReturnRequestWorkflow", + "title": "confirmReturnRequestWorkflow", + "description": "Confirm a return request.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createAndCompleteReturnOrderWorkflow", + "title": "createAndCompleteReturnOrderWorkflow", + "description": "Create and complete a return for an order.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createClaimShippingMethodWorkflow", + "title": "createClaimShippingMethodWorkflow", + "description": "Create an inbound or outbound shipping method for a claim.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createExchangeShippingMethodWorkflow", + "title": "createExchangeShippingMethodWorkflow", + "description": "Create an inbound or outbound shipping method for an exchange.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createOrUpdateOrderPaymentCollectionWorkflow", + "title": "createOrUpdateOrderPaymentCollectionWorkflow", + "description": "Create or update payment collection for an order.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createOrderChangeActionsWorkflow", + "title": "createOrderChangeActionsWorkflow", + "description": "Create an order change action.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createOrderChangeWorkflow", + "title": "createOrderChangeWorkflow", + "description": "Create an order change.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createOrderEditShippingMethodWorkflow", + "title": "createOrderEditShippingMethodWorkflow", + "description": "Create a shipping method for an order edit.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createOrderFulfillmentWorkflow", + "title": "createOrderFulfillmentWorkflow", + "description": "Creates a fulfillment for an order.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createOrderPaymentCollectionWorkflow", + "title": "createOrderPaymentCollectionWorkflow", + "description": "Create a payment collection for an order.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createOrderShipmentWorkflow", + "title": "createOrderShipmentWorkflow", + "description": "Creates a shipment for an order.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createOrderWorkflow", + "title": "createOrderWorkflow", + "description": "Create an order.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createOrdersWorkflow", + "title": "createOrdersWorkflow", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createReturnShippingMethodWorkflow", + "title": "createReturnShippingMethodWorkflow", + "description": "Create a shipping method for a return.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/declineOrderChangeWorkflow", + "title": "declineOrderChangeWorkflow", + "description": "Decline an order change.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/declineOrderTransferRequestWorkflow", + "title": "declineOrderTransferRequestWorkflow", + "description": "Decline a requested order transfer.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteOrderChangeActionsWorkflow", + "title": "deleteOrderChangeActionsWorkflow", + "description": "Delete one or more order change actions.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteOrderChangeWorkflow", + "title": "deleteOrderChangeWorkflow", + "description": "Delete one or more order changes.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/dismissItemReturnRequestWorkflow", + "title": "dismissItemReturnRequestWorkflow", + "description": "Dismiss items from a return request.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/getOrderDetailWorkflow", + "title": "getOrderDetailWorkflow", + "description": "Retrieve an order's details.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/getOrdersListWorkflow", + "title": "getOrdersListWorkflow", + "description": "Retrieve a list of orders.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/markOrderFulfillmentAsDeliveredWorkflow", + "title": "markOrderFulfillmentAsDeliveredWorkflow", + "description": "Mark a fulfillment in an order as delivered.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/orderClaimAddNewItemWorkflow", + "title": "orderClaimAddNewItemWorkflow", + "description": "Add outbound or new items to a claim.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/orderClaimItemWorkflow", + "title": "orderClaimItemWorkflow", + "description": "Add order items to a claim as claim items.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/orderClaimRequestItemReturnWorkflow", + "title": "orderClaimRequestItemReturnWorkflow", + "description": "Request one or more items to be returned as part of a claim.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/orderEditAddNewItemWorkflow", + "title": "orderEditAddNewItemWorkflow", + "description": "Add new items to an order edit.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/orderEditUpdateItemQuantityWorkflow", + "title": "orderEditUpdateItemQuantityWorkflow", + "description": "Update the quantity of an existing order item in the order's edit.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/orderExchangeAddNewItemWorkflow", + "title": "orderExchangeAddNewItemWorkflow", + "description": "Add new or outbound items to an exchange.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/orderExchangeRequestItemReturnWorkflow", + "title": "orderExchangeRequestItemReturnWorkflow", + "description": "Add inbound items to be returned as part of the exchange.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/receiveAndCompleteReturnOrderWorkflow", + "title": "receiveAndCompleteReturnOrderWorkflow", + "description": "Receive and complete a return.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/receiveItemReturnRequestWorkflow", + "title": "receiveItemReturnRequestWorkflow", + "description": "Mark return items as received.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeAddItemClaimActionWorkflow", + "title": "removeAddItemClaimActionWorkflow", + "description": "Remove outbound (new) items from a claim.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeClaimShippingMethodWorkflow", + "title": "removeClaimShippingMethodWorkflow", + "description": "Remove an inbound or outbound shipping method from a claim.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeExchangeShippingMethodWorkflow", + "title": "removeExchangeShippingMethodWorkflow", + "description": "Remove an inbound or outbound shipping method from an exchange.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeItemClaimActionWorkflow", + "title": "removeItemClaimActionWorkflow", + "description": "Remove order items from a claim.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeItemExchangeActionWorkflow", + "title": "removeItemExchangeActionWorkflow", + "description": "Remove an outbound or new item from an exchange.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeItemOrderEditActionWorkflow", + "title": "removeItemOrderEditActionWorkflow", + "description": "Remove an item that was added to an order edit.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeItemReceiveReturnActionWorkflow", + "title": "removeItemReceiveReturnActionWorkflow", + "description": "Remove an item from a return receival.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeItemReturnActionWorkflow", + "title": "removeItemReturnActionWorkflow", + "description": "Remove an item from a return.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeOrderEditShippingMethodWorkflow", + "title": "removeOrderEditShippingMethodWorkflow", + "description": "Remove a shipping method from an order edit.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeReturnShippingMethodWorkflow", + "title": "removeReturnShippingMethodWorkflow", + "description": "Remove a shipping method from a return.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/requestItemReturnWorkflow", + "title": "requestItemReturnWorkflow", + "description": "Add items to a return.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/requestOrderEditRequestWorkflow", + "title": "requestOrderEditRequestWorkflow", + "description": "Request an order edit.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/requestOrderTransferWorkflow", + "title": "requestOrderTransferWorkflow", + "description": "Request a transfer of an order to a customer.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateClaimAddItemWorkflow", + "title": "updateClaimAddItemWorkflow", + "description": "Update a claim's new or outbound item.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateClaimItemWorkflow", + "title": "updateClaimItemWorkflow", + "description": "Update a claim item, added to the claim from an order item.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateClaimShippingMethodWorkflow", + "title": "updateClaimShippingMethodWorkflow", + "description": "Update an inbound or outbound shipping method of a claim.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateExchangeAddItemWorkflow", + "title": "updateExchangeAddItemWorkflow", + "description": "Update an outbound or new item in an exchange.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateExchangeShippingMethodWorkflow", + "title": "updateExchangeShippingMethodWorkflow", + "description": "Update an exchange's inbound or outbound shipping method.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateOrderChangeActionsWorkflow", + "title": "updateOrderChangeActionsWorkflow", + "description": "Update one or more order change actions.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateOrderChangesWorkflow", + "title": "updateOrderChangesWorkflow", + "description": "Update one or more order changes.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateOrderEditAddItemWorkflow", + "title": "updateOrderEditAddItemWorkflow", + "description": "Update a new item in an order edit.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateOrderEditItemQuantityWorkflow", + "title": "updateOrderEditItemQuantityWorkflow", + "description": "Update an existing order item previously added to an order edit.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateOrderEditShippingMethodWorkflow", + "title": "updateOrderEditShippingMethodWorkflow", + "description": "Update a shipping method of an order edit.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateOrderTaxLinesWorkflow", + "title": "updateOrderTaxLinesWorkflow", + "description": "Update the tax lines of items and shipping methods in an order.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateOrderWorkflow", + "title": "updateOrderWorkflow", + "description": "Update an order's details.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateReceiveItemReturnRequestWorkflow", + "title": "updateReceiveItemReturnRequestWorkflow", + "description": "Update an item in a return receival request.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateRequestItemReturnWorkflow", + "title": "updateRequestItemReturnWorkflow", + "description": "Update a requested item in a return.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateReturnShippingMethodWorkflow", + "title": "updateReturnShippingMethodWorkflow", + "description": "Update the shipping method of a return.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateReturnWorkflow", + "title": "updateReturnWorkflow", + "description": "Update a return's details.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/addOrderTransactionStep", + "title": "addOrderTransactionStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/archiveOrdersStep", + "title": "archiveOrdersStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/cancelOrderChangeStep", + "title": "cancelOrderChangeStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/cancelOrderClaimStep", + "title": "cancelOrderClaimStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/cancelOrderExchangeStep", + "title": "cancelOrderExchangeStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/cancelOrderFulfillmentStep", + "title": "cancelOrderFulfillmentStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/cancelOrderReturnStep", + "title": "cancelOrderReturnStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/cancelOrdersStep", + "title": "cancelOrdersStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/completeOrdersStep", + "title": "completeOrdersStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createCompleteReturnStep", + "title": "createCompleteReturnStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createOrderChangeStep", + "title": "createOrderChangeStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createOrderClaimItemsFromActionsStep", + "title": "createOrderClaimItemsFromActionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createOrderClaimsStep", + "title": "createOrderClaimsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createOrderExchangeItemsFromActionsStep", + "title": "createOrderExchangeItemsFromActionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createOrderExchangesStep", + "title": "createOrderExchangesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createOrderLineItemsStep", + "title": "createOrderLineItemsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createOrdersStep", + "title": "createOrdersStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createReturnsStep", + "title": "createReturnsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/declineOrderChangeStep", + "title": "declineOrderChangeStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteClaimsStep", + "title": "deleteClaimsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteExchangesStep", + "title": "deleteExchangesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteOrderChangeActionsStep", + "title": "deleteOrderChangeActionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteOrderChangesStep", + "title": "deleteOrderChangesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteOrderLineItems", + "title": "deleteOrderLineItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteOrderShippingMethods", + "title": "deleteOrderShippingMethods", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteReturnsStep", + "title": "deleteReturnsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/previewOrderChangeStep", + "title": "previewOrderChangeStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/registerOrderChangesStep", + "title": "registerOrderChangesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/registerOrderFulfillmentStep", + "title": "registerOrderFulfillmentStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/registerOrderShipmentStep", + "title": "registerOrderShipmentStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/setOrderTaxLinesForItemsStep", + "title": "setOrderTaxLinesForItemsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateOrderChangeActionsStep", + "title": "updateOrderChangeActionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateOrderChangesStep", + "title": "updateOrderChangesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateOrderShippingMethodsStep", + "title": "updateOrderShippingMethodsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateOrdersStep", + "title": "updateOrdersStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateReturnItemsStep", + "title": "updateReturnItemsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateReturnsStep", + "title": "updateReturnsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/acceptOrderTransferValidationStep", + "title": "acceptOrderTransferValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/beginClaimOrderValidationStep", + "title": "beginClaimOrderValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/beginOrderEditValidationStep", + "title": "beginOrderEditValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/beginOrderExchangeValidationStep", + "title": "beginOrderExchangeValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/beginReceiveReturnValidationStep", + "title": "beginReceiveReturnValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/beginReturnOrderValidationStep", + "title": "beginReturnOrderValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelBeginOrderClaimValidationStep", + "title": "cancelBeginOrderClaimValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelBeginOrderEditValidationStep", + "title": "cancelBeginOrderEditValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelBeginOrderExchangeValidationStep", + "title": "cancelBeginOrderExchangeValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelClaimValidateOrderStep", + "title": "cancelClaimValidateOrderStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelExchangeValidateOrder", + "title": "cancelExchangeValidateOrder", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelOrderFulfillmentValidateOrder", + "title": "cancelOrderFulfillmentValidateOrder", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelReceiveReturnValidationStep", + "title": "cancelReceiveReturnValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelRequestReturnValidationStep", + "title": "cancelRequestReturnValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelReturnValidateOrder", + "title": "cancelReturnValidateOrder", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelTransferOrderRequestValidationStep", + "title": "cancelTransferOrderRequestValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelValidateOrder", + "title": "cancelValidateOrder", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/confirmClaimRequestValidationStep", + "title": "confirmClaimRequestValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/confirmExchangeRequestValidationStep", + "title": "confirmExchangeRequestValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/confirmOrderEditRequestValidationStep", + "title": "confirmOrderEditRequestValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/confirmReceiveReturnValidationStep", + "title": "confirmReceiveReturnValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/confirmReturnRequestValidationStep", + "title": "confirmReturnRequestValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createClaimShippingMethodValidationStep", + "title": "createClaimShippingMethodValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createCompleteReturnValidationStep", + "title": "createCompleteReturnValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createExchangeShippingMethodValidationStep", + "title": "createExchangeShippingMethodValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createFulfillmentValidateOrder", + "title": "createFulfillmentValidateOrder", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createOrderEditShippingMethodValidationStep", + "title": "createOrderEditShippingMethodValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createReturnShippingMethodValidationStep", + "title": "createReturnShippingMethodValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createShipmentValidateOrder", + "title": "createShipmentValidateOrder", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/declineTransferOrderRequestValidationStep", + "title": "declineTransferOrderRequestValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteOrderPaymentCollections", + "title": "deleteOrderPaymentCollections", + "description": "Delete a payment collection of an order.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/dismissItemReturnRequestValidationStep", + "title": "dismissItemReturnRequestValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/exchangeAddNewItemValidationStep", + "title": "exchangeAddNewItemValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/exchangeRequestItemReturnValidationStep", + "title": "exchangeRequestItemReturnValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/markPaymentCollectionAsPaid", + "title": "markPaymentCollectionAsPaid", + "description": "Mark a payment collection for an order as paid.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/orderClaimAddNewItemValidationStep", + "title": "orderClaimAddNewItemValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/orderClaimItemValidationStep", + "title": "orderClaimItemValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/orderClaimRequestItemReturnValidationStep", + "title": "orderClaimRequestItemReturnValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/orderEditAddNewItemValidationStep", + "title": "orderEditAddNewItemValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/orderEditUpdateItemQuantityValidationStep", + "title": "orderEditUpdateItemQuantityValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/orderFulfillmentDeliverablilityValidationStep", + "title": "orderFulfillmentDeliverablilityValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/receiveCompleteReturnValidationStep", + "title": "receiveCompleteReturnValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/receiveItemReturnRequestValidationStep", + "title": "receiveItemReturnRequestValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeClaimAddItemActionValidationStep", + "title": "removeClaimAddItemActionValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeClaimItemActionValidationStep", + "title": "removeClaimItemActionValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeClaimShippingMethodValidationStep", + "title": "removeClaimShippingMethodValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeExchangeItemActionValidationStep", + "title": "removeExchangeItemActionValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeExchangeShippingMethodValidationStep", + "title": "removeExchangeShippingMethodValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeItemReceiveReturnActionValidationStep", + "title": "removeItemReceiveReturnActionValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeOrderEditItemActionValidationStep", + "title": "removeOrderEditItemActionValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeOrderEditShippingMethodValidationStep", + "title": "removeOrderEditShippingMethodValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeReturnItemActionValidationStep", + "title": "removeReturnItemActionValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeReturnShippingMethodValidationStep", + "title": "removeReturnShippingMethodValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/requestItemReturnValidationStep", + "title": "requestItemReturnValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/requestOrderEditRequestValidationStep", + "title": "requestOrderEditRequestValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/requestOrderTransferValidationStep", + "title": "requestOrderTransferValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/throwUnlessPaymentCollectionNotPaid", + "title": "throwUnlessPaymentCollectionNotPaid", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/throwUnlessStatusIsNotPaid", + "title": "throwUnlessStatusIsNotPaid", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateClaimAddItemValidationStep", + "title": "updateClaimAddItemValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateClaimItemValidationStep", + "title": "updateClaimItemValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateClaimShippingMethodValidationStep", + "title": "updateClaimShippingMethodValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateExchangeAddItemValidationStep", + "title": "updateExchangeAddItemValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateExchangeShippingMethodValidationStep", + "title": "updateExchangeShippingMethodValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateOrderEditAddItemValidationStep", + "title": "updateOrderEditAddItemValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateOrderEditItemQuantityValidationStep", + "title": "updateOrderEditItemQuantityValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateOrderEditShippingMethodValidationStep", + "title": "updateOrderEditShippingMethodValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateOrderValidationStep", + "title": "updateOrderValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateReceiveItemReturnRequestValidationStep", + "title": "updateReceiveItemReturnRequestValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateRequestItemReturnValidationStep", + "title": "updateRequestItemReturnValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateReturnShippingMethodValidationStep", + "title": "updateReturnShippingMethodValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateReturnValidationStep", + "title": "updateReturnValidationStep", + "description": "", + "children": [] + } + ] + } + ], + "initialOpen": false + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Payment", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/capturePaymentWorkflow", + "title": "capturePaymentWorkflow", + "description": "Capture a payment.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/processPaymentWorkflow", + "title": "processPaymentWorkflow", + "description": "Process a payment based on a webhook event.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/refundPaymentWorkflow", + "title": "refundPaymentWorkflow", + "description": "Refund a payment.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/refundPaymentsWorkflow", + "title": "refundPaymentsWorkflow", + "description": "Refund one or more payments.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/authorizePaymentSessionStep", + "title": "authorizePaymentSessionStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/cancelPaymentStep", + "title": "cancelPaymentStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/capturePaymentStep", + "title": "capturePaymentStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/refundPaymentStep", + "title": "refundPaymentStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/refundPaymentsStep", + "title": "refundPaymentsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/validatePaymentsRefundStep", + "title": "validatePaymentsRefundStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/validateRefundStep", + "title": "validateRefundStep", + "description": "", + "children": [] + } + ] + } + ], + "initialOpen": false + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Payment Collection", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createPaymentSessionsWorkflow", + "title": "createPaymentSessionsWorkflow", + "description": "Create payment sessions.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createRefundReasonsWorkflow", + "title": "createRefundReasonsWorkflow", + "description": "Create refund reasons.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deletePaymentSessionsWorkflow", + "title": "deletePaymentSessionsWorkflow", + "description": "Delete payment sessions.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteRefundReasonsWorkflow", + "title": "deleteRefundReasonsWorkflow", + "description": "Delete refund reasons.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateRefundReasonsWorkflow", + "title": "updateRefundReasonsWorkflow", + "description": "Update refund reasons.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createPaymentAccountHolderStep", + "title": "createPaymentAccountHolderStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createPaymentSessionStep", + "title": "createPaymentSessionStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createRefundReasonStep", + "title": "createRefundReasonStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deletePaymentSessionsStep", + "title": "deletePaymentSessionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteRefundReasonsStep", + "title": "deleteRefundReasonsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updatePaymentCollectionStep", + "title": "updatePaymentCollectionStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateRefundReasonsStep", + "title": "updateRefundReasonsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validateDeletedPaymentSessionsStep", + "title": "validateDeletedPaymentSessionsStep", + "description": "", + "children": [] + } + ] + } + ], + "initialOpen": false + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Price List", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/batchPriceListPricesWorkflow", + "title": "batchPriceListPricesWorkflow", + "description": "Manage a price list's prices.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createPriceListPricesWorkflow", + "title": "createPriceListPricesWorkflow", + "description": "Create prices in price lists.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createPriceListsWorkflow", + "title": "createPriceListsWorkflow", + "description": "Create one or more price lists.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deletePriceListsWorkflow", + "title": "deletePriceListsWorkflow", + "description": "Delete one or more price lists.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removePriceListPricesWorkflow", + "title": "removePriceListPricesWorkflow", + "description": "Remove prices in price lists.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updatePriceListPricesWorkflow", + "title": "updatePriceListPricesWorkflow", + "description": "Update price lists' prices.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updatePriceListsWorkflow", + "title": "updatePriceListsWorkflow", + "description": "Update one or more price lists.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createPriceListPricesStep", + "title": "createPriceListPricesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createPriceListsStep", + "title": "createPriceListsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deletePriceListsStep", + "title": "deletePriceListsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/getExistingPriceListsPriceIdsStep", + "title": "getExistingPriceListsPriceIdsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/removePriceListPricesStep", + "title": "removePriceListPricesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updatePriceListPricesStep", + "title": "updatePriceListPricesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updatePriceListsStep", + "title": "updatePriceListsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validatePriceListsStep", + "title": "validatePriceListsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validateVariantPriceLinksStep", + "title": "validateVariantPriceLinksStep", + "description": "", + "children": [] + } + ] + } + ], + "initialOpen": false + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Pricing", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createPricePreferencesWorkflow", + "title": "createPricePreferencesWorkflow", + "description": "Create one or more price preferences.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deletePricePreferencesWorkflow", + "title": "deletePricePreferencesWorkflow", + "description": "Delete one or more price preferences.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updatePricePreferencesWorkflow", + "title": "updatePricePreferencesWorkflow", + "description": "Update one or more price preferences.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createPricePreferencesStep", + "title": "createPricePreferencesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createPriceSetsStep", + "title": "createPriceSetsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deletePricePreferencesStep", + "title": "deletePricePreferencesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updatePricePreferencesAsArrayStep", + "title": "updatePricePreferencesAsArrayStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updatePricePreferencesStep", + "title": "updatePricePreferencesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updatePriceSetsStep", + "title": "updatePriceSetsStep", + "description": "", + "children": [] + } + ] + } + ], + "initialOpen": false + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Product", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/batchLinkProductsToCategoryWorkflow", + "title": "batchLinkProductsToCategoryWorkflow", + "description": "Manage the links between a collection and products.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/batchLinkProductsToCollectionWorkflow", + "title": "batchLinkProductsToCollectionWorkflow", + "description": "Manage the links between a collection and products.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/batchProductVariantsWorkflow", + "title": "batchProductVariantsWorkflow", + "description": "Create, update, and delete product variants.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/batchProductsWorkflow", + "title": "batchProductsWorkflow", + "description": "Manage products in bulk.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createCollectionsWorkflow", + "title": "createCollectionsWorkflow", + "description": "Create one or more product collections.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createProductOptionsWorkflow", + "title": "createProductOptionsWorkflow", + "description": "Create one or more product options.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createProductTagsWorkflow", + "title": "createProductTagsWorkflow", + "description": "Create one or more product tags.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createProductTypesWorkflow", + "title": "createProductTypesWorkflow", + "description": "Create one or more product types.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createProductVariantsWorkflow", + "title": "createProductVariantsWorkflow", + "description": "Create one or more product variants.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createProductsWorkflow", + "title": "createProductsWorkflow", + "description": "Create one or more products with options and variants.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteCollectionsWorkflow", + "title": "deleteCollectionsWorkflow", + "description": "Delete one or more product collection.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteProductOptionsWorkflow", + "title": "deleteProductOptionsWorkflow", + "description": "Delete one or more product option.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteProductTagsWorkflow", + "title": "deleteProductTagsWorkflow", + "description": "Delete one or more product tags.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteProductTypesWorkflow", + "title": "deleteProductTypesWorkflow", + "description": "Delete one or more product types.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteProductVariantsWorkflow", + "title": "deleteProductVariantsWorkflow", + "description": "Delete one or more product variants.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteProductsWorkflow", + "title": "deleteProductsWorkflow", + "description": "Delete one or more products.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/exportProductsWorkflow", + "title": "exportProductsWorkflow", + "description": "Export products with filtering capabilities.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/importProductsWorkflow", + "title": "importProductsWorkflow", + "description": "Import products from a CSV file.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateCollectionsWorkflow", + "title": "updateCollectionsWorkflow", + "description": "Update one or more product collections.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateProductOptionsWorkflow", + "title": "updateProductOptionsWorkflow", + "description": "Update one or more product options.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateProductTagsWorkflow", + "title": "updateProductTagsWorkflow", + "description": "Update one or more product tags.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateProductTypesWorkflow", + "title": "updateProductTypesWorkflow", + "description": "Update one or more product types.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateProductVariantsWorkflow", + "title": "updateProductVariantsWorkflow", + "description": "Update one or more product variants.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateProductsWorkflow", + "title": "updateProductsWorkflow", + "description": "Update one or more products with options and variants.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/upsertVariantPricesWorkflow", + "title": "upsertVariantPricesWorkflow", + "description": "Create, update, or remove variants' prices.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/batchLinkProductsToCategoryStep", + "title": "batchLinkProductsToCategoryStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/batchLinkProductsToCollectionStep", + "title": "batchLinkProductsToCollectionStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createCollectionsStep", + "title": "createCollectionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createProductOptionsStep", + "title": "createProductOptionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createProductTagsStep", + "title": "createProductTagsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createProductTypesStep", + "title": "createProductTypesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createProductVariantsStep", + "title": "createProductVariantsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createProductsStep", + "title": "createProductsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createVariantPricingLinkStep", + "title": "createVariantPricingLinkStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteCollectionsStep", + "title": "deleteCollectionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteProductOptionsStep", + "title": "deleteProductOptionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteProductTagsStep", + "title": "deleteProductTagsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteProductTypesStep", + "title": "deleteProductTypesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteProductVariantsStep", + "title": "deleteProductVariantsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteProductsStep", + "title": "deleteProductsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/generateProductCsvStep", + "title": "generateProductCsvStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/getAllProductsStep", + "title": "getAllProductsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/getProductsStep", + "title": "getProductsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/getVariantAvailabilityStep", + "title": "getVariantAvailabilityStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/groupProductsForBatchStep", + "title": "groupProductsForBatchStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/parseProductCsvStep", + "title": "parseProductCsvStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateCollectionsStep", + "title": "updateCollectionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateProductOptionsStep", + "title": "updateProductOptionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateProductTagsStep", + "title": "updateProductTagsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateProductTypesStep", + "title": "updateProductTypesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateProductVariantsStep", + "title": "updateProductVariantsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateProductsStep", + "title": "updateProductsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/waitConfirmationProductImportStep", + "title": "waitConfirmationProductImportStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/validateProductInputStep", + "title": "validateProductInputStep", + "description": "", + "children": [] + } + ] + } + ], + "initialOpen": false + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Product Category", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createProductCategoriesWorkflow", + "title": "createProductCategoriesWorkflow", + "description": "Create product categories.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteProductCategoriesWorkflow", + "title": "deleteProductCategoriesWorkflow", + "description": "Delete product categories.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateProductCategoriesWorkflow", + "title": "updateProductCategoriesWorkflow", + "description": "Update product categories.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createProductCategoriesStep", + "title": "createProductCategoriesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteProductCategoriesStep", + "title": "deleteProductCategoriesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateProductCategoriesStep", + "title": "updateProductCategoriesStep", + "description": "", + "children": [] + } + ] + } + ], + "initialOpen": false + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Promotion", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/addOrRemoveCampaignPromotionsWorkflow", + "title": "addOrRemoveCampaignPromotionsWorkflow", + "description": "Manage the promotions of a campaign.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/batchPromotionRulesWorkflow", + "title": "batchPromotionRulesWorkflow", + "description": "Manage the rules of a promotion.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createCampaignsWorkflow", + "title": "createCampaignsWorkflow", + "description": "Create one or more campaigns.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createPromotionRulesWorkflow", + "title": "createPromotionRulesWorkflow", + "description": "Create one or more promotion rules.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createPromotionsWorkflow", + "title": "createPromotionsWorkflow", + "description": "Create one or more promotions.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteCampaignsWorkflow", + "title": "deleteCampaignsWorkflow", + "description": "Delete one or more campaigns.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deletePromotionRulesWorkflow", + "title": "deletePromotionRulesWorkflow", + "description": "Delete one or more promotion rules.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deletePromotionsWorkflow", + "title": "deletePromotionsWorkflow", + "description": "Delete one or more promotions.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateCampaignsWorkflow", + "title": "updateCampaignsWorkflow", + "description": "Update one or more campaigns.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updatePromotionRulesWorkflow", + "title": "updatePromotionRulesWorkflow", + "description": "Update one or more promotion rules.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updatePromotionsStatusWorkflow", + "title": "updatePromotionsStatusWorkflow", + "description": "Update the status of one or more promotions.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updatePromotionsWorkflow", + "title": "updatePromotionsWorkflow", + "description": "Update one or more promotions.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/addCampaignPromotionsStep", + "title": "addCampaignPromotionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/addRulesToPromotionsStep", + "title": "addRulesToPromotionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createCampaignsStep", + "title": "createCampaignsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createPromotionsStep", + "title": "createPromotionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteCampaignsStep", + "title": "deleteCampaignsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deletePromotionsStep", + "title": "deletePromotionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/removeCampaignPromotionsStep", + "title": "removeCampaignPromotionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/removeRulesFromPromotionsStep", + "title": "removeRulesFromPromotionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateCampaignsStep", + "title": "updateCampaignsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updatePromotionRulesStep", + "title": "updatePromotionRulesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updatePromotionsStep", + "title": "updatePromotionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updatePromotionsValidationStep", + "title": "updatePromotionsValidationStep", + "description": "", + "children": [] + } + ] + } + ], + "initialOpen": false + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Region", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createRegionsWorkflow", + "title": "createRegionsWorkflow", + "description": "Create one or more regions.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteRegionsWorkflow", + "title": "deleteRegionsWorkflow", + "description": "Delete one or more regions.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateRegionsWorkflow", + "title": "updateRegionsWorkflow", + "description": "Update regions.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createRegionsStep", + "title": "createRegionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteRegionsStep", + "title": "deleteRegionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/setRegionsPaymentProvidersStep", + "title": "setRegionsPaymentProvidersStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateRegionsStep", + "title": "updateRegionsStep", + "description": "", + "children": [] + } + ] + } + ], + "initialOpen": false + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Reservation", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createReservationsWorkflow", + "title": "createReservationsWorkflow", + "description": "Create one or more reservations.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteReservationsByLineItemsWorkflow", + "title": "deleteReservationsByLineItemsWorkflow", + "description": "Delete reservations by their associated line items.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteReservationsWorkflow", + "title": "deleteReservationsWorkflow", + "description": "Delete one or more reservations.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateReservationsWorkflow", + "title": "updateReservationsWorkflow", + "description": "Update one or more reservations.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createReservationsStep", + "title": "createReservationsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteReservationsByLineItemsStep", + "title": "deleteReservationsByLineItemsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteReservationsStep", + "title": "deleteReservationsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateReservationsStep", + "title": "updateReservationsStep", + "description": "", + "children": [] + } + ] + } + ], + "initialOpen": false + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Return Reason", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createReturnReasonsWorkflow", + "title": "createReturnReasonsWorkflow", + "description": "Create return reasons.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteReturnReasonsWorkflow", + "title": "deleteReturnReasonsWorkflow", + "description": "Delete return reasons.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateReturnReasonsWorkflow", + "title": "updateReturnReasonsWorkflow", + "description": "Update return reasons.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createReturnReasonsStep", + "title": "createReturnReasonsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteReturnReasonStep", + "title": "deleteReturnReasonStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateReturnReasonsStep", + "title": "updateReturnReasonsStep", + "description": "", + "children": [] + } + ] + } + ], + "initialOpen": false + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Sales Channel", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createSalesChannelsWorkflow", + "title": "createSalesChannelsWorkflow", + "description": "Create sales channels.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteSalesChannelsWorkflow", + "title": "deleteSalesChannelsWorkflow", + "description": "Delete sales channels.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/linkProductsToSalesChannelWorkflow", + "title": "linkProductsToSalesChannelWorkflow", + "description": "Manage the products available in a sales channel.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateSalesChannelsWorkflow", + "title": "updateSalesChannelsWorkflow", + "description": "Update sales channels.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/associateLocationsWithSalesChannelsStep", + "title": "associateLocationsWithSalesChannelsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/associateProductsWithSalesChannelsStep", + "title": "associateProductsWithSalesChannelsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/canDeleteSalesChannelsOrThrowStep", + "title": "canDeleteSalesChannelsOrThrowStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createDefaultSalesChannelStep", + "title": "createDefaultSalesChannelStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createSalesChannelsStep", + "title": "createSalesChannelsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteSalesChannelsStep", + "title": "deleteSalesChannelsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/detachLocationsFromSalesChannelsStep", + "title": "detachLocationsFromSalesChannelsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/detachProductsFromSalesChannelsStep", + "title": "detachProductsFromSalesChannelsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateSalesChannelsStep", + "title": "updateSalesChannelsStep", + "description": "", + "children": [] + } + ] + } + ], + "initialOpen": false + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Shipping Options", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/listShippingOptionsForContextStep", + "title": "listShippingOptionsForContextStep", + "description": "", + "children": [] + } + ] + } + ], + "initialOpen": false + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Shipping Profile", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteShippingProfileWorkflow", + "title": "deleteShippingProfileWorkflow", + "description": "Delete shipping profiles.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteShippingProfilesStep", + "title": "deleteShippingProfilesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/validateStepShippingProfileDelete", + "title": "validateStepShippingProfileDelete", + "description": "", + "children": [] + } + ] + } + ], + "initialOpen": false + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Stock Location", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createLocationFulfillmentSetWorkflow", + "title": "createLocationFulfillmentSetWorkflow", + "description": "Add fulfillment set to a stock location.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createStockLocationsWorkflow", + "title": "createStockLocationsWorkflow", + "description": "Create one or more stock locations.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteStockLocationsWorkflow", + "title": "deleteStockLocationsWorkflow", + "description": "Delete one or more stock locations.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/linkSalesChannelsToStockLocationWorkflow", + "title": "linkSalesChannelsToStockLocationWorkflow", + "description": "Manage the sales channels of a stock location.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateStockLocationsWorkflow", + "title": "updateStockLocationsWorkflow", + "description": "Update stock locations.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createStockLocations", + "title": "createStockLocations", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteStockLocationsStep", + "title": "deleteStockLocationsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateStockLocationsStep", + "title": "updateStockLocationsStep", + "description": "", + "children": [] + } + ] + } + ], + "initialOpen": false + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Store", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createStoresWorkflow", + "title": "createStoresWorkflow", + "description": "Create one or more stores.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteStoresWorkflow", + "title": "deleteStoresWorkflow", + "description": "Delete one or more stores.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateStoresWorkflow", + "title": "updateStoresWorkflow", + "description": "Update stores.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createStoresStep", + "title": "createStoresStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteStoresStep", + "title": "deleteStoresStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateStoresStep", + "title": "updateStoresStep", + "description": "", + "children": [] + } + ] + } + ], + "initialOpen": false + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Tax", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createTaxRateRulesWorkflow", + "title": "createTaxRateRulesWorkflow", + "description": "Create one or more tax rules for rates.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createTaxRatesWorkflow", + "title": "createTaxRatesWorkflow", + "description": "Create one or more tax rates.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createTaxRegionsWorkflow", + "title": "createTaxRegionsWorkflow", + "description": "Create one or more tax regions.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteTaxRateRulesWorkflow", + "title": "deleteTaxRateRulesWorkflow", + "description": "Delete one or more tax rate rules.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteTaxRatesWorkflow", + "title": "deleteTaxRatesWorkflow", + "description": "Delete one or more tax rates.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteTaxRegionsWorkflow", + "title": "deleteTaxRegionsWorkflow", + "description": "Delete one or more tax regions.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/setTaxRateRulesWorkflow", + "title": "setTaxRateRulesWorkflow", + "description": "Set the rules of tax rates.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateTaxRatesWorkflow", + "title": "updateTaxRatesWorkflow", + "description": "Update tax rates.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateTaxRegionsWorkflow", + "title": "updateTaxRegionsWorkflow", + "description": "Update one or more tax regions.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createTaxRateRulesStep", + "title": "createTaxRateRulesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createTaxRatesStep", + "title": "createTaxRatesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createTaxRegionsStep", + "title": "createTaxRegionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteTaxRateRulesStep", + "title": "deleteTaxRateRulesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteTaxRatesStep", + "title": "deleteTaxRatesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteTaxRegionsStep", + "title": "deleteTaxRegionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/getItemTaxLinesStep", + "title": "getItemTaxLinesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/listTaxRateIdsStep", + "title": "listTaxRateIdsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/listTaxRateRuleIdsStep", + "title": "listTaxRateRuleIdsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateTaxRatesStep", + "title": "updateTaxRatesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateTaxRegionsStep", + "title": "updateTaxRegionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/maybeListTaxRateRuleIdsStep", + "title": "maybeListTaxRateRuleIdsStep", + "description": "", + "children": [] + } + ] + } + ], + "initialOpen": false + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "User", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createUserAccountWorkflow", + "title": "createUserAccountWorkflow", + "description": "Create a user account and attach an auth identity.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createUsersWorkflow", + "title": "createUsersWorkflow", + "description": "Create one or more users.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteUsersWorkflow", + "title": "deleteUsersWorkflow", + "description": "Delete one or more users.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeUserAccountWorkflow", + "title": "removeUserAccountWorkflow", + "description": "Delete a user and remove the association to its auth identity.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateUsersWorkflow", + "title": "updateUsersWorkflow", + "description": "Update one or more users.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createUsersStep", + "title": "createUsersStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteUsersStep", + "title": "deleteUsersStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateUsersStep", + "title": "updateUsersStep", + "description": "", + "children": [] + } + ] + } + ], + "initialOpen": false + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "test-tools-reference", + "title": "Testing Framework", + "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "title": "moduleIntegrationTestRunner", - "path": "/test-tools-reference/moduleIntegrationTestRunner", + "path": "/test-tools-reference", + "title": "Reference Overview", "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Functions", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "medusaIntegrationTestRunner", + "path": "/test-tools-reference/medusaIntegrationTestRunner", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "moduleIntegrationTestRunner", + "path": "/test-tools-reference/moduleIntegrationTestRunner", + "children": [] + } + ] } ] } ] } ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Other", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Contribution Guidelines", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/contribution-guidelines/docs", - "title": "Docs", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/contribution-guidelines/admin-translations", - "title": "Admin Translations", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/usage", - "title": "Usage", - "children": [] - } - ] } ] \ No newline at end of file diff --git a/www/apps/resources/next.config.mjs b/www/apps/resources/next.config.mjs index 2c880d782e..4da1541fed 100644 --- a/www/apps/resources/next.config.mjs +++ b/www/apps/resources/next.config.mjs @@ -133,6 +133,16 @@ const nextConfig = { destination: "/recipes/erp", permanent: true, }, + { + source: "/contribution-guidelines/:path", + destination: `${process.env.NEXT_PUBLIC_BASE_URL}/learn/resources/contribution-guidelines/:path`, + permanent: true, + }, + { + source: "/usage", + destination: `${process.env.NEXT_PUBLIC_BASE_URL}/learn/resources/usage`, + permanent: true, + }, ] }, outputFileTracingExcludes: { diff --git a/www/apps/resources/providers/sidebar.tsx b/www/apps/resources/providers/sidebar.tsx index c70f148845..4a7ac455da 100644 --- a/www/apps/resources/providers/sidebar.tsx +++ b/www/apps/resources/providers/sidebar.tsx @@ -14,13 +14,8 @@ const SidebarProvider = ({ children }: SidebarProviderProps) => { return ( {children} diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.draftOrder/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.draftOrder/page.mdx index 6f04b12a8f..08e79dacb5 100644 --- a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.draftOrder/page.mdx +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.draftOrder/page.mdx @@ -4,7 +4,7 @@ sidebar_label: draftOrder tags: - js sdk - admin - - draft order + - order --- import { TypeList } from "docs-ui" diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.product/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.product/page.mdx index 9764675ab2..27333240e1 100644 --- a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.product/page.mdx +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.product/page.mdx @@ -266,7 +266,7 @@ Learn more about the `fields` property in the [API reference](https://docs.medus ### Parameters - + ### Returns diff --git a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.productCollection/page.mdx b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.productCollection/page.mdx index 10707a72dc..c592a78989 100644 --- a/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.productCollection/page.mdx +++ b/www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.productCollection/page.mdx @@ -113,7 +113,7 @@ Learn more about the `fields` property in the [API reference](https://docs.medus ### Parameters - + ### Returns diff --git a/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.list/page.mdx b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.list/page.mdx index 06e360c468..a4654d5d9b 100644 --- a/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.list/page.mdx +++ b/www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.list/page.mdx @@ -46,7 +46,7 @@ Learn more about the `fields` property in the [API reference](https://docs.medus ## Parameters - + ## Returns diff --git a/www/apps/resources/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.list/page.mdx b/www/apps/resources/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.list/page.mdx index 457c99c110..f9a4b7e461 100644 --- a/www/apps/resources/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.list/page.mdx +++ b/www/apps/resources/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.list/page.mdx @@ -46,7 +46,7 @@ Learn more about the `fields` property in the [API reference](https://docs.medus ## Parameters - + ## Returns diff --git a/www/apps/resources/scripts/prepare.mjs b/www/apps/resources/scripts/prepare.mjs index a9ec814a87..9991bd634a 100644 --- a/www/apps/resources/scripts/prepare.mjs +++ b/www/apps/resources/scripts/prepare.mjs @@ -5,9 +5,9 @@ import { sidebar } from "../sidebar.mjs" async function main() { await generateSidebar(sidebar) - await generateSlugChanges() - await generateFilesMap() - await generateEditedDates() + // await generateSlugChanges() + // await generateFilesMap() + // await generateEditedDates() } void main() diff --git a/www/apps/resources/sidebar.mjs b/www/apps/resources/sidebar.mjs index 019e0e4a98..78a4213420 100644 --- a/www/apps/resources/sidebar.mjs +++ b/www/apps/resources/sidebar.mjs @@ -24,219 +24,171 @@ import { storefrontGuidesSidebar } from "./sidebars/storefront.mjs" import { taxSidebar } from "./sidebars/tax.mjs" import { troubleshootingSidebar } from "./sidebars/troubleshooting.mjs" import { userSidebar } from "./sidebars/user.mjs" -import { sidebarAttachHrefCommonOptions } from "./utils/sidebar-attach-common-options.mjs" import { examplesSidebar } from "./sidebars/examples.mjs" -/** @type {import('types').RawSidebarItem[]} */ -export const sidebar = sidebarAttachHrefCommonOptions([ +/** @type {import("types").Sidebar.RawSidebar[]} */ +export const sidebar = [ { - type: "link", - path: "/", - title: "Overview", - }, - ...examplesSidebar, - { - type: "link", - path: "/recipes", - title: "Recipes", - isChildSidebar: true, - children: recipesSidebar, - }, - { - type: "separator", - }, - { - type: "link", - path: "/commerce-modules", - title: "Commerce Modules", - hideChildren: true, - children: [ - ...apiKeySidebar, - ...authSidebar, - ...cartSidebar, - ...currencySidebar, - ...customerSidebar, - ...fulfillmentSidebar, - ...inventorySidebar, - ...orderSidebar, - ...paymentSidebar, - ...pricingSidebar, - ...productSidebar, - ...promotionSidebar, - ...regionSidebar, - ...salesChannelSidebar, - ...stockLocationSidebar, - ...storeSidebar, - ...taxSidebar, - ...userSidebar, - ], - }, - { - type: "link", - path: "/architectural-modules", - title: "Architectural Modules", - isChildSidebar: true, - children: architecturalModulesSidebar, - }, - { - type: "link", - path: "/integrations", - title: "Integrations", - isChildSidebar: true, - children: integrationsSidebar, - }, - { - type: "ref", - path: "/plugins", - title: "Plugins", - isChildSidebar: true, - children: pluginsSidebar, - }, - { - type: "link", - path: "/storefront-development", - title: "Storefront Development", - isChildSidebar: true, - children: storefrontGuidesSidebar, - }, - { - type: "separator", - }, - { - type: "category", - title: "SDKs and Tools", - children: sdkToolsSidebar, - }, - { - type: "category", - title: "General", - children: [ + sidebar_id: "resources", + title: "Development Resources", + items: [ { type: "link", - path: "/references/medusa-config", - title: "Medusa Configurations", + path: "/", + title: "Overview", + }, + ...examplesSidebar, + ...recipesSidebar, + { + type: "separator", }, { type: "link", - path: "/deployment", - title: "Deployment Guides", - isChildSidebar: true, + path: "/commerce-modules", + title: "Commerce Modules", + hideChildren: true, + sort_sidebar: "alphabetize", + children: [ + ...apiKeySidebar, + ...authSidebar, + ...cartSidebar, + ...currencySidebar, + ...customerSidebar, + ...fulfillmentSidebar, + ...inventorySidebar, + ...orderSidebar, + ...paymentSidebar, + ...pricingSidebar, + ...productSidebar, + ...promotionSidebar, + ...regionSidebar, + ...salesChannelSidebar, + ...stockLocationSidebar, + ...storeSidebar, + ...taxSidebar, + ...userSidebar, + ], + }, + ...architecturalModulesSidebar, + ...integrationsSidebar, + ...pluginsSidebar, + ...storefrontGuidesSidebar, + { + type: "separator", + }, + { + type: "category", + title: "SDKs and Tools", + children: sdkToolsSidebar, + }, + { + type: "category", + title: "General", children: [ { - type: "link", - title: "Medusa Cloud", - path: "https://medusajs.com/contact", - }, - { - type: "separator", - }, - { - type: "category", - title: "Self-Hosting", + type: "sidebar", + sidebar_id: "deployment-guides", + title: "Deployment Guides", children: [ { type: "link", - path: "https://docs.medusajs.com/learn/deployment/general", - title: "General", + path: "/deployment", + title: "Overview", + }, + { + type: "separator", }, { type: "link", - path: "/deployment/medusa-application/railway", - title: "Railway", + title: "Medusa Cloud", + path: "https://medusajs.com/pricing", + }, + { + type: "separator", + }, + { + type: "category", + title: "Self-Hosting", + children: [ + { + type: "link", + path: "https://docs.medusajs.com/learn/deployment/general", + title: "General", + }, + { + type: "link", + path: "/deployment/medusa-application/railway", + title: "Railway", + }, + ], + }, + { + type: "category", + title: "Next.js Starter", + autogenerate_path: "/deployment/storefront", }, ], }, - { - type: "category", - title: "Next.js Starter", - autogenerate_path: "/deployment/storefront", - }, + ...troubleshootingSidebar, ], }, { - type: "link", - path: "/troubleshooting", - title: "Troubleshooting Guides", - isChildSidebar: true, - children: troubleshootingSidebar, - }, - ], - }, - { - type: "category", - title: "Admin", - children: [ - { - type: "link", - path: "/admin-widget-injection-zones", - title: "Admin Widget Injection Zones", - }, - { - type: "link", - path: "/admin-components", - title: "Admin Components", - isChildSidebar: true, - children: [ - { - type: "category", - title: "Layouts", - autogenerate_path: "/admin-components/layouts", - }, - { - type: "category", - title: "Components", - autogenerate_path: "/admin-components/components", - }, - ], - }, - ], - }, - { - type: "category", - title: "Lists", - children: [ - { - type: "link", - path: "/medusa-container-resources", - title: "Container Dependencies", - }, - { - type: "link", - path: "/events-reference", - title: "Events List", - }, - ], - }, - { - type: "category", - title: "References", - children: referencesSidebar, - }, - { - type: "category", - title: "Other", - children: [ - { - type: "sub-category", - title: "Contribution Guidelines", + type: "category", + title: "Admin", children: [ { type: "link", - path: "/contribution-guidelines/docs", - title: "Docs", + path: "/admin-widget-injection-zones", + title: "Admin Widget Injection Zones", }, { - type: "link", - path: "/contribution-guidelines/admin-translations", - title: "Admin Translations", + type: "sidebar", + sidebar_id: "admin-components", + title: "Admin Components", + children: [ + { + type: "link", + path: "/admin-components", + title: "Overview", + }, + { + type: "separator", + }, + { + type: "category", + title: "Layouts", + autogenerate_path: "/admin-components/layouts", + }, + { + type: "category", + title: "Components", + autogenerate_path: "/admin-components/components", + }, + ], }, ], }, { - type: "link", - path: "/usage", - title: "Usage", + type: "category", + title: "Lists", + children: [ + { + type: "link", + path: "/medusa-container-resources", + title: "Container Dependencies", + }, + { + type: "link", + path: "/events-reference", + title: "Events List", + }, + ], + }, + { + type: "category", + title: "References", + children: referencesSidebar, }, ], }, -]) +] diff --git a/www/apps/resources/sidebars/api-key.mjs b/www/apps/resources/sidebars/api-key.mjs index 3bd8665aa9..854a2f4a24 100644 --- a/www/apps/resources/sidebars/api-key.mjs +++ b/www/apps/resources/sidebars/api-key.mjs @@ -1,9 +1,9 @@ -/** @type {import('types').RawSidebarItem[]} */ +/** @type {import('types').Sidebar.SidebarItem[]} */ export const apiKeySidebar = [ { - type: "category", + type: "sidebar", + sidebar_id: "api-key", title: "API Key Module", - isChildSidebar: true, children: [ { type: "link", @@ -36,6 +36,7 @@ export const apiKeySidebar = [ autogenerate_tags: "server+auth", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to use the API Key Module in your customizations on the Medusa application server.", }, @@ -45,6 +46,7 @@ export const apiKeySidebar = [ initialOpen: false, autogenerate_tags: "storefront+apiKey,-jsSdk", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to integrate the API Key Module's features into your storefront.", }, @@ -54,6 +56,7 @@ export const apiKeySidebar = [ initialOpen: false, autogenerate_tags: "admin+apiKey,-jsSdk", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to utilize administative features of the API Key Module.", }, @@ -63,6 +66,7 @@ export const apiKeySidebar = [ initialOpen: false, autogenerate_tags: "userGuide+apiKey", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to utilize and manage API Key features in the Medusa Admin dashboard.", }, @@ -84,12 +88,14 @@ export const apiKeySidebar = [ title: "Workflows", autogenerate_tags: "workflow+apiKey", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, { type: "category", title: "Steps", autogenerate_tags: "step+apiKey", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, ], }, @@ -106,6 +112,7 @@ export const apiKeySidebar = [ description: "The following methods or properties are used to send requests to Store API Routes related to the API Key Module.", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, { type: "sub-category", @@ -114,6 +121,7 @@ export const apiKeySidebar = [ description: "The following methods or properties are used to send requests to Admin API Routes related to the API Key Module.", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, ], }, @@ -123,12 +131,19 @@ export const apiKeySidebar = [ title: "Admin Widget Zones", }, { - type: "link", - path: "/references/api-key", + type: "sidebar", + sidebar_id: "api-key-service-reference", title: "Main Service Reference", - isChildSidebar: true, childSidebarTitle: "API Key Module's Main Service Reference", children: [ + { + type: "link", + path: "/references/api-key", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "category", title: "Methods", @@ -139,12 +154,19 @@ export const apiKeySidebar = [ ], }, { - type: "link", - path: "/references/api-key/models", + type: "sidebar", + sidebar_id: "api-key-models-reference", title: "Data Models Reference", - isChildSidebar: true, childSidebarTitle: "API Key Module Data Models Reference", children: [ + { + type: "link", + path: "/references/api-key/models", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "category", title: "Data Models", diff --git a/www/apps/resources/sidebars/architectural-modules.mjs b/www/apps/resources/sidebars/architectural-modules.mjs index 54d59e89cd..4c6146738e 100644 --- a/www/apps/resources/sidebars/architectural-modules.mjs +++ b/www/apps/resources/sidebars/architectural-modules.mjs @@ -1,161 +1,176 @@ -/** @type {import('types').RawSidebarItem[]} */ +/** @type {import('types').Sidebar.SidebarItem[]} */ export const architecturalModulesSidebar = [ { - type: "category", - title: "Cache Modules", + type: "sidebar", + sidebar_id: "architectural-modules", + title: "Architectural Modules", children: [ { type: "link", - path: "/architectural-modules/cache", + path: "/architectural-modules", title: "Overview", }, { - type: "link", - path: "/architectural-modules/cache/in-memory", - title: "In-Memory", + type: "separator", }, { - type: "link", - path: "/architectural-modules/cache/redis", - title: "Redis", - }, - { - type: "sub-category", - title: "Guides", + type: "category", + title: "Cache Modules", children: [ { type: "link", - path: "/architectural-modules/cache/create", - title: "Create Cache Module", + path: "/architectural-modules/cache", + title: "Overview", + }, + { + type: "link", + path: "/architectural-modules/cache/in-memory", + title: "In-Memory", + }, + { + type: "link", + path: "/architectural-modules/cache/redis", + title: "Redis", + }, + { + type: "sub-category", + title: "Guides", + children: [ + { + type: "link", + path: "/architectural-modules/cache/create", + title: "Create Cache Module", + }, + ], }, ], }, - ], - }, - { - type: "category", - title: "Event Modules", - children: [ { - type: "link", - path: "/architectural-modules/event", - title: "Overview", - }, - { - type: "link", - path: "/architectural-modules/event/local", - title: "Local", - }, - { - type: "link", - path: "/architectural-modules/event/redis", - title: "Redis", - }, - { - type: "sub-category", - title: "Guides", + type: "category", + title: "Event Modules", children: [ { type: "link", - path: "/architectural-modules/event/create", - title: "Create Event Module", + path: "/architectural-modules/event", + title: "Overview", + }, + { + type: "link", + path: "/architectural-modules/event/local", + title: "Local", + }, + { + type: "link", + path: "/architectural-modules/event/redis", + title: "Redis", + }, + { + type: "sub-category", + title: "Guides", + children: [ + { + type: "link", + path: "/architectural-modules/event/create", + title: "Create Event Module", + }, + ], }, ], }, - ], - }, - { - type: "category", - title: "File Module Providers", - children: [ { - type: "link", - path: "/architectural-modules/file", - title: "Overview", - }, - { - type: "link", - path: "/architectural-modules/file/local", - title: "Local", - }, - { - type: "link", - path: "/architectural-modules/file/s3", - title: "AWS S3 (and Compatible APIs)", - }, - { - type: "sub-category", - title: "Guides", + type: "category", + title: "File Module Providers", children: [ { type: "link", - path: "/references/file-provider-module", - title: "Create File Provider", + path: "/architectural-modules/file", + title: "Overview", + }, + { + type: "link", + path: "/architectural-modules/file/local", + title: "Local", + }, + { + type: "link", + path: "/architectural-modules/file/s3", + title: "AWS S3 (and Compatible APIs)", + }, + { + type: "sub-category", + title: "Guides", + children: [ + { + type: "link", + path: "/references/file-provider-module", + title: "Create File Provider", + }, + ], }, ], }, - ], - }, - { - type: "category", - title: "Notification Module Providers", - children: [ { - type: "link", - path: "/architectural-modules/notification", - title: "Overview", - }, - { - type: "link", - path: "/architectural-modules/notification/local", - title: "Local", - }, - { - type: "link", - path: "/architectural-modules/notification/sendgrid", - title: "SendGrid", - }, - { - type: "sub-category", - title: "Guides", + type: "category", + title: "Notification Module Providers", children: [ { type: "link", - path: "/architectural-modules/notification/send-notification", - title: "Send Notification", + path: "/architectural-modules/notification", + title: "Overview", }, { type: "link", - path: "/references/notification-provider-module", - title: "Create Notification Provider", + path: "/architectural-modules/notification/local", + title: "Local", }, { type: "link", - path: "/integrations/guides/resend", - title: "Integrate Resend", + path: "/architectural-modules/notification/sendgrid", + title: "SendGrid", + }, + { + type: "sub-category", + title: "Guides", + children: [ + { + type: "link", + path: "/references/notification-provider-module", + title: "Create Notification Provider", + }, + { + type: "link", + path: "/integrations/guides/resend", + title: "Integrate Resend", + }, + { + type: "link", + path: "/architectural-modules/notification/send-notification", + title: "Send Notification", + }, + ], }, ], }, - ], - }, - { - type: "category", - title: "Workflow Engine Modules", - children: [ { - type: "link", - path: "/architectural-modules/workflow-engine", - title: "Overview", - }, - { - type: "link", - path: "/architectural-modules/workflow-engine/in-memory", - title: "In-Memory", - }, - { - type: "link", - path: "/architectural-modules/workflow-engine/redis", - title: "Redis", + type: "category", + title: "Workflow Engine Modules", + children: [ + { + type: "link", + path: "/architectural-modules/workflow-engine", + title: "Overview", + }, + { + type: "link", + path: "/architectural-modules/workflow-engine/in-memory", + title: "In-Memory", + }, + { + type: "link", + path: "/architectural-modules/workflow-engine/redis", + title: "Redis", + }, + ], }, ], }, diff --git a/www/apps/resources/sidebars/auth.mjs b/www/apps/resources/sidebars/auth.mjs index 464f6959be..49199ca8dd 100644 --- a/www/apps/resources/sidebars/auth.mjs +++ b/www/apps/resources/sidebars/auth.mjs @@ -1,9 +1,9 @@ -/** @type {import('types').RawSidebarItem[]} */ +/** @type {import('types').Sidebar.SidebarItem[]} */ export const authSidebar = [ { - type: "category", + type: "sidebar", + sidebar_id: "auth", title: "Auth Module", - isChildSidebar: true, children: [ { type: "link", @@ -51,6 +51,7 @@ export const authSidebar = [ autogenerate_tags: "server+auth", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to use the Auth Module in your customizations on the Medusa application server.", children: [ @@ -77,6 +78,7 @@ export const authSidebar = [ autogenerate_tags: "storefront+auth,-jsSdk", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to integrate the Auth Module's features into your storefront.", }, @@ -86,6 +88,7 @@ export const authSidebar = [ autogenerate_tags: "admin+auth,-jsSdk", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to utilize administative features of the Auth Module.", }, @@ -95,6 +98,7 @@ export const authSidebar = [ autogenerate_tags: "userGuide+auth", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to utilize and manage Auth features in the Medusa Admin dashboard.", }, @@ -138,12 +142,14 @@ export const authSidebar = [ title: "Workflows", autogenerate_tags: "workflow+auth", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, { type: "category", title: "Steps", autogenerate_tags: "step+auth", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, ], }, @@ -154,6 +160,7 @@ export const authSidebar = [ hideChildren: true, autogenerate_tags: "jsSdk+auth", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, { type: "link", @@ -166,12 +173,19 @@ export const authSidebar = [ title: "Admin Widget Zones", }, { - type: "link", - path: "/references/auth", + type: "sidebar", + sidebar_id: "auth-service-reference", title: "Main Service Reference", - isChildSidebar: true, childSidebarTitle: "Auth Module's Main Service Reference", children: [ + { + type: "link", + path: "/references/auth", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "category", title: "Methods", @@ -181,12 +195,19 @@ export const authSidebar = [ ], }, { - type: "link", - path: "/references/auth/models", + type: "sidebar", + sidebar_id: "auth-models-reference", title: "Data Models Reference", - isChildSidebar: true, childSidebarTitle: "Auth Module Data Models Reference", children: [ + { + type: "link", + path: "/references/auth/models", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "category", title: "Data Models", diff --git a/www/apps/resources/sidebars/cart.mjs b/www/apps/resources/sidebars/cart.mjs index 4dff5a3a01..9de8840198 100644 --- a/www/apps/resources/sidebars/cart.mjs +++ b/www/apps/resources/sidebars/cart.mjs @@ -1,9 +1,9 @@ -/** @type {import('types').RawSidebarItem[]} */ +/** @type {import('types').Sidebar.SidebarItem[]} */ export const cartSidebar = [ { - type: "category", + type: "sidebar", + sidebar_id: "cart", title: "Cart Module", - isChildSidebar: true, children: [ { type: "link", @@ -46,6 +46,7 @@ export const cartSidebar = [ autogenerate_tags: "server+cart", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to use the Cart Module in your customizations on the Medusa application server.", children: [ @@ -62,6 +63,7 @@ export const cartSidebar = [ autogenerate_tags: "storefront+cart,-jsSdk", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to integrate the Cart Module's features into your storefront.", }, @@ -71,6 +73,7 @@ export const cartSidebar = [ autogenerate_tags: "admin+cart,-jsSdk", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to utilize administative features of the Cart Module.", }, @@ -80,6 +83,7 @@ export const cartSidebar = [ autogenerate_tags: "userGuide+cart", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to utilize and manage Cart features in the Medusa Admin dashboard.", }, @@ -101,12 +105,14 @@ export const cartSidebar = [ title: "Workflows", autogenerate_tags: "workflow+cart", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, { type: "category", title: "Steps", autogenerate_tags: "step+cart", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, ], }, @@ -123,6 +129,7 @@ export const cartSidebar = [ description: "The following methods or properties are used to send requests to Store API Routes related to the Cart Module.", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, { type: "sub-category", @@ -131,6 +138,7 @@ export const cartSidebar = [ description: "The following methods or properties are used to send requests to Admin API Routes related to the Cart Module.", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, ], }, @@ -140,12 +148,19 @@ export const cartSidebar = [ title: "Events Reference", }, { - type: "link", - path: "/references/cart", + type: "sidebar", + sidebar_id: "cart-service-reference", title: "Main Service Reference", - isChildSidebar: true, childSidebarTitle: "Cart Module's Main Service Reference", children: [ + { + type: "link", + path: "/references/cart", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "category", title: "Methods", @@ -155,12 +170,19 @@ export const cartSidebar = [ ], }, { - type: "link", - path: "/references/cart/models", + type: "sidebar", + sidebar_id: "cart-models-reference", title: "Data Models Reference", - isChildSidebar: true, childSidebarTitle: "Cart Module Data Models Reference", children: [ + { + type: "link", + path: "/references/cart/models", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "category", title: "Data Models", diff --git a/www/apps/resources/sidebars/currency.mjs b/www/apps/resources/sidebars/currency.mjs index d8e7eed1a6..856d70ac18 100644 --- a/www/apps/resources/sidebars/currency.mjs +++ b/www/apps/resources/sidebars/currency.mjs @@ -1,9 +1,9 @@ -/** @type {import('types').RawSidebarItem[]} */ +/** @type {import('types').Sidebar.SidebarItem[]} */ export const currencySidebar = [ { - type: "category", + type: "sidebar", + sidebar_id: "currency", title: "Currency Module", - isChildSidebar: true, children: [ { type: "link", @@ -31,6 +31,7 @@ export const currencySidebar = [ autogenerate_tags: "server+currency", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to use the Currency Module in your customizations on the Medusa application server.", }, @@ -40,6 +41,7 @@ export const currencySidebar = [ autogenerate_tags: "storefront+currency,-jsSdk", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to integrate the Currency Module's features into your storefront.", }, @@ -49,6 +51,7 @@ export const currencySidebar = [ autogenerate_tags: "admin+currency,-jsSdk", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to utilize administative features of the Currency Module.", }, @@ -58,6 +61,7 @@ export const currencySidebar = [ autogenerate_tags: "userGuide+currency", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to utilize and manage Currency features in the Medusa Admin dashboard.", }, @@ -81,6 +85,7 @@ export const currencySidebar = [ description: "The following methods or properties are used to send requests to Store API Routes related to the Currency Module.", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, { type: "sub-category", @@ -89,16 +94,24 @@ export const currencySidebar = [ description: "The following methods or properties are used to send requests to Admin API Routes related to the Currency Module.", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, ], }, { - type: "link", - path: "/references/currency", + type: "sidebar", + sidebar_id: "currency-service-reference", title: "Main Service Reference", - isChildSidebar: true, childSidebarTitle: "Currency Module's Main Service Reference", children: [ + { + type: "link", + path: "/references/currency", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "category", title: "Methods", @@ -108,12 +121,19 @@ export const currencySidebar = [ ], }, { - type: "link", - path: "/references/currency/models", + type: "sidebar", + sidebar_id: "currency-models-reference", title: "Data Models Reference", - isChildSidebar: true, childSidebarTitle: "Currency Module Data Models Reference", children: [ + { + type: "link", + path: "/references/currency/models", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "category", title: "Data Models", diff --git a/www/apps/resources/sidebars/customer.mjs b/www/apps/resources/sidebars/customer.mjs index d416090daf..2f295580ff 100644 --- a/www/apps/resources/sidebars/customer.mjs +++ b/www/apps/resources/sidebars/customer.mjs @@ -1,9 +1,9 @@ -/** @type {import('types').RawSidebarItem[]} */ +/** @type {import('types').Sidebar.SidebarItem[]} */ export const customerSidebar = [ { - type: "category", + type: "sidebar", + sidebar_id: "customer", title: "Customer Module", - isChildSidebar: true, children: [ { type: "link", @@ -36,6 +36,7 @@ export const customerSidebar = [ autogenerate_tags: "server+customer", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to use the Customer Module in your customizations on the Medusa application server.", children: [ @@ -52,6 +53,7 @@ export const customerSidebar = [ autogenerate_tags: "storefront+customer,-jsSdk", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to integrate the Customer Module's features into your storefront.", }, @@ -61,6 +63,7 @@ export const customerSidebar = [ autogenerate_tags: "admin+customer,-jsSdk", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to utilize administative features of the Customer Module.", }, @@ -70,6 +73,7 @@ export const customerSidebar = [ autogenerate_tags: "userGuide+customer", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to utilize and manage Customer features in the Medusa Admin dashboard.", }, @@ -91,12 +95,14 @@ export const customerSidebar = [ title: "Workflows", autogenerate_tags: "workflow+customer", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, { type: "category", title: "Steps", autogenerate_tags: "step+customer", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, ], }, @@ -113,6 +119,7 @@ export const customerSidebar = [ description: "The following methods or properties are used to send requests to Store API Routes related to the Customer Module.", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, { type: "sub-category", @@ -121,6 +128,7 @@ export const customerSidebar = [ description: "The following methods or properties are used to send requests to Admin API Routes related to the Customer Module.", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, ], }, @@ -135,12 +143,19 @@ export const customerSidebar = [ title: "Admin Widget Zones", }, { - type: "link", - path: "/references/customer", + type: "sidebar", + sidebar_id: "customer-service-reference", title: "Main Service Reference", - isChildSidebar: true, childSidebarTitle: "Customer Module's Main Service Reference", children: [ + { + type: "link", + path: "/references/customer", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "category", title: "Methods", @@ -150,12 +165,19 @@ export const customerSidebar = [ ], }, { - type: "link", - path: "/references/customer/models", + type: "sidebar", + sidebar_id: "customer-models-reference", title: "Data Models Reference", - isChildSidebar: true, childSidebarTitle: "Customer Module Data Models Reference", children: [ + { + type: "link", + path: "/references/customer/models", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "category", title: "Data Models", diff --git a/www/apps/resources/sidebars/examples.mjs b/www/apps/resources/sidebars/examples.mjs index 99c3687df9..a4336932d2 100644 --- a/www/apps/resources/sidebars/examples.mjs +++ b/www/apps/resources/sidebars/examples.mjs @@ -1,13 +1,12 @@ -/** @type {import('types').RawSidebarItem[]} */ +/** @type {import('types').Sidebar.SidebarItem[]} */ export const examplesSidebar = [ { - type: "link", - path: "/examples", + type: "sidebar", + sidebar_id: "examples", title: "Examples", - isChildSidebar: true, children: [ { - type: "ref", + type: "link", path: "/examples", title: "Example Snippets", }, @@ -31,6 +30,7 @@ export const examplesSidebar = [ title: "Server Examples", autogenerate_tags: "example+server", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", children: [ { type: "link", @@ -49,6 +49,7 @@ export const examplesSidebar = [ title: "Admin Examples", autogenerate_tags: "example+admin", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", children: [], }, { @@ -56,6 +57,7 @@ export const examplesSidebar = [ title: "Storefront Examples", autogenerate_tags: "example+storefront", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", children: [], }, ], diff --git a/www/apps/resources/sidebars/fulfillment.mjs b/www/apps/resources/sidebars/fulfillment.mjs index a42e8b2d6e..0584c3797c 100644 --- a/www/apps/resources/sidebars/fulfillment.mjs +++ b/www/apps/resources/sidebars/fulfillment.mjs @@ -1,9 +1,9 @@ -/** @type {import('types').RawSidebarItem[]} */ +/** @type {import('types').Sidebar.SidebarItem[]} */ export const fulfillmentSidebar = [ { - type: "category", + type: "sidebar", + sidebar_id: "fulfillment", title: "Fulfillment Module", - isChildSidebar: true, children: [ { type: "link", @@ -58,6 +58,7 @@ export const fulfillmentSidebar = [ autogenerate_tags: "server+fulfillment", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to use the Fulfillment Module in your customizations on the Medusa application server.", children: [ @@ -79,6 +80,7 @@ export const fulfillmentSidebar = [ autogenerate_tags: "storefront+fulfillment,-jsSdk", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to integrate the Fulfillment Module's features into your storefront.", }, @@ -88,6 +90,7 @@ export const fulfillmentSidebar = [ autogenerate_tags: "admin+fulfillment,-jsSdk", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to utilize administative features of the Fulfillment Module.", }, @@ -97,6 +100,7 @@ export const fulfillmentSidebar = [ autogenerate_tags: "userGuide+fulfillment", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to utilize and manage Fulfillment features in the Medusa Admin dashboard.", }, @@ -118,12 +122,14 @@ export const fulfillmentSidebar = [ title: "Workflows", autogenerate_tags: "workflow+fulfillment", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, { type: "category", title: "Steps", autogenerate_tags: "step+fulfillment", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, ], }, @@ -140,6 +146,7 @@ export const fulfillmentSidebar = [ description: "The following methods or properties are used to send requests to Store API Routes related to the Fulfillment Module.", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, { type: "sub-category", @@ -148,6 +155,7 @@ export const fulfillmentSidebar = [ description: "The following methods or properties are used to send requests to Admin API Routes related to the Fulfillment Module.", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, ], }, @@ -162,12 +170,19 @@ export const fulfillmentSidebar = [ title: "Admin Widget Zones", }, { - type: "link", - path: "/references/fulfillment", + type: "sidebar", + sidebar_id: "fulfillment-service-reference", title: "Main Service Reference", - isChildSidebar: true, childSidebarTitle: "Fulfillment Module's Main Service Reference", children: [ + { + type: "link", + path: "/references/fulfillment", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "category", title: "Methods", @@ -177,12 +192,19 @@ export const fulfillmentSidebar = [ ], }, { - type: "link", - path: "/references/fulfillment/models", + type: "sidebar", + sidebar_id: "fulfillment-models-reference", title: "Data Models Reference", - isChildSidebar: true, childSidebarTitle: "Fulfillment Module Data Models Reference", children: [ + { + type: "link", + path: "/references/fulfillment/models", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "category", title: "Data Models", diff --git a/www/apps/resources/sidebars/integrations.mjs b/www/apps/resources/sidebars/integrations.mjs index d40267fe85..c22ed1f7cb 100644 --- a/www/apps/resources/sidebars/integrations.mjs +++ b/www/apps/resources/sidebars/integrations.mjs @@ -1,78 +1,93 @@ -/** @type {import('types').RawSidebarItem[]} */ +/** @type {import('types').Sidebar.SidebarItem[]} */ export const integrationsSidebar = [ { - type: "category", - title: "Auth", + type: "sidebar", + sidebar_id: "integrations", + title: "Integrations", children: [ { type: "link", - path: "/commerce-modules/auth/auth-providers/google", - title: "Google", + path: "/integrations", + title: "Overview", }, { - type: "link", - path: "/commerce-modules/auth/auth-providers/github", - title: "GitHub", - }, - ], - }, - { - type: "category", - title: "CMS", - children: [ - { - type: "link", - path: "/integrations/guides/sanity", - title: "Sanity", - }, - ], - }, - { - type: "category", - title: "File", - children: [ - { - type: "link", - path: "/architectural-modules/file/s3", - title: "AWS", - }, - ], - }, - { - type: "category", - title: "Fulfillment", - children: [ - { - type: "link", - path: "/integrations/guides/shipstation", - title: "ShipStation", - }, - ], - }, - { - type: "category", - title: "Notification", - children: [ - { - type: "link", - path: "/architectural-modules/notification/sendgrid", - title: "SendGrid", + type: "separator", }, { - type: "link", - path: "/integrations/guides/resend", - title: "Resend", + type: "category", + title: "Auth", + children: [ + { + type: "link", + path: "/commerce-modules/auth/auth-providers/google", + title: "Google", + }, + { + type: "link", + path: "/commerce-modules/auth/auth-providers/github", + title: "GitHub", + }, + ], }, - ], - }, - { - type: "category", - title: "Payment", - children: [ { - type: "link", - path: "/commerce-modules/payment/payment-provider/stripe", - title: "Stripe", + type: "category", + title: "CMS", + children: [ + { + type: "link", + path: "/integrations/guides/sanity", + title: "Sanity", + }, + ], + }, + { + type: "category", + title: "File", + children: [ + { + type: "link", + path: "/architectural-modules/file/s3", + title: "AWS", + }, + ], + }, + { + type: "category", + title: "Fulfillment", + children: [ + { + type: "link", + path: "/integrations/guides/shipstation", + title: "ShipStation", + }, + ], + }, + { + type: "category", + title: "Notification", + children: [ + { + type: "link", + path: "/architectural-modules/notification/sendgrid", + title: "SendGrid", + }, + { + type: "link", + path: "/integrations/guides/resend", + title: "Resend", + }, + ], + }, + { + type: "category", + title: "Payment", + children: [ + { + type: "link", + path: "/commerce-modules/payment/payment-provider/stripe", + title: "Stripe", + }, + ], }, ], }, diff --git a/www/apps/resources/sidebars/inventory.mjs b/www/apps/resources/sidebars/inventory.mjs index fa4f48b155..f7b1d6d8d1 100644 --- a/www/apps/resources/sidebars/inventory.mjs +++ b/www/apps/resources/sidebars/inventory.mjs @@ -1,9 +1,9 @@ -/** @type {import('types').RawSidebarItem[]} */ +/** @type {import('types').Sidebar.SidebarItem[]} */ export const inventorySidebar = [ { - type: "category", + type: "sidebar", + sidebar_id: "inventory", title: "Inventory Module", - isChildSidebar: true, children: [ { type: "link", @@ -48,6 +48,7 @@ export const inventorySidebar = [ autogenerate_tags: "server+inventory", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to use the Inventory Module in your customizations on the Medusa application server.", }, @@ -57,6 +58,7 @@ export const inventorySidebar = [ autogenerate_tags: "storefront+inventory,-jsSdk", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to integrate the Inventory Module's features into your storefront.", }, @@ -66,6 +68,7 @@ export const inventorySidebar = [ autogenerate_tags: "admin+inventory,-jsSdk", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to utilize administative features of the Inventory Module.", }, @@ -75,6 +78,7 @@ export const inventorySidebar = [ autogenerate_tags: "userGuide+inventory", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to utilize and manage Inventory features in the Medusa Admin dashboard.", }, @@ -96,12 +100,14 @@ export const inventorySidebar = [ title: "Workflows", autogenerate_tags: "workflow+inventory", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, { type: "category", title: "Steps", autogenerate_tags: "step+inventory", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, ], }, @@ -118,6 +124,7 @@ export const inventorySidebar = [ description: "The following methods or properties are used to send requests to Store API Routes related to the Inventory Module.", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, { type: "sub-category", @@ -126,6 +133,7 @@ export const inventorySidebar = [ description: "The following methods or properties are used to send requests to Admin API Routes related to the Inventory Module.", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, ], }, @@ -135,12 +143,19 @@ export const inventorySidebar = [ title: "Admin Widget Zones", }, { - type: "link", - path: "/references/inventory-next", + type: "sidebar", + sidebar_id: "inventory-service-reference", title: "Main Service Reference", - isChildSidebar: true, childSidebarTitle: "Inventory Module's Main Service Reference", children: [ + { + type: "link", + path: "/references/inventory-next", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "category", title: "Methods", @@ -150,12 +165,19 @@ export const inventorySidebar = [ ], }, { - type: "link", - path: "/references/inventory-next/models", + type: "sidebar", + sidebar_id: "inventory-models-reference", title: "Data Models Reference", - isChildSidebar: true, childSidebarTitle: "Inventory Module Data Models Reference", children: [ + { + type: "link", + path: "/references/inventory-next/models", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "category", title: "Data Models", diff --git a/www/apps/resources/sidebars/order-module.mjs b/www/apps/resources/sidebars/order-module.mjs index 488a861f3f..46cb792dcd 100644 --- a/www/apps/resources/sidebars/order-module.mjs +++ b/www/apps/resources/sidebars/order-module.mjs @@ -1,9 +1,9 @@ -/** @type {import('types').RawSidebarItem[]} */ +/** @type {import('types').Sidebar.SidebarItem[]} */ export const orderSidebar = [ { - type: "category", + type: "sidebar", + sidebar_id: "order", title: "Order Module", - isChildSidebar: true, children: [ { type: "link", @@ -81,6 +81,7 @@ export const orderSidebar = [ autogenerate_tags: "server+order", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to use the Order Module in your customizations on the Medusa application server.", }, @@ -90,6 +91,7 @@ export const orderSidebar = [ autogenerate_tags: "storefront+order,-jsSdk", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to integrate the Order Module's features into your storefront.", }, @@ -99,6 +101,7 @@ export const orderSidebar = [ autogenerate_tags: "admin+order,-jsSdk", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to utilize administative features of the Order Module.", }, @@ -108,6 +111,7 @@ export const orderSidebar = [ autogenerate_tags: "userGuide+order", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to utilize and manage Order features in the Medusa Admin dashboard.", }, @@ -129,12 +133,14 @@ export const orderSidebar = [ title: "Workflows", autogenerate_tags: "workflow+order", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, { type: "category", title: "Steps", autogenerate_tags: "step+order", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, ], }, @@ -151,6 +157,7 @@ export const orderSidebar = [ description: "The following methods or properties are used to send requests to Store API Routes related to the Order Module.", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, { type: "sub-category", @@ -159,6 +166,7 @@ export const orderSidebar = [ description: "The following methods or properties are used to send requests to Admin API Routes related to the Order Module.", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, ], }, @@ -173,12 +181,19 @@ export const orderSidebar = [ title: "Admin Widget Zones", }, { - type: "link", - path: "/references/order", + type: "sidebar", + sidebar_id: "order-service-reference", title: "Main Service Reference", - isChildSidebar: true, childSidebarTitle: "Order Module's Main Service Reference", children: [ + { + type: "link", + path: "/references/order", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "category", title: "Methods", @@ -188,12 +203,19 @@ export const orderSidebar = [ ], }, { - type: "link", - path: "/references/order/models", + type: "sidebar", + sidebar_id: "order-models-reference", title: "Data Models Reference", - isChildSidebar: true, childSidebarTitle: "Order Module Data Models Reference", children: [ + { + type: "link", + path: "/references/order/models", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "category", title: "Data Models", diff --git a/www/apps/resources/sidebars/payment.mjs b/www/apps/resources/sidebars/payment.mjs index 3ca0754192..8383df75dd 100644 --- a/www/apps/resources/sidebars/payment.mjs +++ b/www/apps/resources/sidebars/payment.mjs @@ -1,9 +1,9 @@ -/** @type {import('types').RawSidebarItem[]} */ +/** @type {import('types').Sidebar.SidebarItem[]} */ export const paymentSidebar = [ { - type: "category", + type: "sidebar", + sidebar_id: "payment", title: "Payment Module", - isChildSidebar: true, children: [ { type: "link", @@ -66,6 +66,7 @@ export const paymentSidebar = [ autogenerate_tags: "server+payment", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to use the Payment Module in your customizations on the Medusa application server.", children: [ @@ -87,6 +88,7 @@ export const paymentSidebar = [ autogenerate_tags: "storefront+payment,-jsSdk", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to integrate the Payment Module's features into your storefront.", }, @@ -96,6 +98,7 @@ export const paymentSidebar = [ autogenerate_tags: "admin+payment,-jsSdk", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to utilize administative features of the Payment Module.", }, @@ -105,6 +108,7 @@ export const paymentSidebar = [ autogenerate_tags: "userGuide+payment", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to utilize and manage Payment features in the Medusa Admin dashboard.", }, @@ -138,12 +142,14 @@ export const paymentSidebar = [ title: "Workflows", autogenerate_tags: "workflow+payment", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, { type: "category", title: "Steps", autogenerate_tags: "step+payment", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, ], }, @@ -160,6 +166,7 @@ export const paymentSidebar = [ description: "The following methods or properties are used to send requests to Store API Routes related to the Payment Module.", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, { type: "sub-category", @@ -168,6 +175,7 @@ export const paymentSidebar = [ description: "The following methods or properties are used to send requests to Admin API Routes related to the Payment Module.", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, ], }, @@ -177,12 +185,19 @@ export const paymentSidebar = [ title: "Events Reference", }, { - type: "link", - path: "/references/payment", + type: "sidebar", + sidebar_id: "payment-service-reference", title: "Main Service Reference", - isChildSidebar: true, childSidebarTitle: "Payment Module's Main Service Reference", children: [ + { + type: "link", + path: "/references/payment", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "category", title: "Methods", @@ -192,12 +207,19 @@ export const paymentSidebar = [ ], }, { - type: "link", - path: "/references/payment/models", + type: "sidebar", + sidebar_id: "payment-models-reference", title: "Data Models Reference", - isChildSidebar: true, childSidebarTitle: "Payment Module Data Models Reference", children: [ + { + type: "link", + path: "/references/payment/models", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "category", title: "Data Models", diff --git a/www/apps/resources/sidebars/plugins.mjs b/www/apps/resources/sidebars/plugins.mjs index 890c6426f1..ee352b96bb 100644 --- a/www/apps/resources/sidebars/plugins.mjs +++ b/www/apps/resources/sidebars/plugins.mjs @@ -1,19 +1,26 @@ -/** @type {import('types').RawSidebarItem[]} */ +/** @type {import('types').Sidebar.SidebarItem[]} */ export const pluginsSidebar = [ { - type: "link", - title: "Overview", - path: "/plugins", - }, - { - type: "category", - title: "Guides", + type: "sidebar", + sidebar_id: "plugins", + title: "Plugins", children: [ { type: "link", - title: "Wishlist", - path: "/plugins/guides/wishlist", - description: "Learn how to build a wishlist plugin.", + title: "Overview", + path: "/plugins", + }, + { + type: "category", + title: "Guides", + children: [ + { + type: "link", + title: "Wishlist", + path: "/plugins/guides/wishlist", + description: "Learn how to build a wishlist plugin.", + }, + ], }, ], }, diff --git a/www/apps/resources/sidebars/pricing.mjs b/www/apps/resources/sidebars/pricing.mjs index ebc5287aec..1e32b8916f 100644 --- a/www/apps/resources/sidebars/pricing.mjs +++ b/www/apps/resources/sidebars/pricing.mjs @@ -1,9 +1,9 @@ -/** @type {import('types').RawSidebarItem[]} */ +/** @type {import('types').Sidebar.SidebarItem[]} */ export const pricingSidebar = [ { - type: "category", + type: "sidebar", + sidebar_id: "pricing", title: "Pricing Module", - isChildSidebar: true, children: [ { type: "link", @@ -51,6 +51,7 @@ export const pricingSidebar = [ autogenerate_tags: "server+pricing", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to use the Pricing Module in your customizations on the Medusa application server.", }, @@ -60,6 +61,7 @@ export const pricingSidebar = [ autogenerate_tags: "storefront+pricing,-jsSdk", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to integrate the Pricing Module's features into your storefront.", }, @@ -69,6 +71,7 @@ export const pricingSidebar = [ autogenerate_tags: "admin+pricing,-jsSdk", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to utilize administative features of the Pricing Module.", }, @@ -78,6 +81,7 @@ export const pricingSidebar = [ autogenerate_tags: "userGuide+pricing", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to utilize and manage Pricing features in the Medusa Admin dashboard.", }, @@ -99,12 +103,14 @@ export const pricingSidebar = [ title: "Workflows", autogenerate_tags: "workflow+pricing", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, { type: "category", title: "Steps", autogenerate_tags: "step+pricing", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, ], }, @@ -121,6 +127,7 @@ export const pricingSidebar = [ description: "The following methods or properties are used to send requests to Store API Routes related to the Pricing Module.", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, { type: "sub-category", @@ -129,6 +136,7 @@ export const pricingSidebar = [ description: "The following methods or properties are used to send requests to Admin API Routes related to the Pricing Module.", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, ], }, @@ -138,12 +146,19 @@ export const pricingSidebar = [ title: "Admin Widget Zones", }, { - type: "link", - path: "/references/pricing", + type: "sidebar", + sidebar_id: "pricing-service-reference", title: "Main Service Reference", - isChildSidebar: true, childSidebarTitle: "Pricing Module's Main Service Reference", children: [ + { + type: "link", + path: "/references/pricing", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "category", title: "Methods", @@ -153,12 +168,19 @@ export const pricingSidebar = [ ], }, { - type: "link", - path: "/references/pricing/models", + type: "sidebar", + sidebar_id: "pricing-models-reference", title: "Data Models Reference", - isChildSidebar: true, childSidebarTitle: "Pricing Module Data Models Reference", children: [ + { + type: "link", + path: "/references/pricing/models", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "category", title: "Data Models", diff --git a/www/apps/resources/sidebars/product.mjs b/www/apps/resources/sidebars/product.mjs index 2ca530b9fa..dfe642d5e2 100644 --- a/www/apps/resources/sidebars/product.mjs +++ b/www/apps/resources/sidebars/product.mjs @@ -1,9 +1,9 @@ -/** @type {import('types').RawSidebarItem[]} */ +/** @type {import('types').Sidebar.SidebarItem[]} */ export const productSidebar = [ { - type: "category", + type: "sidebar", + sidebar_id: "product", title: "Product Module", - isChildSidebar: true, children: [ { type: "link", @@ -43,6 +43,7 @@ export const productSidebar = [ autogenerate_tags: "server+product", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to use the Product Module in your customizations on the Medusa application server.", children: [ @@ -69,6 +70,7 @@ export const productSidebar = [ autogenerate_tags: "storefront+product,-jsSdk", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to integrate the Product Module's features into your storefront.", }, @@ -78,6 +80,7 @@ export const productSidebar = [ autogenerate_tags: "admin+product,-jsSdk", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to utilize administative features of the Product Module.", }, @@ -87,6 +90,7 @@ export const productSidebar = [ autogenerate_tags: "userGuide+product", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to utilize and manage Product features in the Medusa Admin dashboard.", }, @@ -108,12 +112,14 @@ export const productSidebar = [ title: "Workflows", autogenerate_tags: "workflow+product", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, { type: "category", title: "Steps", autogenerate_tags: "step+product", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, ], }, @@ -130,6 +136,7 @@ export const productSidebar = [ description: "The following methods or properties are used to send requests to Store API Routes related to the Product Module.", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, { type: "sub-category", @@ -138,6 +145,7 @@ export const productSidebar = [ description: "The following methods or properties are used to send requests to Admin API Routes related to the Product Module.", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, ], }, @@ -152,12 +160,19 @@ export const productSidebar = [ title: "Admin Widget Zones", }, { - type: "link", - path: "/references/product", + type: "sidebar", + sidebar_id: "product-service-reference", title: "Main Service Reference", - isChildSidebar: true, childSidebarTitle: "Product Module's Main Service Reference", children: [ + { + type: "link", + path: "/references/product", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "category", title: "Methods", @@ -167,12 +182,19 @@ export const productSidebar = [ ], }, { - type: "link", - path: "/references/product/models", + type: "sidebar", + sidebar_id: "product-models-reference", title: "Data Models Reference", - isChildSidebar: true, childSidebarTitle: "Product Module Data Models Reference", children: [ + { + type: "link", + path: "/references/product/models", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "category", title: "Data Models", diff --git a/www/apps/resources/sidebars/promotion.mjs b/www/apps/resources/sidebars/promotion.mjs index a9496a2ff3..1208c55fec 100644 --- a/www/apps/resources/sidebars/promotion.mjs +++ b/www/apps/resources/sidebars/promotion.mjs @@ -1,9 +1,9 @@ -/** @type {import('types').RawSidebarItem[]} */ +/** @type {import('types').Sidebar.SidebarItem[]} */ export const promotionSidebar = [ { - type: "category", + type: "sidebar", + sidebar_id: "promotion", title: "Promotion Module", - isChildSidebar: true, children: [ { type: "link", @@ -51,6 +51,7 @@ export const promotionSidebar = [ autogenerate_tags: "server+promotion", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to use the Promotion Module in your customizations on the Medusa application server.", children: [ @@ -67,6 +68,7 @@ export const promotionSidebar = [ autogenerate_tags: "storefront+promotion,-jsSdk", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to integrate the Promotion Module's features into your storefront.", }, @@ -76,6 +78,7 @@ export const promotionSidebar = [ autogenerate_tags: "admin+promotion,-jsSdk", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to utilize administative features of the Promotion Module.", }, @@ -85,6 +88,7 @@ export const promotionSidebar = [ autogenerate_tags: "userGuide+promotion", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to utilize and manage Promotion features in the Medusa Admin dashboard.", }, @@ -106,12 +110,14 @@ export const promotionSidebar = [ title: "Workflows", autogenerate_tags: "workflow+promotion", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, { type: "category", title: "Steps", autogenerate_tags: "step+promotion", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, ], }, @@ -128,6 +134,7 @@ export const promotionSidebar = [ description: "The following methods or properties are used to send requests to Store API Routes related to the Promotion Module.", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, { type: "sub-category", @@ -136,6 +143,7 @@ export const promotionSidebar = [ description: "The following methods or properties are used to send requests to Admin API Routes related to the Promotion Module.", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, ], }, @@ -145,12 +153,19 @@ export const promotionSidebar = [ title: "Admin Widget Zones", }, { - type: "link", - path: "/references/promotion", + type: "sidebar", + sidebar_id: "promotion-service-reference", title: "Main Service Reference", - isChildSidebar: true, childSidebarTitle: "Promotion Module's Main Service Reference", children: [ + { + type: "link", + path: "/references/promotion", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "category", title: "Methods", @@ -161,12 +176,19 @@ export const promotionSidebar = [ ], }, { - type: "link", - path: "/references/promotion/models", + type: "sidebar", + sidebar_id: "promotion-models-reference", title: "Data Models Reference", - isChildSidebar: true, childSidebarTitle: "Promotion Module Data Models Reference", children: [ + { + type: "link", + path: "/references/promotion/models", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "category", title: "Data Models", diff --git a/www/apps/resources/sidebars/recipes.mjs b/www/apps/resources/sidebars/recipes.mjs index 9da72e6dcb..d6a587ac27 100644 --- a/www/apps/resources/sidebars/recipes.mjs +++ b/www/apps/resources/sidebars/recipes.mjs @@ -1,55 +1,70 @@ -/** @type {import('types').RawSidebarItem[]} */ +/** @type {import('types').Sidebar.SidebarItem[]} */ export const recipesSidebar = [ { - type: "link", - path: "/recipes/marketplace", - title: "Marketplace", + type: "sidebar", + sidebar_id: "recipes", + title: "Recipes", children: [ { type: "link", - path: "/recipes/marketplace/examples/vendors", - title: "Example: Vendors", + path: "/recipes", + title: "Overview", + }, + { + type: "separator", }, { type: "link", - path: "/recipes/marketplace/examples/restaurant-delivery", - title: "Example: Restaurant-Delivery", + path: "/recipes/marketplace", + title: "Marketplace", + children: [ + { + type: "link", + path: "/recipes/marketplace/examples/vendors", + title: "Example: Vendors", + }, + { + type: "link", + path: "/recipes/marketplace/examples/restaurant-delivery", + title: "Example: Restaurant-Delivery", + }, + ], }, - ], - }, - { - type: "link", - path: "/recipes/subscriptions", - title: "Subscriptions", - children: [ { type: "link", - path: "/recipes/subscriptions/examples/standard", - title: "Example", + path: "/recipes/subscriptions", + title: "Subscriptions", + children: [ + { + type: "link", + path: "/recipes/subscriptions/examples/standard", + title: "Example", + }, + ], }, - ], - }, - { - type: "link", - path: "/recipes/digital-products", - title: "Digital Products", - children: [ { type: "link", - path: "/recipes/digital-products/examples/standard", - title: "Example", + path: "/recipes/digital-products", + title: "Digital Products", + children: [ + { + type: "link", + path: "/recipes/digital-products/examples/standard", + title: "Example", + }, + ], }, - ], - }, - { - type: "link", - path: "/recipes/erp", - title: "Integrate ERP", - children: [ { type: "link", - path: "/recipes/erp/odoo", - title: "Example: Odoo Integration", + path: "/recipes/erp", + title: "Integrate ERP", + children: [ + { + type: "link", + path: "/recipes/erp/odoo", + title: "Example: Odoo Integration", + }, + ], }, ], }, @@ -72,39 +87,51 @@ export const recipesSidebar = [ children: [ { type: "link", - path: "/recipes/commerce-automation/restock-notification", - title: "Example: Restock Notifications", + path: "/recipes/b2b", + title: "B2B", + }, + { + type: "link", + path: "/recipes/commerce-automation", + title: "Commerce Automation", + children: [ + { + type: "link", + path: "/recipes/commerce-automation/restock-notification", + title: "Example: Restock Notifications", + }, + ], + }, + { + type: "link", + path: "/recipes/ecommerce", + title: "Ecommerce", + }, + { + type: "link", + path: "/recipes/multi-region-store", + title: "Multi-Region Store", + }, + { + type: "link", + path: "/recipes/omnichannel", + title: "Omnichannel Store", + }, + { + type: "link", + path: "/recipes/oms", + title: "OMS", + }, + { + type: "link", + path: "/recipes/personalized-products", + title: "Personalized Products", + }, + { + type: "link", + path: "/recipes/pos", + title: "POS", }, ], }, - { - type: "link", - path: "/recipes/ecommerce", - title: "Ecommerce", - }, - { - type: "link", - path: "/recipes/multi-region-store", - title: "Multi-Region Store", - }, - { - type: "link", - path: "/recipes/omnichannel", - title: "Omnichannel Store", - }, - { - type: "link", - path: "/recipes/oms", - title: "OMS", - }, - { - type: "link", - path: "/recipes/personalized-products", - title: "Personalized Products", - }, - { - type: "link", - path: "/recipes/pos", - title: "POS", - }, ] diff --git a/www/apps/resources/sidebars/references.mjs b/www/apps/resources/sidebars/references.mjs index e1dfcb4a13..83c2ffdec9 100644 --- a/www/apps/resources/sidebars/references.mjs +++ b/www/apps/resources/sidebars/references.mjs @@ -1,12 +1,19 @@ -/** @type {import('types').RawSidebarItem[]} */ +/** @type {import('types').Sidebar.SidebarItem[]} */ export const referencesSidebar = [ { - type: "link", - path: "/references/workflows", + type: "sidebar", + sidebar_id: "workflows-sdk-reference", title: "Workflows SDK", childSidebarTitle: "Workflows SDK Reference", - isChildSidebar: true, children: [ + { + type: "link", + path: "/references/workflows", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "category", title: "Functions", @@ -15,12 +22,19 @@ export const referencesSidebar = [ ], }, { - type: "link", - path: "/references/data-model", + type: "sidebar", + sidebar_id: "dml-reference", title: "Data Model Language", childSidebarTitle: "Data Model Language Reference", - isChildSidebar: true, children: [ + { + type: "link", + path: "/references/data-model", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "link", path: "/references/data-model/define", @@ -53,11 +67,18 @@ export const referencesSidebar = [ ], }, { - type: "link", - path: "/service-factory-reference", + type: "sidebar", + sidebar_id: "service-factory-reference", title: "Service Factory", - isChildSidebar: true, children: [ + { + type: "link", + path: "/service-factory-reference", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "category", title: "Methods", @@ -71,25 +92,44 @@ export const referencesSidebar = [ ], }, { - type: "link", - path: "/references/helper-steps", + type: "sidebar", + sidebar_id: "helper-steps-reference", title: "Helper Steps", - isChildSidebar: true, - autogenerate_path: "/references/helper_steps/functions", + children: [ + { + type: "link", + path: "/references/helper-steps", + title: "Reference Overview", + }, + { + type: "separator", + }, + { + type: "category", + title: "Steps", + autogenerate_path: "/references/helper_steps/functions", + }, + ], }, { - type: "link", + type: "sidebar", + sidebar_id: "core-flows", title: "Core Workflows", - path: "/medusa-workflows-reference", - isChildSidebar: true, custom_autogenerate: "core-flows", }, { - type: "link", + type: "sidebar", + sidebar_id: "test-tools-reference", title: "Testing Framework", - path: "/test-tools-reference", - isChildSidebar: true, children: [ + { + type: "link", + path: "/test-tools-reference", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "category", title: "Functions", diff --git a/www/apps/resources/sidebars/region.mjs b/www/apps/resources/sidebars/region.mjs index bf822f5ff8..4c2631d383 100644 --- a/www/apps/resources/sidebars/region.mjs +++ b/www/apps/resources/sidebars/region.mjs @@ -1,9 +1,9 @@ -/** @type {import('types').RawSidebarItem[]} */ +/** @type {import('types').Sidebar.SidebarItem[]} */ export const regionSidebar = [ { - type: "category", + type: "sidebar", + sidebar_id: "region", title: "Region Module", - isChildSidebar: true, children: [ { type: "link", @@ -31,6 +31,7 @@ export const regionSidebar = [ autogenerate_tags: "server+region", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to use the Region Module in your customizations on the Medusa application server.", }, @@ -40,6 +41,7 @@ export const regionSidebar = [ autogenerate_tags: "storefront+region,-jsSdk", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to integrate the Region Module's features into your storefront.", }, @@ -49,6 +51,7 @@ export const regionSidebar = [ autogenerate_tags: "admin+region,-jsSdk", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to utilize administative features of the Region Module.", }, @@ -58,6 +61,7 @@ export const regionSidebar = [ autogenerate_tags: "userGuide+region", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to utilize and manage Region features in the Medusa Admin dashboard.", }, @@ -79,12 +83,14 @@ export const regionSidebar = [ title: "Workflows", autogenerate_tags: "workflow+region", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, { type: "category", title: "Steps", autogenerate_tags: "step+region", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, ], }, @@ -101,6 +107,7 @@ export const regionSidebar = [ description: "The following methods or properties are used to send requests to Store API Routes related to the Region Module.", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, { type: "sub-category", @@ -109,6 +116,7 @@ export const regionSidebar = [ description: "The following methods or properties are used to send requests to Admin API Routes related to the Region Module.", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, ], }, @@ -123,12 +131,19 @@ export const regionSidebar = [ title: "Admin Widget Zones", }, { - type: "link", - path: "/references/region", + type: "sidebar", + sidebar_id: "region-service-reference", title: "Main Service Reference", - isChildSidebar: true, childSidebarTitle: "Region Module's Main Service Reference", children: [ + { + type: "link", + path: "/references/region", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "category", title: "Methods", @@ -138,12 +153,19 @@ export const regionSidebar = [ ], }, { - type: "link", - path: "/references/region/models", + type: "sidebar", + sidebar_id: "region-models-reference", title: "Data Models Reference", - isChildSidebar: true, childSidebarTitle: "Region Module Data Models Reference", children: [ + { + type: "link", + path: "/references/region/models", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "category", title: "Data Models", diff --git a/www/apps/resources/sidebars/sales-channel.mjs b/www/apps/resources/sidebars/sales-channel.mjs index 4c60cb34aa..95dcf5e7e1 100644 --- a/www/apps/resources/sidebars/sales-channel.mjs +++ b/www/apps/resources/sidebars/sales-channel.mjs @@ -1,9 +1,9 @@ -/** @type {import('types').RawSidebarItem[]} */ +/** @type {import('types').Sidebar.SidebarItem[]} */ export const salesChannelSidebar = [ { - type: "category", + type: "sidebar", + sidebar_id: "sales-channel", title: "Sales Channel Module", - isChildSidebar: true, children: [ { type: "link", @@ -38,6 +38,7 @@ export const salesChannelSidebar = [ autogenerate_tags: "server+salesChannel", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to use the Sales Channel Module in your customizations on the Medusa application server.", }, @@ -47,6 +48,7 @@ export const salesChannelSidebar = [ autogenerate_tags: "storefront+salesChannel,-jsSdk", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to integrate the Sales Channel Module's features into your storefront.", }, @@ -56,6 +58,7 @@ export const salesChannelSidebar = [ autogenerate_tags: "admin+salesChannel,-jsSdk", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to utilize administative features of the Sales Channel Module.", }, @@ -65,6 +68,7 @@ export const salesChannelSidebar = [ autogenerate_tags: "userGuide+salesChannel", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to utilize and manage Sales Channel features in the Medusa Admin dashboard.", }, @@ -86,12 +90,14 @@ export const salesChannelSidebar = [ title: "Workflows", autogenerate_tags: "workflow+salesChannel", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, { type: "category", title: "Steps", autogenerate_tags: "step+salesChannel", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, ], }, @@ -108,6 +114,7 @@ export const salesChannelSidebar = [ description: "The following methods or properties are used to send requests to Store API Routes related to the Sales Channel Module.", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, { type: "sub-category", @@ -116,6 +123,7 @@ export const salesChannelSidebar = [ description: "The following methods or properties are used to send requests to Admin API Routes related to the Sales Channel Module.", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, ], }, @@ -130,12 +138,16 @@ export const salesChannelSidebar = [ title: "Admin Widget Zones", }, { - type: "link", - path: "/references/sales-channel", + type: "sidebar", + sidebar_id: "sales-channel-service-reference", title: "Main Service Reference", - isChildSidebar: true, childSidebarTitle: "Sales Channel Module's Main Service Reference", children: [ + { + type: "link", + path: "/references/sales-channel", + title: "Reference Overview", + }, { type: "category", title: "Methods", @@ -145,12 +157,19 @@ export const salesChannelSidebar = [ ], }, { - type: "link", - path: "/references/sales-channel/models", + type: "sidebar", + sidebar_id: "sales-channel-models-reference", title: "Data Models Reference", - isChildSidebar: true, childSidebarTitle: "Sales Channel Module Data Models Reference", children: [ + { + type: "link", + path: "/references/sales-channel/models", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "category", title: "Data Models", diff --git a/www/apps/resources/sidebars/sdk-tools.mjs b/www/apps/resources/sidebars/sdk-tools.mjs index 9ffb631601..2b5904c8c8 100644 --- a/www/apps/resources/sidebars/sdk-tools.mjs +++ b/www/apps/resources/sidebars/sdk-tools.mjs @@ -1,4 +1,4 @@ -/** @type {import('types').RawSidebarItem[]} */ +/** @type {import('types').Sidebar.SidebarItem[]} */ export const sdkToolsSidebar = [ { type: "link", @@ -6,10 +6,9 @@ export const sdkToolsSidebar = [ title: "create-medusa-app", }, { - type: "link", - path: "/medusa-cli", + type: "sidebar", + sidebar_id: "medusa-cli", title: "Medusa CLI", - isChildSidebar: true, childSidebarTitle: "Medusa CLI Reference", children: [ { @@ -28,12 +27,19 @@ export const sdkToolsSidebar = [ ], }, { - type: "link", - path: "/js-sdk", + type: "sidebar", + sidebar_id: "js-sdk", title: "JS SDK", - isChildSidebar: true, childSidebarTitle: "JS SDK Reference", children: [ + { + type: "link", + path: "/js-sdk", + title: "Overview", + }, + { + type: "separator", + }, { type: "category", title: "Auth", @@ -55,10 +61,9 @@ export const sdkToolsSidebar = [ ], }, { - type: "link", - path: "/nextjs-starter", + type: "sidebar", + sidebar_id: "nextjs-starter", title: "Next.js Starter Storefront", - isChildSidebar: true, children: [ { type: "link", diff --git a/www/apps/resources/sidebars/stock-location.mjs b/www/apps/resources/sidebars/stock-location.mjs index 3c7d6f307d..99e9aa9a13 100644 --- a/www/apps/resources/sidebars/stock-location.mjs +++ b/www/apps/resources/sidebars/stock-location.mjs @@ -1,9 +1,9 @@ -/** @type {import('types').RawSidebarItem[]} */ +/** @type {import('types').Sidebar.SidebarItem[]} */ export const stockLocationSidebar = [ { - type: "category", + type: "sidebar", + sidebar_id: "stock-location", title: "Stock Location Module", - isChildSidebar: true, children: [ { type: "link", @@ -38,6 +38,7 @@ export const stockLocationSidebar = [ autogenerate_tags: "server+stockLocation", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to use the Stock Location Module in your customizations on the Medusa application server.", }, @@ -47,6 +48,7 @@ export const stockLocationSidebar = [ autogenerate_tags: "storefront+stockLocation,-jsSdk", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to integrate the Stock Location Module's features into your storefront.", }, @@ -56,6 +58,7 @@ export const stockLocationSidebar = [ autogenerate_tags: "admin+stockLocation,-jsSdk", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to utilize administative features of the Stock Location Module.", }, @@ -65,6 +68,7 @@ export const stockLocationSidebar = [ autogenerate_tags: "userGuide+stockLocation", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to utilize and manage Stock Location features in the Medusa Admin dashboard.", }, @@ -86,12 +90,14 @@ export const stockLocationSidebar = [ title: "Workflows", autogenerate_tags: "workflow+stockLocation", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, { type: "category", title: "Steps", autogenerate_tags: "step+stockLocation", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, ], }, @@ -108,6 +114,7 @@ export const stockLocationSidebar = [ description: "The following methods or properties are used to send requests to Store API Routes related to the Stock Location Module.", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, { type: "sub-category", @@ -116,6 +123,7 @@ export const stockLocationSidebar = [ description: "The following methods or properties are used to send requests to Admin API Routes related to the Stock Location Module.", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, ], }, @@ -125,12 +133,19 @@ export const stockLocationSidebar = [ title: "Admin Widget Zones", }, { - type: "link", - path: "/references/stock-location-next", + type: "sidebar", + sidebar_id: "stock-location-service-reference", title: "Main Service Reference", - isChildSidebar: true, childSidebarTitle: "Stock Location Module's Main Service Reference", children: [ + { + type: "link", + path: "/references/stock-location-next", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "category", title: "Methods", @@ -140,12 +155,19 @@ export const stockLocationSidebar = [ ], }, { - type: "link", - path: "/references/stock-location-next/models", + type: "sidebar", + sidebar_id: "stock-location-models-reference", title: "Data Models Reference", - isChildSidebar: true, childSidebarTitle: "Stock Location Module Data Models Reference", children: [ + { + type: "link", + path: "/references/stock-location-next/models", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "category", title: "Data Models", diff --git a/www/apps/resources/sidebars/store.mjs b/www/apps/resources/sidebars/store.mjs index f5f0033479..b415092b2e 100644 --- a/www/apps/resources/sidebars/store.mjs +++ b/www/apps/resources/sidebars/store.mjs @@ -1,9 +1,9 @@ -/** @type {import('types').RawSidebarItem[]} */ +/** @type {import('types').Sidebar.SidebarItem[]} */ export const storeSidebar = [ { - type: "category", + type: "sidebar", + sidebar_id: "store", title: "Store Module", - isChildSidebar: true, children: [ { type: "link", @@ -31,6 +31,7 @@ export const storeSidebar = [ autogenerate_tags: "server+store", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to use the Store Module in your customizations on the Medusa application server.", }, @@ -40,6 +41,7 @@ export const storeSidebar = [ autogenerate_tags: "storefront+store,-jsSdk", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to integrate the Store Module's features into your storefront.", }, @@ -49,6 +51,7 @@ export const storeSidebar = [ autogenerate_tags: "admin+store,-jsSdk", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to utilize administative features of the Store Module.", }, @@ -58,6 +61,7 @@ export const storeSidebar = [ autogenerate_tags: "userGuide+store", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to utilize and manage Store features in the Medusa Admin dashboard.", }, @@ -79,12 +83,14 @@ export const storeSidebar = [ title: "Workflows", autogenerate_tags: "workflow+store", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, { type: "category", title: "Steps", autogenerate_tags: "step+store", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, ], }, @@ -101,6 +107,7 @@ export const storeSidebar = [ description: "The following methods or properties are used to send requests to Store API Routes related to the Store Module.", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, { type: "sub-category", @@ -109,6 +116,7 @@ export const storeSidebar = [ description: "The following methods or properties are used to send requests to Admin API Routes related to the Store Module.", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, ], }, @@ -118,12 +126,19 @@ export const storeSidebar = [ title: "Admin Widget Zones", }, { - type: "link", - path: "/references/store", + type: "sidebar", + sidebar_id: "store-service-reference", title: "Main Service Reference", - isChildSidebar: true, childSidebarTitle: "Store Module's Main Service Reference", children: [ + { + type: "link", + path: "/references/store", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "category", title: "Methods", @@ -133,12 +148,19 @@ export const storeSidebar = [ ], }, { - type: "link", - path: "/references/store/models", + type: "sidebar", + sidebar_id: "store-models-reference", title: "Data Models Reference", - isChildSidebar: true, childSidebarTitle: "Store Module Data Models Reference", children: [ + { + type: "link", + path: "/references/store/models", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "category", title: "Data Models", diff --git a/www/apps/resources/sidebars/storefront.mjs b/www/apps/resources/sidebars/storefront.mjs index ba57f25eca..e4f32f2ae2 100644 --- a/www/apps/resources/sidebars/storefront.mjs +++ b/www/apps/resources/sidebars/storefront.mjs @@ -1,259 +1,274 @@ -/** @type {import('types').RawSidebarItem[]} */ +/** @type {import('types').Sidebar.SidebarItem[]} */ export const storefrontGuidesSidebar = [ { - type: "category", - title: "General", + type: "sidebar", + sidebar_id: "storefront-development", + title: "Storefront Development", children: [ { type: "link", - path: "/storefront-development/tips", - title: "Tips", - }, - { - type: "link", - path: "/storefront-development/publishable-api-keys", - title: "Publishable API Key", - }, - ], - }, - { - type: "category", - title: "Examples", - children: [ - { - type: "link", - path: "/storefront-development/guides/express-checkout", - title: "Express Checkout Storefront", - }, - ], - }, - { - type: "category", - title: "Regions", - children: [ - { - type: "link", - path: "/storefront-development/regions", + path: "/storefront-development", title: "Overview", }, { - type: "link", - path: "/storefront-development/regions/list", - title: "List Regions", + type: "separator", }, { - type: "link", - path: "/storefront-development/regions/store-retrieve-region", - title: "Store and Retrieve Regions", - }, - { - type: "link", - path: "/storefront-development/regions/context", - title: "Region React Context", - }, - ], - }, - { - type: "category", - title: "Products", - children: [ - { - type: "link", - path: "/storefront-development/products/list", - title: "List Products", - }, - { - type: "link", - path: "/storefront-development/products/retrieve", - title: "Retrieve a Product", - }, - { - type: "link", - path: "/storefront-development/products/variants", - title: "Select a Variant", - }, - { - type: "link", - path: "/storefront-development/products/price", - title: "Retrieve Variant Prices", - autogenerate_path: "storefront-development/products/price/examples", - }, - { - type: "link", - path: "/storefront-development/products/inventory", - title: "Retrieve Variant Inventory", - }, - ], - }, - { - type: "category", - title: "Product Categories", - children: [ - { - type: "link", - path: "/storefront-development/products/categories/list", - title: "List Categories", - }, - { - type: "link", - path: "/storefront-development/products/categories/retrieve", - title: "Retrieve a Category", - }, - { - type: "link", - path: "/storefront-development/products/categories/products", - title: "Retrieve a Category's Products", - }, - { - type: "link", - path: "/storefront-development/products/categories/nested-categories", - title: "Retrieve Nested Categories", - }, - ], - }, - { - type: "category", - title: "Product Collections", - children: [ - { - type: "link", - path: "/storefront-development/products/collections/list", - title: "List Collections", - }, - { - type: "link", - path: "/storefront-development/products/collections/retrieve", - title: "Retrieve a Collection", - }, - { - type: "link", - path: "/storefront-development/products/collections/products", - title: "Retrieve a Collection's Products", - }, - ], - }, - { - type: "category", - title: "Carts", - children: [ - { - type: "link", - path: "/storefront-development/cart/create", - title: "Create Cart", - }, - { - type: "link", - path: "/storefront-development/cart/retrieve", - title: "Retrieve Cart", - }, - { - type: "link", - path: "/storefront-development/cart/context", - title: "Cart React Context", - }, - { - type: "link", - path: "/storefront-development/cart/update", - title: "Update Cart", - }, - { - type: "link", - path: "/storefront-development/cart/manage-items", - title: "Manage Line Items", - }, - ], - }, - { - type: "category", - title: "Checkout", - children: [ - { - type: "link", - path: "/storefront-development/checkout", - title: "Overview", - }, - { - type: "link", - path: "/storefront-development/checkout/email", - title: "1. Enter Email", - }, - { - type: "link", - path: "/storefront-development/checkout/address", - title: "2. Set Address", - }, - { - type: "link", - path: "/storefront-development/checkout/shipping", - title: "3. Choose Shipping Method", - }, - { - type: "link", - path: "/storefront-development/checkout/payment", - title: "4. Choose Payment Provider", + type: "category", + title: "General", children: [ { type: "link", - path: "/storefront-development/checkout/payment/stripe", - title: "Example: Stripe", + path: "/storefront-development/tips", + title: "Tips", + }, + { + type: "link", + path: "/storefront-development/publishable-api-keys", + title: "Publishable API Key", }, ], }, { - type: "link", - path: "/storefront-development/checkout/complete-cart", - title: "5. Complete Cart", - }, - ], - }, - { - type: "category", - title: "Customers", - children: [ - { - type: "link", - path: "/storefront-development/customers/register", - title: "Register Customer", + type: "category", + title: "Examples", + children: [ + { + type: "link", + path: "/storefront-development/guides/express-checkout", + title: "Express Checkout Storefront", + }, + ], }, { - type: "link", - path: "/storefront-development/customers/login", - title: "Login Customer", + type: "category", + title: "Regions", + children: [ + { + type: "link", + path: "/storefront-development/regions", + title: "Overview", + }, + { + type: "link", + path: "/storefront-development/regions/list", + title: "List Regions", + }, + { + type: "link", + path: "/storefront-development/regions/store-retrieve-region", + title: "Store and Retrieve Regions", + }, + { + type: "link", + path: "/storefront-development/regions/context", + title: "Region React Context", + }, + ], }, { - type: "link", - path: "/storefront-development/customers/third-party-login", - title: "Third-Party (Social) Login", + type: "category", + title: "Products", + children: [ + { + type: "link", + path: "/storefront-development/products/list", + title: "List Products", + }, + { + type: "link", + path: "/storefront-development/products/retrieve", + title: "Retrieve a Product", + }, + { + type: "link", + path: "/storefront-development/products/variants", + title: "Select a Variant", + }, + { + type: "link", + path: "/storefront-development/products/price", + title: "Retrieve Variant Prices", + autogenerate_path: "storefront-development/products/price/examples", + }, + { + type: "link", + path: "/storefront-development/products/inventory", + title: "Retrieve Variant Inventory", + }, + ], }, { - type: "link", - path: "/storefront-development/customers/reset-password", - title: "Reset Password", + type: "category", + title: "Product Categories", + children: [ + { + type: "link", + path: "/storefront-development/products/categories/list", + title: "List Categories", + }, + { + type: "link", + path: "/storefront-development/products/categories/retrieve", + title: "Retrieve a Category", + }, + { + type: "link", + path: "/storefront-development/products/categories/products", + title: "Retrieve a Category's Products", + }, + { + type: "link", + path: "/storefront-development/products/categories/nested-categories", + title: "Retrieve Nested Categories", + }, + ], }, { - type: "link", - path: "/storefront-development/customers/retrieve", - title: "Retrieve Customer", + type: "category", + title: "Product Collections", + children: [ + { + type: "link", + path: "/storefront-development/products/collections/list", + title: "List Collections", + }, + { + type: "link", + path: "/storefront-development/products/collections/retrieve", + title: "Retrieve a Collection", + }, + { + type: "link", + path: "/storefront-development/products/collections/products", + title: "Retrieve a Collection's Products", + }, + ], }, { - type: "link", - path: "/storefront-development/customers/context", - title: "Customer React Context", + type: "category", + title: "Carts", + children: [ + { + type: "link", + path: "/storefront-development/cart/create", + title: "Create Cart", + }, + { + type: "link", + path: "/storefront-development/cart/retrieve", + title: "Retrieve Cart", + }, + { + type: "link", + path: "/storefront-development/cart/context", + title: "Cart React Context", + }, + { + type: "link", + path: "/storefront-development/cart/update", + title: "Update Cart", + }, + { + type: "link", + path: "/storefront-development/cart/manage-items", + title: "Manage Line Items", + }, + ], }, { - type: "link", - path: "/storefront-development/customers/profile", - title: "Edit Customer Profile", + type: "category", + title: "Checkout", + children: [ + { + type: "link", + path: "/storefront-development/checkout", + title: "Overview", + }, + { + type: "link", + path: "/storefront-development/checkout/email", + title: "1. Enter Email", + }, + { + type: "link", + path: "/storefront-development/checkout/address", + title: "2. Set Address", + }, + { + type: "link", + path: "/storefront-development/checkout/shipping", + title: "3. Choose Shipping Method", + }, + { + type: "link", + path: "/storefront-development/checkout/payment", + title: "4. Choose Payment Provider", + children: [ + { + type: "link", + path: "/storefront-development/checkout/payment/stripe", + title: "Example: Stripe", + }, + ], + }, + { + type: "link", + path: "/storefront-development/checkout/complete-cart", + title: "5. Complete Cart", + }, + ], }, { - type: "link", - path: "/storefront-development/customers/addresses", - title: "Manage Customer Addresses", - }, - { - type: "link", - path: "/storefront-development/customers/log-out", - title: "Log-out Customer", + type: "category", + title: "Customers", + children: [ + { + type: "link", + path: "/storefront-development/customers/register", + title: "Register Customer", + }, + { + type: "link", + path: "/storefront-development/customers/login", + title: "Login Customer", + }, + { + type: "link", + path: "/storefront-development/customers/third-party-login", + title: "Third-Party (Social) Login", + }, + { + type: "link", + path: "/storefront-development/customers/reset-password", + title: "Reset Password", + }, + { + type: "link", + path: "/storefront-development/customers/retrieve", + title: "Retrieve Customer", + }, + { + type: "link", + path: "/storefront-development/customers/context", + title: "Customer React Context", + }, + { + type: "link", + path: "/storefront-development/customers/profile", + title: "Edit Customer Profile", + }, + { + type: "link", + path: "/storefront-development/customers/addresses", + title: "Manage Customer Addresses", + }, + { + type: "link", + path: "/storefront-development/customers/log-out", + title: "Log-out Customer", + }, + ], }, ], }, diff --git a/www/apps/resources/sidebars/tax.mjs b/www/apps/resources/sidebars/tax.mjs index 39b8fc3ff7..8240395eba 100644 --- a/www/apps/resources/sidebars/tax.mjs +++ b/www/apps/resources/sidebars/tax.mjs @@ -1,9 +1,9 @@ -/** @type {import('types').RawSidebarItem[]} */ +/** @type {import('types').Sidebar.SidebarItem[]} */ export const taxSidebar = [ { - type: "category", + type: "sidebar", + sidebar_id: "tax", title: "Tax Module", - isChildSidebar: true, children: [ { type: "link", @@ -46,6 +46,7 @@ export const taxSidebar = [ autogenerate_tags: "server+tax", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to use the Tax Module in your customizations on the Medusa application server.", children: [ @@ -62,6 +63,7 @@ export const taxSidebar = [ autogenerate_tags: "storefront+tax,-jsSdk", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to integrate the Tax Module's features into your storefront.", }, @@ -71,6 +73,7 @@ export const taxSidebar = [ autogenerate_tags: "admin+tax,-jsSdk", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to utilize administative features of the Tax Module.", }, @@ -80,6 +83,7 @@ export const taxSidebar = [ autogenerate_tags: "userGuide+tax", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to utilize and manage Tax features in the Medusa Admin dashboard.", }, @@ -101,12 +105,14 @@ export const taxSidebar = [ title: "Workflows", autogenerate_tags: "workflow+tax", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, { type: "category", title: "Steps", autogenerate_tags: "step+tax", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, ], }, @@ -123,6 +129,7 @@ export const taxSidebar = [ description: "The following methods or properties are used to send requests to Store API Routes related to the Tax Module.", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, { type: "sub-category", @@ -131,6 +138,7 @@ export const taxSidebar = [ description: "The following methods or properties are used to send requests to Admin API Routes related to the Tax Module.", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, ], }, @@ -140,12 +148,19 @@ export const taxSidebar = [ title: "Admin Widget Zones", }, { - type: "link", - path: "/references/tax", + type: "sidebar", + sidebar_id: "tax-service-reference", title: "Main Service Reference", - isChildSidebar: true, childSidebarTitle: "Tax Module's Main Service Reference", children: [ + { + type: "link", + path: "/references/tax", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "category", title: "Methods", @@ -154,12 +169,19 @@ export const taxSidebar = [ ], }, { - type: "link", - path: "/references/tax/models", + type: "sidebar", + sidebar_id: "tax-models-reference", title: "Data Models Reference", - isChildSidebar: true, childSidebarTitle: "Tax Module Data Models Reference", children: [ + { + type: "link", + path: "/references/tax/models", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "category", title: "Data Models", diff --git a/www/apps/resources/sidebars/troubleshooting.mjs b/www/apps/resources/sidebars/troubleshooting.mjs index b3d7a75540..2707ae4818 100644 --- a/www/apps/resources/sidebars/troubleshooting.mjs +++ b/www/apps/resources/sidebars/troubleshooting.mjs @@ -1,99 +1,114 @@ -/** @type {import('types').RawSidebarItem[]} */ +/** @type {import('types').Sidebar.SidebarItem[]} */ export const troubleshootingSidebar = [ { - type: "category", - title: "Installation", + type: "sidebar", + sidebar_id: "troubleshooting", + title: "Troubleshooting", children: [ { type: "link", - path: "/troubleshooting/create-medusa-app-errors", - title: "Create Medusa App Errors", + path: "/troubleshooting", + title: "Overview", }, { - type: "link", - path: "/troubleshooting/errors-installing-cli", - title: "Errors Installing CLI", + type: "separator", }, { - type: "link", - path: "/troubleshooting/general-errors", - title: "General Errors", - }, - ], - }, - { - type: "category", - title: "Medusa Application", - children: [ - { - type: "link", - path: "/troubleshooting/eaddrinuse", - title: "EADDRINUSE Error", + type: "category", + title: "Installation", + children: [ + { + type: "link", + path: "/troubleshooting/create-medusa-app-errors", + title: "Create Medusa App Errors", + }, + { + type: "link", + path: "/troubleshooting/errors-installing-cli", + title: "Errors Installing CLI", + }, + { + type: "link", + path: "/troubleshooting/general-errors", + title: "General Errors", + }, + ], }, { - type: "link", - path: "/troubleshooting/database-errors", - title: "Database Errors", + type: "category", + title: "Medusa Application", + children: [ + { + type: "link", + path: "/troubleshooting/eaddrinuse", + title: "EADDRINUSE Error", + }, + { + type: "link", + path: "/troubleshooting/database-errors", + title: "Database Errors", + }, + { + type: "link", + path: "/troubleshooting/dist-imports", + title: "Importing from /dist", + }, + { + type: "link", + path: "/troubleshooting/workflow-errors", + title: "Workflow Errors", + }, + { + type: "link", + path: "/troubleshooting/test-errors", + title: "Test Errors", + }, + ], }, { - type: "link", - path: "/troubleshooting/dist-imports", - title: "Importing from /dist", + type: "category", + title: "Admin Development", + children: [ + { + type: "link", + path: "/troubleshooting/medusa-admin/no-widget-route", + title: "Widget or Route not Showing", + }, + ], }, { - type: "link", - path: "/troubleshooting/workflow-errors", - title: "Workflow Errors", + type: "category", + title: "Upgrade", + children: [ + { + type: "link", + path: "/troubleshooting/errors-after-upgrading", + title: "Errors After Upgrading", + }, + ], }, { - type: "link", - path: "/troubleshooting/test-errors", - title: "Test Errors", + type: "category", + title: "Frontend", + children: [ + { + type: "link", + path: "/troubleshooting/cors-errors", + title: "CORS Errors", + }, + ], }, - ], - }, - { - type: "category", - title: "Admin Development", - children: [ { - type: "link", - path: "/troubleshooting/medusa-admin/no-widget-route", - title: "Widget or Route not Showing", - }, - ], - }, - { - type: "category", - title: "Upgrade", - children: [ - { - type: "link", - path: "/troubleshooting/errors-after-upgrading", - title: "Errors After Upgrading", - }, - ], - }, - { - type: "category", - title: "Frontend", - children: [ - { - type: "link", - path: "/troubleshooting/cors-errors", - title: "CORS Errors", - }, - ], - }, - { - type: "category", - title: "Integrations", - hasTitleStyling: true, - children: [ - { - type: "link", - path: "/troubleshooting/s3", - title: "S3 Module Provider Errors", + type: "category", + title: "Integrations", + hasTitleStyling: true, + children: [ + { + type: "link", + path: "/troubleshooting/s3", + title: "S3 Module Provider Errors", + }, + ], }, ], }, diff --git a/www/apps/resources/sidebars/user.mjs b/www/apps/resources/sidebars/user.mjs index 6344c05de2..71c5a1177b 100644 --- a/www/apps/resources/sidebars/user.mjs +++ b/www/apps/resources/sidebars/user.mjs @@ -1,9 +1,9 @@ -/** @type {import('types').RawSidebarItem[]} */ +/** @type {import('types').Sidebar.SidebarItem[]} */ export const userSidebar = [ { - type: "category", + type: "sidebar", + sidebar_id: "user", title: "User Module", - isChildSidebar: true, children: [ { type: "link", @@ -24,6 +24,7 @@ export const userSidebar = [ autogenerate_tags: "server+user", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to use the User Module in your customizations on the Medusa application server.", children: [ @@ -40,6 +41,7 @@ export const userSidebar = [ autogenerate_tags: "storefront+user,-jsSdk", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to integrate the User Module's features into your storefront.", }, @@ -49,6 +51,7 @@ export const userSidebar = [ autogenerate_tags: "admin+user,-jsSdk", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to utilize administative features of the User Module.", }, @@ -58,6 +61,7 @@ export const userSidebar = [ autogenerate_tags: "userGuide+user", initialOpen: false, autogenerate_as_ref: true, + sort_sidebar: "alphabetize", description: "Learn how to utilize and manage User features in the Medusa Admin dashboard.", }, @@ -79,12 +83,14 @@ export const userSidebar = [ title: "Workflows", autogenerate_tags: "workflow+user", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, { type: "category", title: "Steps", autogenerate_tags: "step+user", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, ], }, @@ -101,6 +107,7 @@ export const userSidebar = [ description: "The following methods or properties are used to send requests to Store API Routes related to the User Module.", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, { type: "sub-category", @@ -109,6 +116,7 @@ export const userSidebar = [ description: "The following methods or properties are used to send requests to Admin API Routes related to the User Module.", autogenerate_as_ref: true, + sort_sidebar: "alphabetize", }, ], }, @@ -123,12 +131,19 @@ export const userSidebar = [ title: "Admin Widget Zones", }, { - type: "link", - path: "/references/user", + type: "sidebar", + sidebar_id: "user-service-reference", title: "Main Service Reference", - isChildSidebar: true, childSidebarTitle: "User Module's Main Service Reference", children: [ + { + type: "link", + path: "/references/user", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "category", title: "Methods", @@ -138,12 +153,19 @@ export const userSidebar = [ ], }, { - type: "link", - path: "/references/user/models", + type: "sidebar", + sidebar_id: "user-models-reference", title: "Data Models Reference", - isChildSidebar: true, childSidebarTitle: "User Module Data Models Reference", children: [ + { + type: "link", + path: "/references/user/models", + title: "Reference Overview", + }, + { + type: "separator", + }, { type: "category", title: "Data Models", diff --git a/www/apps/resources/types/index.d.ts b/www/apps/resources/types/index.d.ts deleted file mode 100644 index 16000e4f06..0000000000 --- a/www/apps/resources/types/index.d.ts +++ /dev/null @@ -1,6 +0,0 @@ -import { SidebarItemType as UiSidebarItemType } from "docs-ui" - -export declare type SidebarItemType = UiSidebarItemType & { - autogenerate_path?: string - children?: SidebarItemType[] -} diff --git a/www/apps/resources/utils/sidebar-attach-common-options.mjs b/www/apps/resources/utils/sidebar-attach-common-options.mjs deleted file mode 100644 index 4ec44f7dd8..0000000000 --- a/www/apps/resources/utils/sidebar-attach-common-options.mjs +++ /dev/null @@ -1,24 +0,0 @@ -/** @type {Partial} */ -const commonOptions = { - loaded: true, - isPathHref: true, -} - -/** - * - * @param {import("types").RawSidebarItem[]} sidebar - * @returns {import("types").RawSidebarItem[]} - */ -export function sidebarAttachHrefCommonOptions(sidebar) { - return sidebar.map((item) => { - if (item.type === "separator") { - return item - } - - return { - ...commonOptions, - ...item, - children: sidebarAttachHrefCommonOptions(item.children || []), - } - }) -} diff --git a/www/apps/ui/package.json b/www/apps/ui/package.json index 4a3b2e6676..51001f2606 100644 --- a/www/apps/ui/package.json +++ b/www/apps/ui/package.json @@ -16,9 +16,9 @@ "dependencies": { "@faker-js/faker": "^8.0.2", "@mdx-js/react": "^3.1.0", - "@medusajs/icons": "~2.5.1", - "@medusajs/ui": "~4.0.6", - "@medusajs/ui-preset": "~2.5.1", + "@medusajs/icons": "2.6.0", + "@medusajs/ui": "4.0.6", + "@medusajs/ui-preset": "2.6.0", "autoprefixer": "10.4.14", "clsx": "^2.0.0", "contentlayer": "^0.3.4", diff --git a/www/apps/ui/src/app/assets/sitemap.ts b/www/apps/ui/src/app/assets/sitemap.ts index 2145d92d8d..dbd1677ac0 100644 --- a/www/apps/ui/src/app/assets/sitemap.ts +++ b/www/apps/ui/src/app/assets/sitemap.ts @@ -1,8 +1,8 @@ import { MetadataRoute } from "next" -import { docsConfig } from "@/config/docs" +import { sidebars } from "@/config/sidebar" import { absoluteUrl } from "@/lib/absolute-url" -import { SidebarItem } from "types" +import { Sidebar } from "types" export default function sitemap(): MetadataRoute.Sitemap { const now = new Date() @@ -12,7 +12,7 @@ export default function sitemap(): MetadataRoute.Sitemap { lastModified?: string | Date }> = [] - function pushItems(newItems: SidebarItem[]) { + function pushItems(newItems: Sidebar.SidebarItem[]) { newItems.forEach((item) => { if (item.type !== "link") { return @@ -29,7 +29,7 @@ export default function sitemap(): MetadataRoute.Sitemap { }) } - pushItems(docsConfig.sidebar.default) + sidebars.forEach((sidebar) => pushItems(sidebar.items)) return items } diff --git a/www/apps/ui/src/app/layout.tsx b/www/apps/ui/src/app/layout.tsx index fc2d519e18..7ae82b31f7 100644 --- a/www/apps/ui/src/app/layout.tsx +++ b/www/apps/ui/src/app/layout.tsx @@ -60,14 +60,7 @@ export default function RootLayout({ htmlClassName={clsx(inter.variable, robotoMono.variable)} gaId={process.env.NEXT_PUBLIC_GA_ID} > - - {children} - + {children} ) } diff --git a/www/apps/ui/src/config/colors.ts b/www/apps/ui/src/config/colors.ts index 87acddcdd0..9908b636cb 100644 --- a/www/apps/ui/src/config/colors.ts +++ b/www/apps/ui/src/config/colors.ts @@ -1,226 +1,182 @@ export const colors = { dark: { - "--fg-on-color": "rgba(255, 255, 255, 1)", - "--border-danger": "rgba(190, 18, 60, 1)", - "--border-interactive": "rgba(96, 165, 250, 1)", - "--fg-interactive-hover": "rgba(59, 130, 246, 1)", - "--fg-error": "rgba(251, 113, 133, 1)", - "--bg-interactive": "rgba(96, 165, 250, 1)", - "--border-error": "rgba(244, 63, 94, 1)", - "--button-danger": "rgba(159, 18, 57, 1)", - "--button-danger-gradient-from": "rgba(255, 255, 255, 1)", - "--button-danger-gradient-to": "rgba(255, 255, 255, 0)", - "--fg-interactive": "rgba(96, 165, 250, 1)", - "--tag-red-border": "rgba(136, 19, 55, 1)", - "--tag-red-bg": "rgba(76, 5, 25, 1)", - "--tag-blue-text": "rgba(96, 165, 250, 1)", - "--tag-orange-text": "rgba(251, 191, 36, 1)", - "--tag-green-text": "rgba(52, 211, 153, 1)", - "--tag-orange-border": "rgba(120, 53, 15, 1)", - "--tag-green-border": "rgba(6, 78, 59, 1)", - "--tag-red-text": "rgba(251, 113, 133, 1)", - "--tag-green-bg-hover": "rgba(6, 78, 59, 1)", - "--tag-purple-bg-hover": "rgba(76, 29, 149, 1)", - "--tag-red-bg-hover": "rgba(136, 19, 55, 1)", - "--border-transparent": "rgba(255, 255, 255, 0)", - "--tag-orange-icon": "rgba(245, 158, 11, 1)", - "--tag-purple-bg": "rgba(46, 16, 100, 1)", - "--tag-blue-bg": "rgba(23, 37, 84, 1)", - "--tag-green-bg": "rgba(2, 44, 34, 1)", - "--tag-blue-border": "rgba(30, 58, 138, 1)", - "--tag-purple-border": "rgba(76, 29, 149, 1)", - "--tag-blue-bg-hover": "rgba(30, 42, 138, 1)", - "--tag-orange-bg": "rgba(69, 26, 3, 1)", - "--tag-orange-bg-hover": "rgba(120, 53, 15, 1)", - "--tag-blue-icon": "rgba(59, 130, 246, 1)", - "--tag-red-icon": "rgba(244, 63, 94, 1)", - "--tag-purple-icon": "rgba(139, 92, 246, 1)", - "--tag-purple-text": "rgba(167, 139, 250, 1)", - "--tag-green-icon": "rgba(16, 185, 129, 1)", "--button-danger-pressed": "rgba(225, 29, 72, 1)", - "--button-danger-pressed-gradient-from": "rgba(255, 255, 255, 1)", - "--button-danger-pressed-gradient-to": "rgba(255, 255, 255, 0)", - "--button-danger-hover": "rgba(190, 18, 60, 1)", - "--button-danger-hover-gradient-from": "rgba(255, 255, 255, 1)", - "--button-danger-hover-gradient-to": "rgba(255, 255, 255, 0)", - "--button-transparent": "rgba(0, 0, 0, 0.01)", - "--code-bg-base": "rgba(9, 9, 11, 1)", - "--button-neutral": "rgba(39, 39, 42, 1)", - "--button-neutral-gradient-from": "rgba(255, 255, 255, 1)", - "--button-neutral-gradient-to": "rgba(255, 255, 255, 0)", - "--button-transparent-hover": "rgba(39, 39, 42, 1)", - "--code-fg-subtle": "rgba(161, 161, 170, 1)", - "--tag-neutral-bg-hover": "rgba(63, 63, 70, 1)", - "--contrast-border-base": "rgba(82, 82, 91, 1)", - "--button-neutral-pressed": "rgba(82, 82, 91, 1)", - "--button-neutral-pressed-gradient-from": "rgba(255, 255, 255, 1)", - "--button-neutral-pressed-gradient-to": "rgba(255, 255, 255, 0)", - "--tag-neutral-bg": "rgba(39, 39, 42, 1)", + "--bg-base-pressed": "rgba(63, 63, 70, 1)", + "--bg-component-hover": "rgba(255, 255, 255, 0.1)", + "--border-interactive": "rgba(96, 165, 250, 1)", + "--button-neutral": "rgba(255, 255, 255, 0.04)", + "--tag-orange-border": "rgba(124, 45, 18, 1)", + "--tag-blue-text": "rgba(147, 197, 253, 1)", "--bg-highlight": "rgba(23, 37, 84, 1)", - "--border-base": "rgba(255, 255, 255, 0.1)", - "--code-fg-base": "rgba(250, 250, 250, 1)", "--tag-neutral-icon": "rgba(113, 113, 122, 1)", "--bg-switch-off-hover": "rgba(82, 82, 91, 1)", - "--bg-base": "rgba(24, 24, 27, 1)", + "--fg-on-color": "rgba(255, 255, 255, 1)", "--button-inverted-pressed": "rgba(161, 161, 170, 1)", - "--button-inverted-pressed-gradient-from": "rgba(255, 255, 255, 1)", - "--button-inverted-pressed-gradient-to": "rgba(255, 255, 255, 0)", - "--button-neutral-hover": "rgba(63, 63, 70, 1)", - "--button-neutral-hover-gradient-from": "rgba(255, 255, 255, 1)", - "--button-neutral-hover-gradient-to": "rgba(255, 255, 255, 0)", + "--fg-interactive-hover": "rgba(147, 197, 253, 1)", + "--fg-error": "rgba(251, 113, 133, 1)", "--bg-switch-off": "rgba(63, 63, 70, 1)", - "--border-strong": "rgba(255, 255, 255, 0.15)", + "--border-strong": "rgba(255, 255, 255, 0.16)", + "--border-error": "rgba(251, 113, 133, 1)", "--fg-subtle": "rgba(161, 161, 170, 1)", "--bg-highlight-hover": "rgba(30, 58, 138, 1)", "--button-inverted": "rgba(82, 82, 91, 1)", - "--button-inverted-gradient-from": "rgba(255, 255, 255, 1)", - "--button-inverted-gradient-to": "rgba(255, 255, 255, 0)", - "--fg-base": "rgba(250, 250, 250, 1)", - "--code-border": "rgba(39, 39, 42, 1)", - "--contrast-bg-subtle": "rgba(39, 39, 42, 1)", - "--contrast-bg-base-hover": "rgba(82, 82, 91, 1)", - "--bg-base-hover": "rgba(39, 39, 42, 1)", - "--bg-subtle-hover": "rgba(24, 24, 27, 1)", - "--fg-disabled": "rgba(63, 63, 70, 1)", - "--bg-subtle": "rgba(9, 9, 11, 1)", - "--tag-neutral-border": "rgba(63, 63, 70, 1)", - "--bg-subtle-pressed": "rgba(39, 39, 42, 1)", - "--tag-neutral-text": "rgba(161, 161, 170, 1)", - "--fg-muted": "rgba(82, 82, 91, 1)", - "--bg-overlay": "rgba(9, 9, 11, 0.7)", + "--tag-orange-text": "rgba(253, 186, 116, 1)", + "--fg-base": "rgba(244, 244, 245, 1)", + "--fg-disabled": "rgba(82, 82, 91, 1)", + "--button-danger": "rgba(159, 18, 57, 1)", + "--tag-neutral-border": "rgba(255, 255, 255, 0.06)", + "--tag-blue-border": "rgba(30, 58, 138, 1)", + "--tag-neutral-text": "rgba(212, 212, 216, 1)", + "--tag-purple-border": "rgba(91, 33, 182, 1)", + "--tag-green-text": "rgba(52, 211, 153, 1)", "--button-inverted-hover": "rgba(113, 113, 122, 1)", - "--button-inverted-hover-gradient-from": "rgba(255, 255, 255, 1)", - "--button-inverted-hover-gradient-to": "rgba(255, 255, 255, 0)", - "--fg-on-inverted": "rgba(9, 9, 11, 1)", - "--code-bg-subtle": "rgba(24, 24, 27, 1)", + "--bg-component-pressed": "rgba(255, 255, 255, 0.16)", + "--contrast-border-bot": "rgba(255, 255, 255, 0.08)", + "--tag-blue-icon": "rgba(96, 165, 250, 1)", + "--bg-field": "rgba(255, 255, 255, 0.04)", + "--tag-neutral-bg": "rgba(255, 255, 255, 0.08)", + "--tag-green-border": "rgba(6, 78, 59, 1)", + "--tag-red-icon": "rgba(251, 113, 133, 1)", + "--tag-red-text": "rgba(253, 164, 175, 1)", + "--tag-purple-icon": "rgba(167, 139, 250, 1)", + "--bg-interactive": "rgba(96, 165, 250, 1)", + "--bg-field-hover": "rgba(255, 255, 255, 0.08)", + "--border-transparent": "rgba(255, 255, 255, 0)", + "--tag-orange-icon": "rgba(251, 146, 60, 1)", + "--tag-purple-bg": "rgba(46, 16, 101, 1)", + "--bg-base-hover": "rgba(39, 39, 42, 1)", + "--tag-blue-bg": "rgba(23, 37, 84, 1)", + "--tag-green-bg": "rgba(2, 44, 34, 1)", + "--tag-purple-text": "rgba(196, 181, 253, 1)", + "--tag-red-border": "rgba(136, 19, 55, 1)", + "--border-danger": "rgba(190, 18, 60, 1)", + "--tag-green-icon": "rgba(16, 185, 129, 1)", + "--tag-red-bg": "rgba(76, 5, 25, 1)", + "--fg-interactive": "rgba(96, 165, 250, 1)", + "--tag-orange-bg": "rgba(67, 20, 7, 1)", + "--button-danger-hover": "rgba(190, 18, 60, 1)", "--bg-component": "rgba(39, 39, 42, 1)", - "--border-loud": "rgba(250, 250, 250, 1)", - "--bg-base-pressed": "rgba(63, 63, 70, 1)", "--bg-disabled": "rgba(39, 39, 42, 1)", - "--contrast-bg-highlight": "rgba(82, 82, 91, 1)", - "--button-transparent-pressed": "rgba(63, 63, 70, 1)", - "--code-fg-muted": "rgba(82, 82, 91, 1)", - "--contrast-fg-secondary": "rgba(161, 161, 170, 1)", - "--contrast-bg-base-pressed": "rgba(113, 113, 122, 1)", - "--contrast-fg-primary": "rgba(250, 250, 250, 1)", - "--contrast-bg-base": "rgba(63, 63, 70, 1)", - "--bg-component-pressed": "rgba(82, 82, 91, 1)", - "--bg-component-hover": "rgba(63, 63, 70, 1)", - "--bg-field": "rgba(39, 39, 42, 1)", - "--bg-field-component": "rgba(24, 24, 27, 1)", - "--bg-field-component-hover": "rgba(24, 24, 27, 1)", - "--bg-field-hover": "rgba(39, 39, 42, 1)", + "--button-transparent": "rgba(255, 255, 255, 0)", + "--border-menu-bot": "rgba(255, 255, 255, 0.08)", + "--tag-purple-bg-hover": "rgba(91, 33, 182, 1)", + "--tag-orange-bg-hover": "rgba(124, 45, 18, 1)", + "--tag-blue-bg-hover": "rgba(30, 58, 138, 1)", + "--tag-red-bg-hover": "rgba(136, 19, 55, 1)", + "--tag-green-bg-hover": "rgba(6, 78, 59, 1)", + "--border-menu-top": "rgba(33, 33, 36, 1)", + "--bg-base": "rgba(33, 33, 36, 1)", + "--contrast-border-top": "rgba(33, 33, 36, 1)", + "--bg-field-component": "rgba(33, 33, 36, 1)", + "--bg-subtle-hover": "rgba(33, 33, 36, 1)", + "--bg-subtle": "rgba(24, 24, 27, 1)", + "--fg-on-inverted": "rgba(24, 24, 27, 1)", + "--bg-overlay": "rgba(24, 24, 27, 0.72)", + "--button-transparent-hover": "rgba(255, 255, 255, 0.08)", + "--contrast-fg-secondary": "rgba(255, 255, 255, 0.56)", + "--contrast-border-base": "rgba(255, 255, 255, 0.16)", + "--contrast-bg-base-pressed": "rgba(82, 82, 91, 1)", + "--button-neutral-pressed": "rgba(255, 255, 255, 0.12)", + "--border-base": "rgba(255, 255, 255, 0.08)", + "--contrast-fg-primary": "rgba(255, 255, 255, 0.88)", + "--button-neutral-hover": "rgba(255, 255, 255, 0.08)", + "--contrast-bg-base": "rgba(39, 39, 42, 1)", + "--tag-neutral-bg-hover": "rgba(255, 255, 255, 0.12)", + "--contrast-bg-subtle": "rgba(255, 255, 255, 0.04)", + "--contrast-bg-base-hover": "rgba(63, 63, 70, 1)", + "--bg-field-component-hover": "rgba(39, 39, 42, 1)", + "--bg-subtle-pressed": "rgba(39, 39, 42, 1)", + "--button-transparent-pressed": "rgba(255, 255, 255, 0.12)", + "--fg-muted": "rgba(113, 113, 122, 1)", }, light: { - "--tag-green-bg": "rgba(209, 250, 229, 1)", - "--border-interactive": "rgba(59, 130, 246, 1)", - "--bg-highlight": "rgba(239, 246, 255, 1)", - "--tag-red-bg": "rgba(255, 228, 230, 1)", - "--tag-orange-bg": "rgba(254, 244, 199, 1)", - "--bg-base": "rgba(255, 255, 255, 1)", - "--tag-green-icon": "rgba(5, 150, 105, 1)", - "--tag-purple-bg-hover": "rgba(221, 214, 254, 1)", - "--tag-blue-border": "rgba(191, 219, 254, 1)", - "--tag-orange-icon": "rgba(217, 119, 6, 1)", - "--tag-purple-bg": "rgba(237, 233, 254, 1)", - "--tag-purple-text": "rgba(109, 40, 217, 1)", - "--tag-blue-bg": "rgba(219, 234, 254, 1)", - "--tag-blue-icon": "rgba(37, 99, 235, 1)", - "--border-error": "rgba(225, 29, 72, 1)", - "--fg-on-inverted": "rgba(255, 255, 255, 1)", - "--fg-on-color": "rgba(255, 255, 255, 1)", - "--fg-interactive-hover": "rgba(37, 99, 235, 1)", - "--fg-interactive": "rgba(59, 130, 246, 1)", - "--fg-error": "rgba(225, 29, 72, 1)", - "--border-danger": "rgba(190, 18, 60, 1)", - "--fg-muted": "rgba(161, 161, 170, 1)", - "--bg-subtle-pressed": "rgba(228, 228, 231, 1)", - "--tag-green-bg-hover": "rgba(167, 243, 208, 1)", - "--tag-blue-bg-hover": "rgba(191, 219, 254, 1)", - "--tag-red-icon": "rgba(225, 29, 72, 1)", - "--tag-red-bg-hover": "rgba(254, 205, 211, 1)", - "--tag-red-text": "rgba(190, 18, 60, 1)", - "--tag-purple-icon": "rgba(124, 58, 237, 1)", - "--tag-blue-text": "rgba(29, 78, 216, 1)", - "--tag-orange-bg-hover": "rgba(253, 230, 138, 1)", - "--tag-purple-border": "rgba(221, 214, 254, 1)", - "--tag-orange-text": "rgba(180, 83, 9, 1)", - "--tag-orange-border": "rgba(253, 230, 138, 1)", - "--tag-red-border": "rgba(254, 205, 211, 1)", - "--tag-green-border": "rgba(167, 243, 208, 1)", - "--tag-green-text": "rgba(4, 120, 87, 1)", - "--button-danger": "rgba(225, 29, 72, 1)", - "--button-danger-gradient-from": "rgba(255, 255, 255, 1)", - "--button-danger-gradient-to": "rgba(255, 255, 255, 0)", - "--button-danger-pressed": "rgba(159, 18, 57, 1)", - "--button-danger-pressed-gradient-from": "rgba(255, 255, 255, 1)", - "--button-danger-pressed-gradient-to": "rgba(255, 255, 255, 0)", - "--button-danger-hover": "rgba(190, 18, 60, 1)", - "--button-danger-hover-gradient-from": "rgba(255, 255, 255, 1)", - "--button-danger-hover-gradient-to": "rgba(255, 255, 255, 0)", - "--bg-interactive": "rgba(59, 130, 246, 1)", - "--bg-highlight-hover": "rgba(219, 234, 254, 1)", - "--button-transparent": "rgba(255, 255, 255, 0.01)", - "--bg-overlay": "rgba(9, 9, 11, 0.4)", "--tag-neutral-border": "rgba(228, 228, 231, 1)", - "--border-loud": "rgba(9, 9, 11, 1)", - "--contrast-fg-primary": "rgba(250, 250, 250, 1)", + "--tag-neutral-icon": "rgba(161, 161, 170, 1)", + "--bg-switch-off-hover": "rgba(212, 212, 216, 1)", + "--border-menu-bot": "rgba(255, 255, 255, 1)", + "--border-menu-top": "rgba(228, 228, 231, 1)", + "--bg-subtle-hover": "rgba(244, 244, 245, 1)", + "--contrast-fg-primary": "rgba(255, 255, 255, 0.88)", "--bg-switch-off": "rgba(228, 228, 231, 1)", "--contrast-bg-base-pressed": "rgba(63, 63, 70, 1)", + "--bg-field-component-hover": "rgba(250, 250, 250, 1)", "--bg-base-pressed": "rgba(228, 228, 231, 1)", "--tag-neutral-text": "rgba(82, 82, 91, 1)", - "--button-transparent-hover": "rgba(244, 244, 245, 1)", + "--tag-red-text": "rgba(159, 18, 57, 1)", "--contrast-bg-base": "rgba(24, 24, 27, 1)", - "--fg-disabled": "rgba(212, 212, 216, 1)", - "--bg-field": "rgba(250, 250, 250, 1)", "--border-strong": "rgba(212, 212, 216, 1)", - "--bg-field-hover": "rgba(244, 244, 245, 1)", - "--contrast-border-base": "rgba(82, 82, 91, 1)", - "--fg-base": "rgba(9, 9, 11, 1)", - "--contrast-bg-subtle": "rgba(39, 39, 42, 1)", - "--contrast-fg-secondary": "rgba(161, 161, 170, 1)", - "--code-fg-subtle": "rgba(161, 161, 170, 1)", - "--tag-neutral-bg": "rgba(244, 244, 245, 1)", - "--button-transparent-pressed": "rgba(228, 228, 231, 1)", - "--tag-neutral-bg-hover": "rgba(228, 228, 231, 1)", - "--code-fg-muted": "rgba(113, 113, 122, 1)", - "--contrast-bg-highlight": "rgba(63, 63, 70, 1)", - "--tag-neutral-icon": "rgba(113, 113, 122, 1)", - "--border-base": "rgba(228, 228, 231, 1)", - "--code-bg-base": "rgba(24, 24, 27, 1)", - "--button-neutral": "rgba(255, 255, 255, 1)", - "--button-neutral-gradient-from": "rgba(9, 9, 11, 0)", - "--button-neutral-gradient-to": "rgba(9, 9, 11, 1)", - "--code-bg-subtle": "rgba(39, 39, 42, 1)", - "--button-neutral-hover": "rgba(244, 244, 245, 1)", - "--button-neutral-hover-gradient-from": "rgba(9, 9, 11, 0)", - "--button-neutral-hover-gradient-to": "rgba(9, 9, 11, 1)", - "--contrast-bg-base-hover": "rgba(39, 39, 42, 1)", - "--bg-subtle": "rgba(250, 250, 250, 1)", - "--bg-switch-off-hover": "rgba(212, 212, 216, 1)", - "--code-fg-base": "rgba(250, 250, 250, 1)", - "--bg-disabled": "rgba(244, 244, 245, 1)", - "--code-border": "rgba(63, 63, 70, 1)", - "--fg-subtle": "rgba(82, 82, 91, 1)", - "--bg-subtle-hover": "rgba(244, 244, 245, 1)", - "--button-neutral-pressed": "rgba(228, 228, 231, 1)", - "--button-neutral-pressed-gradient-from": "rgba(9, 9, 11, 0)", - "--button-neutral-pressed-gradient-to": "rgba(9, 9, 11, 1)", - "--border-transparent": "rgba(9, 9, 11, 0)", - "--button-inverted": "rgba(9, 9, 11, 1)", - "--button-inverted-gradient-from": "rgba(255, 255, 255, 1)", - "--button-inverted-gradient-to": "rgba(255, 255, 255, 0)", - "--button-inverted-pressed": "rgba(39, 39, 42, 1)", - "--button-inverted-pressed-gradient-from": "rgba(255, 255, 255, 1)", - "--button-inverted-pressed-gradient-to": "rgba(255, 255, 255, 0)", - "--button-inverted-hover": "rgba(24, 24, 27, 1)", - "--button-inverted-hover-gradient-from": "rgba(255, 255, 255, 1)", - "--button-inverted-hover-gradient-to": "rgba(255, 255, 255, 0)", - "--bg-component-hover": "rgba(244, 244, 245, 1)", - "--bg-field-component": "rgba(255, 255, 255, 1)", - "--bg-field-component-hover": "rgba(250, 250, 250, 1)", - "--bg-component-pressed": "rgba(228, 228, 231, 1)", - "--bg-component": "rgba(250, 250, 250, 1)", + "--contrast-border-base": "rgba(255, 255, 255, 0.15)", + "--bg-field": "rgba(250, 250, 250, 1)", + "--tag-blue-text": "rgba(30, 64, 175, 1)", + "--button-inverted-pressed": "rgba(82, 82, 91, 1)", + "--border-interactive": "rgba(59, 130, 246, 1)", "--bg-base-hover": "rgba(244, 244, 245, 1)", + "--contrast-bg-subtle": "rgba(39, 39, 42, 1)", + "--bg-highlight": "rgba(239, 246, 255, 1)", + "--contrast-fg-secondary": "rgba(255, 255, 255, 0.56)", + "--tag-red-bg": "rgba(255, 228, 230, 1)", + "--button-transparent": "rgba(255, 255, 255, 0)", + "--button-danger-pressed": "rgba(159, 18, 57, 1)", + "--fg-on-color": "rgba(255, 255, 255, 1)", + "--button-inverted-hover": "rgba(63, 63, 70, 1)", + "--bg-field-component": "rgba(255, 255, 255, 1)", + "--tag-orange-text": "rgba(154, 52, 18, 1)", + "--tag-green-icon": "rgba(16, 185, 129, 1)", + "--border-base": "rgba(228, 228, 231, 1)", + "--bg-base": "rgba(255, 255, 255, 1)", + "--tag-orange-border": "rgba(254, 215, 170, 1)", + "--tag-red-border": "rgba(254, 205, 211, 1)", + "--tag-green-border": "rgba(167, 243, 208, 1)", + "--tag-green-text": "rgba(6, 95, 70, 1)", + "--button-neutral": "rgba(255, 255, 255, 1)", + "--tag-blue-border": "rgba(191, 219, 254, 1)", + "--fg-interactive-hover": "rgba(37, 99, 235, 1)", + "--tag-orange-icon": "rgba(249, 115, 22, 1)", + "--button-neutral-hover": "rgba(244, 244, 245, 1)", + "--fg-interactive": "rgba(59, 130, 246, 1)", + "--bg-component-pressed": "rgba(228, 228, 231, 1)", + "--tag-purple-bg": "rgba(237, 233, 254, 1)", + "--contrast-bg-base-hover": "rgba(39, 39, 42, 1)", + "--bg-component": "rgba(250, 250, 250, 1)", + "--bg-subtle": "rgba(250, 250, 250, 1)", + "--tag-purple-text": "rgba(91, 33, 182, 1)", + "--contrast-border-bot": "rgba(255, 255, 255, 0.1)", + "--button-inverted": "rgba(39, 39, 42, 1)", + "--tag-red-icon": "rgba(244, 63, 94, 1)", + "--button-transparent-hover": "rgba(244, 244, 245, 1)", + "--button-neutral-pressed": "rgba(228, 228, 231, 1)", + "--tag-purple-icon": "rgba(167, 139, 250, 1)", + "--bg-field-hover": "rgba(244, 244, 245, 1)", + "--fg-on-inverted": "rgba(255, 255, 255, 1)", + "--bg-interactive": "rgba(59, 130, 246, 1)", + "--border-danger": "rgba(190, 18, 60, 1)", + "--button-transparent-pressed": "rgba(228, 228, 231, 1)", + "--tag-purple-border": "rgba(221, 214, 254, 1)", + "--bg-highlight-hover": "rgba(219, 234, 254, 1)", + "--border-error": "rgba(225, 29, 72, 1)", + "--button-danger": "rgba(225, 29, 72, 1)", + "--tag-blue-bg": "rgba(219, 234, 254, 1)", + "--border-transparent": "rgba(255, 255, 255, 0)", + "--button-danger-hover": "rgba(190, 18, 60, 1)", + "--bg-subtle-pressed": "rgba(228, 228, 231, 1)", + "--fg-error": "rgba(225, 29, 72, 1)", + "--bg-component-hover": "rgba(244, 244, 245, 1)", + "--bg-disabled": "rgba(244, 244, 245, 1)", + "--tag-blue-icon": "rgba(96, 165, 250, 1)", + "--fg-subtle": "rgba(82, 82, 91, 1)", + "--tag-orange-bg-hover": "rgba(254, 215, 170, 1)", + "--tag-green-bg-hover": "rgba(167, 243, 208, 1)", + "--tag-red-bg-hover": "rgba(254, 205, 211, 1)", + "--tag-purple-bg-hover": "rgba(221, 214, 254, 1)", + "--tag-neutral-bg-hover": "rgba(228, 228, 231, 1)", + "--tag-blue-bg-hover": "rgba(191, 219, 254, 1)", + "--tag-green-bg": "rgba(209, 250, 229, 1)", + "--tag-neutral-bg": "rgba(244, 244, 245, 1)", + "--tag-orange-bg": "rgba(255, 237, 213, 1)", + "--fg-base": "rgba(24, 24, 27, 1)", + "--contrast-border-top": "rgba(24, 24, 27, 1)", + "--bg-overlay": "rgba(24, 24, 27, 0.4)", + "--fg-disabled": "rgba(161, 161, 170, 1)", + "--fg-muted": "rgba(113, 113, 122, 1)", }, } diff --git a/www/apps/ui/src/config/docs.tsx b/www/apps/ui/src/config/sidebar.tsx similarity index 97% rename from www/apps/ui/src/config/docs.tsx rename to www/apps/ui/src/config/sidebar.tsx index a9a0cdf1aa..15c6874d1a 100644 --- a/www/apps/ui/src/config/docs.tsx +++ b/www/apps/ui/src/config/sidebar.tsx @@ -1,12 +1,10 @@ -import { SidebarSectionItems } from "types" +import { Sidebar } from "types" -type DocsConfig = { - sidebar: SidebarSectionItems -} - -export const docsConfig: DocsConfig = { - sidebar: { - default: [ +export const sidebars: Sidebar.Sidebar[] = [ + { + sidebar_id: "ui", + title: "Medusa UI", + items: [ { type: "link", title: "Introduction", @@ -364,6 +362,5 @@ export const docsConfig: DocsConfig = { ], }, ], - mobile: [], }, -} +] diff --git a/www/apps/ui/src/config/site.ts b/www/apps/ui/src/config/site.ts index cf938bf971..bc1d79d60b 100644 --- a/www/apps/ui/src/config/site.ts +++ b/www/apps/ui/src/config/site.ts @@ -1,5 +1,6 @@ import { globalConfig } from "docs-ui" import { DocsConfig } from "types" +import { sidebars } from "./sidebar" type SiteConfig = { name: string @@ -16,17 +17,18 @@ export const siteConfig: SiteConfig = { basePath: process.env.NEXT_PUBLIC_BASE_PATH, url: `${baseUrl}/${process.env.NEXT_PUBLIC_BASE_PATH}`, description: "Primitives for building Medusa applications.", - // sidebar is defined in docs.tsx - sidebar: { - default: [], - mobile: [], - }, + sidebars, project: { title: "Medusa UI", key: "ui", }, breadcrumbOptions: { - showCategories: true, + startItems: [ + { + title: "Documentation", + link: baseUrl, + }, + ], }, logo: `${process.env.NEXT_PUBLIC_BASE_PATH}/images/logo.png`, version: { diff --git a/www/apps/ui/src/providers/sidebar.tsx b/www/apps/ui/src/providers/sidebar.tsx index 8aec55686a..d37748b9ff 100644 --- a/www/apps/ui/src/providers/sidebar.tsx +++ b/www/apps/ui/src/providers/sidebar.tsx @@ -2,7 +2,7 @@ import { SidebarProvider as UiSidebarProvider, useScrollController, } from "docs-ui" -import { docsConfig } from "@/config/docs" +import { sidebars } from "@/config/sidebar" type SidebarProviderProps = { children?: React.ReactNode @@ -13,11 +13,8 @@ const SidebarProvider = ({ children }: SidebarProviderProps) => { return ( {children} diff --git a/www/apps/ui/src/types/nav.ts b/www/apps/ui/src/types/nav.ts deleted file mode 100644 index 1b30f75502..0000000000 --- a/www/apps/ui/src/types/nav.ts +++ /dev/null @@ -1,8 +0,0 @@ -export interface SidebarNavItem { - title: string - href?: string - disabled?: boolean - external?: boolean - label?: string - items?: SidebarNavItem[] -} diff --git a/www/apps/user-guide/app/layout.tsx b/www/apps/user-guide/app/layout.tsx index 028058cadf..69ebaf9466 100644 --- a/www/apps/user-guide/app/layout.tsx +++ b/www/apps/user-guide/app/layout.tsx @@ -64,13 +64,7 @@ export default function RootLayout({ htmlClassName={clsx(inter.variable, robotoMono.variable)} gaId={process.env.NEXT_PUBLIC_GA_ID} > - } - > + }> {children} diff --git a/www/apps/user-guide/app/settings/profile/page.mdx b/www/apps/user-guide/app/settings/profile/page.mdx index 86382cdb8b..62df186fc1 100644 --- a/www/apps/user-guide/app/settings/profile/page.mdx +++ b/www/apps/user-guide/app/settings/profile/page.mdx @@ -38,7 +38,7 @@ To edit your profile details and settings: -Can't find your language? Learn how you can contribute by translating the admin to other languages [here](!resources!/contribution-guidelines/admin-translations). +Can't find your language? Learn how you can contribute by translating the admin to other languages [here](!docs!/learn/resources/contribution-guidelines/admin-translations). diff --git a/www/apps/user-guide/app/tips/languages/page.mdx b/www/apps/user-guide/app/tips/languages/page.mdx index 5f43cf98db..f80e4d1741 100644 --- a/www/apps/user-guide/app/tips/languages/page.mdx +++ b/www/apps/user-guide/app/tips/languages/page.mdx @@ -14,7 +14,7 @@ This document covers the complete list of available languages, both official and -Can't find your language? Learn how you can contribute by translating the admin to other languages [here](!resources!/contribution-guidelines/admin-translations). +Can't find your language? Learn how you can contribute by translating the admin to other languages [here](!docs!/learn/resources/contribution-guidelines/admin-translations). diff --git a/www/apps/user-guide/config/index.ts b/www/apps/user-guide/config/index.ts index 79a9aa2413..c32774ef83 100644 --- a/www/apps/user-guide/config/index.ts +++ b/www/apps/user-guide/config/index.ts @@ -1,5 +1,5 @@ -import { DocsConfig, SidebarItem } from "types" -import { generatedSidebar as sidebar } from "@/generated/sidebar.mjs" +import { DocsConfig, Sidebar } from "types" +import { generatedSidebars } from "@/generated/sidebar.mjs" import { globalConfig } from "docs-ui" const baseUrl = process.env.NEXT_PUBLIC_BASE_URL || "http://localhost:3000" @@ -9,16 +9,18 @@ export const config: DocsConfig = { titleSuffix: "Medusa Admin User Guide", baseUrl, basePath: process.env.NEXT_PUBLIC_BASE_PATH, - sidebar: { - default: sidebar as SidebarItem[], - mobile: [], - }, + sidebars: generatedSidebars as Sidebar.Sidebar[], project: { title: "User Guide", key: "user-guide", }, - breadcrumbOptions: { - showCategories: true, - }, logo: `${process.env.NEXT_PUBLIC_BASE_PATH}/images/logo.png`, + breadcrumbOptions: { + startItems: [ + { + title: "Documentation", + link: baseUrl, + }, + ], + }, } diff --git a/www/apps/user-guide/generated/edit-dates.mjs b/www/apps/user-guide/generated/edit-dates.mjs index 41b6194c7c..e05afb363f 100644 --- a/www/apps/user-guide/generated/edit-dates.mjs +++ b/www/apps/user-guide/generated/edit-dates.mjs @@ -1,5 +1,5 @@ export const generatedEditDates = { - "app/tips/languages/page.mdx": "2025-02-14T14:16:04.867Z", + "app/tips/languages/page.mdx": "2025-03-06T08:49:32.514Z", "app/tips/bulk-editor/page.mdx": "2025-02-14T14:16:04.867Z", "app/tips/lists/page.mdx": "2025-02-14T14:16:04.867Z", "app/settings/sales-channels/page.mdx": "2025-02-19T17:33:55.584Z", @@ -12,7 +12,7 @@ export const generatedEditDates = { "app/orders/page.mdx": "2025-02-17T15:13:42.484Z", "app/settings/users/invites/page.mdx": "2025-02-19T11:38:54.009Z", "app/settings/developer/page.mdx": "2025-02-25T15:11:55.392Z", - "app/settings/profile/page.mdx": "2025-02-25T16:24:21.165Z", + "app/settings/profile/page.mdx": "2025-03-06T08:49:28.814Z", "app/settings/store/page.mdx": "2025-02-26T10:33:07.346Z", "app/products/import/page.mdx": "2025-02-18T12:15:03.830Z", "app/products/categories/page.mdx": "2025-02-19T10:21:42.058Z", diff --git a/www/apps/user-guide/generated/sidebar.mjs b/www/apps/user-guide/generated/sidebar.mjs index 92a3e46990..bd95d8c9bc 100644 --- a/www/apps/user-guide/generated/sidebar.mjs +++ b/www/apps/user-guide/generated/sidebar.mjs @@ -1,166 +1,59 @@ -export const generatedSidebar = [ +export const generatedSidebars = [ { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/", - "title": "Introduction", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/reset-password", - "title": "Reset Password", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Tips", - "autogenerate_path": "/tips", - "children": [ + "sidebar_id": "user-guide", + "title": "User Guide", + "items": [ { "loaded": true, "isPathHref": true, "type": "link", - "path": "/tips/bulk-editor", - "title": "Bulk Editor in Medusa Admin", - "description": "", + "path": "/", + "title": "Introduction", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", - "path": "/tips/languages", - "title": "Languages in Medusa Admin", - "description": "", + "path": "/reset-password", + "title": "Reset Password", "children": [] }, + { + "type": "separator" + }, { "loaded": true, "isPathHref": true, - "type": "link", - "path": "/tips/lists", - "title": "Lists", - "description": "", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Orders", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Overview", - "path": "/orders", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Manage Details", - "path": "/orders/manage", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Manage Payments", - "path": "/orders/payments", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Manage Fulfillments", - "path": "/orders/fulfillments", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Edit Order Items", - "path": "/orders/edit", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Manage Returns", - "path": "/orders/returns", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Manage Exchanges", - "path": "/orders/exchanges", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Manage Claims", - "path": "/orders/claims", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Products", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Overview", - "path": "/products", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Create Product", - "path": "/products/create", + "type": "category", + "title": "Tips", + "autogenerate_path": "/tips", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "title": "Multi-Part Product", - "path": "/products/create/multi-part", + "path": "/tips/bulk-editor", + "title": "Bulk Editor in Medusa Admin", + "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", - "title": "Bundle Product", - "path": "/products/create/bundle", + "path": "/tips/languages", + "title": "Languages in Medusa Admin", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/tips/lists", + "title": "Lists", + "description": "", "children": [] } ] @@ -168,224 +61,71 @@ export const generatedSidebar = [ { "loaded": true, "isPathHref": true, - "type": "link", - "title": "Edit Product", - "path": "/products/edit", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Manage Variants", - "path": "/products/variants", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Manage Collections", - "path": "/products/collections", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Manage Categories", - "path": "/products/categories", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Import Products", - "path": "/products/import", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Export Products", - "path": "/products/export", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Inventory", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Overview", - "path": "/inventory", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Manage Inventory", - "path": "/inventory/inventory", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Manage Reservations", - "path": "/inventory/reservations", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Customers", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Overview", - "path": "/customers", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Manage Customers", - "path": "/customers/manage", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Manage Groups", - "path": "/customers/groups", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Promotions", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Overview", - "path": "/promotions", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Create Promotion", - "path": "/promotions/create", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Manage Promotion", - "path": "/promotions/manage", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Manage Campaigns", - "path": "/promotions/campaigns", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Price Lists", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Overview", - "path": "/price-lists", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Create Price List", - "path": "/price-lists/create", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Manage Price List", - "path": "/price-lists/manage", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Settings", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Overview", - "path": "/settings", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Store", - "path": "/settings/store", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Users", - "path": "/settings/users", + "type": "category", + "title": "Orders", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "title": "Manage Invites", - "path": "/settings/users/invites", + "title": "Overview", + "path": "/orders", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Manage Details", + "path": "/orders/manage", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Manage Payments", + "path": "/orders/payments", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Manage Fulfillments", + "path": "/orders/fulfillments", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Edit Order Items", + "path": "/orders/edit", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Manage Returns", + "path": "/orders/returns", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Manage Exchanges", + "path": "/orders/exchanges", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Manage Claims", + "path": "/orders/claims", "children": [] } ] @@ -393,72 +133,88 @@ export const generatedSidebar = [ { "loaded": true, "isPathHref": true, - "type": "link", - "title": "Regions", - "path": "/settings/regions", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Tax Regions", - "path": "/settings/tax-regions", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Return Reasons", - "path": "/settings/return-reasons", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Sales Channels", - "path": "/settings/sales-channels", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Product Types", - "path": "/settings/product-types", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Product Tags", - "path": "/settings/product-tags", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Location & Shipping", - "path": "/settings/locations-and-shipping", + "type": "category", + "title": "Products", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "title": "Manage Locations", - "path": "/settings/locations-and-shipping/locations", + "title": "Overview", + "path": "/products", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", - "title": "Manage Shipping Profiles", - "path": "/settings/locations-and-shipping/shipping-profiles", + "title": "Create Product", + "path": "/products/create", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Multi-Part Product", + "path": "/products/create/multi-part", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Bundle Product", + "path": "/products/create/bundle", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Edit Product", + "path": "/products/edit", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Manage Variants", + "path": "/products/variants", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Manage Collections", + "path": "/products/collections", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Manage Categories", + "path": "/products/categories", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Import Products", + "path": "/products/import", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Export Products", + "path": "/products/export", "children": [] } ] @@ -466,32 +222,31 @@ export const generatedSidebar = [ { "loaded": true, "isPathHref": true, - "type": "link", - "title": "Developer Settings", - "path": "/settings/developer", + "type": "category", + "title": "Inventory", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "title": "Publishable API Keys", - "path": "/settings/developer/publishable-api-keys", + "title": "Overview", + "path": "/inventory", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", - "title": "Secret API Keys", - "path": "/settings/developer/secret-api-keys", + "title": "Manage Inventory", + "path": "/inventory/inventory", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", - "title": "Workflows", - "path": "/settings/developer/workflows", + "title": "Manage Reservations", + "path": "/inventory/reservations", "children": [] } ] @@ -499,10 +254,261 @@ export const generatedSidebar = [ { "loaded": true, "isPathHref": true, - "type": "link", - "title": "Profile", - "path": "/settings/profile", - "children": [] + "type": "category", + "title": "Customers", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Overview", + "path": "/customers", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Manage Customers", + "path": "/customers/manage", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Manage Groups", + "path": "/customers/groups", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Promotions", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Overview", + "path": "/promotions", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Create Promotion", + "path": "/promotions/create", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Manage Promotion", + "path": "/promotions/manage", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Manage Campaigns", + "path": "/promotions/campaigns", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Price Lists", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Overview", + "path": "/price-lists", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Create Price List", + "path": "/price-lists/create", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Manage Price List", + "path": "/price-lists/manage", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Settings", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Overview", + "path": "/settings", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Store", + "path": "/settings/store", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Users", + "path": "/settings/users", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Manage Invites", + "path": "/settings/users/invites", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Regions", + "path": "/settings/regions", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Tax Regions", + "path": "/settings/tax-regions", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Return Reasons", + "path": "/settings/return-reasons", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Sales Channels", + "path": "/settings/sales-channels", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Product Types", + "path": "/settings/product-types", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Product Tags", + "path": "/settings/product-tags", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Location & Shipping", + "path": "/settings/locations-and-shipping", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Manage Locations", + "path": "/settings/locations-and-shipping/locations", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Manage Shipping Profiles", + "path": "/settings/locations-and-shipping/shipping-profiles", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Developer Settings", + "path": "/settings/developer", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Publishable API Keys", + "path": "/settings/developer/publishable-api-keys", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Secret API Keys", + "path": "/settings/developer/secret-api-keys", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Workflows", + "path": "/settings/developer/workflows", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Profile", + "path": "/settings/profile", + "children": [] + } + ] } ] } diff --git a/www/apps/user-guide/providers/sidebar.tsx b/www/apps/user-guide/providers/sidebar.tsx index e170238727..4a7ac455da 100644 --- a/www/apps/user-guide/providers/sidebar.tsx +++ b/www/apps/user-guide/providers/sidebar.tsx @@ -14,13 +14,8 @@ const SidebarProvider = ({ children }: SidebarProviderProps) => { return ( {children} diff --git a/www/apps/user-guide/sidebar.mjs b/www/apps/user-guide/sidebar.mjs index 51cd3f1d1e..90cb0f447e 100644 --- a/www/apps/user-guide/sidebar.mjs +++ b/www/apps/user-guide/sidebar.mjs @@ -1,320 +1,322 @@ -import { sidebarAttachHrefCommonOptions } from "build-scripts" - -// TODO check the order of items based on the Medusa Admin's sidebar - -/** @type {import('types').RawSidebarItemType[]} */ -export const sidebar = sidebarAttachHrefCommonOptions([ +/** @type {import('types').Sidebar.RawSidebar[]} */ +export const sidebar = [ { - type: "link", - path: "/", - title: "Introduction", - }, - { - type: "link", - path: "/reset-password", - title: "Reset Password", - }, - { - type: "separator", - }, - { - type: "category", - title: "Tips", - autogenerate_path: "/tips", - }, - { - type: "category", - title: "Orders", - children: [ + sidebar_id: "user-guide", + title: "User Guide", + items: [ { type: "link", - title: "Overview", - path: "/orders", + path: "/", + title: "Introduction", }, { type: "link", - title: "Manage Details", - path: "/orders/manage", + path: "/reset-password", + title: "Reset Password", }, { - type: "link", - title: "Manage Payments", - path: "/orders/payments", + type: "separator", }, { - type: "link", - title: "Manage Fulfillments", - path: "/orders/fulfillments", + type: "category", + title: "Tips", + autogenerate_path: "/tips", }, { - type: "link", - title: "Edit Order Items", - path: "/orders/edit", - }, - { - type: "link", - title: "Manage Returns", - path: "/orders/returns", - }, - { - type: "link", - title: "Manage Exchanges", - path: "/orders/exchanges", - }, - { - type: "link", - title: "Manage Claims", - path: "/orders/claims", - }, - ], - }, - { - type: "category", - title: "Products", - children: [ - { - type: "link", - title: "Overview", - path: "/products", - }, - { - type: "link", - title: "Create Product", - path: "/products/create", + type: "category", + title: "Orders", children: [ { type: "link", - title: "Multi-Part Product", - path: "/products/create/multi-part", + title: "Overview", + path: "/orders", }, { type: "link", - title: "Bundle Product", - path: "/products/create/bundle", + title: "Manage Details", + path: "/orders/manage", + }, + { + type: "link", + title: "Manage Payments", + path: "/orders/payments", + }, + { + type: "link", + title: "Manage Fulfillments", + path: "/orders/fulfillments", + }, + { + type: "link", + title: "Edit Order Items", + path: "/orders/edit", + }, + { + type: "link", + title: "Manage Returns", + path: "/orders/returns", + }, + { + type: "link", + title: "Manage Exchanges", + path: "/orders/exchanges", + }, + { + type: "link", + title: "Manage Claims", + path: "/orders/claims", }, ], }, { - type: "link", - title: "Edit Product", - path: "/products/edit", - }, - { - type: "link", - title: "Manage Variants", - path: "/products/variants", - }, - { - type: "link", - title: "Manage Collections", - path: "/products/collections", - }, - { - type: "link", - title: "Manage Categories", - path: "/products/categories", - }, - { - type: "link", - title: "Import Products", - path: "/products/import", - }, - { - type: "link", - title: "Export Products", - path: "/products/export", - }, - ], - }, - { - type: "category", - title: "Inventory", - children: [ - { - type: "link", - title: "Overview", - path: "/inventory", - }, - { - type: "link", - title: "Manage Inventory", - path: "/inventory/inventory", - }, - { - type: "link", - title: "Manage Reservations", - path: "/inventory/reservations", - }, - ], - }, - { - type: "category", - title: "Customers", - children: [ - { - type: "link", - title: "Overview", - path: "/customers", - }, - { - type: "link", - title: "Manage Customers", - path: "/customers/manage", - }, - { - type: "link", - title: "Manage Groups", - path: "/customers/groups", - }, - ], - }, - { - type: "category", - title: "Promotions", - children: [ - { - type: "link", - title: "Overview", - path: "/promotions", - }, - { - type: "link", - title: "Create Promotion", - path: "/promotions/create", - }, - { - type: "link", - title: "Manage Promotion", - path: "/promotions/manage", - }, - { - type: "link", - title: "Manage Campaigns", - path: "/promotions/campaigns", - }, - ], - }, - { - type: "category", - title: "Price Lists", - children: [ - { - type: "link", - title: "Overview", - path: "/price-lists", - }, - { - type: "link", - title: "Create Price List", - path: "/price-lists/create", - }, - { - type: "link", - title: "Manage Price List", - path: "/price-lists/manage", - }, - ], - }, - { - type: "category", - title: "Settings", - children: [ - { - type: "link", - title: "Overview", - path: "/settings", - }, - { - type: "link", - title: "Store", - path: "/settings/store", - }, - { - type: "link", - title: "Users", - path: "/settings/users", + type: "category", + title: "Products", children: [ { type: "link", - title: "Manage Invites", - path: "/settings/users/invites", + title: "Overview", + path: "/products", + }, + { + type: "link", + title: "Create Product", + path: "/products/create", + children: [ + { + type: "link", + title: "Multi-Part Product", + path: "/products/create/multi-part", + }, + { + type: "link", + title: "Bundle Product", + path: "/products/create/bundle", + }, + ], + }, + { + type: "link", + title: "Edit Product", + path: "/products/edit", + }, + { + type: "link", + title: "Manage Variants", + path: "/products/variants", + }, + { + type: "link", + title: "Manage Collections", + path: "/products/collections", + }, + { + type: "link", + title: "Manage Categories", + path: "/products/categories", + }, + { + type: "link", + title: "Import Products", + path: "/products/import", + }, + { + type: "link", + title: "Export Products", + path: "/products/export", }, ], }, { - type: "link", - title: "Regions", - path: "/settings/regions", - }, - { - type: "link", - title: "Tax Regions", - path: "/settings/tax-regions", - }, - { - type: "link", - title: "Return Reasons", - path: "/settings/return-reasons", - }, - { - type: "link", - title: "Sales Channels", - path: "/settings/sales-channels", - }, - { - type: "link", - title: "Product Types", - path: "/settings/product-types", - }, - { - type: "link", - title: "Product Tags", - path: "/settings/product-tags", - }, - { - type: "link", - title: "Location & Shipping", - path: "/settings/locations-and-shipping", + type: "category", + title: "Inventory", children: [ { type: "link", - title: "Manage Locations", - path: "/settings/locations-and-shipping/locations", + title: "Overview", + path: "/inventory", }, { type: "link", - title: "Manage Shipping Profiles", - path: "/settings/locations-and-shipping/shipping-profiles", + title: "Manage Inventory", + path: "/inventory/inventory", + }, + { + type: "link", + title: "Manage Reservations", + path: "/inventory/reservations", }, ], }, { - type: "link", - title: "Developer Settings", - path: "/settings/developer", + type: "category", + title: "Customers", children: [ { type: "link", - title: "Publishable API Keys", - path: "/settings/developer/publishable-api-keys", + title: "Overview", + path: "/customers", }, { type: "link", - title: "Secret API Keys", - path: "/settings/developer/secret-api-keys", + title: "Manage Customers", + path: "/customers/manage", }, { type: "link", - title: "Workflows", - path: "/settings/developer/workflows", + title: "Manage Groups", + path: "/customers/groups", }, ], }, { - type: "link", - title: "Profile", - path: "/settings/profile", + type: "category", + title: "Promotions", + children: [ + { + type: "link", + title: "Overview", + path: "/promotions", + }, + { + type: "link", + title: "Create Promotion", + path: "/promotions/create", + }, + { + type: "link", + title: "Manage Promotion", + path: "/promotions/manage", + }, + { + type: "link", + title: "Manage Campaigns", + path: "/promotions/campaigns", + }, + ], + }, + { + type: "category", + title: "Price Lists", + children: [ + { + type: "link", + title: "Overview", + path: "/price-lists", + }, + { + type: "link", + title: "Create Price List", + path: "/price-lists/create", + }, + { + type: "link", + title: "Manage Price List", + path: "/price-lists/manage", + }, + ], + }, + { + type: "category", + title: "Settings", + children: [ + { + type: "link", + title: "Overview", + path: "/settings", + }, + { + type: "link", + title: "Store", + path: "/settings/store", + }, + { + type: "link", + title: "Users", + path: "/settings/users", + children: [ + { + type: "link", + title: "Manage Invites", + path: "/settings/users/invites", + }, + ], + }, + { + type: "link", + title: "Regions", + path: "/settings/regions", + }, + { + type: "link", + title: "Tax Regions", + path: "/settings/tax-regions", + }, + { + type: "link", + title: "Return Reasons", + path: "/settings/return-reasons", + }, + { + type: "link", + title: "Sales Channels", + path: "/settings/sales-channels", + }, + { + type: "link", + title: "Product Types", + path: "/settings/product-types", + }, + { + type: "link", + title: "Product Tags", + path: "/settings/product-tags", + }, + { + type: "link", + title: "Location & Shipping", + path: "/settings/locations-and-shipping", + children: [ + { + type: "link", + title: "Manage Locations", + path: "/settings/locations-and-shipping/locations", + }, + { + type: "link", + title: "Manage Shipping Profiles", + path: "/settings/locations-and-shipping/shipping-profiles", + }, + ], + }, + { + type: "link", + title: "Developer Settings", + path: "/settings/developer", + children: [ + { + type: "link", + title: "Publishable API Keys", + path: "/settings/developer/publishable-api-keys", + }, + { + type: "link", + title: "Secret API Keys", + path: "/settings/developer/secret-api-keys", + }, + { + type: "link", + title: "Workflows", + path: "/settings/developer/workflows", + }, + ], + }, + { + type: "link", + title: "Profile", + path: "/settings/profile", + }, + ], }, ], }, -]) +] diff --git a/www/packages/build-scripts/src/generate-sidebar.ts b/www/packages/build-scripts/src/generate-sidebar.ts index 411ff02bf3..3e1fb798cc 100644 --- a/www/packages/build-scripts/src/generate-sidebar.ts +++ b/www/packages/build-scripts/src/generate-sidebar.ts @@ -1,12 +1,14 @@ -import type { RawSidebarItem, SidebarItem } from "types" import { existsSync, mkdirSync, readdirSync, statSync } from "fs" import path from "path" -import { getSidebarItemLink, sidebarAttachHrefCommonOptions } from "./index.js" +import { getSidebarItemLink, sidebarAttachCommonOptions } from "./index.js" import getCoreFlowsRefSidebarChildren from "./utils/get-core-flows-ref-sidebar-children.js" import { parseTags } from "./utils/parse-tags.js" import numberSidebarItems from "./utils/number-sidebar-items.js" +import { sortSidebarItems } from "./utils/sidebar-sorting.js" +import { Sidebar } from "types" +import { validateSidebarUniqueIds } from "./utils/validate-sidebar-unique-ids.js" -export type ItemsToAdd = SidebarItem & { +export type ItemsToAdd = Sidebar.SidebarItem & { sidebar_position?: number } @@ -51,9 +53,7 @@ async function getAutogeneratedSidebarItems( loaded: true, }) } else { - items.push( - ...(sidebarAttachHrefCommonOptions(newItems) as ItemsToAdd[]) - ) + items.push(...newItems) } continue } @@ -95,7 +95,7 @@ async function getAutogeneratedSidebarItems( async function getAutogeneratedTagSidebarItems( tags: string, type: "link" | "ref", - existingChildren?: RawSidebarItem[] + existingChildren?: Sidebar.RawSidebarItem[] ): Promise { const items: ItemsToAdd[] = [] @@ -104,13 +104,15 @@ async function getAutogeneratedTagSidebarItems( items.push( ...parsedTags .filter((tagItem) => { - return existingChildren?.every((existingItem) => { - if (existingItem.type !== "link" && existingItem.type !== "ref") { - return true - } + return existingChildren + ? existingChildren.every((existingItem) => { + if (existingItem.type !== "link" && existingItem.type !== "ref") { + return true + } - return existingItem.path !== tagItem.path - }) + return existingItem.path !== tagItem.path + }) + : true }) .map( (tagItem) => @@ -121,10 +123,12 @@ async function getAutogeneratedTagSidebarItems( ) ) - return sidebarAttachHrefCommonOptions([...(existingChildren || []), ...items]) + return sidebarAttachCommonOptions([...(existingChildren || []), ...items]) } -async function checkItem(item: RawSidebarItem): Promise { +async function checkItem( + item: Sidebar.RawSidebarItem +): Promise { if (!item.type) { throw new Error( `ERROR: The following item doesn't have a type: ${JSON.stringify( @@ -137,14 +141,26 @@ async function checkItem(item: RawSidebarItem): Promise { if (item.type === "separator") { return item } + if (item.type === "sidebar" && !item.sidebar_id) { + throw new Error( + `ERROR: The following sidebar item doesn't have a sidebar_id: ${JSON.stringify( + item, + undefined, + 2 + )}` + ) + } if (item.autogenerate_path) { - item.children = ( - await getAutogeneratedSidebarItems(item.autogenerate_path) - ).map((child) => { - delete child.sidebar_position + item.children = [ + ...(item.children || []), + ...(await getAutogeneratedSidebarItems(item.autogenerate_path)).map( + (child) => { + delete child.sidebar_position - return child - }) + return child + } + ), + ] } else if (item.autogenerate_tags) { item.children = await getAutogeneratedTagSidebarItems( item.autogenerate_tags, @@ -155,19 +171,27 @@ async function checkItem(item: RawSidebarItem): Promise { item.custom_autogenerate && Object.hasOwn(customGenerators, item.custom_autogenerate) ) { - item.children = await customGenerators[item.custom_autogenerate]() + item.children = [ + ...(item.children || []), + ...(await customGenerators[item.custom_autogenerate]()), + ] } else if (item.children) { item.children = await checkItems(item.children) } + item.children = sortSidebarItems({ + items: item.children as Sidebar.RawSidebarItem[], + type: item.sort_sidebar, + }) + return item } async function checkItems( - items: RawSidebarItem[], + items: Sidebar.RawSidebarItem[], options?: GenerateSidebarOptions -): Promise { - const updatedItems = ( +): Promise { + let updatedItems = ( await Promise.all(items.map(async (item) => await checkItem(item))) ).filter((item) => { if (item.type !== "category" && item.type !== "sub-category") { @@ -178,20 +202,29 @@ async function checkItems( }) if (options?.addNumbering) { - return numberSidebarItems(updatedItems) + updatedItems = numberSidebarItems(updatedItems) } - return updatedItems + return sidebarAttachCommonOptions(updatedItems) } export async function generateSidebar( - sidebar: RawSidebarItem[], + sidebars: Sidebar.RawSidebar[], options?: GenerateSidebarOptions ): Promise { const path = await import("path") const { writeFileSync } = await import("fs") - const normalizedSidebar = await checkItems(sidebar, options) + const normalizedSidebars: Sidebar.RawSidebar[] = [] + + validateSidebarUniqueIds(sidebars) + + for (const sidebarItem of sidebars) { + normalizedSidebars.push({ + ...sidebarItem, + items: await checkItems(sidebarItem.items, options), + }) + } const generatedDirPath = path.resolve("generated") @@ -202,8 +235,8 @@ export async function generateSidebar( // write normalized sidebar writeFileSync( path.resolve(generatedDirPath, "sidebar.mjs"), - `export const generatedSidebar = ${JSON.stringify( - normalizedSidebar, + `export const generatedSidebars = ${JSON.stringify( + normalizedSidebars, null, 2 )}`, diff --git a/www/packages/build-scripts/src/utils/get-sidebar-item-link.ts b/www/packages/build-scripts/src/utils/get-sidebar-item-link.ts index d30d1ca3bd..3d865e9ee5 100644 --- a/www/packages/build-scripts/src/utils/get-sidebar-item-link.ts +++ b/www/packages/build-scripts/src/utils/get-sidebar-item-link.ts @@ -1,6 +1,6 @@ import { getFrontMatter, findPageTitle } from "docs-utils" -import { ItemsToAdd, sidebarAttachHrefCommonOptions } from "../index.js" -import { InteractiveSidebarItem } from "types" +import { ItemsToAdd, sidebarAttachCommonOptions } from "../index.js" +import { Sidebar } from "types" export async function getSidebarItemLink({ filePath, @@ -16,7 +16,7 @@ export async function getSidebarItemLink({ return } - const newItem = sidebarAttachHrefCommonOptions([ + const newItem = sidebarAttachCommonOptions([ { type: "link", path: @@ -25,7 +25,7 @@ export async function getSidebarItemLink({ title: frontmatter.sidebar_label || findPageTitle(filePath) || "", description: frontmatter.sidebar_description || "", }, - ])[0] as InteractiveSidebarItem + ])[0] as Sidebar.InteractiveSidebarItem return { ...newItem, diff --git a/www/packages/build-scripts/src/utils/number-sidebar-items.ts b/www/packages/build-scripts/src/utils/number-sidebar-items.ts index d6539d1ccc..8e03efd9ce 100644 --- a/www/packages/build-scripts/src/utils/number-sidebar-items.ts +++ b/www/packages/build-scripts/src/utils/number-sidebar-items.ts @@ -1,15 +1,15 @@ -import { InteractiveSidebarItem, SidebarItem, SidebarItemCategory } from "types" +import { Sidebar } from "types" export default function numberSidebarItems( - sidebarItems: SidebarItem[], + sidebarItems: Sidebar.SidebarItem[], numbering = [1] -): SidebarItem[] { +): Sidebar.SidebarItem[] { if (!numbering.length) { numbering.push(1) } const isTopItems = numbering.length === 1 - const numberedItems: SidebarItem[] = [] - let parentItem: InteractiveSidebarItem | undefined + const numberedItems: Sidebar.SidebarItem[] = [] + let parentItem: Sidebar.InteractiveSidebarItem | undefined sidebarItems.forEach((item) => { if (item.type === "separator") { ;(parentItem?.children || numberedItems).push(item) @@ -17,16 +17,19 @@ export default function numberSidebarItems( } // append current number to the item's title - item.chapterTitle = `${numbering.join(".")}. ${ + const currentNumbering = `${numbering.join(".")}.` + item.chapterTitle = `${currentNumbering} ${ item.chapterTitle?.trim() || item.title?.trim() }` item.title = item.title.trim() + item.number = currentNumbering if (isTopItems) { // Add chapter category numberedItems.push( item.type === "category" ? { + initialOpen: false, ...item, title: item.chapterTitle, } @@ -41,7 +44,7 @@ export default function numberSidebarItems( parentItem = numberedItems[ numberedItems.length - 1 - ] as SidebarItemCategory + ] as Sidebar.SidebarItemCategory } if (item.children) { diff --git a/www/packages/build-scripts/src/utils/sidebar-attach-href-common-options.ts b/www/packages/build-scripts/src/utils/sidebar-attach-href-common-options.ts index bb44f8b048..b4e780feae 100644 --- a/www/packages/build-scripts/src/utils/sidebar-attach-href-common-options.ts +++ b/www/packages/build-scripts/src/utils/sidebar-attach-href-common-options.ts @@ -1,13 +1,13 @@ -import { RawSidebarItem } from "types" +import { Sidebar } from "types" -const commonOptions: Partial = { +const commonOptions: Partial = { loaded: true, isPathHref: true, } -export function sidebarAttachHrefCommonOptions( - sidebar: RawSidebarItem[] -): RawSidebarItem[] { +export function sidebarAttachCommonOptions( + sidebar: Sidebar.RawSidebarItem[] +): Sidebar.RawSidebarItem[] { return sidebar.map((item) => { if (item.type === "separator") { return item @@ -16,7 +16,7 @@ export function sidebarAttachHrefCommonOptions( return { ...commonOptions, ...item, - children: sidebarAttachHrefCommonOptions(item.children || []), + children: sidebarAttachCommonOptions(item.children || []), } }) } diff --git a/www/packages/build-scripts/src/utils/sidebar-sorting.ts b/www/packages/build-scripts/src/utils/sidebar-sorting.ts new file mode 100644 index 0000000000..5303bd3417 --- /dev/null +++ b/www/packages/build-scripts/src/utils/sidebar-sorting.ts @@ -0,0 +1,51 @@ +import { Sidebar } from "types" + +type Options = { + items: Sidebar.RawSidebarItem[] + type?: Sidebar.SidebarSortType +} + +export const sortSidebarItems = ({ + items, + type = "none", +}: Options): Sidebar.RawSidebarItem[] => { + switch (type) { + case "alphabetize": + return alphabetizeSidebarItems(items) + default: + return items + } +} + +const alphabetizeSidebarItems = ( + items: Sidebar.RawSidebarItem[] +): Sidebar.RawSidebarItem[] => { + const segments: Sidebar.RawSidebarItem[][] = [] + let currentSegment: Sidebar.RawSidebarItem[] = [] + + items.forEach((item) => { + if (item.type === "separator") { + if (currentSegment.length > 0) { + segments.push(currentSegment) + currentSegment = [] + } + segments.push([item]) + } else { + currentSegment.push(item) + } + }) + + if (currentSegment.length > 0) { + segments.push(currentSegment) + } + + return segments + .map((segment) => { + return segment[0].type === "separator" + ? segment + : (segment as Sidebar.InteractiveSidebarItem[]).sort((a, b) => + a.title.localeCompare(b.title) + ) + }) + .flat() +} diff --git a/www/packages/build-scripts/src/utils/validate-sidebar-unique-ids.ts b/www/packages/build-scripts/src/utils/validate-sidebar-unique-ids.ts new file mode 100644 index 0000000000..684b7d0fdb --- /dev/null +++ b/www/packages/build-scripts/src/utils/validate-sidebar-unique-ids.ts @@ -0,0 +1,22 @@ +import { Sidebar } from "types" + +export const validateSidebarUniqueIds = ( + sidebars: (Sidebar.RawSidebar | Sidebar.SidebarItemSidebar)[], + sidebarIds = new Set() +): void => { + for (const sidebar of sidebars) { + if (sidebarIds.has(sidebar.sidebar_id)) { + throw new Error(`Duplicate sidebar item id found: ${sidebar.sidebar_id}`) + } + + sidebarIds.add(sidebar.sidebar_id) + + const children = ( + "items" in sidebar ? sidebar.items : sidebar.children || [] + ).filter( + (child) => child.type === "sidebar" + ) as Sidebar.SidebarItemSidebar[] + + validateSidebarUniqueIds(children, sidebarIds) + } +} diff --git a/www/packages/docs-ui/package.json b/www/packages/docs-ui/package.json index a1b6b09551..11081abc9b 100644 --- a/www/packages/docs-ui/package.json +++ b/www/packages/docs-ui/package.json @@ -57,8 +57,8 @@ }, "dependencies": { "@emotion/is-prop-valid": "^1.3.1", - "@medusajs/icons": "~2.5.1", - "@medusajs/ui": "~4.0.6", + "@medusajs/icons": "2.6.0", + "@medusajs/ui": "4.0.6", "@next/third-parties": "15.0.4", "@octokit/request": "^8.1.1", "@react-hook/resize-observer": "^1.2.6", diff --git a/www/packages/docs-ui/src/components/Breadcrumbs/index.tsx b/www/packages/docs-ui/src/components/Breadcrumbs/index.tsx index e794c9f34c..97fc268ec2 100644 --- a/www/packages/docs-ui/src/components/Breadcrumbs/index.tsx +++ b/www/packages/docs-ui/src/components/Breadcrumbs/index.tsx @@ -3,98 +3,53 @@ import React, { useMemo } from "react" import clsx from "clsx" import Link from "next/link" -import { SidebarItemLink } from "types" -import { - CurrentItemsState, - isSidebarItemLink, - useSidebar, - useSiteConfig, -} from "../../providers" +import { useSidebar, useSiteConfig } from "../../providers" import { Button } from "../Button" import { TriangleRightMini } from "@medusajs/icons" +import { Sidebar } from "types" + +type BreadcrumbItems = { + title: string + link: string +}[] export const Breadcrumbs = () => { - const { currentItems, activeItem: sidebarActiveItem } = useSidebar() + const { sidebarHistory, getSidebarFirstLinkChild, getSidebar } = useSidebar() const { - config: { breadcrumbOptions, project, baseUrl, basePath }, + config: { breadcrumbOptions }, } = useSiteConfig() - const getLinkPath = (item?: SidebarItemLink): string | undefined => { - if (!item) { - return - } + const getLinkPath = (item: Sidebar.SidebarItemLink): string => { return item.isPathHref ? item.path : `#${item.path}` } - const getBreadcrumbsOfItem = ( - item: CurrentItemsState - ): Map => { - let tempBreadcrumbItems: Map = new Map() - if (item.previousSidebar) { - tempBreadcrumbItems = getBreadcrumbsOfItem(item.previousSidebar) - } - - const parentPath = isSidebarItemLink(item.parentItem) - ? getLinkPath(item.parentItem) - : (item.parentItem?.type === "category" && - breadcrumbOptions?.showCategories) || - item.parentItem?.type === "sub-category" - ? "#" - : undefined - const firstItemPath = isSidebarItemLink(item.default[0]) - ? getLinkPath(item.default[0]) - : (item.default[0].type === "category" && - breadcrumbOptions?.showCategories) || - item.default[0].type === "sub-category" - ? "#" - : undefined - - const breadcrumbPath = parentPath || firstItemPath || "/" - - tempBreadcrumbItems.set( - breadcrumbPath, - item.parentItem?.childSidebarTitle || - item.parentItem?.chapterTitle || - item.parentItem?.title || - "" - ) - - return tempBreadcrumbItems - } - const breadcrumbItems = useMemo(() => { - const tempBreadcrumbItems: Map = new Map() - tempBreadcrumbItems.set(`${baseUrl}${basePath}`, project.title) - - if (currentItems) { - getBreadcrumbsOfItem(currentItems).forEach((value, key) => - tempBreadcrumbItems.set(key, value) - ) + const items: BreadcrumbItems = [] + if (breadcrumbOptions?.startItems) { + items.push(...breadcrumbOptions.startItems) } - if (sidebarActiveItem) { - if ( - sidebarActiveItem.parentItem && - (sidebarActiveItem.parentItem.type !== "category" || - breadcrumbOptions?.showCategories) - ) { - tempBreadcrumbItems.set( - isSidebarItemLink(sidebarActiveItem.parentItem) - ? getLinkPath(sidebarActiveItem.parentItem) || "#" - : "#", - sidebarActiveItem.parentItem.chapterTitle || - sidebarActiveItem.parentItem.title || - "" - ) + sidebarHistory.forEach((sidebar_id) => { + const sidebar = getSidebar(sidebar_id) + + if (!sidebar) { + return } - tempBreadcrumbItems.set( - getLinkPath(sidebarActiveItem) || "/", - sidebarActiveItem.chapterTitle || sidebarActiveItem.title || "" - ) - } - return tempBreadcrumbItems - }, [currentItems, sidebarActiveItem, breadcrumbOptions]) + const sidebarFirstChild = getSidebarFirstLinkChild(sidebar) + + if (!sidebarFirstChild) { + return + } + + items.push({ + title: sidebar.title, + link: getLinkPath(sidebarFirstChild), + }) + }) + + return items + }, [sidebarHistory, breadcrumbOptions]) return (
{ "mb-docs_1 flex-wrap" )} > - {Array.from(breadcrumbItems).map(([link, title], index) => ( + {breadcrumbItems.map(({ title, link }, index) => ( {index > 0 && }
) diff --git a/www/packages/docs-ui/src/components/Sidebar/Item/Category/index.tsx b/www/packages/docs-ui/src/components/Sidebar/Item/Category/index.tsx index 92831fb373..ee6412ce5e 100644 --- a/www/packages/docs-ui/src/components/Sidebar/Item/Category/index.tsx +++ b/www/packages/docs-ui/src/components/Sidebar/Item/Category/index.tsx @@ -3,34 +3,37 @@ // @refresh reset import React, { useEffect, useMemo, useState } from "react" -import { SidebarItemCategory as SidebarItemCategoryType } from "types" +import { Sidebar } from "types" import { Loading, SidebarItem, useSidebar } from "../../../.." import clsx from "clsx" import { MinusMini, PlusMini } from "@medusajs/icons" -export type SidebarItemCategory = { - item: SidebarItemCategoryType - expandItems?: boolean +export type SidebarItemCategoryProps = { + item: Sidebar.SidebarItemCategory } & React.AllHTMLAttributes export const SidebarItemCategory = ({ item, - expandItems = true, className, -}: SidebarItemCategory) => { +}: SidebarItemCategoryProps) => { const [showLoading, setShowLoading] = useState(false) const [open, setOpen] = useState( - item.initialOpen !== undefined ? item.initialOpen : expandItems + item.initialOpen !== undefined ? item.initialOpen : true ) const { - isChildrenActive, + isItemActive, updatePersistedCategoryState, getPersistedCategoryState, - persistState, + persistCategoryState, } = useSidebar() const itemShowLoading = useMemo(() => { return !item.loaded || (item.showLoadingIfEmpty && !item.children?.length) }, [item]) + const isActive = useMemo(() => { + return isItemActive({ + item, + }) + }, [isItemActive, item]) useEffect(() => { if (open && itemShowLoading) { @@ -45,22 +48,20 @@ export const SidebarItemCategory = ({ }, [itemShowLoading, showLoading]) useEffect(() => { - const isActive = isChildrenActive(item) - if (isActive && !open) { setOpen(true) } - }, [isChildrenActive, item.children]) + }, [isActive, item.children]) useEffect(() => { - if (!persistState) { + if (!persistCategoryState) { return } const persistedOpen = getPersistedCategoryState(item.title) - if (persistedOpen !== undefined) { + if (persistedOpen !== undefined && !isActive) { setOpen(persistedOpen) } - }, [persistState]) + }, [persistCategoryState]) const handleOpen = () => { item.onOpen?.() @@ -90,7 +91,7 @@ export const SidebarItemCategory = ({ if (!open) { handleOpen() } - if (persistState) { + if (persistCategoryState) { updatePersistedCategoryState(item.title, !open) } setOpen((prev) => !prev) @@ -133,7 +134,7 @@ export const SidebarItemCategory = ({ ))} diff --git a/www/packages/docs-ui/src/components/Sidebar/Item/Link/index.tsx b/www/packages/docs-ui/src/components/Sidebar/Item/Link/index.tsx index d61ec8fc56..e0c688e090 100644 --- a/www/packages/docs-ui/src/components/Sidebar/Item/Link/index.tsx +++ b/www/packages/docs-ui/src/components/Sidebar/Item/Link/index.tsx @@ -2,8 +2,8 @@ // @refresh reset -import React, { useEffect, useMemo, useRef } from "react" -import { SidebarItemLink as SidebarItemlinkType } from "types" +import React, { useCallback, useEffect, useMemo, useRef } from "react" +import { Sidebar } from "types" import { checkSidebarItemVisibility, SidebarItem, @@ -14,27 +14,36 @@ import clsx from "clsx" import Link from "next/link" export type SidebarItemLinkProps = { - item: SidebarItemlinkType + item: Sidebar.SidebarItemLink nested?: boolean + isParentCategoryOpen?: boolean } & React.AllHTMLAttributes export const SidebarItemLink = ({ item, className, nested = false, + isParentCategoryOpen, }: SidebarItemLinkProps) => { const { - isLinkActive, + isItemActive, setMobileSidebarOpen: setSidebarOpen, disableActiveTransition, sidebarRef, sidebarTopHeight, } = useSidebar() const { isMobile } = useMobile() - const active = useMemo(() => isLinkActive(item, true), [isLinkActive, item]) + const active = useMemo( + () => + isItemActive({ + item, + checkLinkChildren: false, + }), + [isItemActive, item] + ) const ref = useRef(null) - const newTopCalculator = useMemo(() => { + const getNewTopCalculator = useCallback(() => { if (!sidebarRef.current || !ref.current) { return 0 } @@ -48,33 +57,43 @@ export const SidebarItemLink = ({ sidebarRef.current.scrollTop - 10 // remove extra margin just in case ) - }, [sidebarTopHeight, sidebarRef, ref]) + }, [sidebarTopHeight, sidebarRef.current, ref.current]) useEffect(() => { - if (active && ref.current && sidebarRef.current && !isMobile) { - const isVisible = checkSidebarItemVisibility( - (ref.current.children.item(0) as HTMLElement) || ref.current, - !disableActiveTransition - ) - if (isVisible) { - return - } - if (!disableActiveTransition) { - ref.current.scrollIntoView({ - block: "center", - }) - } else { - sidebarRef.current.scrollTo({ - top: newTopCalculator, - }) - } + if ( + !active || + !ref.current || + !sidebarRef.current || + isMobile || + !isParentCategoryOpen + ) { + return + } + + const isVisible = checkSidebarItemVisibility( + (ref.current.children.item(0) as HTMLElement) || ref.current, + !disableActiveTransition + ) + if (isVisible) { + return + } + if (!disableActiveTransition) { + ref.current.scrollIntoView({ + block: "center", + }) + } else { + sidebarRef.current.scrollTo({ + top: getNewTopCalculator(), + }) } }, [ active, sidebarRef.current, disableActiveTransition, isMobile, - newTopCalculator, + ref.current, + getNewTopCalculator, + isParentCategoryOpen, ]) useEffect(() => { @@ -84,11 +103,7 @@ export const SidebarItemLink = ({ }, [active, isMobile]) const hasChildren = useMemo(() => { - return ( - !item.isChildSidebar && - !item.hideChildren && - (item.children?.length || 0) > 0 - ) + return !item.hideChildren && (item.children?.length || 0) > 0 }, [item.children]) const isTitleOneWord = useMemo( @@ -119,6 +134,8 @@ export const SidebarItemLink = ({ "flex justify-between items-center gap-[6px]", className )} + target={item.type === "external" ? "_blank" : undefined} + rel={item.type === "external" ? "noopener noreferrer" : undefined} {...item.linkProps} > ))} diff --git a/www/packages/docs-ui/src/components/Sidebar/Item/Sidebar/index.tsx b/www/packages/docs-ui/src/components/Sidebar/Item/Sidebar/index.tsx new file mode 100644 index 0000000000..60ced0c3ff --- /dev/null +++ b/www/packages/docs-ui/src/components/Sidebar/Item/Sidebar/index.tsx @@ -0,0 +1,63 @@ +"use client" + +// @refresh reset + +import React, { useMemo } from "react" +import { Sidebar } from "types" +import { useSidebar } from "../../../.." +import clsx from "clsx" +import Link from "next/link" + +export type SidebarItemSidebarProps = { + item: Sidebar.SidebarItemSidebar + nested?: boolean +} & React.AllHTMLAttributes + +export const SidebarItemSidebar = ({ + item, + className, + nested = false, +}: SidebarItemSidebarProps) => { + const { getSidebarFirstLinkChild: getSidebarFirstChild } = useSidebar() + + const isTitleOneWord = useMemo( + () => item.title.split(" ").length === 1, + [item.title] + ) + + const firstChild = useMemo(() => getSidebarFirstChild(item), [item]) + + return ( +
  • + + + + {item.title} + + {item.additionalElms} + + +
    • + ) +} diff --git a/www/packages/docs-ui/src/components/Sidebar/Item/SubCategory/index.tsx b/www/packages/docs-ui/src/components/Sidebar/Item/SubCategory/index.tsx index ae9c9e6a9c..31e22cedf5 100644 --- a/www/packages/docs-ui/src/components/Sidebar/Item/SubCategory/index.tsx +++ b/www/packages/docs-ui/src/components/Sidebar/Item/SubCategory/index.tsx @@ -2,90 +2,25 @@ // @refresh reset -import React, { useEffect, useMemo, useRef } from "react" -import { SidebarItemSubCategory as SidebarItemSubCategoryType } from "types" -import { - checkSidebarItemVisibility, - SidebarItem, - useMobile, - useSidebar, -} from "../../../.." +import React, { useMemo, useRef } from "react" +import { Sidebar } from "types" +import { SidebarItem } from "../../../.." import clsx from "clsx" -export type SidebarItemLinkProps = { - item: SidebarItemSubCategoryType +export type SidebarItemSubCategoryProps = { + item: Sidebar.SidebarItemSubCategory nested?: boolean + isParentCategoryOpen?: boolean } & React.AllHTMLAttributes export const SidebarItemSubCategory = ({ item, className, nested = false, -}: SidebarItemLinkProps) => { - const { isLinkActive, disableActiveTransition, sidebarRef } = useSidebar() - const { isMobile } = useMobile() - const active = useMemo( - () => !isMobile && isLinkActive(item, true), - [isLinkActive, item, isMobile] - ) + isParentCategoryOpen, +}: SidebarItemSubCategoryProps) => { const ref = useRef(null) - /** - * Tries to place the item in the center of the sidebar - */ - const newTopCalculator = (): number => { - if (!sidebarRef.current || !ref.current) { - return 0 - } - const sidebarBoundingRect = sidebarRef.current.getBoundingClientRect() - const sidebarHalf = sidebarBoundingRect.height / 2 - const itemTop = ref.current.offsetTop - const itemBottom = - itemTop + (ref.current.children.item(0) as HTMLElement)?.clientHeight - - // try deducting half - let newTop = itemTop - sidebarHalf - let newBottom = newTop + sidebarBoundingRect.height - if (newTop <= itemTop && newBottom >= itemBottom) { - return newTop - } - - // try adding half - newTop = itemTop + sidebarHalf - newBottom = newTop + sidebarBoundingRect.height - if (newTop <= itemTop && newBottom >= itemBottom) { - return newTop - } - - //return the item's top minus some top margin - return itemTop - sidebarBoundingRect.top - } - - useEffect(() => { - if ( - active && - ref.current && - sidebarRef.current && - window.innerWidth >= 1025 - ) { - if ( - !disableActiveTransition && - !checkSidebarItemVisibility( - (ref.current.children.item(0) as HTMLElement) || ref.current, - !disableActiveTransition - ) - ) { - ref.current.scrollIntoView({ - block: "center", - }) - } else if (disableActiveTransition) { - sidebarRef.current.scrollTo({ - top: newTopCalculator(), - }) - } - } - }, [active, sidebarRef.current, disableActiveTransition]) - const hasChildren = useMemo(() => { return !item.hideChildren && (item.children?.length || 0) > 0 }, [item.children]) @@ -103,15 +38,8 @@ export const SidebarItemSubCategory = ({ "py-docs_0.25 px-docs_0.5", "block w-full", !isTitleOneWord && "break-words", - active && [ - "rounded-docs_sm", - "shadow-borders-base dark:shadow-borders-base-dark", - "text-medusa-fg-base", - ], - !active && [ - !nested && "text-medusa-fg-subtle", - nested && "text-medusa-fg-muted", - ], + !nested && "text-medusa-fg-subtle", + nested && "text-medusa-fg-muted", "text-compact-small-plus", className )} @@ -140,6 +68,7 @@ export const SidebarItemSubCategory = ({ item={childItem} key={index} nested={!item.childrenSameLevel} + isParentCategoryOpen={isParentCategoryOpen} /> ))} diff --git a/www/packages/docs-ui/src/components/Sidebar/Item/index.tsx b/www/packages/docs-ui/src/components/Sidebar/Item/index.tsx index 0072d1690b..dad8e8e663 100644 --- a/www/packages/docs-ui/src/components/Sidebar/Item/index.tsx +++ b/www/packages/docs-ui/src/components/Sidebar/Item/index.tsx @@ -1,17 +1,18 @@ "use client" import React from "react" -import { SidebarItem as SidebarItemType } from "types" -import { SidebarItemCategory } from "./Category" +import { Sidebar } from "types" import { SidebarItemLink } from "./Link" import { SidebarItemSubCategory } from "./SubCategory" import { DottedSeparator } from "../.." +import { SidebarItemCategory } from "./Category" +import { SidebarItemSidebar } from "./Sidebar" export type SidebarItemProps = { - item: SidebarItemType + item: Sidebar.SidebarItem nested?: boolean - expandItems?: boolean hasNextItems?: boolean + isParentCategoryOpen?: boolean } & React.AllHTMLAttributes export const SidebarItem = ({ @@ -31,7 +32,10 @@ export const SidebarItem = ({ return case "link": case "ref": + case "external": return + case "sidebar": + return case "separator": return } diff --git a/www/packages/docs-ui/src/components/Sidebar/Top/index.tsx b/www/packages/docs-ui/src/components/Sidebar/Top/index.tsx index 604809e3ff..964b39b9ca 100644 --- a/www/packages/docs-ui/src/components/Sidebar/Top/index.tsx +++ b/www/packages/docs-ui/src/components/Sidebar/Top/index.tsx @@ -2,17 +2,14 @@ import React from "react" import { SidebarChild } from "../Child" -import { InteractiveSidebarItem } from "types" import { SidebarTopMobileClose } from "./MobileClose" -import { DottedSeparator } from "../../.." +import { DottedSeparator, useSidebar } from "../../.." import clsx from "clsx" -export type SidebarTopProps = { - parentItem?: InteractiveSidebarItem -} +export const SidebarTop = React.forwardRef( + function SidebarTop(props, ref) { + const { sidebarHistory } = useSidebar() -export const SidebarTop = React.forwardRef( - function SidebarTop({ parentItem }, ref) { return (
    ( >
    - {parentItem && ( + {sidebarHistory.length > 1 && ( <> - + )} diff --git a/www/packages/docs-ui/src/components/Sidebar/index.tsx b/www/packages/docs-ui/src/components/Sidebar/index.tsx index cdde5f23ec..70fb094dfa 100644 --- a/www/packages/docs-ui/src/components/Sidebar/index.tsx +++ b/www/packages/docs-ui/src/components/Sidebar/index.tsx @@ -1,39 +1,35 @@ "use client" import React, { Suspense, useMemo, useRef } from "react" -import { isSidebarItemLink, useSidebar } from "@/providers" +import { useSidebar } from "@/providers" import clsx from "clsx" import { Loading } from "@/components" import { SidebarItem } from "./Item" // @ts-expect-error can't install the types package because it doesn't support React v19 import { CSSTransition, SwitchTransition } from "react-transition-group" -import { SidebarTop, SidebarTopProps } from "./Top" +import { SidebarTop } from "./Top" import { useClickOutside, useKeyboardShortcut } from "@/hooks" import useResizeObserver from "@react-hook/resize-observer" +import { isSidebarItemLink } from "../../utils/sidebar-utils" export type SidebarProps = { className?: string - expandItems?: boolean - sidebarTopProps?: Omit } -export const Sidebar = ({ - className = "", - expandItems = true, - sidebarTopProps, -}: SidebarProps) => { +export const Sidebar = ({ className = "" }: SidebarProps) => { const sidebarWrapperRef = useRef(null) const sidebarTopRef = useRef(null) const { - items, - currentItems, + sidebars, + shownSidebar, mobileSidebarOpen, setMobileSidebarOpen, - staticSidebarItems, + isSidebarStatic, sidebarRef, desktopSidebarOpen, setDesktopSidebarOpen, setSidebarTopHeight, + sidebarHistory, } = useSidebar() useClickOutside({ elmRef: sidebarWrapperRef, @@ -51,15 +47,16 @@ export const Sidebar = ({ }, }) - const sidebarItems = useMemo( - () => currentItems || items, - [items, currentItems] - ) - useResizeObserver(sidebarTopRef as React.RefObject, () => { setSidebarTopHeight(sidebarTopRef.current?.clientHeight || 0) }) + const sidebarItems = useMemo(() => { + return shownSidebar && "items" in shownSidebar + ? shownSidebar.items + : shownSidebar?.children || [] + }, [shownSidebar]) + return ( <> {mobileSidebarOpen && ( @@ -94,7 +91,11 @@ export const Sidebar = ({
      - - {/* MOBILE SIDEBAR - keeping this in case we need it in the future */} - {/*
      - {!sidebarItems.mobile.length && !staticSidebarItems && ( - - )} - {sidebarItems.mobile.map((item, index) => ( - - ))} - {sidebarItems.mobile.length > 0 && } -
      */} - {/* DESKTOP SIDEBAR */} +
      - {!sidebarItems.default.length && !staticSidebarItems && ( - + {!sidebarItems.length && !isSidebarStatic && ( + )} - {sidebarItems.default.map((item, index) => { + {sidebarItems.map((item, index) => { const itemKey = item.type === "separator" ? index @@ -155,10 +136,7 @@ export const Sidebar = ({ > ) diff --git a/www/packages/docs-ui/src/hooks/use-child-docs/index.tsx b/www/packages/docs-ui/src/hooks/use-child-docs/index.tsx index f57107d26b..01239b4df5 100644 --- a/www/packages/docs-ui/src/hooks/use-child-docs/index.tsx +++ b/www/packages/docs-ui/src/hooks/use-child-docs/index.tsx @@ -9,17 +9,17 @@ import { H3, H4, Hr, - isSidebarItemLink, LocalSearch, MarkdownContent, SearchInput, useIsBrowser, useSidebar, } from "../.." -import { InteractiveSidebarItem, SidebarItem, SidebarItemLink } from "types" +import { Sidebar } from "types" import slugify from "slugify" import { MDXComponents } from "../.." import { ChevronDoubleRight, ExclamationCircle } from "@medusajs/icons" +import { isSidebarItemLink } from "../../utils/sidebar-utils" type HeadingComponent = ( props: React.HTMLAttributes @@ -60,11 +60,11 @@ export const useChildDocs = ({ ...searchProps } = { enable: false }, }: UseChildDocsProps) => { - const { currentItems, activeItem } = useSidebar() + const { shownSidebar, activeItem } = useSidebar() const { isBrowser } = useIsBrowser() const [searchQuery, setSearchQuery] = useState("") const [localSearch, setLocalSearch] = useState< - LocalSearch | undefined + LocalSearch | undefined >() const TitleHeaderComponent = useCallback( (level: number): HeadingComponent => { @@ -91,7 +91,7 @@ export const useChildDocs = ({ : "all" }, [showItems, hideItems]) - const filterCondition = (item: SidebarItem): boolean => { + const filterCondition = (item: Sidebar.SidebarItem): boolean => { if (item.type === "separator") { return false } @@ -111,8 +111,10 @@ export const useChildDocs = ({ } } - const filterItems = (items: SidebarItem[]): InteractiveSidebarItem[] => { - return (items.filter(filterCondition) as InteractiveSidebarItem[]) + const filterItems = ( + items: Sidebar.SidebarItem[] + ): Sidebar.InteractiveSidebarItem[] => { + return (items.filter(filterCondition) as Sidebar.InteractiveSidebarItem[]) .map((item) => Object.assign({}, item)) .map((item) => { if (item.children && filterType === "hide") { @@ -124,19 +126,19 @@ export const useChildDocs = ({ } const filterNonInteractiveItems = ( - items: SidebarItem[] | undefined - ): InteractiveSidebarItem[] => { + items: Sidebar.SidebarItem[] | undefined + ): Sidebar.InteractiveSidebarItem[] => { return ( (items?.filter( (item) => item.type !== "separator" - ) as InteractiveSidebarItem[]) || [] + ) as Sidebar.InteractiveSidebarItem[]) || [] ) } const getChildrenForLevel = ( - item: InteractiveSidebarItem, + item: Sidebar.InteractiveSidebarItem, currentLevel = 1 - ): InteractiveSidebarItem[] | undefined => { + ): Sidebar.InteractiveSidebarItem[] | undefined => { if (currentLevel === childLevel) { return filterNonInteractiveItems(item.children) } @@ -144,7 +146,7 @@ export const useChildDocs = ({ return } - const childrenResult: InteractiveSidebarItem[] = [] + const childrenResult: Sidebar.InteractiveSidebarItem[] = [] filterNonInteractiveItems(item.children).forEach((child) => { const childChildren = getChildrenForLevel(child, currentLevel + 1) @@ -162,34 +164,24 @@ export const useChildDocs = ({ const filteredItems = useMemo(() => { let targetItems = type === "sidebar" - ? currentItems - ? Object.assign({}, currentItems) - : undefined - : { - default: [...(activeItem?.children || [])], - } + ? shownSidebar && "items" in shownSidebar + ? shownSidebar.items + : shownSidebar?.children || [] + : [...(activeItem?.children || [])] if (filterType !== "all" && targetItems) { - targetItems = { - ...targetItems, - default: filterItems(targetItems.default), - } + targetItems = filterItems(targetItems) } - return targetItems - ? { - ...targetItems, - default: filterNonInteractiveItems(targetItems?.default), - } - : undefined - }, [currentItems, type, activeItem, filterType]) + return filterNonInteractiveItems(targetItems) + }, [shownSidebar, type, activeItem, filterType]) const searchableItems = useMemo(() => { - const searchableItems: SidebarItemLink[] = [] + const searchableItems: Sidebar.SidebarItemLink[] = [] if (!enableSearch) { return searchableItems } if (onlyTopLevel) { - filteredItems?.default?.forEach((item) => { + filteredItems.forEach((item) => { if (isSidebarItemLink(item)) { searchableItems.push(item) } else { @@ -197,16 +189,16 @@ export const useChildDocs = ({ isSidebarItemLink(child) ) if (firstChild) { - searchableItems.push(firstChild as SidebarItemLink) + searchableItems.push(firstChild as Sidebar.SidebarItemLink) } } }) } else { - filteredItems?.default?.forEach((item) => { - const childItems: SidebarItemLink[] = + filteredItems?.forEach((item) => { + const childItems: Sidebar.SidebarItemLink[] = (getChildrenForLevel(item)?.filter((childItem) => { return isSidebarItemLink(childItem) - }) as SidebarItemLink[]) || [] + }) as Sidebar.SidebarItemLink[]) || [] searchableItems.push(...childItems) }) } @@ -224,7 +216,7 @@ export const useChildDocs = ({ } setLocalSearch( - getLocalSearch({ + getLocalSearch({ docs: searchableItems, searchableFields: ["title", "description"], options: { @@ -263,7 +255,7 @@ export const useChildDocs = ({ localStorage.setItem(`${storageKey}-query`, searchQuery) }, [isBrowser, searchQuery, storageKey, enableSearch]) - const getTopLevelElms = (items?: InteractiveSidebarItem[]) => { + const getTopLevelElms = (items?: Sidebar.InteractiveSidebarItem[]) => { return ( isSidebarItemLink(item) - ) as SidebarItemLink + ) as Sidebar.SidebarItemLink )?.path : "#" return { @@ -292,7 +284,7 @@ export const useChildDocs = ({ } const getAllLevelsElms = ( - items?: InteractiveSidebarItem[], + items?: Sidebar.InteractiveSidebarItem[], headerLevel = titleLevel ) => { return items?.map((item, key) => { @@ -405,8 +397,8 @@ export const useChildDocs = ({ {!searchQuery && ( <> {onlyTopLevel - ? getTopLevelElms(filteredItems?.default) - : getAllLevelsElms(filteredItems?.default)} + ? getTopLevelElms(filteredItems) + : getAllLevelsElms(filteredItems)} )} diff --git a/www/packages/docs-ui/src/layouts/main-content.tsx b/www/packages/docs-ui/src/layouts/main-content.tsx index b012949562..61b56d74a3 100644 --- a/www/packages/docs-ui/src/layouts/main-content.tsx +++ b/www/packages/docs-ui/src/layouts/main-content.tsx @@ -1,9 +1,8 @@ "use client" import React, { useEffect } from "react" -import { useSidebar } from "../providers/Sidebar" import clsx from "clsx" -import { MainNav, useIsBrowser, useLayout } from ".." +import { MainNav, useIsBrowser, useLayout, useSidebar } from ".." export type MainContentLayoutProps = { mainWrapperClasses?: string diff --git a/www/packages/docs-ui/src/providers/Pagination/index.tsx b/www/packages/docs-ui/src/providers/Pagination/index.tsx index 8788edbfc6..bdf409baa2 100644 --- a/www/packages/docs-ui/src/providers/Pagination/index.tsx +++ b/www/packages/docs-ui/src/providers/Pagination/index.tsx @@ -1,15 +1,10 @@ "use client" -import React, { - createContext, - useContext, - useEffect, - useMemo, - useState, -} from "react" -import { isSidebarItemLink, useSidebar } from "../Sidebar" +import React, { createContext, useContext, useEffect, useState } from "react" import { usePrevious } from "@uidotdev/usehooks" -import { InteractiveSidebarItem, SidebarItem } from "types" +import { useSidebar } from "../Sidebar" +import { isSidebarItemLink } from "../../utils/sidebar-utils" +import { Sidebar } from "types" export type Page = { title: string @@ -27,8 +22,8 @@ export const PaginationContext = createContext( null ) -type SidebarItemWithParent = InteractiveSidebarItem & { - parent?: SidebarItem +type SidebarItemWithParent = Sidebar.InteractiveSidebarItem & { + parent?: Sidebar.InteractiveSidebarItem } type SearchItemsResult = { @@ -42,14 +37,13 @@ export type PaginationProviderProps = { } export const PaginationProvider = ({ children }: PaginationProviderProps) => { - const { items, activePath } = useSidebar() - const combinedItems = useMemo(() => [...items.default], [items]) + const { shownSidebar, activePath } = useSidebar() const previousActivePath = usePrevious(activePath) const [nextPage, setNextPage] = useState() const [prevPage, setPrevPage] = useState() const getFirstChild = ( - item: InteractiveSidebarItem + item: Sidebar.InteractiveSidebarItem ): SidebarItemWithParent | undefined => { const children = getChildrenWithPages(item) if (!children?.length) { @@ -65,7 +59,7 @@ export const PaginationProvider = ({ children }: PaginationProviderProps) => { } const getChildrenWithPages = ( - item: InteractiveSidebarItem + item: Sidebar.InteractiveSidebarItem ): SidebarItemWithParent[] | undefined => { return item.children?.filter( (childItem) => @@ -76,7 +70,7 @@ export const PaginationProvider = ({ children }: PaginationProviderProps) => { } const getPrevItem = ( - items: SidebarItem[], + items: Sidebar.SidebarItem[], index: number ): SidebarItemWithParent | undefined => { let foundItem: SidebarItemWithParent | undefined @@ -106,7 +100,7 @@ export const PaginationProvider = ({ children }: PaginationProviderProps) => { } const getNextItem = ( - items: SidebarItem[], + items: Sidebar.SidebarItem[], index: number ): SidebarItemWithParent | undefined => { let foundItem: SidebarItemWithParent | undefined @@ -133,7 +127,9 @@ export const PaginationProvider = ({ children }: PaginationProviderProps) => { return foundItem } - const searchItems = (currentItems: SidebarItem[]): SearchItemsResult => { + const searchItems = ( + currentItems: Sidebar.SidebarItem[] + ): SearchItemsResult => { const result: SearchItemsResult = { foundActive: false, } @@ -182,7 +178,11 @@ export const PaginationProvider = ({ children }: PaginationProviderProps) => { useEffect(() => { if (activePath !== previousActivePath) { - const result = searchItems(combinedItems) + const sidebarItems = + shownSidebar && "items" in shownSidebar + ? shownSidebar.items + : shownSidebar?.children || [] + const result = searchItems(sidebarItems) setPrevPage( result.prevItem ? { @@ -190,10 +190,7 @@ export const PaginationProvider = ({ children }: PaginationProviderProps) => { link: isSidebarItemLink(result.prevItem) ? result.prevItem.path : "", - parentTitle: - result.prevItem.parent?.type !== "separator" - ? result.prevItem.parent?.title - : undefined, + parentTitle: result.prevItem.parent?.title, } : undefined ) @@ -204,10 +201,7 @@ export const PaginationProvider = ({ children }: PaginationProviderProps) => { link: isSidebarItemLink(result.nextItem) ? result.nextItem.path : "", - parentTitle: - result.nextItem.parent?.type !== "separator" - ? result.nextItem.parent?.title - : undefined, + parentTitle: result.nextItem?.parent?.title, } : undefined ) diff --git a/www/packages/docs-ui/src/providers/Sidebar/index.tsx b/www/packages/docs-ui/src/providers/Sidebar/index.tsx index a8b61ce339..e91987a590 100644 --- a/www/packages/docs-ui/src/providers/Sidebar/index.tsx +++ b/www/packages/docs-ui/src/providers/Sidebar/index.tsx @@ -1,7 +1,6 @@ "use client" import React, { - ReactNode, createContext, useCallback, useContext, @@ -11,224 +10,180 @@ import React, { useRef, useState, } from "react" -import { usePathname, useRouter } from "next/navigation" -import { getScrolledTop } from "@/utils" +import { Sidebar } from "types" import { - SidebarItemSections, - SidebarItem, - SidebarSectionItems, - SidebarItemLink, - InteractiveSidebarItem, - SidebarItemCategory, - SidebarItemLinkWithParent, - SidebarItemTypes, -} from "types" + areSidebarItemsEqual, + findSidebarItem, + getSidebarItemWithHistory, + isSidebarItemLink, +} from "../../utils/sidebar-utils" +import { useSiteConfig } from "../SiteConifg" import { useIsBrowser } from "../BrowserProvider" +import { getScrolledTop } from "../../utils" +import { usePathname, useRouter } from "next/navigation" -export type CurrentItemsState = SidebarSectionItems & { - previousSidebar?: CurrentItemsState +export type SidebarActionOptions = { + sidebar_id: string + /** + * When specified, the items are added as children of the parent item + */ + parent?: { + type: Sidebar.InteractiveSidebarItemTypes + path: string + title: string + /** + * Whether to change the loaded state of the parent item + */ + changeLoaded?: boolean + } + /** + * The position to insert the items at + */ + indexPosition?: number + /** + * If enabled, the items are filtered to not add items that already exist + */ + ignoreExisting?: boolean } export type SidebarStyleOptions = { + /** + * Useful for projects that have nested sidebars. + */ disableActiveTransition?: boolean } export type SidebarContextType = { - items: SidebarSectionItems - currentItems: CurrentItemsState | undefined + sidebars: Sidebar.Sidebar[] + /** + * The sidebar that is currently shown + */ + shownSidebar: Sidebar.Sidebar | Sidebar.SidebarItemSidebar | undefined activePath: string | null - activeItem: SidebarItemLinkWithParent | undefined + activeItem: Sidebar.SidebarItemLink | null setActivePath: (path: string | null) => void - isLinkActive: (item: SidebarItem, checkChildren?: boolean) => boolean - isChildrenActive: (item: SidebarItemCategory) => boolean - addItems: (items: SidebarItem[], options?: ActionOptionsType) => void - removeItems: (items: SidebarItem[]) => void - findItemInSection: ( - section: SidebarItem[], - item: Partial, - checkChildren?: boolean - ) => SidebarItem | undefined + /** + * Check if an item is active. This includes checking its child items, + * so for UI links that have children, the `checkLinkChildren` option should be set to `false` + * to ensure that the link isn't shown as active if a child link is active. + */ + isItemActive: (options: { + item: Sidebar.InteractiveSidebarItem + checkLinkChildren?: boolean + }) => boolean + addItems: ( + items: Sidebar.SidebarItem[], + options?: SidebarActionOptions + ) => void + removeItems: (options: { + items: Sidebar.SidebarItem[] + sidebar_id: string + }) => void mobileSidebarOpen: boolean setMobileSidebarOpen: React.Dispatch> desktopSidebarOpen: boolean setDesktopSidebarOpen: React.Dispatch> - staticSidebarItems?: boolean + // Whether the items in the sidebar are static or are added dynamically + // TODO look into generating the sidebar item of the API reference + isSidebarStatic: boolean + /** + * Whether the active path should change when the hash changes + * This is only used by the API reference + */ shouldHandleHashChange: boolean sidebarRef: React.RefObject + /** + * Go back in the sidebar history + */ goBack: () => void + /** + * The height of the top part of the sidebar + */ sidebarTopHeight: number setSidebarTopHeight: React.Dispatch> + /** + * Reset the sidebar to its initial state (the sidebars passed as a prop) + */ resetItems: () => void - isItemLoaded: (path: string) => boolean updatePersistedCategoryState: (title: string, opened: boolean) => void getPersistedCategoryState: (title: string) => boolean | undefined - persistState: boolean + persistCategoryState: boolean isSidebarShown: boolean + sidebarHistory: string[] + /** + * Get the first link child of a sidebar + */ + getSidebarFirstLinkChild: ( + sidebar: Sidebar.Sidebar | Sidebar.SidebarItemSidebar + ) => Sidebar.SidebarItemLink | undefined + getSidebar: ( + sidebar_id: string + ) => Sidebar.Sidebar | Sidebar.SidebarItemSidebar } & SidebarStyleOptions export const SidebarContext = createContext(null) -export type ActionOptionsType = { - section?: SidebarItemSections - parent?: { - type: SidebarItemTypes - path: string - title: string - changeLoaded?: boolean - } - indexPosition?: number - ignoreExisting?: boolean -} - export type ActionType = | { type: "add" | "update" - items: SidebarItem[] - options?: ActionOptionsType + items: Sidebar.SidebarItem[] + options?: SidebarActionOptions } | { type: "replace" - replacementItems: SidebarSectionItems + sidebars: Sidebar.Sidebar[] } | { type: "remove" - items: SidebarItem[] + items: Sidebar.SidebarItem[] + sidebar_id: string } -type LinksMap = Map - -export const isSidebarItemLink = ( - item: SidebarItem | undefined, - checkRef = true -): item is SidebarItemLink => { - return ( - item !== undefined && - (item.type === "link" || (checkRef && item.type === "ref")) - ) -} - -const areItemsEqual = ( - itemA: SidebarItem, - itemB: SidebarItem, - compareTitles = true -): boolean => { - if ( - itemA.type === "separator" || - itemB.type === "separator" || - itemA.type !== itemB.type - ) { - return false - } - const hasSameTitle = !compareTitles || itemA.title === itemB.title - const hasSamePath = - !isSidebarItemLink(itemA) || - !isSidebarItemLink(itemB) || - itemA.path === itemB.path - - return hasSameTitle && hasSamePath -} - -const findItem = ( - section: SidebarItem[], - item: Partial, - checkChildren = true, - compareTitles = true -): SidebarItemLinkWithParent | undefined => { - let foundItem: SidebarItemLinkWithParent | undefined - section.some((i) => { - if (i.type === "separator") { - return false - } - if (areItemsEqual(item as SidebarItem, i, compareTitles)) { - foundItem = i as SidebarItemLink - } else if (checkChildren && i.children) { - foundItem = findItem(i.children, item, checkChildren, compareTitles) - if (foundItem && !foundItem.parentItem) { - foundItem.parentItem = i - } - } - - return foundItem !== undefined - }) - - return foundItem -} - -const getLinksMap = ( - items: SidebarItem[], - initMap?: LinksMap, - parentItem?: InteractiveSidebarItem -): LinksMap => { - const map: LinksMap = initMap || new Map() - - items.forEach((item) => { - if (item.type === "separator") { - return - } - - if (isSidebarItemLink(item)) { - map.set(item.path, { - ...item, - parentItem, - }) - } - if (item.children?.length) { - getLinksMap(item.children, map, item) - } - }) - - return map -} - export const reducer = ( - state: SidebarSectionItems, + state: Sidebar.Sidebar[], actionData: ActionType -): SidebarSectionItems => { +): Sidebar.Sidebar[] => { if (actionData.type === "replace") { - return actionData.replacementItems + return actionData.sidebars } if (actionData.type === "remove") { - return { - ...state, - default: state.default.filter((item) => { - if (item.type === "separator") { - return true + const { sidebar_id, items: itemsToRemove } = actionData + return state.map((sidebar) => { + if (sidebar.sidebar_id === sidebar_id) { + return { + ...sidebar, + items: sidebar.items.filter((item) => { + return !itemsToRemove.some((itemToRemove) => + areSidebarItemsEqual({ + itemA: item, + itemB: itemToRemove, + }) + ) + }), } - - const found = actionData.items.some((itemToRemove) => { - if ( - itemToRemove.type === "separator" || - itemToRemove.type !== item.type - ) { - return false - } - - if ( - itemToRemove.type === "category" || - itemToRemove.type === "sub-category" - ) { - return itemToRemove.title === item.title - } - - return ( - itemToRemove.path === (item as SidebarItemLink).path && - itemToRemove.title === (item as SidebarItemLink).title - ) - }) - - return !found - }), - } + } + return sidebar + }) } + const { type, options } = actionData let { items } = actionData const { parent, ignoreExisting = false, indexPosition } = options || {} - const sectionName = SidebarItemSections.DEFAULT - const sectionItems = state[sectionName] + const sidebarIndex = state.findIndex( + (s) => s.sidebar_id === options?.sidebar_id + ) + const sidebar = state[sidebarIndex] + + if (!sidebar) { + return state + } if (!ignoreExisting) { - items = items.filter((item) => !findItem(sectionItems, item)) + items = items.filter( + (item) => + findSidebarItem({ sidebarItems: sidebar.items, item }) === undefined + ) } if (!items.length) { @@ -237,114 +192,206 @@ export const reducer = ( switch (type) { case "add": - return { - ...state, - [sectionName]: - indexPosition !== undefined - ? [ - ...sectionItems.slice(0, indexPosition), - ...items, - ...sectionItems.slice(indexPosition), - ] - : [...sectionItems, ...items], - } + return [ + ...state.slice(0, sidebarIndex), + { + ...sidebar, + items: + indexPosition !== undefined + ? [ + ...sidebar.items.slice(0, indexPosition), + ...items, + ...sidebar.items.slice(indexPosition), + ] + : [...sidebar.items, ...items], + }, + ...state.slice(sidebarIndex + 1), + ] case "update": // find item index - return { - ...state, - [sectionName]: sectionItems.map((i) => { - if (i.type === "separator") { - return i - } - if (parent && areItemsEqual(i, parent as SidebarItem)) { - return { - ...i, - children: - indexPosition !== undefined - ? [ - ...(i.children?.slice(0, indexPosition) || []), - ...items, - ...(i.children?.slice(indexPosition) || []), - ] - : [...(i.children || []), ...items], - loaded: parent.changeLoaded - ? true - : isSidebarItemLink(i) - ? i.loaded - : true, + return [ + ...state.slice(0, sidebarIndex), + { + ...sidebar, + items: sidebar.items.map((i) => { + if (i.type === "separator") { + return i } - } - return i - }), - } + if ( + parent && + areSidebarItemsEqual({ + itemA: i, + itemB: parent as Sidebar.InteractiveSidebarItem, + }) + ) { + return { + ...i, + children: + indexPosition !== undefined + ? [ + ...(i.children?.slice(0, indexPosition) || []), + ...items, + ...(i.children?.slice(indexPosition) || []), + ] + : [...(i.children || []), ...items], + loaded: parent.changeLoaded + ? true + : isSidebarItemLink(i) + ? i.loaded + : true, + } + } + return i + }), + }, + ...state.slice(sidebarIndex + 1), + ] default: return state } } export type SidebarProviderProps = { - children?: ReactNode + children?: React.ReactNode isLoading?: boolean setIsLoading?: React.Dispatch> - initialItems?: SidebarSectionItems + sidebars: Sidebar.Sidebar[] shouldHandleHashChange?: boolean shouldHandlePathChange?: boolean scrollableElement?: Element | Window - staticSidebarItems?: boolean - resetOnCondition?: () => boolean - projectName: string - persistState?: boolean + isSidebarStatic?: boolean + persistCategoryState?: boolean + disableActiveTransition?: boolean } & SidebarStyleOptions export const SidebarProvider = ({ children, - isLoading = false, + isLoading, setIsLoading, - initialItems, + sidebars: initialSidebars = [], shouldHandleHashChange = false, - shouldHandlePathChange = false, + shouldHandlePathChange = true, scrollableElement, - staticSidebarItems = false, - disableActiveTransition = false, - resetOnCondition, - projectName, - persistState = true, + isSidebarStatic = true, + persistCategoryState = true, + disableActiveTransition = true, }: SidebarProviderProps) => { - const categoriesStorageKey = `${projectName}_categories` + const { + config: { project }, + } = useSiteConfig() + const categoriesStorageKey = `${project.title}_categories` const hideSidebarStorageKey = `hide_sidebar` - const [items, dispatch] = useReducer(reducer, { - default: initialItems?.default || [], - mobile: initialItems?.mobile || [], - }) - const [currentItems, setCurrentItems] = useState< - CurrentItemsState | undefined - >() + const [sidebars, dispatch] = useReducer(reducer, initialSidebars) const [activePath, setActivePath] = useState("") - const linksMap: LinksMap = useMemo(() => { - return new Map([ - ...getLinksMap(items.mobile), - ...getLinksMap(items.default), - ]) - }, [items]) - const findItemInSection = useCallback(findItem, []) - const activeItem = useMemo(() => { - if (activePath === null) { - return undefined - } - - return linksMap.get(activePath) - }, [activePath, linksMap]) const [mobileSidebarOpen, setMobileSidebarOpen] = useState(false) - const [sidebarTopHeight, setSidebarTopHeight] = useState(0) const [desktopSidebarOpen, setDesktopSidebarOpen] = useState(true) const sidebarRef = useRef(null) + const [sidebarTopHeight, setSidebarTopHeight] = useState(0) const pathname = usePathname() const router = useRouter() const { isBrowser } = useIsBrowser() - const getResolvedScrollableElement = useCallback(() => { + + const resolvedScrollableElement = useMemo(() => { + if (!isBrowser) { + return + } + return scrollableElement || window - }, [scrollableElement]) + }, [scrollableElement, isBrowser]) + + const activeMainSidebar = useMemo(() => { + if (!activePath) { + // set first sidebar as active + return sidebars[0] + } + return ( + sidebars.find( + (s) => + findSidebarItem({ + sidebarItems: s.items, + item: { type: "link", path: activePath, title: "" }, + }) !== undefined + ) || sidebars[0] + ) + }, [sidebars, activePath]) + + const { activeItem, sidebarHistory } = useMemo(() => { + if (!activePath) { + return { + activeItem: null, + sidebarHistory: [] as string[], + } + } + const result = + getSidebarItemWithHistory({ + sidebarItems: activeMainSidebar.items, + item: { type: "link", path: activePath, title: "" }, + compareTitles: false, + }) || null + + return { + ...result, + sidebarHistory: [ + activeMainSidebar.sidebar_id, + ...(result.sidebarHistory || []), + ], + activeItem: (result.item as Sidebar.SidebarItemLink) || null, + } + }, [activePath, activeMainSidebar]) + + const getSidebar = useCallback( + (sidebar_id: string) => { + return ( + sidebars.find((s) => s.sidebar_id === sidebar_id) || + (findSidebarItem({ + sidebarItems: activeMainSidebar.items || [], + item: { type: "sidebar", sidebar_id, title: "" }, + compareTitles: false, + }) as Sidebar.SidebarItemSidebar) + ) + }, + [sidebars, activeMainSidebar] + ) + + const shownSidebar = useMemo(() => { + if (!sidebarHistory.length) { + return + } + + return getSidebar(sidebarHistory[sidebarHistory.length - 1]) + }, [activeMainSidebar, sidebarHistory, getSidebar]) + + const isItemActive: SidebarContextType["isItemActive"] = useCallback( + ({ item, checkLinkChildren = true }): boolean => { + if (!activePath) { + return false + } + + if (isSidebarItemLink(item)) { + if (item.path === activePath) { + return true + } else if (!checkLinkChildren) { + return false + } + } + + return ( + item.children?.some((child) => { + if (child.type === "separator") { + return false + } + + return isItemActive({ + item: child as Sidebar.InteractiveSidebarItem, + checkLinkChildren, + }) + }) || false + ) + }, + [activePath] + ) + const isSidebarShown = useMemo(() => { if (!isBrowser) { return true @@ -353,16 +400,10 @@ export const SidebarProvider = ({ return document.getElementsByTagName("aside").length > 0 }, [isBrowser]) - const isItemLoaded = useCallback( - (path: string) => { - const item = linksMap.get(path) - - return item?.loaded || false - }, - [items, linksMap] - ) - - const addItems = (newItems: SidebarItem[], options?: ActionOptionsType) => { + const addItems = ( + newItems: Sidebar.SidebarItem[], + options?: SidebarActionOptions + ) => { dispatch({ type: options?.parent ? "update" : "add", items: newItems, @@ -370,123 +411,39 @@ export const SidebarProvider = ({ }) } - const removeItems = (itemsToRemove: SidebarItem[]) => { + const removeItems = ({ + items, + sidebar_id, + }: { + items: Sidebar.SidebarItem[] + sidebar_id: string + }) => { dispatch({ type: "remove", - items: itemsToRemove, + items, + sidebar_id, }) } - const isLinkActive = useCallback( - (item: SidebarItem, checkChildren = false, checkRef = true): boolean => { - if (!isSidebarItemLink(item, checkRef)) { - return false - } - - return ( - item.path === activePath || - (checkChildren && activePath?.split("_")[0] === item.path) - ) - }, - [activePath] - ) - - const isChildrenActive = useCallback( - (item: InteractiveSidebarItem): boolean => { - return ( - item.children?.some((child) => { - if (isLinkActive(child, true)) { - return true - } - - return child.type !== "separator" && child.children - ? isChildrenActive(child) - : false - }) || false - ) - }, - [isLinkActive] - ) - - const init = () => { - const currentPath = location.hash.replace("#", "") - if (currentPath) { - setActivePath(currentPath) - } - } - - const getCurrentSidebar = useCallback( - (searchItems: SidebarItem[]): InteractiveSidebarItem | undefined => { - let currentSidebar: InteractiveSidebarItem | undefined - searchItems.some((item) => { - if (item.type === "separator") { - return false - } - if (item.isChildSidebar && isLinkActive(item, false, false)) { - currentSidebar = item - return true - } - if (!item.children?.length) { - return false - } - - const childSidebar = - getCurrentSidebar(item.children) || - (activePath - ? findItem( - item.children, - { - path: activePath, - type: "link", - }, - true, - false - ) - : undefined) - - currentSidebar = childSidebar - ? childSidebar.isChildSidebar - ? childSidebar - : item - : undefined - - return currentSidebar !== undefined - }) - - return currentSidebar - }, - [isLinkActive, activePath] - ) - - const goBack = () => { - if (!currentItems) { - return - } - - const previousSidebar = currentItems.previousSidebar || items - - const backItem = previousSidebar.default.find( - (item) => isSidebarItemLink(item) && !item.isChildSidebar - ) as SidebarItemLink - - if (!backItem) { - return - } - - setActivePath(backItem.path!) - setCurrentItems(previousSidebar) - router.replace(backItem.path!) - } - const resetItems = useCallback(() => { dispatch({ type: "replace", - replacementItems: { - default: initialItems?.default || [], - mobile: initialItems?.mobile || [], - }, + sidebars: initialSidebars, }) - }, [initialItems]) + }, [initialSidebars]) + + const init = () => { + const currentPath = location.hash.replace("#", "") + if (currentPath) { + setActivePath(currentPath) + } else { + const firstChild = getFirstLinkChild(activeMainSidebar.items) + + if (firstChild) { + setActivePath(firstChild.path) + } + } + } useEffect(() => { if (shouldHandleHashChange) { @@ -495,21 +452,17 @@ export const SidebarProvider = ({ }, [shouldHandleHashChange]) useEffect(() => { - if (!shouldHandleHashChange) { + if (!shouldHandleHashChange || !resolvedScrollableElement) { return } - const resolvedScrollableElement = getResolvedScrollableElement() - const handleScroll = () => { if (getScrolledTop(resolvedScrollableElement) === 0) { - const firstItemPath = - items.default.length && isSidebarItemLink(items.default[0]) - ? items.default[0].path - : "" - setActivePath(firstItemPath) - if (firstItemPath) { - router.push(`#${firstItemPath}`, { + const firstChild = getFirstLinkChild(activeMainSidebar.items) + + if (firstChild) { + setActivePath(firstChild.path) + router.push(`#${firstChild.path}`, { scroll: false, }) } @@ -521,7 +474,7 @@ export const SidebarProvider = ({ return () => { resolvedScrollableElement.removeEventListener("scroll", handleScroll) } - }, [shouldHandleHashChange, getResolvedScrollableElement]) + }, [shouldHandleHashChange, resolvedScrollableElement]) useEffect(() => { if (!shouldHandleHashChange || !isBrowser) { @@ -544,10 +497,10 @@ export const SidebarProvider = ({ }, [shouldHandleHashChange, isBrowser]) useEffect(() => { - if (isLoading && items.default.length) { + if (isLoading && sidebars.length) { setIsLoading?.(false) } - }, [items, isLoading, setIsLoading]) + }, [sidebars, isLoading, setIsLoading]) useEffect(() => { if (!shouldHandlePathChange) { @@ -559,47 +512,6 @@ export const SidebarProvider = ({ } }, [shouldHandlePathChange, pathname]) - useEffect(() => { - if (!activePath?.length) { - setCurrentItems(undefined) - return - } - - const currentSidebar = getCurrentSidebar(items.default) - - if (!currentSidebar) { - setCurrentItems(undefined) - return - } - - if ( - currentSidebar.isChildSidebar && - currentSidebar.children && - (!currentItems?.parentItem || - !areItemsEqual(currentItems?.parentItem, currentSidebar)) - ) { - const { children, ...parentItem } = currentSidebar - const hasPreviousSidebar = - isSidebarItemLink(currentItems?.previousSidebar?.parentItem) && - isSidebarItemLink(parentItem) && - currentItems.previousSidebar.parentItem.path !== parentItem.path - - setCurrentItems({ - default: children, - mobile: items.mobile, - parentItem: parentItem, - previousSidebar: hasPreviousSidebar ? currentItems : undefined, - }) - } - }, [getCurrentSidebar, activePath]) - - useEffect(() => { - if (resetOnCondition?.()) { - resetItems() - setActivePath(null) - } - }, [resetOnCondition, resetItems]) - useEffect(() => { if (!isBrowser) { return @@ -627,12 +539,12 @@ export const SidebarProvider = ({ const storageData = JSON.parse( localStorage.getItem(categoriesStorageKey) || "{}" ) - if (!Object.hasOwn(storageData, projectName)) { - storageData[projectName] = {} + if (!Object.hasOwn(storageData, project.title)) { + storageData[project.title] = {} } - storageData[projectName] = { - ...storageData[projectName], + storageData[project.title] = { + ...storageData[project.title], [title]: opened, } @@ -644,42 +556,98 @@ export const SidebarProvider = ({ localStorage.getItem(categoriesStorageKey) || "{}" ) - return !Object.hasOwn(storageData, projectName) || - !Object.hasOwn(storageData[projectName], title) + return !Object.hasOwn(storageData, project.title) || + !Object.hasOwn(storageData[project.title], title) ? undefined - : storageData[projectName][title] + : storageData[project.title][title] + } + + const getFirstLinkChild = useCallback( + (items: Sidebar.SidebarItem[]): Sidebar.SidebarItemLink | undefined => { + let foundItem: Sidebar.SidebarItemLink | undefined + items.some((item) => { + if (item.type === "link") { + foundItem = item + } else if ("children" in item && item.children) { + foundItem = getFirstLinkChild(item.children) + } + + return foundItem !== undefined + }) + + return foundItem + }, + [] + ) + + const getSidebarFirstLinkChild = useCallback( + ( + sidebar: Sidebar.Sidebar | Sidebar.SidebarItemSidebar + ): Sidebar.SidebarItemLink | undefined => { + const itemsToSearch = + "items" in sidebar ? sidebar.items : sidebar.children || [] + + return getFirstLinkChild(itemsToSearch) + }, + [getFirstLinkChild] + ) + + const openSidebar = (sidebar_id: string) => { + const sidebar = getSidebar(sidebar_id) + if (!sidebar) { + return + } + + const firstChild = getSidebarFirstLinkChild(sidebar) + + if (firstChild) { + setActivePath(firstChild.path) + router.replace( + firstChild.isPathHref ? firstChild.path : `#${firstChild.path}` + ) + } + } + + const goBack = () => { + if (!sidebarHistory || sidebarHistory.length <= 1) { + openSidebar(activeMainSidebar.sidebar_id) + } else { + const lastSidebar = sidebarHistory[sidebarHistory.length - 2] + + openSidebar(lastSidebar) + } } return ( {children} diff --git a/www/packages/docs-ui/src/providers/SiteConifg/index.tsx b/www/packages/docs-ui/src/providers/SiteConifg/index.tsx index 6ec5aa9777..f9e08a4967 100644 --- a/www/packages/docs-ui/src/providers/SiteConifg/index.tsx +++ b/www/packages/docs-ui/src/providers/SiteConifg/index.tsx @@ -25,17 +25,11 @@ export const SiteConfigProvider = ({ Object.assign( { baseUrl: "", - sidebar: { - default: [], - mobile: [], - }, + sidebars: [], project: { title: "", key: "", }, - breadcrumbOptions: { - showCategories: true, - }, reportIssueLink: GITHUB_ISSUES_LINK, logo: "", }, diff --git a/www/packages/docs-ui/src/utils/get-local-search.ts b/www/packages/docs-ui/src/utils/get-local-search.ts index 00c753f524..0deb0dec17 100644 --- a/www/packages/docs-ui/src/utils/get-local-search.ts +++ b/www/packages/docs-ui/src/utils/get-local-search.ts @@ -21,12 +21,16 @@ export const getLocalSearch = ({ docs, searchableFields, options, -}: GetLocalSearchInput): LocalSearch => { - const miniSearch = new MiniSearch({ - fields: searchableFields, - ...options, - }) - miniSearch.addAll(docs) +}: GetLocalSearchInput): LocalSearch | undefined => { + try { + const miniSearch = new MiniSearch({ + fields: searchableFields, + ...options, + }) + miniSearch.addAll(docs) - return miniSearch as LocalSearch + return miniSearch as LocalSearch + } catch (e) { + console.warn(e) + } } diff --git a/www/packages/docs-ui/src/utils/index.ts b/www/packages/docs-ui/src/utils/index.ts index 54988860ad..a946dda6b8 100644 --- a/www/packages/docs-ui/src/utils/index.ts +++ b/www/packages/docs-ui/src/utils/index.ts @@ -12,6 +12,6 @@ export * from "./is-elm-window" export * from "./is-in-view" export * from "./learning-paths" export * from "./set-obj-value" -export * from "./sidebar-attach-href-common-options" +export * from "./sidebar-utils" export * from "./swr-fetcher" export * from "./workflow-diagram-utils" diff --git a/www/packages/docs-ui/src/utils/sidebar-attach-href-common-options.ts b/www/packages/docs-ui/src/utils/sidebar-attach-href-common-options.ts deleted file mode 100644 index bb44f8b048..0000000000 --- a/www/packages/docs-ui/src/utils/sidebar-attach-href-common-options.ts +++ /dev/null @@ -1,22 +0,0 @@ -import { RawSidebarItem } from "types" - -const commonOptions: Partial = { - loaded: true, - isPathHref: true, -} - -export function sidebarAttachHrefCommonOptions( - sidebar: RawSidebarItem[] -): RawSidebarItem[] { - return sidebar.map((item) => { - if (item.type === "separator") { - return item - } - - return { - ...commonOptions, - ...item, - children: sidebarAttachHrefCommonOptions(item.children || []), - } - }) -} diff --git a/www/packages/docs-ui/src/utils/sidebar-utils.ts b/www/packages/docs-ui/src/utils/sidebar-utils.ts new file mode 100644 index 0000000000..f98e0c7442 --- /dev/null +++ b/www/packages/docs-ui/src/utils/sidebar-utils.ts @@ -0,0 +1,129 @@ +import { Sidebar } from "types" + +export const isSidebarItemLink = ( + item: Sidebar.SidebarItem | undefined, + options?: { + checkRef?: boolean + checkExternal?: boolean + } +): item is Sidebar.SidebarItemLink => { + const { checkRef = true, checkExternal = true } = options || {} + + return ( + item !== undefined && + (item.type === "link" || + (checkRef && item.type === "ref") || + (checkExternal && item.type === "external")) + ) +} + +export const areSidebarItemsEqual = ({ + itemA, + itemB, + compareTitles = true, +}: { + itemA: Sidebar.SidebarItem + itemB: Sidebar.SidebarItem + compareTitles?: boolean +}): boolean => { + if (itemA.type !== itemB.type) { + return false + } + // after this, we know that itemA and itemB have the same type + switch (itemA.type) { + case "separator": + return true + case "sidebar": + return ( + itemA.sidebar_id === (itemB as Sidebar.SidebarItemSidebar).sidebar_id + ) + case "category": + case "sub-category": + return compareTitles + ? itemA.title === (itemB as Sidebar.SidebarItemCategory).title + : false + case "link": + case "ref": + case "external": { + const hasSameTitle = + !compareTitles || + itemA.title === (itemB as Sidebar.SidebarItemLink).title + const hasSamePath = itemA.path === (itemB as Sidebar.SidebarItemLink).path + + return hasSameTitle && hasSamePath + } + } +} + +export const findSidebarItem = ({ + sidebarItems, + item, + checkChildren = true, + compareTitles = true, +}: { + sidebarItems: Sidebar.SidebarItem[] + item: Sidebar.SidebarItem + checkChildren?: boolean + compareTitles?: boolean +}): Sidebar.SidebarItem | undefined => { + let foundItem: Sidebar.SidebarItem | undefined + sidebarItems.some((i) => { + if (areSidebarItemsEqual({ itemA: i, itemB: item })) { + foundItem = i + } else if (checkChildren && "children" in i && i.children) { + foundItem = findSidebarItem({ + sidebarItems: i.children, + item, + checkChildren, + compareTitles, + }) + } + + return foundItem !== undefined + }) + + return foundItem +} + +export const getSidebarItemWithHistory = ({ + sidebarItems, + item, + sidebarHistory = [], + checkChildren = true, + compareTitles = true, +}: { + sidebarItems: Sidebar.SidebarItem[] + item: Sidebar.SidebarItem + sidebarHistory?: string[] + checkChildren?: boolean + compareTitles?: boolean +}): { + item: Sidebar.SidebarItem | undefined + sidebarHistory: string[] +} => { + let foundItem: Sidebar.SidebarItem | undefined + sidebarItems.some((i) => { + if (areSidebarItemsEqual({ itemA: i, itemB: item, compareTitles })) { + foundItem = i + } else if (checkChildren && "children" in i && i.children) { + const result = getSidebarItemWithHistory({ + sidebarItems: i.children, + item, + checkChildren, + compareTitles, + }) + + if (result.item) { + foundItem = result.item + if (i.type === "sidebar") { + sidebarHistory.push(i.sidebar_id) + } + sidebarHistory.push(...result.sidebarHistory) + } + } + + return foundItem !== undefined + }) + + return { item: foundItem, sidebarHistory } +} diff --git a/www/packages/remark-rehype-plugins/src/page-number.ts b/www/packages/remark-rehype-plugins/src/page-number.ts index 32c5b77a36..56acb32cc3 100644 --- a/www/packages/remark-rehype-plugins/src/page-number.ts +++ b/www/packages/remark-rehype-plugins/src/page-number.ts @@ -1,12 +1,11 @@ import path from "path" import type { Transformer } from "unified" -import type { RawSidebarItem } from "types" -import type { UnistTree } from "types" +import type { Sidebar, UnistTree } from "types" export function pageNumberRehypePlugin({ sidebar, }: { - sidebar: RawSidebarItem[] + sidebar: Sidebar.RawSidebarItem[] }): Transformer { return async (tree, file) => { const { valueToEstree } = await import("estree-util-value-to-estree") @@ -66,9 +65,9 @@ export function pageNumberRehypePlugin({ } function findSidebarItem( - sidebar: RawSidebarItem[], + sidebar: Sidebar.RawSidebarItem[], path: string -): RawSidebarItem | undefined { +): Sidebar.RawSidebarItem | undefined { let foundItem = undefined for (const item of sidebar) { if (item.type === "separator") { diff --git a/www/packages/tags/src/tags/draft-order.ts b/www/packages/tags/src/tags/draft-order.ts deleted file mode 100644 index 0bd1434007..0000000000 --- a/www/packages/tags/src/tags/draft-order.ts +++ /dev/null @@ -1,6 +0,0 @@ -export const draftOrder = [ - { - "title": "draftOrder", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/draftOrder" - } -] \ No newline at end of file diff --git a/www/packages/tags/src/tags/index.ts b/www/packages/tags/src/tags/index.ts index 4d3f5a7e44..a525f6e220 100644 --- a/www/packages/tags/src/tags/index.ts +++ b/www/packages/tags/src/tags/index.ts @@ -1,41 +1,40 @@ export * from "./user-guide.js" -export * from "./payment.js" export * from "./fulfillment.js" +export * from "./payment.js" export * from "./pricing.js" -export * from "./inventory.js" +export * from "./promotion.js" export * from "./product.js" -export * from "./customer.js" -export * from "./order.js" +export * from "./auth.js" export * from "./api-key.js" -export * from "./user.js" +export * from "./workflow.js" export * from "./stock-location.js" export * from "./region.js" export * from "./sales-channel.js" +export * from "./user.js" export * from "./store.js" export * from "./currency.js" -export * from "./tax.js" -export * from "./concept.js" -export * from "./promotion.js" -export * from "./workflow.js" +export * from "./customer.js" +export * from "./inventory.js" export * from "./cart.js" -export * from "./query.js" -export * from "./js-sdk.js" export * from "./server.js" -export * from "./storefront.js" +export * from "./query.js" +export * from "./concept.js" export * from "./example.js" -export * from "./auth.js" +export * from "./publishable-api-key.js" +export * from "./checkout.js" +export * from "./product-collection.js" +export * from "./step.js" export * from "./product-category.js" export * from "./link.js" -export * from "./product-collection.js" -export * from "./publishable-api-key.js" export * from "./remote-query.js" -export * from "./logger.js" export * from "./locking.js" +export * from "./file.js" +export * from "./js-sdk.js" export * from "./event-bus.js" export * from "./admin.js" -export * from "./draft-order.js" +export * from "./storefront.js" +export * from "./logger.js" +export * from "./tax.js" export * from "./notification.js" -export * from "./step.js" -export * from "./checkout.js" export * from "./stripe.js" -export * from "./file.js" +export * from "./order.js" diff --git a/www/packages/tags/src/tags/js-sdk.ts b/www/packages/tags/src/tags/js-sdk.ts index 15a2a3d213..4da90faa50 100644 --- a/www/packages/tags/src/tags/js-sdk.ts +++ b/www/packages/tags/src/tags/js-sdk.ts @@ -1,8 +1,4 @@ export const jsSdk = [ - { - "title": "Implement Express Checkout with Medusa", - "path": "https://docs.medusajs.com/resources/storefront-development/guides/express-checkout" - }, { "title": "apiKey", "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/apiKey" diff --git a/www/packages/tags/src/tags/order.ts b/www/packages/tags/src/tags/order.ts index 708e1507c2..7e35fb081a 100644 --- a/www/packages/tags/src/tags/order.ts +++ b/www/packages/tags/src/tags/order.ts @@ -543,6 +543,10 @@ export const order = [ "title": "claim", "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/claim" }, + { + "title": "draftOrder", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/draftOrder" + }, { "title": "exchange", "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/exchange" diff --git a/www/packages/tags/src/tags/workflow.ts b/www/packages/tags/src/tags/workflow.ts index 1486a59080..21d45a01b2 100644 --- a/www/packages/tags/src/tags/workflow.ts +++ b/www/packages/tags/src/tags/workflow.ts @@ -43,6 +43,10 @@ export const workflow = [ "title": "confirmVariantInventoryWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmVariantInventoryWorkflow" }, + { + "title": "createCartCreditLinesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartCreditLinesWorkflow" + }, { "title": "createCartWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow" @@ -51,6 +55,10 @@ export const workflow = [ "title": "createPaymentCollectionForCartWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createPaymentCollectionForCartWorkflow" }, + { + "title": "deleteCartCreditLinesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteCartCreditLinesWorkflow" + }, { "title": "listShippingOptionsForCartWithPricingWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/listShippingOptionsForCartWithPricingWorkflow" diff --git a/www/packages/tailwind/package.json b/www/packages/tailwind/package.json index c01715f39f..dd593ccb76 100644 --- a/www/packages/tailwind/package.json +++ b/www/packages/tailwind/package.json @@ -12,7 +12,7 @@ "postcss.config.js" ], "dependencies": { - "@medusajs/ui-preset": "~2.5.1", + "@medusajs/ui-preset": "2.6.0", "tailwindcss-animate": "^1.0.7" }, "peerDependencies": { diff --git a/www/packages/types/package.json b/www/packages/types/package.json index a253e7d1a0..b3ddd422c2 100644 --- a/www/packages/types/package.json +++ b/www/packages/types/package.json @@ -32,7 +32,7 @@ "watch": "tsc --watch" }, "devDependencies": { - "@medusajs/icons": "~2.5.1", + "@medusajs/icons": "2.6.0", "@types/node": "^20.11.20", "rimraf": "^5.0.5", "tsconfig": "*", diff --git a/www/packages/types/src/config.ts b/www/packages/types/src/config.ts index 106138b45a..78961ab130 100644 --- a/www/packages/types/src/config.ts +++ b/www/packages/types/src/config.ts @@ -1,14 +1,17 @@ -import { SidebarSectionItems } from "./sidebar.js" +import { Sidebar } from "./index.js" export type BreadcrumbOptions = { - showCategories?: boolean + startItems?: { + title: string + link: string + }[] } export declare type DocsConfig = { titleSuffix?: string baseUrl: string basePath?: string - sidebar: SidebarSectionItems + sidebars: Sidebar.Sidebar[] filesBasePath?: string useNextLinks?: boolean project: { diff --git a/www/packages/types/src/index.ts b/www/packages/types/src/index.ts index b9984408b2..0e8dc05ae9 100644 --- a/www/packages/types/src/index.ts +++ b/www/packages/types/src/index.ts @@ -7,7 +7,7 @@ export * from "./menu.js" export * from "./navigation.js" export * from "./remark-rehype.js" export * from "./navigation-dropdown.js" -export * from "./sidebar.js" +export * as Sidebar from "./sidebar.js" export * from "./tags.js" export * from "./toc.js" export * from "./ui.js" diff --git a/www/packages/types/src/sidebar.ts b/www/packages/types/src/sidebar.ts index 0e18306680..948354be35 100644 --- a/www/packages/types/src/sidebar.ts +++ b/www/packages/types/src/sidebar.ts @@ -1,32 +1,44 @@ -export enum SidebarItemSections { - DEFAULT = "default", - MOBILE = "mobile", +export type Sidebar = { + sidebar_id: string + title: string + items: SidebarItem[] } export type SidebarItemCommon = { title: string children?: SidebarItem[] - isChildSidebar?: boolean - hasTitleStyling?: boolean - childSidebarTitle?: string loaded?: boolean additionalElms?: React.ReactNode chapterTitle?: string + childSidebarTitle?: string hideChildren?: boolean + // generated by scripts + number?: string // can be used to hold any description relevant when showing cards, etc... description?: string } -export type SidebarItemTypes = "category" | "sub-category" | "link" | "ref" +export type InteractiveSidebarItemTypes = + | "category" + | "sub-category" + | "link" + | "ref" + | "external" + | "sidebar" export type SidebarItemLink = SidebarItemCommon & { - type: "link" | "ref" + type: "link" | "ref" | "external" path: string isPathHref?: boolean linkProps?: React.AllHTMLAttributes childrenSameLevel?: boolean } +export type SidebarItemSidebar = SidebarItemCommon & { + type: "sidebar" + sidebar_id: string +} + export type SidebarItemCategory = SidebarItemCommon & { type: "category" onOpen?: () => void @@ -47,6 +59,7 @@ export type InteractiveSidebarItem = | SidebarItemLink | SidebarItemCategory | SidebarItemSubCategory + | SidebarItemSidebar export type SidebarItemLinkWithParent = SidebarItemLink & { parentItem?: InteractiveSidebarItem @@ -54,21 +67,18 @@ export type SidebarItemLinkWithParent = SidebarItemLink & { export type SidebarItem = InteractiveSidebarItem | SidebarItemSeparator -export type SidebarSectionItems = { - [k in SidebarItemSections]: SidebarItem[] -} & { - parentItem?: InteractiveSidebarItem -} +export type SidebarSortType = "none" | "alphabetize" export type RawSidebarItem = SidebarItem & { autogenerate_path?: string autogenerate_tags?: string autogenerate_as_ref?: boolean + sort_sidebar?: SidebarSortType custom_autogenerate?: string number?: string } & ( | { - type: "category" | "sub-category" | "link" | "ref" + type: InteractiveSidebarItemTypes children?: RawSidebarItem[] } | { @@ -76,8 +86,17 @@ export type RawSidebarItem = SidebarItem & { } ) +export type RawSidebar = Omit & { + items: RawSidebarItem[] +} + export type PersistedSidebarCategoryState = { [k: string]: { [k: string]: boolean } } + +// export type SidebarHeirarchyItem = { +// title: string +// path?: string +// } diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_invites_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_invites_[id].ts index 1af1647369..59a970b5ec 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_invites_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_invites_[id].ts @@ -3,7 +3,7 @@ * operationId: DeleteInvitesId * summary: Delete Invite * description: Delete an invite. - * x-authenticated: false + * x-authenticated: true * parameters: * - name: id * in: path @@ -56,6 +56,10 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: deleteInvitesWorkflow + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_users_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_users_[id].ts index 4296faeaf2..d0e600c2c5 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_users_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_users_[id].ts @@ -3,7 +3,7 @@ * operationId: DeleteUsersId * summary: Delete a User * description: Delete a user. - * x-authenticated: false + * x-authenticated: true * parameters: * - name: id * in: path @@ -37,6 +37,9 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: removeUserAccountWorkflow + * security: + * - cookie_auth: [] + * - jwt_token: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_invites.ts b/www/utils/generated/oas-output/operations/admin/get_admin_invites.ts index 293b272ded..e699fb8ec1 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_invites.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_invites.ts @@ -3,7 +3,7 @@ * operationId: GetInvites * summary: List Invites * description: Retrieve a list of invites. The invites can be filtered by fields such as `id`. The invites can also be sorted or paginated. - * x-authenticated: false + * x-authenticated: true * parameters: * - name: fields * in: query @@ -512,6 +512,10 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_invites_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_invites_[id].ts index d5368c38c9..d0ff01117c 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_invites_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_invites_[id].ts @@ -3,7 +3,7 @@ * operationId: GetInvitesId * summary: Get an Invite * description: Retrieve an invite by its ID. You can expand the invite's relations or select the fields that should be returned. - * x-authenticated: false + * x-authenticated: true * parameters: * - name: id * in: path @@ -48,6 +48,10 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_users.ts b/www/utils/generated/oas-output/operations/admin/get_admin_users.ts index c47c93b514..5b8453a45f 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_users.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_users.ts @@ -3,7 +3,7 @@ * operationId: GetUsers * summary: List Users * description: Retrieve a list of users. The users can be filtered by fields such as `id`. The users can also be sorted or paginated. - * x-authenticated: false + * x-authenticated: true * parameters: * - name: fields * in: query @@ -474,6 +474,9 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * security: + * - cookie_auth: [] + * - jwt_token: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_users_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_users_[id].ts index db3880819c..f106fa055d 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_users_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_users_[id].ts @@ -3,7 +3,7 @@ * operationId: GetUsersId * summary: Get a User * description: Retrieve a user by its ID. You can expand the user's relations or select the fields that should be returned. - * x-authenticated: false + * x-authenticated: true * parameters: * - name: id * in: path @@ -48,6 +48,9 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * security: + * - cookie_auth: [] + * - jwt_token: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_users_me.ts b/www/utils/generated/oas-output/operations/admin/get_admin_users_me.ts index 0905c73484..cbe5a6dcbf 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_users_me.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_users_me.ts @@ -3,7 +3,7 @@ * operationId: GetUsersMe * summary: Get Logged-In User * description: Retrieve the logged-in user's details. - * x-authenticated: false + * x-authenticated: true * parameters: * - name: fields * in: query @@ -42,6 +42,9 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * security: + * - cookie_auth: [] + * - jwt_token: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_invites.ts b/www/utils/generated/oas-output/operations/admin/post_admin_invites.ts index d535a8c1fb..d818193ad4 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_invites.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_invites.ts @@ -3,7 +3,7 @@ * operationId: PostInvites * summary: Create Invite * description: Create a invite. - * x-authenticated: false + * x-authenticated: true * parameters: * - name: fields * in: query @@ -65,6 +65,10 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createInvitesWorkflow + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_invites_[id]_resend.ts b/www/utils/generated/oas-output/operations/admin/post_admin_invites_[id]_resend.ts index d22c125aba..0b1fb6d106 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_invites_[id]_resend.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_invites_[id]_resend.ts @@ -3,7 +3,7 @@ * operationId: PostInvitesIdResend * summary: Refresh Invite Token * description: Refresh the token of an invite. - * x-authenticated: false + * x-authenticated: true * parameters: * - name: id * in: path @@ -49,6 +49,10 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: refreshInviteTokensWorkflow + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_invites_accept.ts b/www/utils/generated/oas-output/operations/admin/post_admin_invites_accept.ts index 80ce64627f..7c1e389b2a 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_invites_accept.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_invites_accept.ts @@ -6,7 +6,7 @@ * Accept an invite and create a new user. * * Since the user isn't created yet, the JWT token used in the authorization header is retrieved from the `/auth/user/emailpass/register` API route (or a provider other than `emailpass`). The user can then authenticate using the `/auth/user/emailpass` API route. - * x-authenticated: false + * x-authenticated: true * requestBody: * content: * application/json: @@ -76,6 +76,9 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: acceptInviteWorkflow + * security: + * - cookie_auth: [] + * - jwt_token: [] * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_users_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_users_[id].ts index bfa4b92dde..8c06c01174 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_users_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_users_[id].ts @@ -3,7 +3,7 @@ * operationId: PostUsersId * summary: Update a User * description: Update a user's details. - * x-authenticated: false + * x-authenticated: true * parameters: * - name: id * in: path @@ -61,6 +61,9 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: updateUsersWorkflow + * security: + * - cookie_auth: [] + * - jwt_token: [] * */ diff --git a/www/utils/generated/typedoc-json-output/js-sdk.json b/www/utils/generated/typedoc-json-output/js-sdk.json index 27d410c06d..48f1292ba5 100644 --- a/www/utils/generated/typedoc-json-output/js-sdk.json +++ b/www/utils/generated/typedoc-json-output/js-sdk.json @@ -1,26 +1,26 @@ { - "id": 39150, + "id": 0, "name": "js-sdk", "variant": "project", "kind": 1, "flags": {}, "children": [ { - "id": 39151, + "id": 1, "name": "admin", "variant": "declaration", "kind": 2, "flags": {}, "children": [ { - "id": 40950, + "id": 1800, "name": "ApiKey", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 40954, + "id": 1804, "name": "client", "variant": "declaration", "kind": 1024, @@ -35,34 +35,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/api-key.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/api-key.ts", "line": 9, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 40951, + "id": 1801, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/api-key.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/api-key.ts", "line": 13, "character": 2 } ], "signatures": [ { - "id": 40952, + "id": 1802, "name": "ApiKey", "variant": "signature", "kind": 16384, @@ -75,21 +75,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/api-key.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/api-key.ts", "line": 13, "character": 2 } ], "parameters": [ { - "id": 40953, + "id": 1803, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -97,7 +97,7 @@ ], "type": { "type": "reference", - "target": 40950, + "target": 1800, "name": "ApiKey", "package": "@medusajs/js-sdk" } @@ -105,21 +105,21 @@ ] }, { - "id": 40955, + "id": 1805, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/api-key.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/api-key.ts", "line": 63, "character": 8 } ], "signatures": [ { - "id": 40956, + "id": 1806, "name": "list", "variant": "signature", "kind": 4096, @@ -210,14 +210,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/api-key.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/api-key.ts", "line": 63, "character": 8 } ], "parameters": [ { - "id": 40957, + "id": 1807, "name": "queryParams", "variant": "param", "kind": 32768, @@ -243,7 +243,7 @@ } }, { - "id": 40958, + "id": 1808, "name": "headers", "variant": "param", "kind": 32768, @@ -260,7 +260,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -290,21 +290,21 @@ ] }, { - "id": 40959, + "id": 1809, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/api-key.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/api-key.ts", "line": 93, "character": 8 } ], "signatures": [ { - "id": 40960, + "id": 1810, "name": "create", "variant": "signature", "kind": 4096, @@ -339,14 +339,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/api-key.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/api-key.ts", "line": 93, "character": 8 } ], "parameters": [ { - "id": 40961, + "id": 1811, "name": "body", "variant": "param", "kind": 32768, @@ -370,7 +370,7 @@ } }, { - "id": 40962, + "id": 1812, "name": "query", "variant": "param", "kind": 32768, @@ -396,7 +396,7 @@ } }, { - "id": 40963, + "id": 1813, "name": "headers", "variant": "param", "kind": 32768, @@ -413,7 +413,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -443,21 +443,21 @@ ] }, { - "id": 40964, + "id": 1814, "name": "revoke", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/api-key.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/api-key.ts", "line": 123, "character": 8 } ], "signatures": [ { - "id": 40965, + "id": 1815, "name": "revoke", "variant": "signature", "kind": 4096, @@ -492,14 +492,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/api-key.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/api-key.ts", "line": 123, "character": 8 } ], "parameters": [ { - "id": 40966, + "id": 1816, "name": "id", "variant": "param", "kind": 32768, @@ -518,7 +518,7 @@ } }, { - "id": 40967, + "id": 1817, "name": "headers", "variant": "param", "kind": 32768, @@ -535,7 +535,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -565,21 +565,21 @@ ] }, { - "id": 40968, + "id": 1818, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/api-key.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/api-key.ts", "line": 147, "character": 8 } ], "signatures": [ { - "id": 40969, + "id": 1819, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -614,14 +614,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/api-key.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/api-key.ts", "line": 147, "character": 8 } ], "parameters": [ { - "id": 40970, + "id": 1820, "name": "id", "variant": "param", "kind": 32768, @@ -640,7 +640,7 @@ } }, { - "id": 40971, + "id": 1821, "name": "headers", "variant": "param", "kind": 32768, @@ -657,7 +657,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -687,21 +687,21 @@ ] }, { - "id": 40972, + "id": 1822, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/api-key.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/api-key.ts", "line": 174, "character": 8 } ], "signatures": [ { - "id": 40973, + "id": 1823, "name": "update", "variant": "signature", "kind": 4096, @@ -736,14 +736,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/api-key.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/api-key.ts", "line": 174, "character": 8 } ], "parameters": [ { - "id": 40974, + "id": 1824, "name": "id", "variant": "param", "kind": 32768, @@ -762,7 +762,7 @@ } }, { - "id": 40975, + "id": 1825, "name": "body", "variant": "param", "kind": 32768, @@ -786,7 +786,7 @@ } }, { - "id": 40976, + "id": 1826, "name": "query", "variant": "param", "kind": 32768, @@ -812,7 +812,7 @@ } }, { - "id": 40977, + "id": 1827, "name": "headers", "variant": "param", "kind": 32768, @@ -829,7 +829,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -859,21 +859,21 @@ ] }, { - "id": 40978, + "id": 1828, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/api-key.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/api-key.ts", "line": 205, "character": 8 } ], "signatures": [ { - "id": 40979, + "id": 1829, "name": "delete", "variant": "signature", "kind": 4096, @@ -908,14 +908,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/api-key.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/api-key.ts", "line": 205, "character": 8 } ], "parameters": [ { - "id": 40980, + "id": 1830, "name": "id", "variant": "param", "kind": 32768, @@ -934,7 +934,7 @@ } }, { - "id": 40981, + "id": 1831, "name": "headers", "variant": "param", "kind": 32768, @@ -951,7 +951,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -981,21 +981,21 @@ ] }, { - "id": 40982, + "id": 1832, "name": "batchSalesChannels", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/api-key.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/api-key.ts", "line": 234, "character": 8 } ], "signatures": [ { - "id": 40983, + "id": 1833, "name": "batchSalesChannels", "variant": "signature", "kind": 4096, @@ -1030,14 +1030,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/api-key.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/api-key.ts", "line": 234, "character": 8 } ], "parameters": [ { - "id": 40984, + "id": 1834, "name": "id", "variant": "param", "kind": 32768, @@ -1056,7 +1056,7 @@ } }, { - "id": 40985, + "id": 1835, "name": "body", "variant": "param", "kind": 32768, @@ -1080,7 +1080,7 @@ } }, { - "id": 40986, + "id": 1836, "name": "headers", "variant": "param", "kind": 32768, @@ -1097,7 +1097,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -1131,45 +1131,45 @@ { "title": "Constructors", "children": [ - 40951 + 1801 ] }, { "title": "Properties", "children": [ - 40954 + 1804 ] }, { "title": "Methods", "children": [ - 40955, - 40959, - 40964, - 40968, - 40972, - 40978, - 40982 + 1805, + 1809, + 1814, + 1818, + 1822, + 1828, + 1832 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/api-key.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/api-key.ts", "line": 5, "character": 13 } ] }, { - "id": 41125, + "id": 1975, "name": "Campaign", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 41129, + "id": 1979, "name": "client", "variant": "declaration", "kind": 1024, @@ -1184,34 +1184,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/campaign.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/campaign.ts", "line": 9, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 41126, + "id": 1976, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/campaign.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/campaign.ts", "line": 13, "character": 2 } ], "signatures": [ { - "id": 41127, + "id": 1977, "name": "Campaign", "variant": "signature", "kind": 16384, @@ -1224,21 +1224,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/campaign.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/campaign.ts", "line": 13, "character": 2 } ], "parameters": [ { - "id": 41128, + "id": 1978, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -1246,7 +1246,7 @@ ], "type": { "type": "reference", - "target": 41125, + "target": 1975, "name": "Campaign", "package": "@medusajs/js-sdk" } @@ -1254,21 +1254,21 @@ ] }, { - "id": 41130, + "id": 1980, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/campaign.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/campaign.ts", "line": 49, "character": 8 } ], "signatures": [ { - "id": 41131, + "id": 1981, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -1327,14 +1327,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/campaign.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/campaign.ts", "line": 49, "character": 8 } ], "parameters": [ { - "id": 41132, + "id": 1982, "name": "id", "variant": "param", "kind": 32768, @@ -1353,7 +1353,7 @@ } }, { - "id": 41133, + "id": 1983, "name": "query", "variant": "param", "kind": 32768, @@ -1379,7 +1379,7 @@ } }, { - "id": 41134, + "id": 1984, "name": "headers", "variant": "param", "kind": 32768, @@ -1396,7 +1396,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -1426,21 +1426,21 @@ ] }, { - "id": 41135, + "id": 1985, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/campaign.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/campaign.ts", "line": 109, "character": 8 } ], "signatures": [ { - "id": 41136, + "id": 1986, "name": "list", "variant": "signature", "kind": 4096, @@ -1531,14 +1531,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/campaign.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/campaign.ts", "line": 109, "character": 8 } ], "parameters": [ { - "id": 41137, + "id": 1987, "name": "query", "variant": "param", "kind": 32768, @@ -1564,7 +1564,7 @@ } }, { - "id": 41138, + "id": 1988, "name": "headers", "variant": "param", "kind": 32768, @@ -1581,7 +1581,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -1611,21 +1611,21 @@ ] }, { - "id": 41139, + "id": 1989, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/campaign.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/campaign.ts", "line": 138, "character": 8 } ], "signatures": [ { - "id": 41140, + "id": 1990, "name": "create", "variant": "signature", "kind": 4096, @@ -1660,14 +1660,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/campaign.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/campaign.ts", "line": 138, "character": 8 } ], "parameters": [ { - "id": 41141, + "id": 1991, "name": "payload", "variant": "param", "kind": 32768, @@ -1691,7 +1691,7 @@ } }, { - "id": 41142, + "id": 1992, "name": "headers", "variant": "param", "kind": 32768, @@ -1708,7 +1708,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -1738,21 +1738,21 @@ ] }, { - "id": 41143, + "id": 1993, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/campaign.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/campaign.ts", "line": 169, "character": 8 } ], "signatures": [ { - "id": 41144, + "id": 1994, "name": "update", "variant": "signature", "kind": 4096, @@ -1787,14 +1787,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/campaign.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/campaign.ts", "line": 169, "character": 8 } ], "parameters": [ { - "id": 41145, + "id": 1995, "name": "id", "variant": "param", "kind": 32768, @@ -1813,7 +1813,7 @@ } }, { - "id": 41146, + "id": 1996, "name": "payload", "variant": "param", "kind": 32768, @@ -1837,7 +1837,7 @@ } }, { - "id": 41147, + "id": 1997, "name": "headers", "variant": "param", "kind": 32768, @@ -1854,7 +1854,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -1884,21 +1884,21 @@ ] }, { - "id": 41148, + "id": 1998, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/campaign.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/campaign.ts", "line": 198, "character": 8 } ], "signatures": [ { - "id": 41149, + "id": 1999, "name": "delete", "variant": "signature", "kind": 4096, @@ -1933,14 +1933,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/campaign.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/campaign.ts", "line": 198, "character": 8 } ], "parameters": [ { - "id": 41150, + "id": 2000, "name": "id", "variant": "param", "kind": 32768, @@ -1959,7 +1959,7 @@ } }, { - "id": 41151, + "id": 2001, "name": "headers", "variant": "param", "kind": 32768, @@ -1976,7 +1976,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -2012,21 +2012,21 @@ ] }, { - "id": 41152, + "id": 2002, "name": "batchPromotions", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/campaign.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/campaign.ts", "line": 218, "character": 8 } ], "signatures": [ { - "id": 41153, + "id": 2003, "name": "batchPromotions", "variant": "signature", "kind": 4096, @@ -2052,14 +2052,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/campaign.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/campaign.ts", "line": 218, "character": 8 } ], "parameters": [ { - "id": 41154, + "id": 2004, "name": "id", "variant": "param", "kind": 32768, @@ -2078,7 +2078,7 @@ } }, { - "id": 41155, + "id": 2005, "name": "payload", "variant": "param", "kind": 32768, @@ -2102,7 +2102,7 @@ } }, { - "id": 41156, + "id": 2006, "name": "headers", "variant": "param", "kind": 32768, @@ -2119,7 +2119,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -2153,44 +2153,44 @@ { "title": "Constructors", "children": [ - 41126 + 1976 ] }, { "title": "Properties", "children": [ - 41129 + 1979 ] }, { "title": "Methods", "children": [ - 41130, - 41135, - 41139, - 41143, - 41148, - 41152 + 1980, + 1985, + 1989, + 1993, + 1998, + 2002 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/campaign.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/campaign.ts", "line": 5, "character": 13 } ] }, { - "id": 40498, + "id": 1348, "name": "Claim", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 40502, + "id": 1352, "name": "client", "variant": "declaration", "kind": 1024, @@ -2205,34 +2205,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 10, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 40499, + "id": 1349, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 14, "character": 2 } ], "signatures": [ { - "id": 40500, + "id": 1350, "name": "Claim", "variant": "signature", "kind": 16384, @@ -2245,21 +2245,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 14, "character": 2 } ], "parameters": [ { - "id": 40501, + "id": 1351, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -2267,7 +2267,7 @@ ], "type": { "type": "reference", - "target": 40498, + "target": 1348, "name": "Claim", "package": "@medusajs/js-sdk" } @@ -2275,21 +2275,21 @@ ] }, { - "id": 40503, + "id": 1353, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 64, "character": 8 } ], "signatures": [ { - "id": 40504, + "id": 1354, "name": "list", "variant": "signature", "kind": 4096, @@ -2380,14 +2380,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 64, "character": 8 } ], "parameters": [ { - "id": 40505, + "id": 1355, "name": "query", "variant": "param", "kind": 32768, @@ -2413,7 +2413,7 @@ } }, { - "id": 40506, + "id": 1356, "name": "headers", "variant": "param", "kind": 32768, @@ -2430,7 +2430,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -2460,21 +2460,21 @@ ] }, { - "id": 40507, + "id": 1357, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 106, "character": 8 } ], "signatures": [ { - "id": 40508, + "id": 1358, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -2533,14 +2533,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 106, "character": 8 } ], "parameters": [ { - "id": 40509, + "id": 1359, "name": "id", "variant": "param", "kind": 32768, @@ -2559,7 +2559,7 @@ } }, { - "id": 40510, + "id": 1360, "name": "query", "variant": "param", "kind": 32768, @@ -2585,7 +2585,7 @@ } }, { - "id": 40511, + "id": 1361, "name": "headers", "variant": "param", "kind": 32768, @@ -2602,7 +2602,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -2632,21 +2632,21 @@ ] }, { - "id": 40512, + "id": 1362, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 138, "character": 8 } ], "signatures": [ { - "id": 40513, + "id": 1363, "name": "create", "variant": "signature", "kind": 4096, @@ -2681,14 +2681,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 138, "character": 8 } ], "parameters": [ { - "id": 40514, + "id": 1364, "name": "body", "variant": "param", "kind": 32768, @@ -2712,7 +2712,7 @@ } }, { - "id": 40515, + "id": 1365, "name": "query", "variant": "param", "kind": 32768, @@ -2738,7 +2738,7 @@ } }, { - "id": 40516, + "id": 1366, "name": "headers", "variant": "param", "kind": 32768, @@ -2755,7 +2755,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -2785,21 +2785,21 @@ ] }, { - "id": 40517, + "id": 1367, "name": "cancel", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 169, "character": 8 } ], "signatures": [ { - "id": 40518, + "id": 1368, "name": "cancel", "variant": "signature", "kind": 4096, @@ -2834,14 +2834,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 169, "character": 8 } ], "parameters": [ { - "id": 40519, + "id": 1369, "name": "id", "variant": "param", "kind": 32768, @@ -2860,7 +2860,7 @@ } }, { - "id": 40520, + "id": 1370, "name": "query", "variant": "param", "kind": 32768, @@ -2886,7 +2886,7 @@ } }, { - "id": 40521, + "id": 1371, "name": "headers", "variant": "param", "kind": 32768, @@ -2903,7 +2903,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -2933,21 +2933,21 @@ ] }, { - "id": 40522, + "id": 1372, "name": "addItems", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 207, "character": 8 } ], "signatures": [ { - "id": 40523, + "id": 1373, "name": "addItems", "variant": "signature", "kind": 4096, @@ -2982,14 +2982,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 207, "character": 8 } ], "parameters": [ { - "id": 40524, + "id": 1374, "name": "id", "variant": "param", "kind": 32768, @@ -3008,7 +3008,7 @@ } }, { - "id": 40525, + "id": 1375, "name": "body", "variant": "param", "kind": 32768, @@ -3032,7 +3032,7 @@ } }, { - "id": 40526, + "id": 1376, "name": "query", "variant": "param", "kind": 32768, @@ -3058,7 +3058,7 @@ } }, { - "id": 40527, + "id": 1377, "name": "headers", "variant": "param", "kind": 32768, @@ -3075,7 +3075,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -3105,21 +3105,21 @@ ] }, { - "id": 40528, + "id": 1378, "name": "updateItem", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 250, "character": 8 } ], "signatures": [ { - "id": 40529, + "id": 1379, "name": "updateItem", "variant": "signature", "kind": 4096, @@ -3186,14 +3186,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 250, "character": 8 } ], "parameters": [ { - "id": 40530, + "id": 1380, "name": "id", "variant": "param", "kind": 32768, @@ -3212,7 +3212,7 @@ } }, { - "id": 40531, + "id": 1381, "name": "actionId", "variant": "param", "kind": 32768, @@ -3239,7 +3239,7 @@ } }, { - "id": 40532, + "id": 1382, "name": "body", "variant": "param", "kind": 32768, @@ -3263,7 +3263,7 @@ } }, { - "id": 40533, + "id": 1383, "name": "query", "variant": "param", "kind": 32768, @@ -3289,7 +3289,7 @@ } }, { - "id": 40534, + "id": 1384, "name": "headers", "variant": "param", "kind": 32768, @@ -3306,7 +3306,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -3336,21 +3336,21 @@ ] }, { - "id": 40535, + "id": 1385, "name": "removeItem", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 291, "character": 8 } ], "signatures": [ { - "id": 40536, + "id": 1386, "name": "removeItem", "variant": "signature", "kind": 4096, @@ -3417,14 +3417,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 291, "character": 8 } ], "parameters": [ { - "id": 40537, + "id": 1387, "name": "id", "variant": "param", "kind": 32768, @@ -3443,7 +3443,7 @@ } }, { - "id": 40538, + "id": 1388, "name": "actionId", "variant": "param", "kind": 32768, @@ -3470,7 +3470,7 @@ } }, { - "id": 40539, + "id": 1389, "name": "query", "variant": "param", "kind": 32768, @@ -3496,7 +3496,7 @@ } }, { - "id": 40540, + "id": 1390, "name": "headers", "variant": "param", "kind": 32768, @@ -3513,7 +3513,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -3543,21 +3543,21 @@ ] }, { - "id": 40541, + "id": 1391, "name": "addInboundItems", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 335, "character": 8 } ], "signatures": [ { - "id": 40542, + "id": 1392, "name": "addInboundItems", "variant": "signature", "kind": 4096, @@ -3600,14 +3600,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 335, "character": 8 } ], "parameters": [ { - "id": 40543, + "id": 1393, "name": "id", "variant": "param", "kind": 32768, @@ -3626,7 +3626,7 @@ } }, { - "id": 40544, + "id": 1394, "name": "body", "variant": "param", "kind": 32768, @@ -3650,7 +3650,7 @@ } }, { - "id": 40545, + "id": 1395, "name": "query", "variant": "param", "kind": 32768, @@ -3676,7 +3676,7 @@ } }, { - "id": 40546, + "id": 1396, "name": "headers", "variant": "param", "kind": 32768, @@ -3693,7 +3693,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -3723,21 +3723,21 @@ ] }, { - "id": 40547, + "id": 1397, "name": "updateInboundItem", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 379, "character": 8 } ], "signatures": [ { - "id": 40548, + "id": 1398, "name": "updateInboundItem", "variant": "signature", "kind": 4096, @@ -3804,14 +3804,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 379, "character": 8 } ], "parameters": [ { - "id": 40549, + "id": 1399, "name": "id", "variant": "param", "kind": 32768, @@ -3830,7 +3830,7 @@ } }, { - "id": 40550, + "id": 1400, "name": "actionId", "variant": "param", "kind": 32768, @@ -3857,7 +3857,7 @@ } }, { - "id": 40551, + "id": 1401, "name": "body", "variant": "param", "kind": 32768, @@ -3881,7 +3881,7 @@ } }, { - "id": 40552, + "id": 1402, "name": "query", "variant": "param", "kind": 32768, @@ -3907,7 +3907,7 @@ } }, { - "id": 40553, + "id": 1403, "name": "headers", "variant": "param", "kind": 32768, @@ -3924,7 +3924,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -3954,21 +3954,21 @@ ] }, { - "id": 40554, + "id": 1404, "name": "removeInboundItem", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 420, "character": 8 } ], "signatures": [ { - "id": 40555, + "id": 1405, "name": "removeInboundItem", "variant": "signature", "kind": 4096, @@ -4035,14 +4035,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 420, "character": 8 } ], "parameters": [ { - "id": 40556, + "id": 1406, "name": "id", "variant": "param", "kind": 32768, @@ -4061,7 +4061,7 @@ } }, { - "id": 40557, + "id": 1407, "name": "actionId", "variant": "param", "kind": 32768, @@ -4088,7 +4088,7 @@ } }, { - "id": 40558, + "id": 1408, "name": "query", "variant": "param", "kind": 32768, @@ -4114,7 +4114,7 @@ } }, { - "id": 40559, + "id": 1409, "name": "headers", "variant": "param", "kind": 32768, @@ -4131,7 +4131,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -4161,21 +4161,21 @@ ] }, { - "id": 40560, + "id": 1410, "name": "addInboundShipping", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 461, "character": 8 } ], "signatures": [ { - "id": 40561, + "id": 1411, "name": "addInboundShipping", "variant": "signature", "kind": 4096, @@ -4218,14 +4218,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 461, "character": 8 } ], "parameters": [ { - "id": 40562, + "id": 1412, "name": "id", "variant": "param", "kind": 32768, @@ -4244,7 +4244,7 @@ } }, { - "id": 40563, + "id": 1413, "name": "body", "variant": "param", "kind": 32768, @@ -4268,7 +4268,7 @@ } }, { - "id": 40564, + "id": 1414, "name": "query", "variant": "param", "kind": 32768, @@ -4294,7 +4294,7 @@ } }, { - "id": 40565, + "id": 1415, "name": "headers", "variant": "param", "kind": 32768, @@ -4311,7 +4311,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -4341,21 +4341,21 @@ ] }, { - "id": 40566, + "id": 1416, "name": "updateInboundShipping", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 505, "character": 8 } ], "signatures": [ { - "id": 40567, + "id": 1417, "name": "updateInboundShipping", "variant": "signature", "kind": 4096, @@ -4422,14 +4422,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 505, "character": 8 } ], "parameters": [ { - "id": 40568, + "id": 1418, "name": "id", "variant": "param", "kind": 32768, @@ -4448,7 +4448,7 @@ } }, { - "id": 40569, + "id": 1419, "name": "actionId", "variant": "param", "kind": 32768, @@ -4475,7 +4475,7 @@ } }, { - "id": 40570, + "id": 1420, "name": "body", "variant": "param", "kind": 32768, @@ -4499,7 +4499,7 @@ } }, { - "id": 40571, + "id": 1421, "name": "query", "variant": "param", "kind": 32768, @@ -4525,7 +4525,7 @@ } }, { - "id": 40572, + "id": 1422, "name": "headers", "variant": "param", "kind": 32768, @@ -4542,7 +4542,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -4572,21 +4572,21 @@ ] }, { - "id": 40573, + "id": 1423, "name": "deleteInboundShipping", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 546, "character": 8 } ], "signatures": [ { - "id": 40574, + "id": 1424, "name": "deleteInboundShipping", "variant": "signature", "kind": 4096, @@ -4653,14 +4653,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 546, "character": 8 } ], "parameters": [ { - "id": 40575, + "id": 1425, "name": "id", "variant": "param", "kind": 32768, @@ -4679,7 +4679,7 @@ } }, { - "id": 40576, + "id": 1426, "name": "actionId", "variant": "param", "kind": 32768, @@ -4706,7 +4706,7 @@ } }, { - "id": 40577, + "id": 1427, "name": "query", "variant": "param", "kind": 32768, @@ -4732,7 +4732,7 @@ } }, { - "id": 40578, + "id": 1428, "name": "headers", "variant": "param", "kind": 32768, @@ -4749,7 +4749,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -4779,21 +4779,21 @@ ] }, { - "id": 40579, + "id": 1429, "name": "addOutboundItems", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 587, "character": 8 } ], "signatures": [ { - "id": 40580, + "id": 1430, "name": "addOutboundItems", "variant": "signature", "kind": 4096, @@ -4836,14 +4836,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 587, "character": 8 } ], "parameters": [ { - "id": 40581, + "id": 1431, "name": "id", "variant": "param", "kind": 32768, @@ -4862,7 +4862,7 @@ } }, { - "id": 40582, + "id": 1432, "name": "body", "variant": "param", "kind": 32768, @@ -4886,7 +4886,7 @@ } }, { - "id": 40583, + "id": 1433, "name": "query", "variant": "param", "kind": 32768, @@ -4912,7 +4912,7 @@ } }, { - "id": 40584, + "id": 1434, "name": "headers", "variant": "param", "kind": 32768, @@ -4929,7 +4929,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -4959,21 +4959,21 @@ ] }, { - "id": 40585, + "id": 1435, "name": "updateOutboundItem", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 631, "character": 8 } ], "signatures": [ { - "id": 40586, + "id": 1436, "name": "updateOutboundItem", "variant": "signature", "kind": 4096, @@ -5040,14 +5040,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 631, "character": 8 } ], "parameters": [ { - "id": 40587, + "id": 1437, "name": "id", "variant": "param", "kind": 32768, @@ -5066,7 +5066,7 @@ } }, { - "id": 40588, + "id": 1438, "name": "actionId", "variant": "param", "kind": 32768, @@ -5093,7 +5093,7 @@ } }, { - "id": 40589, + "id": 1439, "name": "body", "variant": "param", "kind": 32768, @@ -5117,7 +5117,7 @@ } }, { - "id": 40590, + "id": 1440, "name": "query", "variant": "param", "kind": 32768, @@ -5143,7 +5143,7 @@ } }, { - "id": 40591, + "id": 1441, "name": "headers", "variant": "param", "kind": 32768, @@ -5160,7 +5160,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -5190,21 +5190,21 @@ ] }, { - "id": 40592, + "id": 1442, "name": "removeOutboundItem", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 672, "character": 8 } ], "signatures": [ { - "id": 40593, + "id": 1443, "name": "removeOutboundItem", "variant": "signature", "kind": 4096, @@ -5271,14 +5271,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 672, "character": 8 } ], "parameters": [ { - "id": 40594, + "id": 1444, "name": "id", "variant": "param", "kind": 32768, @@ -5297,7 +5297,7 @@ } }, { - "id": 40595, + "id": 1445, "name": "actionId", "variant": "param", "kind": 32768, @@ -5324,7 +5324,7 @@ } }, { - "id": 40596, + "id": 1446, "name": "query", "variant": "param", "kind": 32768, @@ -5350,7 +5350,7 @@ } }, { - "id": 40597, + "id": 1447, "name": "headers", "variant": "param", "kind": 32768, @@ -5367,7 +5367,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -5397,21 +5397,21 @@ ] }, { - "id": 40598, + "id": 1448, "name": "addOutboundShipping", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 714, "character": 8 } ], "signatures": [ { - "id": 40599, + "id": 1449, "name": "addOutboundShipping", "variant": "signature", "kind": 4096, @@ -5454,14 +5454,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 714, "character": 8 } ], "parameters": [ { - "id": 40600, + "id": 1450, "name": "id", "variant": "param", "kind": 32768, @@ -5480,7 +5480,7 @@ } }, { - "id": 40601, + "id": 1451, "name": "body", "variant": "param", "kind": 32768, @@ -5504,7 +5504,7 @@ } }, { - "id": 40602, + "id": 1452, "name": "query", "variant": "param", "kind": 32768, @@ -5530,7 +5530,7 @@ } }, { - "id": 40603, + "id": 1453, "name": "headers", "variant": "param", "kind": 32768, @@ -5547,7 +5547,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -5577,21 +5577,21 @@ ] }, { - "id": 40604, + "id": 1454, "name": "updateOutboundShipping", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 758, "character": 8 } ], "signatures": [ { - "id": 40605, + "id": 1455, "name": "updateOutboundShipping", "variant": "signature", "kind": 4096, @@ -5658,14 +5658,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 758, "character": 8 } ], "parameters": [ { - "id": 40606, + "id": 1456, "name": "id", "variant": "param", "kind": 32768, @@ -5684,7 +5684,7 @@ } }, { - "id": 40607, + "id": 1457, "name": "actionId", "variant": "param", "kind": 32768, @@ -5711,7 +5711,7 @@ } }, { - "id": 40608, + "id": 1458, "name": "body", "variant": "param", "kind": 32768, @@ -5735,7 +5735,7 @@ } }, { - "id": 40609, + "id": 1459, "name": "query", "variant": "param", "kind": 32768, @@ -5761,7 +5761,7 @@ } }, { - "id": 40610, + "id": 1460, "name": "headers", "variant": "param", "kind": 32768, @@ -5778,7 +5778,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -5808,21 +5808,21 @@ ] }, { - "id": 40611, + "id": 1461, "name": "deleteOutboundShipping", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 797, "character": 8 } ], "signatures": [ { - "id": 40612, + "id": 1462, "name": "deleteOutboundShipping", "variant": "signature", "kind": 4096, @@ -5889,14 +5889,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 797, "character": 8 } ], "parameters": [ { - "id": 40613, + "id": 1463, "name": "id", "variant": "param", "kind": 32768, @@ -5915,7 +5915,7 @@ } }, { - "id": 40614, + "id": 1464, "name": "actionId", "variant": "param", "kind": 32768, @@ -5942,7 +5942,7 @@ } }, { - "id": 40615, + "id": 1465, "name": "query", "variant": "param", "kind": 32768, @@ -5968,7 +5968,7 @@ } }, { - "id": 40616, + "id": 1466, "name": "headers", "variant": "param", "kind": 32768, @@ -5985,7 +5985,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -6015,21 +6015,21 @@ ] }, { - "id": 40617, + "id": 1467, "name": "request", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 833, "character": 8 } ], "signatures": [ { - "id": 40618, + "id": 1468, "name": "request", "variant": "signature", "kind": 4096, @@ -6064,14 +6064,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 833, "character": 8 } ], "parameters": [ { - "id": 40619, + "id": 1469, "name": "id", "variant": "param", "kind": 32768, @@ -6090,7 +6090,7 @@ } }, { - "id": 40620, + "id": 1470, "name": "body", "variant": "param", "kind": 32768, @@ -6114,7 +6114,7 @@ } }, { - "id": 40621, + "id": 1471, "name": "query", "variant": "param", "kind": 32768, @@ -6140,7 +6140,7 @@ } }, { - "id": 40622, + "id": 1472, "name": "headers", "variant": "param", "kind": 32768, @@ -6157,7 +6157,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -6187,21 +6187,21 @@ ] }, { - "id": 40623, + "id": 1473, "name": "cancelRequest", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 868, "character": 8 } ], "signatures": [ { - "id": 40624, + "id": 1474, "name": "cancelRequest", "variant": "signature", "kind": 4096, @@ -6236,14 +6236,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 868, "character": 8 } ], "parameters": [ { - "id": 40625, + "id": 1475, "name": "id", "variant": "param", "kind": 32768, @@ -6262,7 +6262,7 @@ } }, { - "id": 40626, + "id": 1476, "name": "query", "variant": "param", "kind": 32768, @@ -6288,7 +6288,7 @@ } }, { - "id": 40627, + "id": 1477, "name": "headers", "variant": "param", "kind": 32768, @@ -6305,7 +6305,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -6339,59 +6339,59 @@ { "title": "Constructors", "children": [ - 40499 + 1349 ] }, { "title": "Properties", "children": [ - 40502 + 1352 ] }, { "title": "Methods", "children": [ - 40503, - 40507, - 40512, - 40517, - 40522, - 40528, - 40535, - 40541, - 40547, - 40554, - 40560, - 40566, - 40573, - 40579, - 40585, - 40592, - 40598, - 40604, - 40611, - 40617, - 40623 + 1353, + 1357, + 1362, + 1367, + 1372, + 1378, + 1385, + 1391, + 1397, + 1404, + 1410, + 1416, + 1423, + 1429, + 1435, + 1442, + 1448, + 1454, + 1461, + 1467, + 1473 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/claim.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/claim.ts", "line": 6, "character": 13 } ] }, { - "id": 40868, + "id": 1718, "name": "Currency", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 40872, + "id": 1722, "name": "client", "variant": "declaration", "kind": 1024, @@ -6406,34 +6406,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/currency.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/currency.ts", "line": 9, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 40869, + "id": 1719, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/currency.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/currency.ts", "line": 13, "character": 2 } ], "signatures": [ { - "id": 40870, + "id": 1720, "name": "Currency", "variant": "signature", "kind": 16384, @@ -6446,21 +6446,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/currency.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/currency.ts", "line": 13, "character": 2 } ], "parameters": [ { - "id": 40871, + "id": 1721, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -6468,7 +6468,7 @@ ], "type": { "type": "reference", - "target": 40868, + "target": 1718, "name": "Currency", "package": "@medusajs/js-sdk" } @@ -6476,21 +6476,21 @@ ] }, { - "id": 40873, + "id": 1723, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/currency.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/currency.ts", "line": 64, "character": 8 } ], "signatures": [ { - "id": 40874, + "id": 1724, "name": "list", "variant": "signature", "kind": 4096, @@ -6581,14 +6581,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/currency.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/currency.ts", "line": 64, "character": 8 } ], "parameters": [ { - "id": 40875, + "id": 1725, "name": "query", "variant": "param", "kind": 32768, @@ -6614,7 +6614,7 @@ } }, { - "id": 40876, + "id": 1726, "name": "headers", "variant": "param", "kind": 32768, @@ -6631,7 +6631,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -6661,21 +6661,21 @@ ] }, { - "id": 40877, + "id": 1727, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/currency.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/currency.ts", "line": 109, "character": 8 } ], "signatures": [ { - "id": 40878, + "id": 1728, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -6734,14 +6734,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/currency.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/currency.ts", "line": 109, "character": 8 } ], "parameters": [ { - "id": 40879, + "id": 1729, "name": "code", "variant": "param", "kind": 32768, @@ -6760,7 +6760,7 @@ } }, { - "id": 40880, + "id": 1730, "name": "query", "variant": "param", "kind": 32768, @@ -6786,7 +6786,7 @@ } }, { - "id": 40881, + "id": 1731, "name": "headers", "variant": "param", "kind": 32768, @@ -6803,7 +6803,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -6837,40 +6837,40 @@ { "title": "Constructors", "children": [ - 40869 + 1719 ] }, { "title": "Properties", "children": [ - 40872 + 1722 ] }, { "title": "Methods", "children": [ - 40873, - 40877 + 1723, + 1727 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/currency.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/currency.ts", "line": 5, "character": 13 } ] }, { - "id": 41029, + "id": 1879, "name": "CustomerGroup", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 41033, + "id": 1883, "name": "client", "variant": "declaration", "kind": 1024, @@ -6885,34 +6885,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/customer-group.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/customer-group.ts", "line": 9, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 41030, + "id": 1880, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/customer-group.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/customer-group.ts", "line": 13, "character": 2 } ], "signatures": [ { - "id": 41031, + "id": 1881, "name": "CustomerGroup", "variant": "signature", "kind": 16384, @@ -6925,21 +6925,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/customer-group.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/customer-group.ts", "line": 13, "character": 2 } ], "parameters": [ { - "id": 41032, + "id": 1882, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -6947,7 +6947,7 @@ ], "type": { "type": "reference", - "target": 41029, + "target": 1879, "name": "CustomerGroup", "package": "@medusajs/js-sdk" } @@ -6955,21 +6955,21 @@ ] }, { - "id": 41034, + "id": 1884, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/customer-group.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/customer-group.ts", "line": 49, "character": 8 } ], "signatures": [ { - "id": 41035, + "id": 1885, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -7028,14 +7028,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/customer-group.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/customer-group.ts", "line": 49, "character": 8 } ], "parameters": [ { - "id": 41036, + "id": 1886, "name": "id", "variant": "param", "kind": 32768, @@ -7054,7 +7054,7 @@ } }, { - "id": 41037, + "id": 1887, "name": "query", "variant": "param", "kind": 32768, @@ -7080,7 +7080,7 @@ } }, { - "id": 41038, + "id": 1888, "name": "headers", "variant": "param", "kind": 32768, @@ -7097,7 +7097,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -7127,21 +7127,21 @@ ] }, { - "id": 41039, + "id": 1889, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/customer-group.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/customer-group.ts", "line": 111, "character": 8 } ], "signatures": [ { - "id": 41040, + "id": 1890, "name": "list", "variant": "signature", "kind": 4096, @@ -7232,14 +7232,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/customer-group.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/customer-group.ts", "line": 111, "character": 8 } ], "parameters": [ { - "id": 41041, + "id": 1891, "name": "query", "variant": "param", "kind": 32768, @@ -7265,7 +7265,7 @@ } }, { - "id": 41042, + "id": 1892, "name": "headers", "variant": "param", "kind": 32768, @@ -7282,7 +7282,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -7312,21 +7312,21 @@ ] }, { - "id": 41043, + "id": 1893, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/customer-group.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/customer-group.ts", "line": 143, "character": 8 } ], "signatures": [ { - "id": 41044, + "id": 1894, "name": "create", "variant": "signature", "kind": 4096, @@ -7361,14 +7361,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/customer-group.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/customer-group.ts", "line": 143, "character": 8 } ], "parameters": [ { - "id": 41045, + "id": 1895, "name": "body", "variant": "param", "kind": 32768, @@ -7392,7 +7392,7 @@ } }, { - "id": 41046, + "id": 1896, "name": "query", "variant": "param", "kind": 32768, @@ -7418,7 +7418,7 @@ } }, { - "id": 41047, + "id": 1897, "name": "headers", "variant": "param", "kind": 32768, @@ -7435,7 +7435,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -7465,21 +7465,21 @@ ] }, { - "id": 41048, + "id": 1898, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/customer-group.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/customer-group.ts", "line": 178, "character": 8 } ], "signatures": [ { - "id": 41049, + "id": 1899, "name": "update", "variant": "signature", "kind": 4096, @@ -7514,14 +7514,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/customer-group.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/customer-group.ts", "line": 178, "character": 8 } ], "parameters": [ { - "id": 41050, + "id": 1900, "name": "id", "variant": "param", "kind": 32768, @@ -7540,7 +7540,7 @@ } }, { - "id": 41051, + "id": 1901, "name": "body", "variant": "param", "kind": 32768, @@ -7564,7 +7564,7 @@ } }, { - "id": 41052, + "id": 1902, "name": "query", "variant": "param", "kind": 32768, @@ -7590,7 +7590,7 @@ } }, { - "id": 41053, + "id": 1903, "name": "headers", "variant": "param", "kind": 32768, @@ -7607,7 +7607,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -7637,21 +7637,21 @@ ] }, { - "id": 41054, + "id": 1904, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/customer-group.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/customer-group.ts", "line": 210, "character": 8 } ], "signatures": [ { - "id": 41055, + "id": 1905, "name": "delete", "variant": "signature", "kind": 4096, @@ -7686,14 +7686,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/customer-group.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/customer-group.ts", "line": 210, "character": 8 } ], "parameters": [ { - "id": 41056, + "id": 1906, "name": "id", "variant": "param", "kind": 32768, @@ -7712,7 +7712,7 @@ } }, { - "id": 41057, + "id": 1907, "name": "headers", "variant": "param", "kind": 32768, @@ -7729,7 +7729,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -7759,21 +7759,21 @@ ] }, { - "id": 41058, + "id": 1908, "name": "batchCustomers", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/customer-group.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/customer-group.ts", "line": 239, "character": 8 } ], "signatures": [ { - "id": 41059, + "id": 1909, "name": "batchCustomers", "variant": "signature", "kind": 4096, @@ -7808,14 +7808,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/customer-group.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/customer-group.ts", "line": 239, "character": 8 } ], "parameters": [ { - "id": 41060, + "id": 1910, "name": "id", "variant": "param", "kind": 32768, @@ -7834,7 +7834,7 @@ } }, { - "id": 41061, + "id": 1911, "name": "body", "variant": "param", "kind": 32768, @@ -7858,7 +7858,7 @@ } }, { - "id": 41062, + "id": 1912, "name": "headers", "variant": "param", "kind": 32768, @@ -7875,7 +7875,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -7909,44 +7909,44 @@ { "title": "Constructors", "children": [ - 41030 + 1880 ] }, { "title": "Properties", "children": [ - 41033 + 1883 ] }, { "title": "Methods", "children": [ - 41034, - 41039, - 41043, - 41048, - 41054, - 41058 + 1884, + 1889, + 1893, + 1898, + 1904, + 1908 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/customer-group.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/customer-group.ts", "line": 5, "character": 13 } ] }, { - "id": 39514, + "id": 364, "name": "Customer", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 39518, + "id": 368, "name": "client", "variant": "declaration", "kind": 1024, @@ -7961,34 +7961,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/customer.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/customer.ts", "line": 12, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 39515, + "id": 365, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/customer.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/customer.ts", "line": 16, "character": 2 } ], "signatures": [ { - "id": 39516, + "id": 366, "name": "Customer", "variant": "signature", "kind": 16384, @@ -8001,21 +8001,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/customer.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/customer.ts", "line": 16, "character": 2 } ], "parameters": [ { - "id": 39517, + "id": 367, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -8023,7 +8023,7 @@ ], "type": { "type": "reference", - "target": 39514, + "target": 364, "name": "Customer", "package": "@medusajs/js-sdk" } @@ -8031,21 +8031,21 @@ ] }, { - "id": 39519, + "id": 369, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/customer.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/customer.ts", "line": 37, "character": 8 } ], "signatures": [ { - "id": 39520, + "id": 370, "name": "create", "variant": "signature", "kind": 4096, @@ -8080,14 +8080,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/customer.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/customer.ts", "line": 37, "character": 8 } ], "parameters": [ { - "id": 39521, + "id": 371, "name": "body", "variant": "param", "kind": 32768, @@ -8111,7 +8111,7 @@ } }, { - "id": 39522, + "id": 372, "name": "query", "variant": "param", "kind": 32768, @@ -8137,7 +8137,7 @@ } }, { - "id": 39523, + "id": 373, "name": "headers", "variant": "param", "kind": 32768, @@ -8154,7 +8154,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -8184,21 +8184,21 @@ ] }, { - "id": 39524, + "id": 374, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/customer.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/customer.ts", "line": 70, "character": 8 } ], "signatures": [ { - "id": 39525, + "id": 375, "name": "update", "variant": "signature", "kind": 4096, @@ -8233,14 +8233,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/customer.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/customer.ts", "line": 70, "character": 8 } ], "parameters": [ { - "id": 39526, + "id": 376, "name": "id", "variant": "param", "kind": 32768, @@ -8259,7 +8259,7 @@ } }, { - "id": 39527, + "id": 377, "name": "body", "variant": "param", "kind": 32768, @@ -8283,7 +8283,7 @@ } }, { - "id": 39528, + "id": 378, "name": "query", "variant": "param", "kind": 32768, @@ -8309,7 +8309,7 @@ } }, { - "id": 39529, + "id": 379, "name": "headers", "variant": "param", "kind": 32768, @@ -8326,7 +8326,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -8356,21 +8356,21 @@ ] }, { - "id": 39530, + "id": 380, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/customer.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/customer.ts", "line": 134, "character": 8 } ], "signatures": [ { - "id": 39531, + "id": 381, "name": "list", "variant": "signature", "kind": 4096, @@ -8461,14 +8461,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/customer.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/customer.ts", "line": 134, "character": 8 } ], "parameters": [ { - "id": 39532, + "id": 382, "name": "queryParams", "variant": "param", "kind": 32768, @@ -8494,7 +8494,7 @@ } }, { - "id": 39533, + "id": 383, "name": "headers", "variant": "param", "kind": 32768, @@ -8511,7 +8511,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -8541,21 +8541,21 @@ ] }, { - "id": 39534, + "id": 384, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/customer.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/customer.ts", "line": 179, "character": 8 } ], "signatures": [ { - "id": 39535, + "id": 385, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -8614,14 +8614,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/customer.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/customer.ts", "line": 179, "character": 8 } ], "parameters": [ { - "id": 39536, + "id": 386, "name": "id", "variant": "param", "kind": 32768, @@ -8640,7 +8640,7 @@ } }, { - "id": 39537, + "id": 387, "name": "query", "variant": "param", "kind": 32768, @@ -8666,7 +8666,7 @@ } }, { - "id": 39538, + "id": 388, "name": "headers", "variant": "param", "kind": 32768, @@ -8683,7 +8683,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -8713,21 +8713,21 @@ ] }, { - "id": 39539, + "id": 389, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/customer.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/customer.ts", "line": 204, "character": 8 } ], "signatures": [ { - "id": 39540, + "id": 390, "name": "delete", "variant": "signature", "kind": 4096, @@ -8762,14 +8762,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/customer.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/customer.ts", "line": 204, "character": 8 } ], "parameters": [ { - "id": 39541, + "id": 391, "name": "id", "variant": "param", "kind": 32768, @@ -8788,7 +8788,7 @@ } }, { - "id": 39542, + "id": 392, "name": "headers", "variant": "param", "kind": 32768, @@ -8805,7 +8805,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -8835,21 +8835,21 @@ ] }, { - "id": 39543, + "id": 393, "name": "batchCustomerGroups", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/customer.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/customer.ts", "line": 233, "character": 8 } ], "signatures": [ { - "id": 39544, + "id": 394, "name": "batchCustomerGroups", "variant": "signature", "kind": 4096, @@ -8884,14 +8884,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/customer.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/customer.ts", "line": 233, "character": 8 } ], "parameters": [ { - "id": 39545, + "id": 395, "name": "id", "variant": "param", "kind": 32768, @@ -8910,7 +8910,7 @@ } }, { - "id": 39546, + "id": 396, "name": "body", "variant": "param", "kind": 32768, @@ -8934,7 +8934,7 @@ } }, { - "id": 39547, + "id": 397, "name": "headers", "variant": "param", "kind": 32768, @@ -8951,7 +8951,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -8985,44 +8985,44 @@ { "title": "Constructors", "children": [ - 39515 + 365 ] }, { "title": "Properties", "children": [ - 39518 + 368 ] }, { "title": "Methods", "children": [ - 39519, - 39524, - 39530, - 39534, - 39539, - 39543 + 369, + 374, + 380, + 384, + 389, + 393 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/customer.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/customer.ts", "line": 8, "character": 13 } ] }, { - "id": 40288, + "id": 1138, "name": "DraftOrder", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 40292, + "id": 1142, "name": "client", "variant": "declaration", "kind": 1024, @@ -9037,34 +9037,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/draft-order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/draft-order.ts", "line": 10, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 40289, + "id": 1139, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/draft-order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/draft-order.ts", "line": 14, "character": 2 } ], "signatures": [ { - "id": 40290, + "id": 1140, "name": "DraftOrder", "variant": "signature", "kind": 16384, @@ -9077,21 +9077,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/draft-order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/draft-order.ts", "line": 14, "character": 2 } ], "parameters": [ { - "id": 40291, + "id": 1141, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -9099,7 +9099,7 @@ ], "type": { "type": "reference", - "target": 40288, + "target": 1138, "name": "DraftOrder", "package": "@medusajs/js-sdk" } @@ -9107,21 +9107,21 @@ ] }, { - "id": 40293, + "id": 1143, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/draft-order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/draft-order.ts", "line": 51, "character": 8 } ], "signatures": [ { - "id": 40294, + "id": 1144, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -9180,14 +9180,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/draft-order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/draft-order.ts", "line": 51, "character": 8 } ], "parameters": [ { - "id": 40295, + "id": 1145, "name": "id", "variant": "param", "kind": 32768, @@ -9206,7 +9206,7 @@ } }, { - "id": 40296, + "id": 1146, "name": "query", "variant": "param", "kind": 32768, @@ -9232,7 +9232,7 @@ } }, { - "id": 40297, + "id": 1147, "name": "headers", "variant": "param", "kind": 32768, @@ -9249,7 +9249,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -9279,21 +9279,21 @@ ] }, { - "id": 40298, + "id": 1148, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/draft-order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/draft-order.ts", "line": 111, "character": 8 } ], "signatures": [ { - "id": 40299, + "id": 1149, "name": "list", "variant": "signature", "kind": 4096, @@ -9384,14 +9384,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/draft-order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/draft-order.ts", "line": 111, "character": 8 } ], "parameters": [ { - "id": 40300, + "id": 1150, "name": "queryParams", "variant": "param", "kind": 32768, @@ -9417,7 +9417,7 @@ } }, { - "id": 40301, + "id": 1151, "name": "headers", "variant": "param", "kind": 32768, @@ -9434,7 +9434,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -9464,21 +9464,21 @@ ] }, { - "id": 40302, + "id": 1152, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/draft-order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/draft-order.ts", "line": 152, "character": 8 } ], "signatures": [ { - "id": 40303, + "id": 1153, "name": "create", "variant": "signature", "kind": 4096, @@ -9508,14 +9508,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/draft-order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/draft-order.ts", "line": 152, "character": 8 } ], "parameters": [ { - "id": 40304, + "id": 1154, "name": "body", "variant": "param", "kind": 32768, @@ -9539,7 +9539,7 @@ } }, { - "id": 40305, + "id": 1155, "name": "query", "variant": "param", "kind": 32768, @@ -9565,7 +9565,7 @@ } }, { - "id": 40306, + "id": 1156, "name": "headers", "variant": "param", "kind": 32768, @@ -9582,7 +9582,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -9612,21 +9612,21 @@ ] }, { - "id": 40307, + "id": 1157, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/draft-order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/draft-order.ts", "line": 189, "character": 8 } ], "signatures": [ { - "id": 40308, + "id": 1158, "name": "update", "variant": "signature", "kind": 4096, @@ -9656,14 +9656,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/draft-order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/draft-order.ts", "line": 189, "character": 8 } ], "parameters": [ { - "id": 40309, + "id": 1159, "name": "id", "variant": "param", "kind": 32768, @@ -9682,7 +9682,7 @@ } }, { - "id": 40310, + "id": 1160, "name": "body", "variant": "param", "kind": 32768, @@ -9706,7 +9706,7 @@ } }, { - "id": 40311, + "id": 1161, "name": "query", "variant": "param", "kind": 32768, @@ -9732,7 +9732,7 @@ } }, { - "id": 40312, + "id": 1162, "name": "headers", "variant": "param", "kind": 32768, @@ -9749,7 +9749,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -9783,42 +9783,42 @@ { "title": "Constructors", "children": [ - 40289 + 1139 ] }, { "title": "Properties", "children": [ - 40292 + 1142 ] }, { "title": "Methods", "children": [ - 40293, - 40298, - 40302, - 40307 + 1143, + 1148, + 1152, + 1157 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/draft-order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/draft-order.ts", "line": 6, "character": 13 } ] }, { - "id": 40628, + "id": 1478, "name": "Exchange", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 40632, + "id": 1482, "name": "client", "variant": "declaration", "kind": 1024, @@ -9833,34 +9833,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 10, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 40629, + "id": 1479, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 14, "character": 2 } ], "signatures": [ { - "id": 40630, + "id": 1480, "name": "Exchange", "variant": "signature", "kind": 16384, @@ -9873,21 +9873,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 14, "character": 2 } ], "parameters": [ { - "id": 40631, + "id": 1481, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -9895,7 +9895,7 @@ ], "type": { "type": "reference", - "target": 40628, + "target": 1478, "name": "Exchange", "package": "@medusajs/js-sdk" } @@ -9903,21 +9903,21 @@ ] }, { - "id": 40633, + "id": 1483, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 65, "character": 8 } ], "signatures": [ { - "id": 40634, + "id": 1484, "name": "list", "variant": "signature", "kind": 4096, @@ -10008,14 +10008,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 65, "character": 8 } ], "parameters": [ { - "id": 40635, + "id": 1485, "name": "query", "variant": "param", "kind": 32768, @@ -10041,7 +10041,7 @@ } }, { - "id": 40636, + "id": 1486, "name": "headers", "variant": "param", "kind": 32768, @@ -10058,7 +10058,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -10088,21 +10088,21 @@ ] }, { - "id": 40637, + "id": 1487, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 111, "character": 8 } ], "signatures": [ { - "id": 40638, + "id": 1488, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -10161,14 +10161,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 111, "character": 8 } ], "parameters": [ { - "id": 40639, + "id": 1489, "name": "id", "variant": "param", "kind": 32768, @@ -10187,7 +10187,7 @@ } }, { - "id": 40640, + "id": 1490, "name": "query", "variant": "param", "kind": 32768, @@ -10213,7 +10213,7 @@ } }, { - "id": 40641, + "id": 1491, "name": "headers", "variant": "param", "kind": 32768, @@ -10230,7 +10230,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -10260,21 +10260,21 @@ ] }, { - "id": 40642, + "id": 1492, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 142, "character": 8 } ], "signatures": [ { - "id": 40643, + "id": 1493, "name": "create", "variant": "signature", "kind": 4096, @@ -10309,14 +10309,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 142, "character": 8 } ], "parameters": [ { - "id": 40644, + "id": 1494, "name": "body", "variant": "param", "kind": 32768, @@ -10340,7 +10340,7 @@ } }, { - "id": 40645, + "id": 1495, "name": "query", "variant": "param", "kind": 32768, @@ -10366,7 +10366,7 @@ } }, { - "id": 40646, + "id": 1496, "name": "headers", "variant": "param", "kind": 32768, @@ -10383,7 +10383,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -10413,21 +10413,21 @@ ] }, { - "id": 40647, + "id": 1497, "name": "cancel", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 173, "character": 8 } ], "signatures": [ { - "id": 40648, + "id": 1498, "name": "cancel", "variant": "signature", "kind": 4096, @@ -10462,14 +10462,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 173, "character": 8 } ], "parameters": [ { - "id": 40649, + "id": 1499, "name": "id", "variant": "param", "kind": 32768, @@ -10488,7 +10488,7 @@ } }, { - "id": 40650, + "id": 1500, "name": "query", "variant": "param", "kind": 32768, @@ -10514,7 +10514,7 @@ } }, { - "id": 40651, + "id": 1501, "name": "headers", "variant": "param", "kind": 32768, @@ -10531,7 +10531,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -10561,21 +10561,21 @@ ] }, { - "id": 40652, + "id": 1502, "name": "addInboundItems", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 212, "character": 8 } ], "signatures": [ { - "id": 40653, + "id": 1503, "name": "addInboundItems", "variant": "signature", "kind": 4096, @@ -10618,14 +10618,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 212, "character": 8 } ], "parameters": [ { - "id": 40654, + "id": 1504, "name": "id", "variant": "param", "kind": 32768, @@ -10644,7 +10644,7 @@ } }, { - "id": 40655, + "id": 1505, "name": "body", "variant": "param", "kind": 32768, @@ -10668,7 +10668,7 @@ } }, { - "id": 40656, + "id": 1506, "name": "query", "variant": "param", "kind": 32768, @@ -10694,7 +10694,7 @@ } }, { - "id": 40657, + "id": 1507, "name": "headers", "variant": "param", "kind": 32768, @@ -10711,7 +10711,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -10741,21 +10741,21 @@ ] }, { - "id": 40658, + "id": 1508, "name": "updateInboundItem", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 258, "character": 8 } ], "signatures": [ { - "id": 40659, + "id": 1509, "name": "updateInboundItem", "variant": "signature", "kind": 4096, @@ -10822,14 +10822,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 258, "character": 8 } ], "parameters": [ { - "id": 40660, + "id": 1510, "name": "id", "variant": "param", "kind": 32768, @@ -10848,7 +10848,7 @@ } }, { - "id": 40661, + "id": 1511, "name": "actionId", "variant": "param", "kind": 32768, @@ -10875,7 +10875,7 @@ } }, { - "id": 40662, + "id": 1512, "name": "body", "variant": "param", "kind": 32768, @@ -10899,7 +10899,7 @@ } }, { - "id": 40663, + "id": 1513, "name": "query", "variant": "param", "kind": 32768, @@ -10925,7 +10925,7 @@ } }, { - "id": 40664, + "id": 1514, "name": "headers", "variant": "param", "kind": 32768, @@ -10942,7 +10942,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -10972,21 +10972,21 @@ ] }, { - "id": 40665, + "id": 1515, "name": "removeInboundItem", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 301, "character": 8 } ], "signatures": [ { - "id": 40666, + "id": 1516, "name": "removeInboundItem", "variant": "signature", "kind": 4096, @@ -11053,14 +11053,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 301, "character": 8 } ], "parameters": [ { - "id": 40667, + "id": 1517, "name": "id", "variant": "param", "kind": 32768, @@ -11079,7 +11079,7 @@ } }, { - "id": 40668, + "id": 1518, "name": "actionId", "variant": "param", "kind": 32768, @@ -11106,7 +11106,7 @@ } }, { - "id": 40669, + "id": 1519, "name": "query", "variant": "param", "kind": 32768, @@ -11132,7 +11132,7 @@ } }, { - "id": 40670, + "id": 1520, "name": "headers", "variant": "param", "kind": 32768, @@ -11149,7 +11149,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -11179,21 +11179,21 @@ ] }, { - "id": 40671, + "id": 1521, "name": "addInboundShipping", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 341, "character": 8 } ], "signatures": [ { - "id": 40672, + "id": 1522, "name": "addInboundShipping", "variant": "signature", "kind": 4096, @@ -11236,14 +11236,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 341, "character": 8 } ], "parameters": [ { - "id": 40673, + "id": 1523, "name": "id", "variant": "param", "kind": 32768, @@ -11262,7 +11262,7 @@ } }, { - "id": 40674, + "id": 1524, "name": "body", "variant": "param", "kind": 32768, @@ -11286,7 +11286,7 @@ } }, { - "id": 40675, + "id": 1525, "name": "query", "variant": "param", "kind": 32768, @@ -11312,7 +11312,7 @@ } }, { - "id": 40676, + "id": 1526, "name": "headers", "variant": "param", "kind": 32768, @@ -11329,7 +11329,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -11359,21 +11359,21 @@ ] }, { - "id": 40677, + "id": 1527, "name": "updateInboundShipping", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 387, "character": 8 } ], "signatures": [ { - "id": 40678, + "id": 1528, "name": "updateInboundShipping", "variant": "signature", "kind": 4096, @@ -11440,14 +11440,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 387, "character": 8 } ], "parameters": [ { - "id": 40679, + "id": 1529, "name": "id", "variant": "param", "kind": 32768, @@ -11466,7 +11466,7 @@ } }, { - "id": 40680, + "id": 1530, "name": "actionId", "variant": "param", "kind": 32768, @@ -11493,7 +11493,7 @@ } }, { - "id": 40681, + "id": 1531, "name": "body", "variant": "param", "kind": 32768, @@ -11517,7 +11517,7 @@ } }, { - "id": 40682, + "id": 1532, "name": "query", "variant": "param", "kind": 32768, @@ -11543,7 +11543,7 @@ } }, { - "id": 40683, + "id": 1533, "name": "headers", "variant": "param", "kind": 32768, @@ -11560,7 +11560,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -11590,21 +11590,21 @@ ] }, { - "id": 40684, + "id": 1534, "name": "deleteInboundShipping", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 430, "character": 8 } ], "signatures": [ { - "id": 40685, + "id": 1535, "name": "deleteInboundShipping", "variant": "signature", "kind": 4096, @@ -11671,14 +11671,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 430, "character": 8 } ], "parameters": [ { - "id": 40686, + "id": 1536, "name": "id", "variant": "param", "kind": 32768, @@ -11697,7 +11697,7 @@ } }, { - "id": 40687, + "id": 1537, "name": "actionId", "variant": "param", "kind": 32768, @@ -11724,7 +11724,7 @@ } }, { - "id": 40688, + "id": 1538, "name": "query", "variant": "param", "kind": 32768, @@ -11750,7 +11750,7 @@ } }, { - "id": 40689, + "id": 1539, "name": "headers", "variant": "param", "kind": 32768, @@ -11767,7 +11767,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -11797,21 +11797,21 @@ ] }, { - "id": 40690, + "id": 1540, "name": "addOutboundItems", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 470, "character": 8 } ], "signatures": [ { - "id": 40691, + "id": 1541, "name": "addOutboundItems", "variant": "signature", "kind": 4096, @@ -11854,14 +11854,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 470, "character": 8 } ], "parameters": [ { - "id": 40692, + "id": 1542, "name": "id", "variant": "param", "kind": 32768, @@ -11880,7 +11880,7 @@ } }, { - "id": 40693, + "id": 1543, "name": "body", "variant": "param", "kind": 32768, @@ -11904,7 +11904,7 @@ } }, { - "id": 40694, + "id": 1544, "name": "query", "variant": "param", "kind": 32768, @@ -11930,7 +11930,7 @@ } }, { - "id": 40695, + "id": 1545, "name": "headers", "variant": "param", "kind": 32768, @@ -11947,7 +11947,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -11977,21 +11977,21 @@ ] }, { - "id": 40696, + "id": 1546, "name": "updateOutboundItem", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 516, "character": 8 } ], "signatures": [ { - "id": 40697, + "id": 1547, "name": "updateOutboundItem", "variant": "signature", "kind": 4096, @@ -12058,14 +12058,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 516, "character": 8 } ], "parameters": [ { - "id": 40698, + "id": 1548, "name": "id", "variant": "param", "kind": 32768, @@ -12084,7 +12084,7 @@ } }, { - "id": 40699, + "id": 1549, "name": "actionId", "variant": "param", "kind": 32768, @@ -12111,7 +12111,7 @@ } }, { - "id": 40700, + "id": 1550, "name": "body", "variant": "param", "kind": 32768, @@ -12135,7 +12135,7 @@ } }, { - "id": 40701, + "id": 1551, "name": "query", "variant": "param", "kind": 32768, @@ -12161,7 +12161,7 @@ } }, { - "id": 40702, + "id": 1552, "name": "headers", "variant": "param", "kind": 32768, @@ -12178,7 +12178,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -12208,21 +12208,21 @@ ] }, { - "id": 40703, + "id": 1553, "name": "removeOutboundItem", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 559, "character": 8 } ], "signatures": [ { - "id": 40704, + "id": 1554, "name": "removeOutboundItem", "variant": "signature", "kind": 4096, @@ -12289,14 +12289,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 559, "character": 8 } ], "parameters": [ { - "id": 40705, + "id": 1555, "name": "id", "variant": "param", "kind": 32768, @@ -12315,7 +12315,7 @@ } }, { - "id": 40706, + "id": 1556, "name": "actionId", "variant": "param", "kind": 32768, @@ -12342,7 +12342,7 @@ } }, { - "id": 40707, + "id": 1557, "name": "query", "variant": "param", "kind": 32768, @@ -12368,7 +12368,7 @@ } }, { - "id": 40708, + "id": 1558, "name": "headers", "variant": "param", "kind": 32768, @@ -12385,7 +12385,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -12415,21 +12415,21 @@ ] }, { - "id": 40709, + "id": 1559, "name": "addOutboundShipping", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 596, "character": 8 } ], "signatures": [ { - "id": 40710, + "id": 1560, "name": "addOutboundShipping", "variant": "signature", "kind": 4096, @@ -12472,14 +12472,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 596, "character": 8 } ], "parameters": [ { - "id": 40711, + "id": 1561, "name": "id", "variant": "param", "kind": 32768, @@ -12498,7 +12498,7 @@ } }, { - "id": 40712, + "id": 1562, "name": "body", "variant": "param", "kind": 32768, @@ -12522,7 +12522,7 @@ } }, { - "id": 40713, + "id": 1563, "name": "query", "variant": "param", "kind": 32768, @@ -12548,7 +12548,7 @@ } }, { - "id": 40714, + "id": 1564, "name": "headers", "variant": "param", "kind": 32768, @@ -12565,7 +12565,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -12595,21 +12595,21 @@ ] }, { - "id": 40715, + "id": 1565, "name": "updateOutboundShipping", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 642, "character": 8 } ], "signatures": [ { - "id": 40716, + "id": 1566, "name": "updateOutboundShipping", "variant": "signature", "kind": 4096, @@ -12676,14 +12676,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 642, "character": 8 } ], "parameters": [ { - "id": 40717, + "id": 1567, "name": "id", "variant": "param", "kind": 32768, @@ -12702,7 +12702,7 @@ } }, { - "id": 40718, + "id": 1568, "name": "actionId", "variant": "param", "kind": 32768, @@ -12729,7 +12729,7 @@ } }, { - "id": 40719, + "id": 1569, "name": "body", "variant": "param", "kind": 32768, @@ -12753,7 +12753,7 @@ } }, { - "id": 40720, + "id": 1570, "name": "query", "variant": "param", "kind": 32768, @@ -12779,7 +12779,7 @@ } }, { - "id": 40721, + "id": 1571, "name": "headers", "variant": "param", "kind": 32768, @@ -12796,7 +12796,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -12826,21 +12826,21 @@ ] }, { - "id": 40722, + "id": 1572, "name": "deleteOutboundShipping", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 685, "character": 8 } ], "signatures": [ { - "id": 40723, + "id": 1573, "name": "deleteOutboundShipping", "variant": "signature", "kind": 4096, @@ -12907,14 +12907,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 685, "character": 8 } ], "parameters": [ { - "id": 40724, + "id": 1574, "name": "id", "variant": "param", "kind": 32768, @@ -12933,7 +12933,7 @@ } }, { - "id": 40725, + "id": 1575, "name": "actionId", "variant": "param", "kind": 32768, @@ -12960,7 +12960,7 @@ } }, { - "id": 40726, + "id": 1576, "name": "query", "variant": "param", "kind": 32768, @@ -12986,7 +12986,7 @@ } }, { - "id": 40727, + "id": 1577, "name": "headers", "variant": "param", "kind": 32768, @@ -13003,7 +13003,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -13033,21 +13033,21 @@ ] }, { - "id": 40728, + "id": 1578, "name": "request", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 719, "character": 8 } ], "signatures": [ { - "id": 40729, + "id": 1579, "name": "request", "variant": "signature", "kind": 4096, @@ -13082,14 +13082,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 719, "character": 8 } ], "parameters": [ { - "id": 40730, + "id": 1580, "name": "id", "variant": "param", "kind": 32768, @@ -13108,7 +13108,7 @@ } }, { - "id": 40731, + "id": 1581, "name": "body", "variant": "param", "kind": 32768, @@ -13132,7 +13132,7 @@ } }, { - "id": 40732, + "id": 1582, "name": "query", "variant": "param", "kind": 32768, @@ -13158,7 +13158,7 @@ } }, { - "id": 40733, + "id": 1583, "name": "headers", "variant": "param", "kind": 32768, @@ -13175,7 +13175,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -13205,21 +13205,21 @@ ] }, { - "id": 40734, + "id": 1584, "name": "cancelRequest", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 752, "character": 8 } ], "signatures": [ { - "id": 40735, + "id": 1585, "name": "cancelRequest", "variant": "signature", "kind": 4096, @@ -13254,14 +13254,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 752, "character": 8 } ], "parameters": [ { - "id": 40736, + "id": 1586, "name": "id", "variant": "param", "kind": 32768, @@ -13280,7 +13280,7 @@ } }, { - "id": 40737, + "id": 1587, "name": "query", "variant": "param", "kind": 32768, @@ -13306,7 +13306,7 @@ } }, { - "id": 40738, + "id": 1588, "name": "headers", "variant": "param", "kind": 32768, @@ -13323,7 +13323,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -13357,56 +13357,56 @@ { "title": "Constructors", "children": [ - 40629 + 1479 ] }, { "title": "Properties", "children": [ - 40632 + 1482 ] }, { "title": "Methods", "children": [ - 40633, - 40637, - 40642, - 40647, - 40652, - 40658, - 40665, - 40671, - 40677, - 40684, - 40690, - 40696, - 40703, - 40709, - 40715, - 40722, - 40728, - 40734 + 1483, + 1487, + 1492, + 1497, + 1502, + 1508, + 1515, + 1521, + 1527, + 1534, + 1540, + 1546, + 1553, + 1559, + 1565, + 1572, + 1578, + 1584 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/exchange.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/exchange.ts", "line": 6, "character": 13 } ] }, { - "id": 40065, + "id": 915, "name": "FulfillmentProvider", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 40069, + "id": 919, "name": "client", "variant": "declaration", "kind": 1024, @@ -13421,34 +13421,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/fulfillment-provider.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/fulfillment-provider.ts", "line": 9, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 40066, + "id": 916, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/fulfillment-provider.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/fulfillment-provider.ts", "line": 13, "character": 2 } ], "signatures": [ { - "id": 40067, + "id": 917, "name": "FulfillmentProvider", "variant": "signature", "kind": 16384, @@ -13461,21 +13461,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/fulfillment-provider.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/fulfillment-provider.ts", "line": 13, "character": 2 } ], "parameters": [ { - "id": 40068, + "id": 918, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -13483,7 +13483,7 @@ ], "type": { "type": "reference", - "target": 40065, + "target": 915, "name": "FulfillmentProvider", "package": "@medusajs/js-sdk" } @@ -13491,21 +13491,21 @@ ] }, { - "id": 40070, + "id": 920, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/fulfillment-provider.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/fulfillment-provider.ts", "line": 64, "character": 8 } ], "signatures": [ { - "id": 40071, + "id": 921, "name": "list", "variant": "signature", "kind": 4096, @@ -13596,14 +13596,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/fulfillment-provider.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/fulfillment-provider.ts", "line": 64, "character": 8 } ], "parameters": [ { - "id": 40072, + "id": 922, "name": "query", "variant": "param", "kind": 32768, @@ -13629,7 +13629,7 @@ } }, { - "id": 40073, + "id": 923, "name": "headers", "variant": "param", "kind": 32768, @@ -13646,7 +13646,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -13676,21 +13676,21 @@ ] }, { - "id": 40074, + "id": 924, "name": "listFulfillmentOptions", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/fulfillment-provider.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/fulfillment-provider.ts", "line": 87, "character": 8 } ], "signatures": [ { - "id": 40075, + "id": 925, "name": "listFulfillmentOptions", "variant": "signature", "kind": 4096, @@ -13716,14 +13716,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/fulfillment-provider.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/fulfillment-provider.ts", "line": 87, "character": 8 } ], "parameters": [ { - "id": 40076, + "id": 926, "name": "id", "variant": "param", "kind": 32768, @@ -13742,7 +13742,7 @@ } }, { - "id": 40077, + "id": 927, "name": "headers", "variant": "param", "kind": 32768, @@ -13759,7 +13759,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -13793,40 +13793,40 @@ { "title": "Constructors", "children": [ - 40066 + 916 ] }, { "title": "Properties", "children": [ - 40069 + 919 ] }, { "title": "Methods", "children": [ - 40070, - 40074 + 920, + 924 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/fulfillment-provider.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/fulfillment-provider.ts", "line": 5, "character": 13 } ] }, { - "id": 40011, + "id": 861, "name": "FulfillmentSet", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 40015, + "id": 865, "name": "client", "variant": "declaration", "kind": 1024, @@ -13841,34 +13841,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/fulfillment-set.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/fulfillment-set.ts", "line": 9, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 40012, + "id": 862, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/fulfillment-set.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/fulfillment-set.ts", "line": 13, "character": 2 } ], "signatures": [ { - "id": 40013, + "id": 863, "name": "FulfillmentSet", "variant": "signature", "kind": 16384, @@ -13881,21 +13881,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/fulfillment-set.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/fulfillment-set.ts", "line": 13, "character": 2 } ], "parameters": [ { - "id": 40014, + "id": 864, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -13903,7 +13903,7 @@ ], "type": { "type": "reference", - "target": 40011, + "target": 861, "name": "FulfillmentSet", "package": "@medusajs/js-sdk" } @@ -13911,21 +13911,21 @@ ] }, { - "id": 40016, + "id": 866, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/fulfillment-set.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/fulfillment-set.ts", "line": 32, "character": 8 } ], "signatures": [ { - "id": 40017, + "id": 867, "name": "delete", "variant": "signature", "kind": 4096, @@ -13960,14 +13960,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/fulfillment-set.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/fulfillment-set.ts", "line": 32, "character": 8 } ], "parameters": [ { - "id": 40018, + "id": 868, "name": "id", "variant": "param", "kind": 32768, @@ -13986,7 +13986,7 @@ } }, { - "id": 40019, + "id": 869, "name": "headers", "variant": "param", "kind": 32768, @@ -14003,7 +14003,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -14033,21 +14033,21 @@ ] }, { - "id": 40020, + "id": 870, "name": "createServiceZone", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/fulfillment-set.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/fulfillment-set.ts", "line": 65, "character": 8 } ], "signatures": [ { - "id": 40021, + "id": 871, "name": "createServiceZone", "variant": "signature", "kind": 4096, @@ -14082,14 +14082,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/fulfillment-set.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/fulfillment-set.ts", "line": 65, "character": 8 } ], "parameters": [ { - "id": 40022, + "id": 872, "name": "id", "variant": "param", "kind": 32768, @@ -14108,7 +14108,7 @@ } }, { - "id": 40023, + "id": 873, "name": "body", "variant": "param", "kind": 32768, @@ -14132,7 +14132,7 @@ } }, { - "id": 40024, + "id": 874, "name": "query", "variant": "param", "kind": 32768, @@ -14158,7 +14158,7 @@ } }, { - "id": 40025, + "id": 875, "name": "headers", "variant": "param", "kind": 32768, @@ -14175,7 +14175,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -14205,21 +14205,21 @@ ] }, { - "id": 40026, + "id": 876, "name": "retrieveServiceZone", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/fulfillment-set.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/fulfillment-set.ts", "line": 123, "character": 8 } ], "signatures": [ { - "id": 40027, + "id": 877, "name": "retrieveServiceZone", "variant": "signature", "kind": 4096, @@ -14278,14 +14278,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/fulfillment-set.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/fulfillment-set.ts", "line": 123, "character": 8 } ], "parameters": [ { - "id": 40028, + "id": 878, "name": "fulfillmentSetId", "variant": "param", "kind": 32768, @@ -14304,7 +14304,7 @@ } }, { - "id": 40029, + "id": 879, "name": "serviceZoneId", "variant": "param", "kind": 32768, @@ -14323,7 +14323,7 @@ } }, { - "id": 40030, + "id": 880, "name": "query", "variant": "param", "kind": 32768, @@ -14349,7 +14349,7 @@ } }, { - "id": 40031, + "id": 881, "name": "headers", "variant": "param", "kind": 32768, @@ -14366,7 +14366,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -14396,21 +14396,21 @@ ] }, { - "id": 40032, + "id": 882, "name": "updateServiceZone", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/fulfillment-set.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/fulfillment-set.ts", "line": 163, "character": 8 } ], "signatures": [ { - "id": 40033, + "id": 883, "name": "updateServiceZone", "variant": "signature", "kind": 4096, @@ -14445,14 +14445,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/fulfillment-set.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/fulfillment-set.ts", "line": 163, "character": 8 } ], "parameters": [ { - "id": 40034, + "id": 884, "name": "fulfillmentSetId", "variant": "param", "kind": 32768, @@ -14471,7 +14471,7 @@ } }, { - "id": 40035, + "id": 885, "name": "serviceZoneId", "variant": "param", "kind": 32768, @@ -14490,7 +14490,7 @@ } }, { - "id": 40036, + "id": 886, "name": "body", "variant": "param", "kind": 32768, @@ -14514,7 +14514,7 @@ } }, { - "id": 40037, + "id": 887, "name": "query", "variant": "param", "kind": 32768, @@ -14540,7 +14540,7 @@ } }, { - "id": 40038, + "id": 888, "name": "headers", "variant": "param", "kind": 32768, @@ -14557,7 +14557,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -14587,21 +14587,21 @@ ] }, { - "id": 40039, + "id": 889, "name": "deleteServiceZone", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/fulfillment-set.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/fulfillment-set.ts", "line": 200, "character": 8 } ], "signatures": [ { - "id": 40040, + "id": 890, "name": "deleteServiceZone", "variant": "signature", "kind": 4096, @@ -14636,14 +14636,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/fulfillment-set.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/fulfillment-set.ts", "line": 200, "character": 8 } ], "parameters": [ { - "id": 40041, + "id": 891, "name": "fulfillmentSetId", "variant": "param", "kind": 32768, @@ -14662,7 +14662,7 @@ } }, { - "id": 40042, + "id": 892, "name": "serviceZoneId", "variant": "param", "kind": 32768, @@ -14681,7 +14681,7 @@ } }, { - "id": 40043, + "id": 893, "name": "headers", "variant": "param", "kind": 32768, @@ -14698,7 +14698,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -14732,43 +14732,43 @@ { "title": "Constructors", "children": [ - 40012 + 862 ] }, { "title": "Properties", "children": [ - 40015 + 865 ] }, { "title": "Methods", "children": [ - 40016, - 40020, - 40026, - 40032, - 40039 + 866, + 870, + 876, + 882, + 889 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/fulfillment-set.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/fulfillment-set.ts", "line": 5, "character": 13 } ] }, { - "id": 40044, + "id": 894, "name": "Fulfillment", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 40048, + "id": 898, "name": "client", "variant": "declaration", "kind": 1024, @@ -14783,34 +14783,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/fulfillment.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/fulfillment.ts", "line": 9, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 40045, + "id": 895, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/fulfillment.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/fulfillment.ts", "line": 13, "character": 2 } ], "signatures": [ { - "id": 40046, + "id": 896, "name": "Fulfillment", "variant": "signature", "kind": 16384, @@ -14823,21 +14823,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/fulfillment.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/fulfillment.ts", "line": 13, "character": 2 } ], "parameters": [ { - "id": 40047, + "id": 897, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -14845,7 +14845,7 @@ ], "type": { "type": "reference", - "target": 40044, + "target": 894, "name": "Fulfillment", "package": "@medusajs/js-sdk" } @@ -14853,21 +14853,21 @@ ] }, { - "id": 40049, + "id": 899, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/fulfillment.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/fulfillment.ts", "line": 50, "character": 8 } ], "signatures": [ { - "id": 40050, + "id": 900, "name": "create", "variant": "signature", "kind": 4096, @@ -14902,14 +14902,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/fulfillment.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/fulfillment.ts", "line": 50, "character": 8 } ], "parameters": [ { - "id": 40051, + "id": 901, "name": "body", "variant": "param", "kind": 32768, @@ -14933,7 +14933,7 @@ } }, { - "id": 40052, + "id": 902, "name": "query", "variant": "param", "kind": 32768, @@ -14959,7 +14959,7 @@ } }, { - "id": 40053, + "id": 903, "name": "headers", "variant": "param", "kind": 32768, @@ -14976,7 +14976,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -15006,21 +15006,21 @@ ] }, { - "id": 40054, + "id": 904, "name": "cancel", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/fulfillment.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/fulfillment.ts", "line": 82, "character": 8 } ], "signatures": [ { - "id": 40055, + "id": 905, "name": "cancel", "variant": "signature", "kind": 4096, @@ -15055,14 +15055,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/fulfillment.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/fulfillment.ts", "line": 82, "character": 8 } ], "parameters": [ { - "id": 40056, + "id": 906, "name": "id", "variant": "param", "kind": 32768, @@ -15081,7 +15081,7 @@ } }, { - "id": 40057, + "id": 907, "name": "query", "variant": "param", "kind": 32768, @@ -15107,7 +15107,7 @@ } }, { - "id": 40058, + "id": 908, "name": "headers", "variant": "param", "kind": 32768, @@ -15124,7 +15124,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -15154,21 +15154,21 @@ ] }, { - "id": 40059, + "id": 909, "name": "createShipment", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/fulfillment.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/fulfillment.ts", "line": 123, "character": 8 } ], "signatures": [ { - "id": 40060, + "id": 910, "name": "createShipment", "variant": "signature", "kind": 4096, @@ -15203,14 +15203,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/fulfillment.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/fulfillment.ts", "line": 123, "character": 8 } ], "parameters": [ { - "id": 40061, + "id": 911, "name": "id", "variant": "param", "kind": 32768, @@ -15229,7 +15229,7 @@ } }, { - "id": 40062, + "id": 912, "name": "body", "variant": "param", "kind": 32768, @@ -15253,7 +15253,7 @@ } }, { - "id": 40063, + "id": 913, "name": "query", "variant": "param", "kind": 32768, @@ -15279,7 +15279,7 @@ } }, { - "id": 40064, + "id": 914, "name": "headers", "variant": "param", "kind": 32768, @@ -15296,7 +15296,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -15330,41 +15330,41 @@ { "title": "Constructors", "children": [ - 40045 + 895 ] }, { "title": "Properties", "children": [ - 40048 + 898 ] }, { "title": "Methods", "children": [ - 40049, - 40054, - 40059 + 899, + 904, + 909 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/fulfillment.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/fulfillment.ts", "line": 5, "character": 13 } ] }, { - "id": 39152, + "id": 2, "name": "Admin", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 39156, + "id": 6, "name": "invite", "variant": "declaration", "kind": 1024, @@ -15390,18 +15390,18 @@ "fileName": "admin/index.ts", "line": 49, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L49" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L49" } ], "type": { "type": "reference", - "target": 39480, + "target": 330, "name": "Invite", "package": "@medusajs/js-sdk" } }, { - "id": 39157, + "id": 7, "name": "customer", "variant": "declaration", "kind": 1024, @@ -15427,18 +15427,18 @@ "fileName": "admin/index.ts", "line": 53, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L53" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L53" } ], "type": { "type": "reference", - "target": 39514, + "target": 364, "name": "Customer", "package": "@medusajs/js-sdk" } }, { - "id": 39158, + "id": 8, "name": "productCollection", "variant": "declaration", "kind": 1024, @@ -15464,18 +15464,18 @@ "fileName": "admin/index.ts", "line": 57, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L57" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L57" } ], "type": { "type": "reference", - "target": 39548, + "target": 398, "name": "ProductCollection", "package": "@medusajs/js-sdk" } }, { - "id": 39159, + "id": 9, "name": "productCategory", "variant": "declaration", "kind": 1024, @@ -15501,18 +15501,18 @@ "fileName": "admin/index.ts", "line": 61, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L61" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L61" } ], "type": { "type": "reference", - "target": 39582, + "target": 432, "name": "ProductCategory", "package": "@medusajs/js-sdk" } }, { - "id": 39160, + "id": 10, "name": "priceList", "variant": "declaration", "kind": 1024, @@ -15538,18 +15538,18 @@ "fileName": "admin/index.ts", "line": 65, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L65" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L65" } ], "type": { "type": "reference", - "target": 39617, + "target": 467, "name": "PriceList", "package": "@medusajs/js-sdk" } }, { - "id": 39161, + "id": 11, "name": "pricePreference", "variant": "declaration", "kind": 1024, @@ -15575,18 +15575,18 @@ "fileName": "admin/index.ts", "line": 69, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L69" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L69" } ], "type": { "type": "reference", - "target": 39658, + "target": 508, "name": "PricePreference", "package": "@medusajs/js-sdk" } }, { - "id": 39162, + "id": 12, "name": "product", "variant": "declaration", "kind": 1024, @@ -15612,18 +15612,18 @@ "fileName": "admin/index.ts", "line": 73, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L73" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L73" } ], "type": { "type": "reference", - "target": 39687, + "target": 537, "name": "Product", "package": "@medusajs/js-sdk" } }, { - "id": 39163, + "id": 13, "name": "productType", "variant": "declaration", "kind": 1024, @@ -15649,18 +15649,18 @@ "fileName": "admin/index.ts", "line": 77, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L77" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L77" } ], "type": { "type": "reference", - "target": 39809, + "target": 659, "name": "ProductType", "package": "@medusajs/js-sdk" } }, { - "id": 39164, + "id": 14, "name": "upload", "variant": "declaration", "kind": 1024, @@ -15686,18 +15686,18 @@ "fileName": "admin/index.ts", "line": 81, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L81" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L81" } ], "type": { "type": "reference", - "target": 39838, + "target": 688, "name": "Upload", "package": "@medusajs/js-sdk" } }, { - "id": 39165, + "id": 15, "name": "region", "variant": "declaration", "kind": 1024, @@ -15723,18 +15723,18 @@ "fileName": "admin/index.ts", "line": 85, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L85" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L85" } ], "type": { "type": "reference", - "target": 39861, + "target": 711, "name": "Region", "package": "@medusajs/js-sdk" } }, { - "id": 39166, + "id": 16, "name": "returnReason", "variant": "declaration", "kind": 1024, @@ -15760,18 +15760,18 @@ "fileName": "admin/index.ts", "line": 89, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L89" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L89" } ], "type": { "type": "reference", - "target": 39898, + "target": 748, "name": "ReturnReason", "package": "@medusajs/js-sdk" } }, { - "id": 39167, + "id": 17, "name": "stockLocation", "variant": "declaration", "kind": 1024, @@ -15797,18 +15797,18 @@ "fileName": "admin/index.ts", "line": 93, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L93" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L93" } ], "type": { "type": "reference", - "target": 39928, + "target": 778, "name": "StockLocation", "package": "@medusajs/js-sdk" } }, { - "id": 39168, + "id": 18, "name": "salesChannel", "variant": "declaration", "kind": 1024, @@ -15834,18 +15834,18 @@ "fileName": "admin/index.ts", "line": 97, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L97" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L97" } ], "type": { "type": "reference", - "target": 39972, + "target": 822, "name": "SalesChannel", "package": "@medusajs/js-sdk" } }, { - "id": 39169, + "id": 19, "name": "fulfillmentSet", "variant": "declaration", "kind": 1024, @@ -15871,18 +15871,18 @@ "fileName": "admin/index.ts", "line": 101, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L101" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L101" } ], "type": { "type": "reference", - "target": 40011, + "target": 861, "name": "FulfillmentSet", "package": "@medusajs/js-sdk" } }, { - "id": 39170, + "id": 20, "name": "fulfillment", "variant": "declaration", "kind": 1024, @@ -15908,18 +15908,18 @@ "fileName": "admin/index.ts", "line": 105, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L105" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L105" } ], "type": { "type": "reference", - "target": 40044, + "target": 894, "name": "Fulfillment", "package": "@medusajs/js-sdk" } }, { - "id": 39171, + "id": 21, "name": "fulfillmentProvider", "variant": "declaration", "kind": 1024, @@ -15945,18 +15945,18 @@ "fileName": "admin/index.ts", "line": 109, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L109" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L109" } ], "type": { "type": "reference", - "target": 40065, + "target": 915, "name": "FulfillmentProvider", "package": "@medusajs/js-sdk" } }, { - "id": 39172, + "id": 22, "name": "shippingOption", "variant": "declaration", "kind": 1024, @@ -15982,18 +15982,18 @@ "fileName": "admin/index.ts", "line": 113, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L113" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L113" } ], "type": { "type": "reference", - "target": 40078, + "target": 928, "name": "ShippingOption", "package": "@medusajs/js-sdk" } }, { - "id": 39173, + "id": 23, "name": "shippingProfile", "variant": "declaration", "kind": 1024, @@ -16019,18 +16019,18 @@ "fileName": "admin/index.ts", "line": 117, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L117" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L117" } ], "type": { "type": "reference", - "target": 40112, + "target": 962, "name": "ShippingProfile", "package": "@medusajs/js-sdk" } }, { - "id": 39174, + "id": 24, "name": "inventoryItem", "variant": "declaration", "kind": 1024, @@ -16056,18 +16056,18 @@ "fileName": "admin/index.ts", "line": 121, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L121" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L121" } ], "type": { "type": "reference", - "target": 40141, + "target": 991, "name": "InventoryItem", "package": "@medusajs/js-sdk" } }, { - "id": 39175, + "id": 25, "name": "notification", "variant": "declaration", "kind": 1024, @@ -16093,18 +16093,18 @@ "fileName": "admin/index.ts", "line": 125, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L125" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L125" } ], "type": { "type": "reference", - "target": 40202, + "target": 1052, "name": "Notification", "package": "@medusajs/js-sdk" } }, { - "id": 39176, + "id": 26, "name": "order", "variant": "declaration", "kind": 1024, @@ -16130,18 +16130,18 @@ "fileName": "admin/index.ts", "line": 129, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L129" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L129" } ], "type": { "type": "reference", - "target": 40216, + "target": 1066, "name": "Order", "package": "@medusajs/js-sdk" } }, { - "id": 39177, + "id": 27, "name": "draftOrder", "variant": "declaration", "kind": 1024, @@ -16156,7 +16156,7 @@ "content": [ { "kind": "text", - "text": "draft order" + "text": "order" } ] } @@ -16167,18 +16167,18 @@ "fileName": "admin/index.ts", "line": 133, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L133" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L133" } ], "type": { "type": "reference", - "target": 40288, + "target": 1138, "name": "DraftOrder", "package": "@medusajs/js-sdk" } }, { - "id": 39178, + "id": 28, "name": "orderEdit", "variant": "declaration", "kind": 1024, @@ -16204,18 +16204,18 @@ "fileName": "admin/index.ts", "line": 137, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L137" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L137" } ], "type": { "type": "reference", - "target": 40313, + "target": 1163, "name": "OrderEdit", "package": "@medusajs/js-sdk" } }, { - "id": 39179, + "id": 29, "name": "return", "variant": "declaration", "kind": 1024, @@ -16241,18 +16241,18 @@ "fileName": "admin/index.ts", "line": 141, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L141" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L141" } ], "type": { "type": "reference", - "target": 40364, + "target": 1214, "name": "Return", "package": "@medusajs/js-sdk" } }, { - "id": 39180, + "id": 30, "name": "claim", "variant": "declaration", "kind": 1024, @@ -16278,18 +16278,18 @@ "fileName": "admin/index.ts", "line": 145, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L145" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L145" } ], "type": { "type": "reference", - "target": 40498, + "target": 1348, "name": "Claim", "package": "@medusajs/js-sdk" } }, { - "id": 39181, + "id": 31, "name": "exchange", "variant": "declaration", "kind": 1024, @@ -16315,18 +16315,18 @@ "fileName": "admin/index.ts", "line": 149, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L149" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L149" } ], "type": { "type": "reference", - "target": 40628, + "target": 1478, "name": "Exchange", "package": "@medusajs/js-sdk" } }, { - "id": 39182, + "id": 32, "name": "taxRate", "variant": "declaration", "kind": 1024, @@ -16352,18 +16352,18 @@ "fileName": "admin/index.ts", "line": 153, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L153" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L153" } ], "type": { "type": "reference", - "target": 40739, + "target": 1589, "name": "TaxRate", "package": "@medusajs/js-sdk" } }, { - "id": 39183, + "id": 33, "name": "taxRegion", "variant": "declaration", "kind": 1024, @@ -16389,18 +16389,18 @@ "fileName": "admin/index.ts", "line": 157, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L157" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L157" } ], "type": { "type": "reference", - "target": 40768, + "target": 1618, "name": "TaxRegion", "package": "@medusajs/js-sdk" } }, { - "id": 39184, + "id": 34, "name": "store", "variant": "declaration", "kind": 1024, @@ -16426,18 +16426,18 @@ "fileName": "admin/index.ts", "line": 161, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L161" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L161" } ], "type": { "type": "reference", - "target": 40791, + "target": 1641, "name": "Store", "package": "@medusajs/js-sdk" } }, { - "id": 39185, + "id": 35, "name": "productTag", "variant": "declaration", "kind": 1024, @@ -16463,18 +16463,18 @@ "fileName": "admin/index.ts", "line": 165, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L165" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L165" } ], "type": { "type": "reference", - "target": 40811, + "target": 1661, "name": "ProductTag", "package": "@medusajs/js-sdk" } }, { - "id": 39186, + "id": 36, "name": "user", "variant": "declaration", "kind": 1024, @@ -16500,18 +16500,18 @@ "fileName": "admin/index.ts", "line": 169, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L169" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L169" } ], "type": { "type": "reference", - "target": 40840, + "target": 1690, "name": "User", "package": "@medusajs/js-sdk" } }, { - "id": 39187, + "id": 37, "name": "currency", "variant": "declaration", "kind": 1024, @@ -16537,18 +16537,18 @@ "fileName": "admin/index.ts", "line": 173, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L173" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L173" } ], "type": { "type": "reference", - "target": 40868, + "target": 1718, "name": "Currency", "package": "@medusajs/js-sdk" } }, { - "id": 39188, + "id": 38, "name": "payment", "variant": "declaration", "kind": 1024, @@ -16574,18 +16574,18 @@ "fileName": "admin/index.ts", "line": 177, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L177" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L177" } ], "type": { "type": "reference", - "target": 40882, + "target": 1732, "name": "Payment", "package": "@medusajs/js-sdk" } }, { - "id": 39189, + "id": 39, "name": "productVariant", "variant": "declaration", "kind": 1024, @@ -16611,18 +16611,18 @@ "fileName": "admin/index.ts", "line": 181, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L181" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L181" } ], "type": { "type": "reference", - "target": 40912, + "target": 1762, "name": "ProductVariant", "package": "@medusajs/js-sdk" } }, { - "id": 39190, + "id": 40, "name": "refundReason", "variant": "declaration", "kind": 1024, @@ -16648,18 +16648,18 @@ "fileName": "admin/index.ts", "line": 185, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L185" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L185" } ], "type": { "type": "reference", - "target": 40921, + "target": 1771, "name": "RefundReason", "package": "@medusajs/js-sdk" } }, { - "id": 39191, + "id": 41, "name": "paymentCollection", "variant": "declaration", "kind": 1024, @@ -16685,18 +16685,18 @@ "fileName": "admin/index.ts", "line": 189, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L189" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L189" } ], "type": { "type": "reference", - "target": 40930, + "target": 1780, "name": "PaymentCollection", "package": "@medusajs/js-sdk" } }, { - "id": 39192, + "id": 42, "name": "apiKey", "variant": "declaration", "kind": 1024, @@ -16722,18 +16722,18 @@ "fileName": "admin/index.ts", "line": 193, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L193" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L193" } ], "type": { "type": "reference", - "target": 40950, + "target": 1800, "name": "ApiKey", "package": "@medusajs/js-sdk" } }, { - "id": 39193, + "id": 43, "name": "workflowExecution", "variant": "declaration", "kind": 1024, @@ -16759,18 +16759,18 @@ "fileName": "admin/index.ts", "line": 197, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L197" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L197" } ], "type": { "type": "reference", - "target": 40987, + "target": 1837, "name": "WorkflowExecution", "package": "@medusajs/js-sdk" } }, { - "id": 39194, + "id": 44, "name": "reservation", "variant": "declaration", "kind": 1024, @@ -16796,18 +16796,18 @@ "fileName": "admin/index.ts", "line": 201, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L201" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L201" } ], "type": { "type": "reference", - "target": 41000, + "target": 1850, "name": "Reservation", "package": "@medusajs/js-sdk" } }, { - "id": 39195, + "id": 45, "name": "customerGroup", "variant": "declaration", "kind": 1024, @@ -16833,18 +16833,18 @@ "fileName": "admin/index.ts", "line": 205, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L205" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L205" } ], "type": { "type": "reference", - "target": 41029, + "target": 1879, "name": "CustomerGroup", "package": "@medusajs/js-sdk" } }, { - "id": 39196, + "id": 46, "name": "promotion", "variant": "declaration", "kind": 1024, @@ -16870,18 +16870,18 @@ "fileName": "admin/index.ts", "line": 209, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L209" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L209" } ], "type": { "type": "reference", - "target": 41063, + "target": 1913, "name": "Promotion", "package": "@medusajs/js-sdk" } }, { - "id": 39197, + "id": 47, "name": "campaign", "variant": "declaration", "kind": 1024, @@ -16907,18 +16907,18 @@ "fileName": "admin/index.ts", "line": 213, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L213" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L213" } ], "type": { "type": "reference", - "target": 41125, + "target": 1975, "name": "Campaign", "package": "@medusajs/js-sdk" } }, { - "id": 39153, + "id": 3, "name": "constructor", "variant": "declaration", "kind": 512, @@ -16928,12 +16928,12 @@ "fileName": "admin/index.ts", "line": 215, "character": 2, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L215" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L215" } ], "signatures": [ { - "id": 39154, + "id": 4, "name": "Admin", "variant": "signature", "kind": 16384, @@ -16943,19 +16943,19 @@ "fileName": "admin/index.ts", "line": 215, "character": 2, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L215" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L215" } ], "parameters": [ { - "id": 39155, + "id": 5, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -16963,7 +16963,7 @@ ], "type": { "type": "reference", - "target": 39152, + "target": 2, "name": "Admin", "package": "@medusajs/js-sdk" } @@ -16975,54 +16975,54 @@ { "title": "Constructors", "children": [ - 39153 + 3 ] }, { "title": "Properties", "children": [ - 39156, - 39157, - 39158, - 39159, - 39160, - 39161, - 39162, - 39163, - 39164, - 39165, - 39166, - 39167, - 39168, - 39169, - 39170, - 39171, - 39172, - 39173, - 39174, - 39175, - 39176, - 39177, - 39178, - 39179, - 39180, - 39181, - 39182, - 39183, - 39184, - 39185, - 39186, - 39187, - 39188, - 39189, - 39190, - 39191, - 39192, - 39193, - 39194, - 39195, - 39196, - 39197 + 6, + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47 ] } ], @@ -17031,19 +17031,19 @@ "fileName": "admin/index.ts", "line": 45, "character": 13, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L45" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L45" } ] }, { - "id": 40141, + "id": 991, "name": "InventoryItem", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 40145, + "id": 995, "name": "client", "variant": "declaration", "kind": 1024, @@ -17058,34 +17058,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", "line": 9, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 40142, + "id": 992, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", "line": 13, "character": 2 } ], "signatures": [ { - "id": 40143, + "id": 993, "name": "InventoryItem", "variant": "signature", "kind": 16384, @@ -17098,21 +17098,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", "line": 13, "character": 2 } ], "parameters": [ { - "id": 40144, + "id": 994, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -17120,7 +17120,7 @@ ], "type": { "type": "reference", - "target": 40141, + "target": 991, "name": "InventoryItem", "package": "@medusajs/js-sdk" } @@ -17128,21 +17128,21 @@ ] }, { - "id": 40146, + "id": 996, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", "line": 35, "character": 8 } ], "signatures": [ { - "id": 40147, + "id": 997, "name": "create", "variant": "signature", "kind": 4096, @@ -17177,14 +17177,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", "line": 35, "character": 8 } ], "parameters": [ { - "id": 40148, + "id": 998, "name": "body", "variant": "param", "kind": 32768, @@ -17208,7 +17208,7 @@ } }, { - "id": 40149, + "id": 999, "name": "query", "variant": "param", "kind": 32768, @@ -17234,7 +17234,7 @@ } }, { - "id": 40150, + "id": 1000, "name": "headers", "variant": "param", "kind": 32768, @@ -17251,7 +17251,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -17281,21 +17281,21 @@ ] }, { - "id": 40151, + "id": 1001, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", "line": 70, "character": 8 } ], "signatures": [ { - "id": 40152, + "id": 1002, "name": "update", "variant": "signature", "kind": 4096, @@ -17330,14 +17330,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", "line": 70, "character": 8 } ], "parameters": [ { - "id": 40153, + "id": 1003, "name": "id", "variant": "param", "kind": 32768, @@ -17356,7 +17356,7 @@ } }, { - "id": 40154, + "id": 1004, "name": "body", "variant": "param", "kind": 32768, @@ -17380,7 +17380,7 @@ } }, { - "id": 40155, + "id": 1005, "name": "query", "variant": "param", "kind": 32768, @@ -17406,7 +17406,7 @@ } }, { - "id": 40156, + "id": 1006, "name": "headers", "variant": "param", "kind": 32768, @@ -17423,7 +17423,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -17453,21 +17453,21 @@ ] }, { - "id": 40157, + "id": 1007, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", "line": 134, "character": 8 } ], "signatures": [ { - "id": 40158, + "id": 1008, "name": "list", "variant": "signature", "kind": 4096, @@ -17558,14 +17558,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", "line": 134, "character": 8 } ], "parameters": [ { - "id": 40159, + "id": 1009, "name": "query", "variant": "param", "kind": 32768, @@ -17591,7 +17591,7 @@ } }, { - "id": 40160, + "id": 1010, "name": "headers", "variant": "param", "kind": 32768, @@ -17608,7 +17608,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -17638,21 +17638,21 @@ ] }, { - "id": 40161, + "id": 1011, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", "line": 179, "character": 8 } ], "signatures": [ { - "id": 40162, + "id": 1012, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -17711,14 +17711,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", "line": 179, "character": 8 } ], "parameters": [ { - "id": 40163, + "id": 1013, "name": "id", "variant": "param", "kind": 32768, @@ -17737,7 +17737,7 @@ } }, { - "id": 40164, + "id": 1014, "name": "query", "variant": "param", "kind": 32768, @@ -17763,7 +17763,7 @@ } }, { - "id": 40165, + "id": 1015, "name": "headers", "variant": "param", "kind": 32768, @@ -17780,7 +17780,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -17810,21 +17810,21 @@ ] }, { - "id": 40166, + "id": 1016, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", "line": 204, "character": 8 } ], "signatures": [ { - "id": 40167, + "id": 1017, "name": "delete", "variant": "signature", "kind": 4096, @@ -17859,14 +17859,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", "line": 204, "character": 8 } ], "parameters": [ { - "id": 40168, + "id": 1018, "name": "id", "variant": "param", "kind": 32768, @@ -17885,7 +17885,7 @@ } }, { - "id": 40169, + "id": 1019, "name": "headers", "variant": "param", "kind": 32768, @@ -17902,7 +17902,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -17932,21 +17932,21 @@ ] }, { - "id": 40170, + "id": 1020, "name": "listLevels", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", "line": 262, "character": 8 } ], "signatures": [ { - "id": 40171, + "id": 1021, "name": "listLevels", "variant": "signature", "kind": 4096, @@ -18037,14 +18037,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", "line": 262, "character": 8 } ], "parameters": [ { - "id": 40172, + "id": 1022, "name": "id", "variant": "param", "kind": 32768, @@ -18063,7 +18063,7 @@ } }, { - "id": 40173, + "id": 1023, "name": "query", "variant": "param", "kind": 32768, @@ -18089,7 +18089,7 @@ } }, { - "id": 40174, + "id": 1024, "name": "headers", "variant": "param", "kind": 32768, @@ -18106,7 +18106,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -18136,21 +18136,21 @@ ] }, { - "id": 40175, + "id": 1025, "name": "updateLevel", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", "line": 303, "character": 8 } ], "signatures": [ { - "id": 40176, + "id": 1026, "name": "updateLevel", "variant": "signature", "kind": 4096, @@ -18185,14 +18185,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", "line": 303, "character": 8 } ], "parameters": [ { - "id": 40177, + "id": 1027, "name": "id", "variant": "param", "kind": 32768, @@ -18211,7 +18211,7 @@ } }, { - "id": 40178, + "id": 1028, "name": "locationId", "variant": "param", "kind": 32768, @@ -18230,7 +18230,7 @@ } }, { - "id": 40179, + "id": 1029, "name": "body", "variant": "param", "kind": 32768, @@ -18254,7 +18254,7 @@ } }, { - "id": 40180, + "id": 1030, "name": "query", "variant": "param", "kind": 32768, @@ -18280,7 +18280,7 @@ } }, { - "id": 40181, + "id": 1031, "name": "headers", "variant": "param", "kind": 32768, @@ -18297,7 +18297,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -18327,21 +18327,21 @@ ] }, { - "id": 40182, + "id": 1032, "name": "deleteLevel", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", "line": 343, "character": 8 } ], "signatures": [ { - "id": 40183, + "id": 1033, "name": "deleteLevel", "variant": "signature", "kind": 4096, @@ -18376,14 +18376,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", "line": 343, "character": 8 } ], "parameters": [ { - "id": 40184, + "id": 1034, "name": "id", "variant": "param", "kind": 32768, @@ -18402,7 +18402,7 @@ } }, { - "id": 40185, + "id": 1035, "name": "locationId", "variant": "param", "kind": 32768, @@ -18421,7 +18421,7 @@ } }, { - "id": 40186, + "id": 1036, "name": "headers", "variant": "param", "kind": 32768, @@ -18438,7 +18438,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -18468,21 +18468,21 @@ ] }, { - "id": 40187, + "id": 1037, "name": "batchUpdateLevels", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", "line": 378, "character": 8 } ], "signatures": [ { - "id": 40188, + "id": 1038, "name": "batchUpdateLevels", "variant": "signature", "kind": 4096, @@ -18534,14 +18534,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", "line": 378, "character": 8 } ], "parameters": [ { - "id": 40189, + "id": 1039, "name": "id", "variant": "param", "kind": 32768, @@ -18560,7 +18560,7 @@ } }, { - "id": 40190, + "id": 1040, "name": "body", "variant": "param", "kind": 32768, @@ -18584,7 +18584,7 @@ } }, { - "id": 40191, + "id": 1041, "name": "query", "variant": "param", "kind": 32768, @@ -18610,7 +18610,7 @@ } }, { - "id": 40192, + "id": 1042, "name": "headers", "variant": "param", "kind": 32768, @@ -18627,7 +18627,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -18657,21 +18657,21 @@ ] }, { - "id": 40193, + "id": 1043, "name": "batchInventoryItemLocationLevels", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", "line": 417, "character": 8 } ], "signatures": [ { - "id": 40194, + "id": 1044, "name": "batchInventoryItemLocationLevels", "variant": "signature", "kind": 4096, @@ -18706,14 +18706,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", "line": 417, "character": 8 } ], "parameters": [ { - "id": 40195, + "id": 1045, "name": "id", "variant": "param", "kind": 32768, @@ -18732,7 +18732,7 @@ } }, { - "id": 40196, + "id": 1046, "name": "body", "variant": "param", "kind": 32768, @@ -18764,7 +18764,7 @@ } }, { - "id": 40197, + "id": 1047, "name": "headers", "variant": "param", "kind": 32768, @@ -18781,7 +18781,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -18811,21 +18811,21 @@ ] }, { - "id": 40198, + "id": 1048, "name": "batchInventoryItemsLocationLevels", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", "line": 452, "character": 8 } ], "signatures": [ { - "id": 40199, + "id": 1049, "name": "batchInventoryItemsLocationLevels", "variant": "signature", "kind": 4096, @@ -18860,14 +18860,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", "line": 452, "character": 8 } ], "parameters": [ { - "id": 40200, + "id": 1050, "name": "body", "variant": "param", "kind": 32768, @@ -18899,7 +18899,7 @@ } }, { - "id": 40201, + "id": 1051, "name": "headers", "variant": "param", "kind": 32768, @@ -18916,7 +18916,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -18950,49 +18950,49 @@ { "title": "Constructors", "children": [ - 40142 + 992 ] }, { "title": "Properties", "children": [ - 40145 + 995 ] }, { "title": "Methods", "children": [ - 40146, - 40151, - 40157, - 40161, - 40166, - 40170, - 40175, - 40182, - 40187, - 40193, - 40198 + 996, + 1001, + 1007, + 1011, + 1016, + 1020, + 1025, + 1032, + 1037, + 1043, + 1048 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/inventory-item.ts", "line": 5, "character": 13 } ] }, { - "id": 39480, + "id": 330, "name": "Invite", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 39484, + "id": 334, "name": "client", "variant": "declaration", "kind": 1024, @@ -19007,34 +19007,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/invite.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/invite.ts", "line": 13, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 39481, + "id": 331, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/invite.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/invite.ts", "line": 17, "character": 2 } ], "signatures": [ { - "id": 39482, + "id": 332, "name": "Invite", "variant": "signature", "kind": 16384, @@ -19047,21 +19047,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/invite.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/invite.ts", "line": 17, "character": 2 } ], "parameters": [ { - "id": 39483, + "id": 333, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -19069,7 +19069,7 @@ ], "type": { "type": "reference", - "target": 39480, + "target": 330, "name": "Invite", "package": "@medusajs/js-sdk" } @@ -19077,21 +19077,21 @@ ] }, { - "id": 39485, + "id": 335, "name": "accept", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/invite.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/invite.ts", "line": 55, "character": 8 } ], "signatures": [ { - "id": 39486, + "id": 336, "name": "accept", "variant": "signature", "kind": 4096, @@ -19135,14 +19135,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/invite.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/invite.ts", "line": 55, "character": 8 } ], "parameters": [ { - "id": 39487, + "id": 337, "name": "input", "variant": "param", "kind": 32768, @@ -19170,14 +19170,14 @@ { "type": "reflection", "declaration": { - "id": 39488, + "id": 338, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 39489, + "id": 339, "name": "invite_token", "variant": "declaration", "kind": 1024, @@ -19192,7 +19192,7 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/invite.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/invite.ts", "line": 60, "character": 6 } @@ -19207,13 +19207,13 @@ { "title": "Properties", "children": [ - 39489 + 339 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/invite.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/invite.ts", "line": 56, "character": 41 } @@ -19224,7 +19224,7 @@ } }, { - "id": 39490, + "id": 340, "name": "query", "variant": "param", "kind": 32768, @@ -19250,7 +19250,7 @@ } }, { - "id": 39491, + "id": 341, "name": "headers", "variant": "param", "kind": 32768, @@ -19267,7 +19267,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -19297,21 +19297,21 @@ ] }, { - "id": 39492, + "id": 342, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/invite.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/invite.ts", "line": 95, "character": 8 } ], "signatures": [ { - "id": 39493, + "id": 343, "name": "create", "variant": "signature", "kind": 4096, @@ -19346,14 +19346,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/invite.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/invite.ts", "line": 95, "character": 8 } ], "parameters": [ { - "id": 39494, + "id": 344, "name": "body", "variant": "param", "kind": 32768, @@ -19377,7 +19377,7 @@ } }, { - "id": 39495, + "id": 345, "name": "query", "variant": "param", "kind": 32768, @@ -19403,7 +19403,7 @@ } }, { - "id": 39496, + "id": 346, "name": "headers", "variant": "param", "kind": 32768, @@ -19420,7 +19420,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -19450,21 +19450,21 @@ ] }, { - "id": 39497, + "id": 347, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/invite.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/invite.ts", "line": 144, "character": 8 } ], "signatures": [ { - "id": 39498, + "id": 348, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -19523,14 +19523,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/invite.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/invite.ts", "line": 144, "character": 8 } ], "parameters": [ { - "id": 39499, + "id": 349, "name": "id", "variant": "param", "kind": 32768, @@ -19549,7 +19549,7 @@ } }, { - "id": 39500, + "id": 350, "name": "query", "variant": "param", "kind": 32768, @@ -19575,7 +19575,7 @@ } }, { - "id": 39501, + "id": 351, "name": "headers", "variant": "param", "kind": 32768, @@ -19592,7 +19592,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -19622,21 +19622,21 @@ ] }, { - "id": 39502, + "id": 352, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/invite.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/invite.ts", "line": 201, "character": 8 } ], "signatures": [ { - "id": 39503, + "id": 353, "name": "list", "variant": "signature", "kind": 4096, @@ -19727,14 +19727,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/invite.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/invite.ts", "line": 201, "character": 8 } ], "parameters": [ { - "id": 39504, + "id": 354, "name": "queryParams", "variant": "param", "kind": 32768, @@ -19760,7 +19760,7 @@ } }, { - "id": 39505, + "id": 355, "name": "headers", "variant": "param", "kind": 32768, @@ -19777,7 +19777,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -19807,21 +19807,21 @@ ] }, { - "id": 39506, + "id": 356, "name": "resend", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/invite.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/invite.ts", "line": 225, "character": 8 } ], "signatures": [ { - "id": 39507, + "id": 357, "name": "resend", "variant": "signature", "kind": 4096, @@ -19856,14 +19856,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/invite.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/invite.ts", "line": 225, "character": 8 } ], "parameters": [ { - "id": 39508, + "id": 358, "name": "id", "variant": "param", "kind": 32768, @@ -19882,7 +19882,7 @@ } }, { - "id": 39509, + "id": 359, "name": "headers", "variant": "param", "kind": 32768, @@ -19899,7 +19899,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -19929,21 +19929,21 @@ ] }, { - "id": 39510, + "id": 360, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/invite.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/invite.ts", "line": 250, "character": 8 } ], "signatures": [ { - "id": 39511, + "id": 361, "name": "delete", "variant": "signature", "kind": 4096, @@ -19978,14 +19978,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/invite.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/invite.ts", "line": 250, "character": 8 } ], "parameters": [ { - "id": 39512, + "id": 362, "name": "id", "variant": "param", "kind": 32768, @@ -20004,7 +20004,7 @@ } }, { - "id": 39513, + "id": 363, "name": "headers", "variant": "param", "kind": 32768, @@ -20021,7 +20021,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -20055,44 +20055,44 @@ { "title": "Constructors", "children": [ - 39481 + 331 ] }, { "title": "Properties", "children": [ - 39484 + 334 ] }, { "title": "Methods", "children": [ - 39485, - 39492, - 39497, - 39502, - 39506, - 39510 + 335, + 342, + 347, + 352, + 356, + 360 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/invite.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/invite.ts", "line": 9, "character": 13 } ] }, { - "id": 40202, + "id": 1052, "name": "Notification", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 40206, + "id": 1056, "name": "client", "variant": "declaration", "kind": 1024, @@ -20107,34 +20107,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/notification.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/notification.ts", "line": 9, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 40203, + "id": 1053, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/notification.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/notification.ts", "line": 13, "character": 2 } ], "signatures": [ { - "id": 40204, + "id": 1054, "name": "Notification", "variant": "signature", "kind": 16384, @@ -20147,21 +20147,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/notification.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/notification.ts", "line": 13, "character": 2 } ], "parameters": [ { - "id": 40205, + "id": 1055, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -20169,7 +20169,7 @@ ], "type": { "type": "reference", - "target": 40202, + "target": 1052, "name": "Notification", "package": "@medusajs/js-sdk" } @@ -20177,21 +20177,21 @@ ] }, { - "id": 40207, + "id": 1057, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/notification.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/notification.ts", "line": 50, "character": 8 } ], "signatures": [ { - "id": 40208, + "id": 1058, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -20250,14 +20250,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/notification.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/notification.ts", "line": 50, "character": 8 } ], "parameters": [ { - "id": 40209, + "id": 1059, "name": "id", "variant": "param", "kind": 32768, @@ -20276,7 +20276,7 @@ } }, { - "id": 40210, + "id": 1060, "name": "query", "variant": "param", "kind": 32768, @@ -20302,7 +20302,7 @@ } }, { - "id": 40211, + "id": 1061, "name": "headers", "variant": "param", "kind": 32768, @@ -20319,7 +20319,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -20349,21 +20349,21 @@ ] }, { - "id": 40212, + "id": 1062, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/notification.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/notification.ts", "line": 112, "character": 8 } ], "signatures": [ { - "id": 40213, + "id": 1063, "name": "list", "variant": "signature", "kind": 4096, @@ -20454,14 +20454,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/notification.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/notification.ts", "line": 112, "character": 8 } ], "parameters": [ { - "id": 40214, + "id": 1064, "name": "query", "variant": "param", "kind": 32768, @@ -20487,7 +20487,7 @@ } }, { - "id": 40215, + "id": 1065, "name": "headers", "variant": "param", "kind": 32768, @@ -20504,7 +20504,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -20538,40 +20538,40 @@ { "title": "Constructors", "children": [ - 40203 + 1053 ] }, { "title": "Properties", "children": [ - 40206 + 1056 ] }, { "title": "Methods", "children": [ - 40207, - 40212 + 1057, + 1062 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/notification.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/notification.ts", "line": 5, "character": 13 } ] }, { - "id": 40313, + "id": 1163, "name": "OrderEdit", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 40317, + "id": 1167, "name": "client", "variant": "declaration", "kind": 1024, @@ -20586,34 +20586,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order-edit.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order-edit.ts", "line": 9, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 40314, + "id": 1164, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order-edit.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order-edit.ts", "line": 13, "character": 2 } ], "signatures": [ { - "id": 40315, + "id": 1165, "name": "OrderEdit", "variant": "signature", "kind": 16384, @@ -20626,21 +20626,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order-edit.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order-edit.ts", "line": 13, "character": 2 } ], "parameters": [ { - "id": 40316, + "id": 1166, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -20648,7 +20648,7 @@ ], "type": { "type": "reference", - "target": 40313, + "target": 1163, "name": "OrderEdit", "package": "@medusajs/js-sdk" } @@ -20656,21 +20656,21 @@ ] }, { - "id": 40318, + "id": 1168, "name": "initiateRequest", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order-edit.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order-edit.ts", "line": 35, "character": 8 } ], "signatures": [ { - "id": 40319, + "id": 1169, "name": "initiateRequest", "variant": "signature", "kind": 4096, @@ -20705,14 +20705,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order-edit.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order-edit.ts", "line": 35, "character": 8 } ], "parameters": [ { - "id": 40320, + "id": 1170, "name": "body", "variant": "param", "kind": 32768, @@ -20736,7 +20736,7 @@ } }, { - "id": 40321, + "id": 1171, "name": "query", "variant": "param", "kind": 32768, @@ -20762,7 +20762,7 @@ } }, { - "id": 40322, + "id": 1172, "name": "headers", "variant": "param", "kind": 32768, @@ -20779,7 +20779,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -20809,21 +20809,21 @@ ] }, { - "id": 40323, + "id": 1173, "name": "request", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order-edit.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order-edit.ts", "line": 67, "character": 8 } ], "signatures": [ { - "id": 40324, + "id": 1174, "name": "request", "variant": "signature", "kind": 4096, @@ -20858,14 +20858,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order-edit.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order-edit.ts", "line": 67, "character": 8 } ], "parameters": [ { - "id": 40325, + "id": 1175, "name": "id", "variant": "param", "kind": 32768, @@ -20884,7 +20884,7 @@ } }, { - "id": 40326, + "id": 1176, "name": "query", "variant": "param", "kind": 32768, @@ -20910,7 +20910,7 @@ } }, { - "id": 40327, + "id": 1177, "name": "headers", "variant": "param", "kind": 32768, @@ -20927,7 +20927,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -20957,21 +20957,21 @@ ] }, { - "id": 40328, + "id": 1178, "name": "confirm", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order-edit.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order-edit.ts", "line": 98, "character": 8 } ], "signatures": [ { - "id": 40329, + "id": 1179, "name": "confirm", "variant": "signature", "kind": 4096, @@ -21006,14 +21006,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order-edit.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order-edit.ts", "line": 98, "character": 8 } ], "parameters": [ { - "id": 40330, + "id": 1180, "name": "id", "variant": "param", "kind": 32768, @@ -21032,7 +21032,7 @@ } }, { - "id": 40331, + "id": 1181, "name": "query", "variant": "param", "kind": 32768, @@ -21058,7 +21058,7 @@ } }, { - "id": 40332, + "id": 1182, "name": "headers", "variant": "param", "kind": 32768, @@ -21075,7 +21075,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -21105,21 +21105,21 @@ ] }, { - "id": 40333, + "id": 1183, "name": "cancelRequest", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order-edit.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order-edit.ts", "line": 129, "character": 8 } ], "signatures": [ { - "id": 40334, + "id": 1184, "name": "cancelRequest", "variant": "signature", "kind": 4096, @@ -21154,14 +21154,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order-edit.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order-edit.ts", "line": 129, "character": 8 } ], "parameters": [ { - "id": 40335, + "id": 1185, "name": "id", "variant": "param", "kind": 32768, @@ -21180,7 +21180,7 @@ } }, { - "id": 40336, + "id": 1186, "name": "query", "variant": "param", "kind": 32768, @@ -21206,7 +21206,7 @@ } }, { - "id": 40337, + "id": 1187, "name": "headers", "variant": "param", "kind": 32768, @@ -21223,7 +21223,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -21253,21 +21253,21 @@ ] }, { - "id": 40338, + "id": 1188, "name": "addItems", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order-edit.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order-edit.ts", "line": 169, "character": 8 } ], "signatures": [ { - "id": 40339, + "id": 1189, "name": "addItems", "variant": "signature", "kind": 4096, @@ -21310,14 +21310,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order-edit.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order-edit.ts", "line": 169, "character": 8 } ], "parameters": [ { - "id": 40340, + "id": 1190, "name": "id", "variant": "param", "kind": 32768, @@ -21336,7 +21336,7 @@ } }, { - "id": 40341, + "id": 1191, "name": "body", "variant": "param", "kind": 32768, @@ -21360,7 +21360,7 @@ } }, { - "id": 40342, + "id": 1192, "name": "query", "variant": "param", "kind": 32768, @@ -21386,7 +21386,7 @@ } }, { - "id": 40343, + "id": 1193, "name": "headers", "variant": "param", "kind": 32768, @@ -21403,7 +21403,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -21433,21 +21433,21 @@ ] }, { - "id": 40344, + "id": 1194, "name": "updateOriginalItem", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order-edit.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order-edit.ts", "line": 210, "character": 8 } ], "signatures": [ { - "id": 40345, + "id": 1195, "name": "updateOriginalItem", "variant": "signature", "kind": 4096, @@ -21482,14 +21482,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order-edit.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order-edit.ts", "line": 210, "character": 8 } ], "parameters": [ { - "id": 40346, + "id": 1196, "name": "id", "variant": "param", "kind": 32768, @@ -21508,7 +21508,7 @@ } }, { - "id": 40347, + "id": 1197, "name": "itemId", "variant": "param", "kind": 32768, @@ -21527,7 +21527,7 @@ } }, { - "id": 40348, + "id": 1198, "name": "body", "variant": "param", "kind": 32768, @@ -21551,7 +21551,7 @@ } }, { - "id": 40349, + "id": 1199, "name": "query", "variant": "param", "kind": 32768, @@ -21577,7 +21577,7 @@ } }, { - "id": 40350, + "id": 1200, "name": "headers", "variant": "param", "kind": 32768, @@ -21594,7 +21594,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -21624,21 +21624,21 @@ ] }, { - "id": 40351, + "id": 1201, "name": "updateAddedItem", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order-edit.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order-edit.ts", "line": 257, "character": 8 } ], "signatures": [ { - "id": 40352, + "id": 1202, "name": "updateAddedItem", "variant": "signature", "kind": 4096, @@ -21705,14 +21705,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order-edit.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order-edit.ts", "line": 257, "character": 8 } ], "parameters": [ { - "id": 40353, + "id": 1203, "name": "id", "variant": "param", "kind": 32768, @@ -21731,7 +21731,7 @@ } }, { - "id": 40354, + "id": 1204, "name": "actionId", "variant": "param", "kind": 32768, @@ -21758,7 +21758,7 @@ } }, { - "id": 40355, + "id": 1205, "name": "body", "variant": "param", "kind": 32768, @@ -21782,7 +21782,7 @@ } }, { - "id": 40356, + "id": 1206, "name": "query", "variant": "param", "kind": 32768, @@ -21808,7 +21808,7 @@ } }, { - "id": 40357, + "id": 1207, "name": "headers", "variant": "param", "kind": 32768, @@ -21825,7 +21825,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -21855,21 +21855,21 @@ ] }, { - "id": 40358, + "id": 1208, "name": "removeAddedItem", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order-edit.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order-edit.ts", "line": 296, "character": 8 } ], "signatures": [ { - "id": 40359, + "id": 1209, "name": "removeAddedItem", "variant": "signature", "kind": 4096, @@ -21936,14 +21936,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order-edit.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order-edit.ts", "line": 296, "character": 8 } ], "parameters": [ { - "id": 40360, + "id": 1210, "name": "id", "variant": "param", "kind": 32768, @@ -21962,7 +21962,7 @@ } }, { - "id": 40361, + "id": 1211, "name": "actionId", "variant": "param", "kind": 32768, @@ -21989,7 +21989,7 @@ } }, { - "id": 40362, + "id": 1212, "name": "query", "variant": "param", "kind": 32768, @@ -22015,7 +22015,7 @@ } }, { - "id": 40363, + "id": 1213, "name": "headers", "variant": "param", "kind": 32768, @@ -22032,7 +22032,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -22066,46 +22066,46 @@ { "title": "Constructors", "children": [ - 40314 + 1164 ] }, { "title": "Properties", "children": [ - 40317 + 1167 ] }, { "title": "Methods", "children": [ - 40318, - 40323, - 40328, - 40333, - 40338, - 40344, - 40351, - 40358 + 1168, + 1173, + 1178, + 1183, + 1188, + 1194, + 1201, + 1208 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order-edit.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order-edit.ts", "line": 5, "character": 13 } ] }, { - "id": 40216, + "id": 1066, "name": "Order", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 40220, + "id": 1070, "name": "client", "variant": "declaration", "kind": 1024, @@ -22120,34 +22120,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order.ts", "line": 16, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 40217, + "id": 1067, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order.ts", "line": 20, "character": 2 } ], "signatures": [ { - "id": 40218, + "id": 1068, "name": "Order", "variant": "signature", "kind": 16384, @@ -22160,21 +22160,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order.ts", "line": 20, "character": 2 } ], "parameters": [ { - "id": 40219, + "id": 1069, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -22182,7 +22182,7 @@ ], "type": { "type": "reference", - "target": 40216, + "target": 1066, "name": "Order", "package": "@medusajs/js-sdk" } @@ -22190,21 +22190,21 @@ ] }, { - "id": 40221, + "id": 1071, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order.ts", "line": 57, "character": 8 } ], "signatures": [ { - "id": 40222, + "id": 1072, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -22263,14 +22263,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order.ts", "line": 57, "character": 8 } ], "parameters": [ { - "id": 40223, + "id": 1073, "name": "id", "variant": "param", "kind": 32768, @@ -22289,7 +22289,7 @@ } }, { - "id": 40224, + "id": 1074, "name": "query", "variant": "param", "kind": 32768, @@ -22315,7 +22315,7 @@ } }, { - "id": 40225, + "id": 1075, "name": "headers", "variant": "param", "kind": 32768, @@ -22332,7 +22332,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -22362,21 +22362,21 @@ ] }, { - "id": 40226, + "id": 1076, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order.ts", "line": 93, "character": 8 } ], "signatures": [ { - "id": 40227, + "id": 1077, "name": "update", "variant": "signature", "kind": 4096, @@ -22411,14 +22411,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order.ts", "line": 93, "character": 8 } ], "parameters": [ { - "id": 40228, + "id": 1078, "name": "id", "variant": "param", "kind": 32768, @@ -22437,7 +22437,7 @@ } }, { - "id": 40229, + "id": 1079, "name": "body", "variant": "param", "kind": 32768, @@ -22461,7 +22461,7 @@ } }, { - "id": 40230, + "id": 1080, "name": "headers", "variant": "param", "kind": 32768, @@ -22478,7 +22478,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -22508,21 +22508,21 @@ ] }, { - "id": 40231, + "id": 1081, "name": "retrievePreview", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order.ts", "line": 123, "character": 8 } ], "signatures": [ { - "id": 40232, + "id": 1082, "name": "retrievePreview", "variant": "signature", "kind": 4096, @@ -22557,14 +22557,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order.ts", "line": 123, "character": 8 } ], "parameters": [ { - "id": 40233, + "id": 1083, "name": "id", "variant": "param", "kind": 32768, @@ -22583,7 +22583,7 @@ } }, { - "id": 40234, + "id": 1084, "name": "query", "variant": "param", "kind": 32768, @@ -22609,7 +22609,7 @@ } }, { - "id": 40235, + "id": 1085, "name": "headers", "variant": "param", "kind": 32768, @@ -22626,7 +22626,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -22656,21 +22656,21 @@ ] }, { - "id": 40236, + "id": 1086, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order.ts", "line": 183, "character": 8 } ], "signatures": [ { - "id": 40237, + "id": 1087, "name": "list", "variant": "signature", "kind": 4096, @@ -22761,14 +22761,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order.ts", "line": 183, "character": 8 } ], "parameters": [ { - "id": 40238, + "id": 1088, "name": "queryParams", "variant": "param", "kind": 32768, @@ -22794,7 +22794,7 @@ } }, { - "id": 40239, + "id": 1089, "name": "headers", "variant": "param", "kind": 32768, @@ -22811,7 +22811,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -22841,21 +22841,21 @@ ] }, { - "id": 40240, + "id": 1090, "name": "cancel", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order.ts", "line": 211, "character": 8 } ], "signatures": [ { - "id": 40241, + "id": 1091, "name": "cancel", "variant": "signature", "kind": 4096, @@ -22890,14 +22890,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order.ts", "line": 211, "character": 8 } ], "parameters": [ { - "id": 40242, + "id": 1092, "name": "id", "variant": "param", "kind": 32768, @@ -22916,7 +22916,7 @@ } }, { - "id": 40243, + "id": 1093, "name": "headers", "variant": "param", "kind": 32768, @@ -22933,7 +22933,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -22963,21 +22963,21 @@ ] }, { - "id": 40244, + "id": 1094, "name": "requestTransfer", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order.ts", "line": 240, "character": 8 } ], "signatures": [ { - "id": 40245, + "id": 1095, "name": "requestTransfer", "variant": "signature", "kind": 4096, @@ -23012,14 +23012,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order.ts", "line": 240, "character": 8 } ], "parameters": [ { - "id": 40246, + "id": 1096, "name": "id", "variant": "param", "kind": 32768, @@ -23038,7 +23038,7 @@ } }, { - "id": 40247, + "id": 1097, "name": "body", "variant": "param", "kind": 32768, @@ -23062,7 +23062,7 @@ } }, { - "id": 40248, + "id": 1098, "name": "headers", "variant": "param", "kind": 32768, @@ -23079,7 +23079,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -23109,21 +23109,21 @@ ] }, { - "id": 40249, + "id": 1099, "name": "cancelTransfer", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order.ts", "line": 270, "character": 8 } ], "signatures": [ { - "id": 40250, + "id": 1100, "name": "cancelTransfer", "variant": "signature", "kind": 4096, @@ -23158,14 +23158,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order.ts", "line": 270, "character": 8 } ], "parameters": [ { - "id": 40251, + "id": 1101, "name": "id", "variant": "param", "kind": 32768, @@ -23184,7 +23184,7 @@ } }, { - "id": 40252, + "id": 1102, "name": "headers", "variant": "param", "kind": 32768, @@ -23201,7 +23201,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -23231,21 +23231,21 @@ ] }, { - "id": 40253, + "id": 1103, "name": "createFulfillment", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order.ts", "line": 304, "character": 8 } ], "signatures": [ { - "id": 40254, + "id": 1104, "name": "createFulfillment", "variant": "signature", "kind": 4096, @@ -23280,14 +23280,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order.ts", "line": 304, "character": 8 } ], "parameters": [ { - "id": 40255, + "id": 1105, "name": "id", "variant": "param", "kind": 32768, @@ -23306,7 +23306,7 @@ } }, { - "id": 40256, + "id": 1106, "name": "body", "variant": "param", "kind": 32768, @@ -23330,7 +23330,7 @@ } }, { - "id": 40257, + "id": 1107, "name": "query", "variant": "param", "kind": 32768, @@ -23356,7 +23356,7 @@ } }, { - "id": 40258, + "id": 1108, "name": "headers", "variant": "param", "kind": 32768, @@ -23373,7 +23373,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -23403,21 +23403,21 @@ ] }, { - "id": 40259, + "id": 1109, "name": "cancelFulfillment", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order.ts", "line": 344, "character": 8 } ], "signatures": [ { - "id": 40260, + "id": 1110, "name": "cancelFulfillment", "variant": "signature", "kind": 4096, @@ -23452,14 +23452,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order.ts", "line": 344, "character": 8 } ], "parameters": [ { - "id": 40261, + "id": 1111, "name": "id", "variant": "param", "kind": 32768, @@ -23478,7 +23478,7 @@ } }, { - "id": 40262, + "id": 1112, "name": "fulfillmentId", "variant": "param", "kind": 32768, @@ -23497,7 +23497,7 @@ } }, { - "id": 40263, + "id": 1113, "name": "body", "variant": "param", "kind": 32768, @@ -23521,7 +23521,7 @@ } }, { - "id": 40264, + "id": 1114, "name": "headers", "variant": "param", "kind": 32768, @@ -23538,7 +23538,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -23568,21 +23568,21 @@ ] }, { - "id": 40265, + "id": 1115, "name": "createShipment", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order.ts", "line": 389, "character": 8 } ], "signatures": [ { - "id": 40266, + "id": 1116, "name": "createShipment", "variant": "signature", "kind": 4096, @@ -23617,14 +23617,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order.ts", "line": 389, "character": 8 } ], "parameters": [ { - "id": 40267, + "id": 1117, "name": "id", "variant": "param", "kind": 32768, @@ -23643,7 +23643,7 @@ } }, { - "id": 40268, + "id": 1118, "name": "fulfillmentId", "variant": "param", "kind": 32768, @@ -23662,7 +23662,7 @@ } }, { - "id": 40269, + "id": 1119, "name": "body", "variant": "param", "kind": 32768, @@ -23686,7 +23686,7 @@ } }, { - "id": 40270, + "id": 1120, "name": "query", "variant": "param", "kind": 32768, @@ -23712,7 +23712,7 @@ } }, { - "id": 40271, + "id": 1121, "name": "headers", "variant": "param", "kind": 32768, @@ -23729,7 +23729,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -23759,21 +23759,21 @@ ] }, { - "id": 40272, + "id": 1122, "name": "markAsDelivered", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order.ts", "line": 427, "character": 8 } ], "signatures": [ { - "id": 40273, + "id": 1123, "name": "markAsDelivered", "variant": "signature", "kind": 4096, @@ -23808,14 +23808,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order.ts", "line": 427, "character": 8 } ], "parameters": [ { - "id": 40274, + "id": 1124, "name": "id", "variant": "param", "kind": 32768, @@ -23834,7 +23834,7 @@ } }, { - "id": 40275, + "id": 1125, "name": "fulfillmentId", "variant": "param", "kind": 32768, @@ -23853,7 +23853,7 @@ } }, { - "id": 40276, + "id": 1126, "name": "query", "variant": "param", "kind": 32768, @@ -23879,7 +23879,7 @@ } }, { - "id": 40277, + "id": 1127, "name": "headers", "variant": "param", "kind": 32768, @@ -23896,7 +23896,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -23926,21 +23926,21 @@ ] }, { - "id": 40278, + "id": 1128, "name": "listChanges", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order.ts", "line": 460, "character": 8 } ], "signatures": [ { - "id": 40279, + "id": 1129, "name": "listChanges", "variant": "signature", "kind": 4096, @@ -23975,14 +23975,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order.ts", "line": 460, "character": 8 } ], "parameters": [ { - "id": 40280, + "id": 1130, "name": "id", "variant": "param", "kind": 32768, @@ -24001,7 +24001,7 @@ } }, { - "id": 40281, + "id": 1131, "name": "queryParams", "variant": "param", "kind": 32768, @@ -24041,7 +24041,7 @@ } }, { - "id": 40282, + "id": 1132, "name": "headers", "variant": "param", "kind": 32768, @@ -24058,7 +24058,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -24099,21 +24099,21 @@ ] }, { - "id": 40283, + "id": 1133, "name": "listLineItems", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order.ts", "line": 489, "character": 8 } ], "signatures": [ { - "id": 40284, + "id": 1134, "name": "listLineItems", "variant": "signature", "kind": 4096, @@ -24148,14 +24148,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order.ts", "line": 489, "character": 8 } ], "parameters": [ { - "id": 40285, + "id": 1135, "name": "id", "variant": "param", "kind": 32768, @@ -24174,7 +24174,7 @@ } }, { - "id": 40286, + "id": 1136, "name": "queryParams", "variant": "param", "kind": 32768, @@ -24214,7 +24214,7 @@ } }, { - "id": 40287, + "id": 1137, "name": "headers", "variant": "param", "kind": 32768, @@ -24231,7 +24231,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -24265,51 +24265,51 @@ { "title": "Constructors", "children": [ - 40217 + 1067 ] }, { "title": "Properties", "children": [ - 40220 + 1070 ] }, { "title": "Methods", "children": [ - 40221, - 40226, - 40231, - 40236, - 40240, - 40244, - 40249, - 40253, - 40259, - 40265, - 40272, - 40278, - 40283 + 1071, + 1076, + 1081, + 1086, + 1090, + 1094, + 1099, + 1103, + 1109, + 1115, + 1122, + 1128, + 1133 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/order.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/order.ts", "line": 12, "character": 13 } ] }, { - "id": 40930, + "id": 1780, "name": "PaymentCollection", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 40934, + "id": 1784, "name": "client", "variant": "declaration", "kind": 1024, @@ -24324,34 +24324,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/payment-collection.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/payment-collection.ts", "line": 9, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 40931, + "id": 1781, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/payment-collection.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/payment-collection.ts", "line": 13, "character": 2 } ], "signatures": [ { - "id": 40932, + "id": 1782, "name": "PaymentCollection", "variant": "signature", "kind": 16384, @@ -24364,21 +24364,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/payment-collection.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/payment-collection.ts", "line": 13, "character": 2 } ], "parameters": [ { - "id": 40933, + "id": 1783, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -24386,7 +24386,7 @@ ], "type": { "type": "reference", - "target": 40930, + "target": 1780, "name": "PaymentCollection", "package": "@medusajs/js-sdk" } @@ -24394,21 +24394,21 @@ ] }, { - "id": 40935, + "id": 1785, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/payment-collection.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/payment-collection.ts", "line": 35, "character": 8 } ], "signatures": [ { - "id": 40936, + "id": 1786, "name": "create", "variant": "signature", "kind": 4096, @@ -24443,14 +24443,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/payment-collection.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/payment-collection.ts", "line": 35, "character": 8 } ], "parameters": [ { - "id": 40937, + "id": 1787, "name": "body", "variant": "param", "kind": 32768, @@ -24474,7 +24474,7 @@ } }, { - "id": 40938, + "id": 1788, "name": "query", "variant": "param", "kind": 32768, @@ -24500,7 +24500,7 @@ } }, { - "id": 40939, + "id": 1789, "name": "headers", "variant": "param", "kind": 32768, @@ -24517,7 +24517,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -24547,21 +24547,21 @@ ] }, { - "id": 40940, + "id": 1790, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/payment-collection.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/payment-collection.ts", "line": 66, "character": 8 } ], "signatures": [ { - "id": 40941, + "id": 1791, "name": "delete", "variant": "signature", "kind": 4096, @@ -24596,14 +24596,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/payment-collection.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/payment-collection.ts", "line": 66, "character": 8 } ], "parameters": [ { - "id": 40942, + "id": 1792, "name": "id", "variant": "param", "kind": 32768, @@ -24622,7 +24622,7 @@ } }, { - "id": 40943, + "id": 1793, "name": "headers", "variant": "param", "kind": 32768, @@ -24639,7 +24639,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -24669,21 +24669,21 @@ ] }, { - "id": 40944, + "id": 1794, "name": "markAsPaid", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/payment-collection.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/payment-collection.ts", "line": 98, "character": 8 } ], "signatures": [ { - "id": 40945, + "id": 1795, "name": "markAsPaid", "variant": "signature", "kind": 4096, @@ -24718,14 +24718,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/payment-collection.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/payment-collection.ts", "line": 98, "character": 8 } ], "parameters": [ { - "id": 40946, + "id": 1796, "name": "id", "variant": "param", "kind": 32768, @@ -24744,7 +24744,7 @@ } }, { - "id": 40947, + "id": 1797, "name": "body", "variant": "param", "kind": 32768, @@ -24768,7 +24768,7 @@ } }, { - "id": 40948, + "id": 1798, "name": "query", "variant": "param", "kind": 32768, @@ -24794,7 +24794,7 @@ } }, { - "id": 40949, + "id": 1799, "name": "headers", "variant": "param", "kind": 32768, @@ -24811,7 +24811,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -24845,41 +24845,41 @@ { "title": "Constructors", "children": [ - 40931 + 1781 ] }, { "title": "Properties", "children": [ - 40934 + 1784 ] }, { "title": "Methods", "children": [ - 40935, - 40940, - 40944 + 1785, + 1790, + 1794 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/payment-collection.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/payment-collection.ts", "line": 5, "character": 13 } ] }, { - "id": 40882, + "id": 1732, "name": "Payment", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 40886, + "id": 1736, "name": "client", "variant": "declaration", "kind": 1024, @@ -24894,34 +24894,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/payment.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/payment.ts", "line": 9, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 40883, + "id": 1733, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/payment.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/payment.ts", "line": 13, "character": 2 } ], "signatures": [ { - "id": 40884, + "id": 1734, "name": "Payment", "variant": "signature", "kind": 16384, @@ -24934,21 +24934,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/payment.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/payment.ts", "line": 13, "character": 2 } ], "parameters": [ { - "id": 40885, + "id": 1735, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -24956,7 +24956,7 @@ ], "type": { "type": "reference", - "target": 40882, + "target": 1732, "name": "Payment", "package": "@medusajs/js-sdk" } @@ -24964,21 +24964,21 @@ ] }, { - "id": 40887, + "id": 1737, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/payment.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/payment.ts", "line": 63, "character": 8 } ], "signatures": [ { - "id": 40888, + "id": 1738, "name": "list", "variant": "signature", "kind": 4096, @@ -25069,14 +25069,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/payment.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/payment.ts", "line": 63, "character": 8 } ], "parameters": [ { - "id": 40889, + "id": 1739, "name": "query", "variant": "param", "kind": 32768, @@ -25102,7 +25102,7 @@ } }, { - "id": 40890, + "id": 1740, "name": "headers", "variant": "param", "kind": 32768, @@ -25119,7 +25119,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -25149,21 +25149,21 @@ ] }, { - "id": 40891, + "id": 1741, "name": "listPaymentProviders", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/payment.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/payment.ts", "line": 119, "character": 8 } ], "signatures": [ { - "id": 40892, + "id": 1742, "name": "listPaymentProviders", "variant": "signature", "kind": 4096, @@ -25254,14 +25254,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/payment.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/payment.ts", "line": 119, "character": 8 } ], "parameters": [ { - "id": 40893, + "id": 1743, "name": "query", "variant": "param", "kind": 32768, @@ -25287,7 +25287,7 @@ } }, { - "id": 40894, + "id": 1744, "name": "headers", "variant": "param", "kind": 32768, @@ -25304,7 +25304,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -25334,21 +25334,21 @@ ] }, { - "id": 40895, + "id": 1745, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/payment.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/payment.ts", "line": 165, "character": 8 } ], "signatures": [ { - "id": 40896, + "id": 1746, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -25407,14 +25407,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/payment.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/payment.ts", "line": 165, "character": 8 } ], "parameters": [ { - "id": 40897, + "id": 1747, "name": "id", "variant": "param", "kind": 32768, @@ -25433,7 +25433,7 @@ } }, { - "id": 40898, + "id": 1748, "name": "query", "variant": "param", "kind": 32768, @@ -25459,7 +25459,7 @@ } }, { - "id": 40899, + "id": 1749, "name": "headers", "variant": "param", "kind": 32768, @@ -25476,7 +25476,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -25506,21 +25506,21 @@ ] }, { - "id": 40900, + "id": 1750, "name": "capture", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/payment.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/payment.ts", "line": 197, "character": 8 } ], "signatures": [ { - "id": 40901, + "id": 1751, "name": "capture", "variant": "signature", "kind": 4096, @@ -25563,14 +25563,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/payment.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/payment.ts", "line": 197, "character": 8 } ], "parameters": [ { - "id": 40902, + "id": 1752, "name": "id", "variant": "param", "kind": 32768, @@ -25589,7 +25589,7 @@ } }, { - "id": 40903, + "id": 1753, "name": "body", "variant": "param", "kind": 32768, @@ -25613,7 +25613,7 @@ } }, { - "id": 40904, + "id": 1754, "name": "query", "variant": "param", "kind": 32768, @@ -25639,7 +25639,7 @@ } }, { - "id": 40905, + "id": 1755, "name": "headers", "variant": "param", "kind": 32768, @@ -25656,7 +25656,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -25686,21 +25686,21 @@ ] }, { - "id": 40906, + "id": 1756, "name": "refund", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/payment.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/payment.ts", "line": 232, "character": 8 } ], "signatures": [ { - "id": 40907, + "id": 1757, "name": "refund", "variant": "signature", "kind": 4096, @@ -25743,14 +25743,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/payment.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/payment.ts", "line": 232, "character": 8 } ], "parameters": [ { - "id": 40908, + "id": 1758, "name": "id", "variant": "param", "kind": 32768, @@ -25769,7 +25769,7 @@ } }, { - "id": 40909, + "id": 1759, "name": "body", "variant": "param", "kind": 32768, @@ -25793,7 +25793,7 @@ } }, { - "id": 40910, + "id": 1760, "name": "query", "variant": "param", "kind": 32768, @@ -25819,7 +25819,7 @@ } }, { - "id": 40911, + "id": 1761, "name": "headers", "variant": "param", "kind": 32768, @@ -25836,7 +25836,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -25870,43 +25870,43 @@ { "title": "Constructors", "children": [ - 40883 + 1733 ] }, { "title": "Properties", "children": [ - 40886 + 1736 ] }, { "title": "Methods", "children": [ - 40887, - 40891, - 40895, - 40900, - 40906 + 1737, + 1741, + 1745, + 1750, + 1756 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/payment.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/payment.ts", "line": 5, "character": 13 } ] }, { - "id": 39617, + "id": 467, "name": "PriceList", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 39621, + "id": 471, "name": "client", "variant": "declaration", "kind": 1024, @@ -25921,34 +25921,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/price-list.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/price-list.ts", "line": 9, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 39618, + "id": 468, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/price-list.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/price-list.ts", "line": 14, "character": 2 } ], "signatures": [ { - "id": 39619, + "id": 469, "name": "PriceList", "variant": "signature", "kind": 16384, @@ -25961,21 +25961,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/price-list.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/price-list.ts", "line": 14, "character": 2 } ], "parameters": [ { - "id": 39620, + "id": 470, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -25983,7 +25983,7 @@ ], "type": { "type": "reference", - "target": 39617, + "target": 467, "name": "PriceList", "package": "@medusajs/js-sdk" } @@ -25991,21 +25991,21 @@ ] }, { - "id": 39622, + "id": 472, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/price-list.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/price-list.ts", "line": 51, "character": 8 } ], "signatures": [ { - "id": 39623, + "id": 473, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -26064,14 +26064,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/price-list.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/price-list.ts", "line": 51, "character": 8 } ], "parameters": [ { - "id": 39624, + "id": 474, "name": "id", "variant": "param", "kind": 32768, @@ -26090,7 +26090,7 @@ } }, { - "id": 39625, + "id": 475, "name": "query", "variant": "param", "kind": 32768, @@ -26116,7 +26116,7 @@ } }, { - "id": 39626, + "id": 476, "name": "headers", "variant": "param", "kind": 32768, @@ -26133,7 +26133,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -26163,21 +26163,21 @@ ] }, { - "id": 39627, + "id": 477, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/price-list.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/price-list.ts", "line": 112, "character": 8 } ], "signatures": [ { - "id": 39628, + "id": 478, "name": "list", "variant": "signature", "kind": 4096, @@ -26268,14 +26268,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/price-list.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/price-list.ts", "line": 112, "character": 8 } ], "parameters": [ { - "id": 39629, + "id": 479, "name": "query", "variant": "param", "kind": 32768, @@ -26301,7 +26301,7 @@ } }, { - "id": 39630, + "id": 480, "name": "headers", "variant": "param", "kind": 32768, @@ -26318,7 +26318,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -26348,21 +26348,21 @@ ] }, { - "id": 39631, + "id": 481, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/price-list.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/price-list.ts", "line": 156, "character": 8 } ], "signatures": [ { - "id": 39632, + "id": 482, "name": "create", "variant": "signature", "kind": 4096, @@ -26397,14 +26397,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/price-list.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/price-list.ts", "line": 156, "character": 8 } ], "parameters": [ { - "id": 39633, + "id": 483, "name": "body", "variant": "param", "kind": 32768, @@ -26428,7 +26428,7 @@ } }, { - "id": 39634, + "id": 484, "name": "query", "variant": "param", "kind": 32768, @@ -26454,7 +26454,7 @@ } }, { - "id": 39635, + "id": 485, "name": "headers", "variant": "param", "kind": 32768, @@ -26471,7 +26471,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -26501,21 +26501,21 @@ ] }, { - "id": 39636, + "id": 486, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/price-list.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/price-list.ts", "line": 191, "character": 8 } ], "signatures": [ { - "id": 39637, + "id": 487, "name": "update", "variant": "signature", "kind": 4096, @@ -26550,14 +26550,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/price-list.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/price-list.ts", "line": 191, "character": 8 } ], "parameters": [ { - "id": 39638, + "id": 488, "name": "id", "variant": "param", "kind": 32768, @@ -26576,7 +26576,7 @@ } }, { - "id": 39639, + "id": 489, "name": "body", "variant": "param", "kind": 32768, @@ -26600,7 +26600,7 @@ } }, { - "id": 39640, + "id": 490, "name": "query", "variant": "param", "kind": 32768, @@ -26626,7 +26626,7 @@ } }, { - "id": 39641, + "id": 491, "name": "headers", "variant": "param", "kind": 32768, @@ -26643,7 +26643,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -26673,21 +26673,21 @@ ] }, { - "id": 39642, + "id": 492, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/price-list.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/price-list.ts", "line": 223, "character": 8 } ], "signatures": [ { - "id": 39643, + "id": 493, "name": "delete", "variant": "signature", "kind": 4096, @@ -26722,14 +26722,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/price-list.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/price-list.ts", "line": 223, "character": 8 } ], "parameters": [ { - "id": 39644, + "id": 494, "name": "id", "variant": "param", "kind": 32768, @@ -26748,7 +26748,7 @@ } }, { - "id": 39645, + "id": 495, "name": "headers", "variant": "param", "kind": 32768, @@ -26765,7 +26765,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -26795,21 +26795,21 @@ ] }, { - "id": 39646, + "id": 496, "name": "batchPrices", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/price-list.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/price-list.ts", "line": 265, "character": 8 } ], "signatures": [ { - "id": 39647, + "id": 497, "name": "batchPrices", "variant": "signature", "kind": 4096, @@ -26844,14 +26844,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/price-list.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/price-list.ts", "line": 265, "character": 8 } ], "parameters": [ { - "id": 39648, + "id": 498, "name": "id", "variant": "param", "kind": 32768, @@ -26870,7 +26870,7 @@ } }, { - "id": 39649, + "id": 499, "name": "body", "variant": "param", "kind": 32768, @@ -26894,7 +26894,7 @@ } }, { - "id": 39650, + "id": 500, "name": "query", "variant": "param", "kind": 32768, @@ -26920,7 +26920,7 @@ } }, { - "id": 39651, + "id": 501, "name": "headers", "variant": "param", "kind": 32768, @@ -26937,7 +26937,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -26967,21 +26967,21 @@ ] }, { - "id": 39652, + "id": 502, "name": "linkProducts", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/price-list.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/price-list.ts", "line": 301, "character": 8 } ], "signatures": [ { - "id": 39653, + "id": 503, "name": "linkProducts", "variant": "signature", "kind": 4096, @@ -27016,14 +27016,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/price-list.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/price-list.ts", "line": 301, "character": 8 } ], "parameters": [ { - "id": 39654, + "id": 504, "name": "id", "variant": "param", "kind": 32768, @@ -27042,7 +27042,7 @@ } }, { - "id": 39655, + "id": 505, "name": "body", "variant": "param", "kind": 32768, @@ -27066,7 +27066,7 @@ } }, { - "id": 39656, + "id": 506, "name": "query", "variant": "param", "kind": 32768, @@ -27092,7 +27092,7 @@ } }, { - "id": 39657, + "id": 507, "name": "headers", "variant": "param", "kind": 32768, @@ -27109,7 +27109,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -27143,45 +27143,45 @@ { "title": "Constructors", "children": [ - 39618 + 468 ] }, { "title": "Properties", "children": [ - 39621 + 471 ] }, { "title": "Methods", "children": [ - 39622, - 39627, - 39631, - 39636, - 39642, - 39646, - 39652 + 472, + 477, + 481, + 486, + 492, + 496, + 502 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/price-list.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/price-list.ts", "line": 5, "character": 13 } ] }, { - "id": 39658, + "id": 508, "name": "PricePreference", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 39662, + "id": 512, "name": "client", "variant": "declaration", "kind": 1024, @@ -27196,34 +27196,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/price-preference.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/price-preference.ts", "line": 9, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 39659, + "id": 509, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/price-preference.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/price-preference.ts", "line": 14, "character": 2 } ], "signatures": [ { - "id": 39660, + "id": 510, "name": "PricePreference", "variant": "signature", "kind": 16384, @@ -27236,21 +27236,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/price-preference.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/price-preference.ts", "line": 14, "character": 2 } ], "parameters": [ { - "id": 39661, + "id": 511, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -27258,7 +27258,7 @@ ], "type": { "type": "reference", - "target": 39658, + "target": 508, "name": "PricePreference", "package": "@medusajs/js-sdk" } @@ -27266,21 +27266,21 @@ ] }, { - "id": 39663, + "id": 513, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/price-preference.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/price-preference.ts", "line": 51, "character": 8 } ], "signatures": [ { - "id": 39664, + "id": 514, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -27339,14 +27339,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/price-preference.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/price-preference.ts", "line": 51, "character": 8 } ], "parameters": [ { - "id": 39665, + "id": 515, "name": "id", "variant": "param", "kind": 32768, @@ -27365,7 +27365,7 @@ } }, { - "id": 39666, + "id": 516, "name": "query", "variant": "param", "kind": 32768, @@ -27391,7 +27391,7 @@ } }, { - "id": 39667, + "id": 517, "name": "headers", "variant": "param", "kind": 32768, @@ -27408,7 +27408,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -27438,21 +27438,21 @@ ] }, { - "id": 39668, + "id": 518, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/price-preference.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/price-preference.ts", "line": 112, "character": 8 } ], "signatures": [ { - "id": 39669, + "id": 519, "name": "list", "variant": "signature", "kind": 4096, @@ -27543,14 +27543,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/price-preference.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/price-preference.ts", "line": 112, "character": 8 } ], "parameters": [ { - "id": 39670, + "id": 520, "name": "query", "variant": "param", "kind": 32768, @@ -27576,7 +27576,7 @@ } }, { - "id": 39671, + "id": 521, "name": "headers", "variant": "param", "kind": 32768, @@ -27593,7 +27593,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -27623,21 +27623,21 @@ ] }, { - "id": 39672, + "id": 522, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/price-preference.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/price-preference.ts", "line": 146, "character": 8 } ], "signatures": [ { - "id": 39673, + "id": 523, "name": "create", "variant": "signature", "kind": 4096, @@ -27672,14 +27672,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/price-preference.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/price-preference.ts", "line": 146, "character": 8 } ], "parameters": [ { - "id": 39674, + "id": 524, "name": "body", "variant": "param", "kind": 32768, @@ -27703,7 +27703,7 @@ } }, { - "id": 39675, + "id": 525, "name": "query", "variant": "param", "kind": 32768, @@ -27729,7 +27729,7 @@ } }, { - "id": 39676, + "id": 526, "name": "headers", "variant": "param", "kind": 32768, @@ -27746,7 +27746,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -27776,21 +27776,21 @@ ] }, { - "id": 39677, + "id": 527, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/price-preference.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/price-preference.ts", "line": 181, "character": 8 } ], "signatures": [ { - "id": 39678, + "id": 528, "name": "update", "variant": "signature", "kind": 4096, @@ -27825,14 +27825,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/price-preference.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/price-preference.ts", "line": 181, "character": 8 } ], "parameters": [ { - "id": 39679, + "id": 529, "name": "id", "variant": "param", "kind": 32768, @@ -27851,7 +27851,7 @@ } }, { - "id": 39680, + "id": 530, "name": "body", "variant": "param", "kind": 32768, @@ -27875,7 +27875,7 @@ } }, { - "id": 39681, + "id": 531, "name": "query", "variant": "param", "kind": 32768, @@ -27901,7 +27901,7 @@ } }, { - "id": 39682, + "id": 532, "name": "headers", "variant": "param", "kind": 32768, @@ -27918,7 +27918,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -27948,21 +27948,21 @@ ] }, { - "id": 39683, + "id": 533, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/price-preference.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/price-preference.ts", "line": 213, "character": 8 } ], "signatures": [ { - "id": 39684, + "id": 534, "name": "delete", "variant": "signature", "kind": 4096, @@ -27997,14 +27997,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/price-preference.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/price-preference.ts", "line": 213, "character": 8 } ], "parameters": [ { - "id": 39685, + "id": 535, "name": "id", "variant": "param", "kind": 32768, @@ -28023,7 +28023,7 @@ } }, { - "id": 39686, + "id": 536, "name": "headers", "variant": "param", "kind": 32768, @@ -28040,7 +28040,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -28074,43 +28074,43 @@ { "title": "Constructors", "children": [ - 39659 + 509 ] }, { "title": "Properties", "children": [ - 39662 + 512 ] }, { "title": "Methods", "children": [ - 39663, - 39668, - 39672, - 39677, - 39683 + 513, + 518, + 522, + 527, + 533 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/price-preference.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/price-preference.ts", "line": 5, "character": 13 } ] }, { - "id": 39582, + "id": 432, "name": "ProductCategory", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 39586, + "id": 436, "name": "client", "variant": "declaration", "kind": 1024, @@ -28125,34 +28125,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-category.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-category.ts", "line": 9, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 39583, + "id": 433, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-category.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-category.ts", "line": 13, "character": 2 } ], "signatures": [ { - "id": 39584, + "id": 434, "name": "ProductCategory", "variant": "signature", "kind": 16384, @@ -28165,21 +28165,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-category.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-category.ts", "line": 13, "character": 2 } ], "parameters": [ { - "id": 39585, + "id": 435, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -28187,7 +28187,7 @@ ], "type": { "type": "reference", - "target": 39582, + "target": 432, "name": "ProductCategory", "package": "@medusajs/js-sdk" } @@ -28195,21 +28195,21 @@ ] }, { - "id": 39587, + "id": 437, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-category.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-category.ts", "line": 35, "character": 8 } ], "signatures": [ { - "id": 39588, + "id": 438, "name": "create", "variant": "signature", "kind": 4096, @@ -28244,14 +28244,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-category.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-category.ts", "line": 35, "character": 8 } ], "parameters": [ { - "id": 39589, + "id": 439, "name": "body", "variant": "param", "kind": 32768, @@ -28275,7 +28275,7 @@ } }, { - "id": 39590, + "id": 440, "name": "query", "variant": "param", "kind": 32768, @@ -28301,7 +28301,7 @@ } }, { - "id": 39591, + "id": 441, "name": "headers", "variant": "param", "kind": 32768, @@ -28318,7 +28318,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -28348,21 +28348,21 @@ ] }, { - "id": 39592, + "id": 442, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-category.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-category.ts", "line": 70, "character": 8 } ], "signatures": [ { - "id": 39593, + "id": 443, "name": "update", "variant": "signature", "kind": 4096, @@ -28397,14 +28397,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-category.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-category.ts", "line": 70, "character": 8 } ], "parameters": [ { - "id": 39594, + "id": 444, "name": "id", "variant": "param", "kind": 32768, @@ -28423,7 +28423,7 @@ } }, { - "id": 39595, + "id": 445, "name": "body", "variant": "param", "kind": 32768, @@ -28447,7 +28447,7 @@ } }, { - "id": 39596, + "id": 446, "name": "query", "variant": "param", "kind": 32768, @@ -28473,7 +28473,7 @@ } }, { - "id": 39597, + "id": 447, "name": "headers", "variant": "param", "kind": 32768, @@ -28490,7 +28490,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -28520,21 +28520,21 @@ ] }, { - "id": 39598, + "id": 448, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-category.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-category.ts", "line": 133, "character": 8 } ], "signatures": [ { - "id": 39599, + "id": 449, "name": "list", "variant": "signature", "kind": 4096, @@ -28625,14 +28625,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-category.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-category.ts", "line": 133, "character": 8 } ], "parameters": [ { - "id": 39600, + "id": 450, "name": "query", "variant": "param", "kind": 32768, @@ -28658,7 +28658,7 @@ } }, { - "id": 39601, + "id": 451, "name": "headers", "variant": "param", "kind": 32768, @@ -28675,7 +28675,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -28705,21 +28705,21 @@ ] }, { - "id": 39602, + "id": 452, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-category.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-category.ts", "line": 178, "character": 8 } ], "signatures": [ { - "id": 39603, + "id": 453, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -28778,14 +28778,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-category.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-category.ts", "line": 178, "character": 8 } ], "parameters": [ { - "id": 39604, + "id": 454, "name": "id", "variant": "param", "kind": 32768, @@ -28804,7 +28804,7 @@ } }, { - "id": 39605, + "id": 455, "name": "query", "variant": "param", "kind": 32768, @@ -28830,7 +28830,7 @@ } }, { - "id": 39606, + "id": 456, "name": "headers", "variant": "param", "kind": 32768, @@ -28847,7 +28847,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -28877,21 +28877,21 @@ ] }, { - "id": 39607, + "id": 457, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-category.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-category.ts", "line": 207, "character": 8 } ], "signatures": [ { - "id": 39608, + "id": 458, "name": "delete", "variant": "signature", "kind": 4096, @@ -28926,14 +28926,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-category.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-category.ts", "line": 207, "character": 8 } ], "parameters": [ { - "id": 39609, + "id": 459, "name": "id", "variant": "param", "kind": 32768, @@ -28952,7 +28952,7 @@ } }, { - "id": 39610, + "id": 460, "name": "headers", "variant": "param", "kind": 32768, @@ -28969,7 +28969,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -28999,21 +28999,21 @@ ] }, { - "id": 39611, + "id": 461, "name": "updateProducts", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-category.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-category.ts", "line": 237, "character": 8 } ], "signatures": [ { - "id": 39612, + "id": 462, "name": "updateProducts", "variant": "signature", "kind": 4096, @@ -29048,14 +29048,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-category.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-category.ts", "line": 237, "character": 8 } ], "parameters": [ { - "id": 39613, + "id": 463, "name": "id", "variant": "param", "kind": 32768, @@ -29074,7 +29074,7 @@ } }, { - "id": 39614, + "id": 464, "name": "body", "variant": "param", "kind": 32768, @@ -29098,7 +29098,7 @@ } }, { - "id": 39615, + "id": 465, "name": "query", "variant": "param", "kind": 32768, @@ -29124,7 +29124,7 @@ } }, { - "id": 39616, + "id": 466, "name": "headers", "variant": "param", "kind": 32768, @@ -29141,7 +29141,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -29175,44 +29175,44 @@ { "title": "Constructors", "children": [ - 39583 + 433 ] }, { "title": "Properties", "children": [ - 39586 + 436 ] }, { "title": "Methods", "children": [ - 39587, - 39592, - 39598, - 39602, - 39607, - 39611 + 437, + 442, + 448, + 452, + 457, + 461 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-category.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-category.ts", "line": 5, "character": 13 } ] }, { - "id": 39548, + "id": 398, "name": "ProductCollection", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 39552, + "id": 402, "name": "client", "variant": "declaration", "kind": 1024, @@ -29227,34 +29227,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-collection.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-collection.ts", "line": 9, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 39549, + "id": 399, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-collection.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-collection.ts", "line": 13, "character": 2 } ], "signatures": [ { - "id": 39550, + "id": 400, "name": "ProductCollection", "variant": "signature", "kind": 16384, @@ -29267,21 +29267,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-collection.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-collection.ts", "line": 13, "character": 2 } ], "parameters": [ { - "id": 39551, + "id": 401, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -29289,7 +29289,7 @@ ], "type": { "type": "reference", - "target": 39548, + "target": 398, "name": "ProductCollection", "package": "@medusajs/js-sdk" } @@ -29297,21 +29297,21 @@ ] }, { - "id": 39553, + "id": 403, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-collection.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-collection.ts", "line": 35, "character": 8 } ], "signatures": [ { - "id": 39554, + "id": 404, "name": "create", "variant": "signature", "kind": 4096, @@ -29346,14 +29346,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-collection.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-collection.ts", "line": 35, "character": 8 } ], "parameters": [ { - "id": 39555, + "id": 405, "name": "body", "variant": "param", "kind": 32768, @@ -29377,7 +29377,7 @@ } }, { - "id": 39556, + "id": 406, "name": "query", "variant": "param", "kind": 32768, @@ -29403,7 +29403,7 @@ } }, { - "id": 39557, + "id": 407, "name": "headers", "variant": "param", "kind": 32768, @@ -29420,7 +29420,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -29450,21 +29450,21 @@ ] }, { - "id": 39558, + "id": 408, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-collection.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-collection.ts", "line": 70, "character": 8 } ], "signatures": [ { - "id": 39559, + "id": 409, "name": "update", "variant": "signature", "kind": 4096, @@ -29499,14 +29499,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-collection.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-collection.ts", "line": 70, "character": 8 } ], "parameters": [ { - "id": 39560, + "id": 410, "name": "id", "variant": "param", "kind": 32768, @@ -29525,7 +29525,7 @@ } }, { - "id": 39561, + "id": 411, "name": "body", "variant": "param", "kind": 32768, @@ -29549,7 +29549,7 @@ } }, { - "id": 39562, + "id": 412, "name": "query", "variant": "param", "kind": 32768, @@ -29575,7 +29575,7 @@ } }, { - "id": 39563, + "id": 413, "name": "headers", "variant": "param", "kind": 32768, @@ -29592,7 +29592,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -29622,21 +29622,21 @@ ] }, { - "id": 39564, + "id": 414, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-collection.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-collection.ts", "line": 133, "character": 8 } ], "signatures": [ { - "id": 39565, + "id": 415, "name": "list", "variant": "signature", "kind": 4096, @@ -29727,20 +29727,28 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-collection.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-collection.ts", "line": 133, "character": 8 } ], "parameters": [ { - "id": 39566, + "id": 416, "name": "queryParams", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations." + } + ] + }, "type": { "type": "reference", "target": { @@ -29752,7 +29760,7 @@ } }, { - "id": 39567, + "id": 417, "name": "headers", "variant": "param", "kind": 32768, @@ -29769,7 +29777,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -29799,21 +29807,21 @@ ] }, { - "id": 39568, + "id": 418, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-collection.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-collection.ts", "line": 178, "character": 8 } ], "signatures": [ { - "id": 39569, + "id": 419, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -29872,14 +29880,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-collection.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-collection.ts", "line": 178, "character": 8 } ], "parameters": [ { - "id": 39570, + "id": 420, "name": "id", "variant": "param", "kind": 32768, @@ -29898,7 +29906,7 @@ } }, { - "id": 39571, + "id": 421, "name": "query", "variant": "param", "kind": 32768, @@ -29924,7 +29932,7 @@ } }, { - "id": 39572, + "id": 422, "name": "headers", "variant": "param", "kind": 32768, @@ -29941,7 +29949,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -29971,21 +29979,21 @@ ] }, { - "id": 39573, + "id": 423, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-collection.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-collection.ts", "line": 207, "character": 8 } ], "signatures": [ { - "id": 39574, + "id": 424, "name": "delete", "variant": "signature", "kind": 4096, @@ -30020,14 +30028,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-collection.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-collection.ts", "line": 207, "character": 8 } ], "parameters": [ { - "id": 39575, + "id": 425, "name": "id", "variant": "param", "kind": 32768, @@ -30046,7 +30054,7 @@ } }, { - "id": 39576, + "id": 426, "name": "headers", "variant": "param", "kind": 32768, @@ -30063,7 +30071,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -30093,21 +30101,21 @@ ] }, { - "id": 39577, + "id": 427, "name": "updateProducts", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-collection.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-collection.ts", "line": 236, "character": 8 } ], "signatures": [ { - "id": 39578, + "id": 428, "name": "updateProducts", "variant": "signature", "kind": 4096, @@ -30142,14 +30150,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-collection.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-collection.ts", "line": 236, "character": 8 } ], "parameters": [ { - "id": 39579, + "id": 429, "name": "id", "variant": "param", "kind": 32768, @@ -30168,7 +30176,7 @@ } }, { - "id": 39580, + "id": 430, "name": "body", "variant": "param", "kind": 32768, @@ -30192,7 +30200,7 @@ } }, { - "id": 39581, + "id": 431, "name": "headers", "variant": "param", "kind": 32768, @@ -30209,7 +30217,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -30243,44 +30251,44 @@ { "title": "Constructors", "children": [ - 39549 + 399 ] }, { "title": "Properties", "children": [ - 39552 + 402 ] }, { "title": "Methods", "children": [ - 39553, - 39558, - 39564, - 39568, - 39573, - 39577 + 403, + 408, + 414, + 418, + 423, + 427 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-collection.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-collection.ts", "line": 5, "character": 13 } ] }, { - "id": 40811, + "id": 1661, "name": "ProductTag", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 40815, + "id": 1665, "name": "client", "variant": "declaration", "kind": 1024, @@ -30295,34 +30303,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-tag.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-tag.ts", "line": 9, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 40812, + "id": 1662, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-tag.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-tag.ts", "line": 13, "character": 2 } ], "signatures": [ { - "id": 40813, + "id": 1663, "name": "ProductTag", "variant": "signature", "kind": 16384, @@ -30335,21 +30343,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-tag.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-tag.ts", "line": 13, "character": 2 } ], "parameters": [ { - "id": 40814, + "id": 1664, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -30357,7 +30365,7 @@ ], "type": { "type": "reference", - "target": 40811, + "target": 1661, "name": "ProductTag", "package": "@medusajs/js-sdk" } @@ -30365,21 +30373,21 @@ ] }, { - "id": 40816, + "id": 1666, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-tag.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-tag.ts", "line": 35, "character": 8 } ], "signatures": [ { - "id": 40817, + "id": 1667, "name": "create", "variant": "signature", "kind": 4096, @@ -30414,14 +30422,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-tag.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-tag.ts", "line": 35, "character": 8 } ], "parameters": [ { - "id": 40818, + "id": 1668, "name": "body", "variant": "param", "kind": 32768, @@ -30445,7 +30453,7 @@ } }, { - "id": 40819, + "id": 1669, "name": "query", "variant": "param", "kind": 32768, @@ -30471,7 +30479,7 @@ } }, { - "id": 40820, + "id": 1670, "name": "headers", "variant": "param", "kind": 32768, @@ -30488,7 +30496,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -30518,21 +30526,21 @@ ] }, { - "id": 40821, + "id": 1671, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-tag.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-tag.ts", "line": 70, "character": 8 } ], "signatures": [ { - "id": 40822, + "id": 1672, "name": "update", "variant": "signature", "kind": 4096, @@ -30567,14 +30575,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-tag.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-tag.ts", "line": 70, "character": 8 } ], "parameters": [ { - "id": 40823, + "id": 1673, "name": "id", "variant": "param", "kind": 32768, @@ -30593,7 +30601,7 @@ } }, { - "id": 40824, + "id": 1674, "name": "body", "variant": "param", "kind": 32768, @@ -30617,7 +30625,7 @@ } }, { - "id": 40825, + "id": 1675, "name": "query", "variant": "param", "kind": 32768, @@ -30643,7 +30651,7 @@ } }, { - "id": 40826, + "id": 1676, "name": "headers", "variant": "param", "kind": 32768, @@ -30660,7 +30668,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -30690,21 +30698,21 @@ ] }, { - "id": 40827, + "id": 1677, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-tag.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-tag.ts", "line": 133, "character": 8 } ], "signatures": [ { - "id": 40828, + "id": 1678, "name": "list", "variant": "signature", "kind": 4096, @@ -30795,14 +30803,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-tag.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-tag.ts", "line": 133, "character": 8 } ], "parameters": [ { - "id": 40829, + "id": 1679, "name": "query", "variant": "param", "kind": 32768, @@ -30828,7 +30836,7 @@ } }, { - "id": 40830, + "id": 1680, "name": "headers", "variant": "param", "kind": 32768, @@ -30845,7 +30853,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -30875,21 +30883,21 @@ ] }, { - "id": 40831, + "id": 1681, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-tag.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-tag.ts", "line": 178, "character": 8 } ], "signatures": [ { - "id": 40832, + "id": 1682, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -30948,14 +30956,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-tag.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-tag.ts", "line": 178, "character": 8 } ], "parameters": [ { - "id": 40833, + "id": 1683, "name": "id", "variant": "param", "kind": 32768, @@ -30974,7 +30982,7 @@ } }, { - "id": 40834, + "id": 1684, "name": "query", "variant": "param", "kind": 32768, @@ -31000,7 +31008,7 @@ } }, { - "id": 40835, + "id": 1685, "name": "headers", "variant": "param", "kind": 32768, @@ -31017,7 +31025,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -31047,21 +31055,21 @@ ] }, { - "id": 40836, + "id": 1686, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-tag.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-tag.ts", "line": 207, "character": 8 } ], "signatures": [ { - "id": 40837, + "id": 1687, "name": "delete", "variant": "signature", "kind": 4096, @@ -31096,14 +31104,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-tag.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-tag.ts", "line": 207, "character": 8 } ], "parameters": [ { - "id": 40838, + "id": 1688, "name": "id", "variant": "param", "kind": 32768, @@ -31122,7 +31130,7 @@ } }, { - "id": 40839, + "id": 1689, "name": "headers", "variant": "param", "kind": 32768, @@ -31139,7 +31147,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -31173,43 +31181,43 @@ { "title": "Constructors", "children": [ - 40812 + 1662 ] }, { "title": "Properties", "children": [ - 40815 + 1665 ] }, { "title": "Methods", "children": [ - 40816, - 40821, - 40827, - 40831, - 40836 + 1666, + 1671, + 1677, + 1681, + 1686 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-tag.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-tag.ts", "line": 5, "character": 13 } ] }, { - "id": 39809, + "id": 659, "name": "ProductType", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 39813, + "id": 663, "name": "client", "variant": "declaration", "kind": 1024, @@ -31224,34 +31232,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-type.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-type.ts", "line": 9, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 39810, + "id": 660, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-type.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-type.ts", "line": 13, "character": 2 } ], "signatures": [ { - "id": 39811, + "id": 661, "name": "ProductType", "variant": "signature", "kind": 16384, @@ -31264,21 +31272,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-type.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-type.ts", "line": 13, "character": 2 } ], "parameters": [ { - "id": 39812, + "id": 662, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -31286,7 +31294,7 @@ ], "type": { "type": "reference", - "target": 39809, + "target": 659, "name": "ProductType", "package": "@medusajs/js-sdk" } @@ -31294,21 +31302,21 @@ ] }, { - "id": 39814, + "id": 664, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-type.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-type.ts", "line": 35, "character": 8 } ], "signatures": [ { - "id": 39815, + "id": 665, "name": "create", "variant": "signature", "kind": 4096, @@ -31343,14 +31351,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-type.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-type.ts", "line": 35, "character": 8 } ], "parameters": [ { - "id": 39816, + "id": 666, "name": "body", "variant": "param", "kind": 32768, @@ -31374,7 +31382,7 @@ } }, { - "id": 39817, + "id": 667, "name": "query", "variant": "param", "kind": 32768, @@ -31400,7 +31408,7 @@ } }, { - "id": 39818, + "id": 668, "name": "headers", "variant": "param", "kind": 32768, @@ -31417,7 +31425,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -31447,21 +31455,21 @@ ] }, { - "id": 39819, + "id": 669, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-type.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-type.ts", "line": 70, "character": 8 } ], "signatures": [ { - "id": 39820, + "id": 670, "name": "update", "variant": "signature", "kind": 4096, @@ -31496,14 +31504,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-type.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-type.ts", "line": 70, "character": 8 } ], "parameters": [ { - "id": 39821, + "id": 671, "name": "id", "variant": "param", "kind": 32768, @@ -31522,7 +31530,7 @@ } }, { - "id": 39822, + "id": 672, "name": "body", "variant": "param", "kind": 32768, @@ -31546,7 +31554,7 @@ } }, { - "id": 39823, + "id": 673, "name": "query", "variant": "param", "kind": 32768, @@ -31572,7 +31580,7 @@ } }, { - "id": 39824, + "id": 674, "name": "headers", "variant": "param", "kind": 32768, @@ -31589,7 +31597,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -31619,21 +31627,21 @@ ] }, { - "id": 39825, + "id": 675, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-type.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-type.ts", "line": 133, "character": 8 } ], "signatures": [ { - "id": 39826, + "id": 676, "name": "list", "variant": "signature", "kind": 4096, @@ -31724,14 +31732,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-type.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-type.ts", "line": 133, "character": 8 } ], "parameters": [ { - "id": 39827, + "id": 677, "name": "query", "variant": "param", "kind": 32768, @@ -31757,7 +31765,7 @@ } }, { - "id": 39828, + "id": 678, "name": "headers", "variant": "param", "kind": 32768, @@ -31774,7 +31782,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -31804,21 +31812,21 @@ ] }, { - "id": 39829, + "id": 679, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-type.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-type.ts", "line": 179, "character": 8 } ], "signatures": [ { - "id": 39830, + "id": 680, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -31877,14 +31885,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-type.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-type.ts", "line": 179, "character": 8 } ], "parameters": [ { - "id": 39831, + "id": 681, "name": "id", "variant": "param", "kind": 32768, @@ -31903,7 +31911,7 @@ } }, { - "id": 39832, + "id": 682, "name": "query", "variant": "param", "kind": 32768, @@ -31929,7 +31937,7 @@ } }, { - "id": 39833, + "id": 683, "name": "headers", "variant": "param", "kind": 32768, @@ -31946,7 +31954,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -31976,21 +31984,21 @@ ] }, { - "id": 39834, + "id": 684, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-type.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-type.ts", "line": 208, "character": 8 } ], "signatures": [ { - "id": 39835, + "id": 685, "name": "delete", "variant": "signature", "kind": 4096, @@ -32025,14 +32033,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-type.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-type.ts", "line": 208, "character": 8 } ], "parameters": [ { - "id": 39836, + "id": 686, "name": "id", "variant": "param", "kind": 32768, @@ -32051,7 +32059,7 @@ } }, { - "id": 39837, + "id": 687, "name": "headers", "variant": "param", "kind": 32768, @@ -32068,7 +32076,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -32102,43 +32110,43 @@ { "title": "Constructors", "children": [ - 39810 + 660 ] }, { "title": "Properties", "children": [ - 39813 + 663 ] }, { "title": "Methods", "children": [ - 39814, - 39819, - 39825, - 39829, - 39834 + 664, + 669, + 675, + 679, + 684 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-type.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-type.ts", "line": 5, "character": 13 } ] }, { - "id": 40912, + "id": 1762, "name": "ProductVariant", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 40916, + "id": 1766, "name": "client", "variant": "declaration", "kind": 1024, @@ -32153,34 +32161,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-variant.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-variant.ts", "line": 9, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 40913, + "id": 1763, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-variant.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-variant.ts", "line": 13, "character": 2 } ], "signatures": [ { - "id": 40914, + "id": 1764, "name": "ProductVariant", "variant": "signature", "kind": 16384, @@ -32193,21 +32201,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-variant.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-variant.ts", "line": 13, "character": 2 } ], "parameters": [ { - "id": 40915, + "id": 1765, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -32215,7 +32223,7 @@ ], "type": { "type": "reference", - "target": 40912, + "target": 1762, "name": "ProductVariant", "package": "@medusajs/js-sdk" } @@ -32223,21 +32231,21 @@ ] }, { - "id": 40917, + "id": 1767, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-variant.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-variant.ts", "line": 64, "character": 8 } ], "signatures": [ { - "id": 40918, + "id": 1768, "name": "list", "variant": "signature", "kind": 4096, @@ -32328,14 +32336,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-variant.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-variant.ts", "line": 64, "character": 8 } ], "parameters": [ { - "id": 40919, + "id": 1769, "name": "query", "variant": "param", "kind": 32768, @@ -32361,7 +32369,7 @@ } }, { - "id": 40920, + "id": 1770, "name": "headers", "variant": "param", "kind": 32768, @@ -32378,7 +32386,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -32412,39 +32420,39 @@ { "title": "Constructors", "children": [ - 40913 + 1763 ] }, { "title": "Properties", "children": [ - 40916 + 1766 ] }, { "title": "Methods", "children": [ - 40917 + 1767 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product-variant.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product-variant.ts", "line": 5, "character": 13 } ] }, { - "id": 39687, + "id": 537, "name": "Product", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 39691, + "id": 541, "name": "client", "variant": "declaration", "kind": 1024, @@ -32459,34 +32467,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 9, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 39688, + "id": 538, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 13, "character": 2 } ], "signatures": [ { - "id": 39689, + "id": 539, "name": "Product", "variant": "signature", "kind": 16384, @@ -32499,21 +32507,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 13, "character": 2 } ], "parameters": [ { - "id": 39690, + "id": 540, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -32521,7 +32529,7 @@ ], "type": { "type": "reference", - "target": 39687, + "target": 537, "name": "Product", "package": "@medusajs/js-sdk" } @@ -32529,21 +32537,21 @@ ] }, { - "id": 39692, + "id": 542, "name": "import", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 38, "character": 8 } ], "signatures": [ { - "id": 39693, + "id": 543, "name": "import", "variant": "signature", "kind": 4096, @@ -32558,7 +32566,7 @@ "kind": "inline-tag", "tag": "@link", "text": "confirmImport", - "target": 39698 + "target": 548 }, { "kind": "text", @@ -32588,14 +32596,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 38, "character": 8 } ], "parameters": [ { - "id": 39694, + "id": 544, "name": "body", "variant": "param", "kind": 32768, @@ -32619,7 +32627,7 @@ } }, { - "id": 39695, + "id": 545, "name": "query", "variant": "param", "kind": 32768, @@ -32637,7 +32645,7 @@ "type": { "type": "reflection", "declaration": { - "id": 39696, + "id": 546, "name": "__type", "variant": "declaration", "kind": 65536, @@ -32646,7 +32654,7 @@ } }, { - "id": 39697, + "id": 547, "name": "headers", "variant": "param", "kind": 32768, @@ -32663,7 +32671,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -32693,21 +32701,21 @@ ] }, { - "id": 39698, + "id": 548, "name": "confirmImport", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 78, "character": 8 } ], "signatures": [ { - "id": 39699, + "id": 549, "name": "confirmImport", "variant": "signature", "kind": 4096, @@ -32722,7 +32730,7 @@ "kind": "inline-tag", "tag": "@link", "text": "import", - "target": 39692 + "target": 542 }, { "kind": "text", @@ -32743,14 +32751,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 78, "character": 8 } ], "parameters": [ { - "id": 39700, + "id": 550, "name": "transactionId", "variant": "param", "kind": 32768, @@ -32769,7 +32777,7 @@ } }, { - "id": 39701, + "id": 551, "name": "query", "variant": "param", "kind": 32768, @@ -32787,7 +32795,7 @@ "type": { "type": "reflection", "declaration": { - "id": 39702, + "id": 552, "name": "__type", "variant": "declaration", "kind": 65536, @@ -32796,7 +32804,7 @@ } }, { - "id": 39703, + "id": 553, "name": "headers", "variant": "param", "kind": 32768, @@ -32813,7 +32821,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -32829,7 +32837,7 @@ { "type": "reflection", "declaration": { - "id": 39704, + "id": 554, "name": "__type", "variant": "declaration", "kind": 65536, @@ -32844,21 +32852,21 @@ ] }, { - "id": 39705, + "id": 555, "name": "export", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 119, "character": 8 } ], "signatures": [ { - "id": 39706, + "id": 556, "name": "export", "variant": "signature", "kind": 4096, @@ -32917,14 +32925,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 119, "character": 8 } ], "parameters": [ { - "id": 39707, + "id": 557, "name": "body", "variant": "param", "kind": 32768, @@ -32948,7 +32956,7 @@ } }, { - "id": 39708, + "id": 558, "name": "query", "variant": "param", "kind": 32768, @@ -32974,7 +32982,7 @@ } }, { - "id": 39709, + "id": 559, "name": "headers", "variant": "param", "kind": 32768, @@ -32991,7 +32999,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -33021,21 +33029,21 @@ ] }, { - "id": 39710, + "id": 560, "name": "batch", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 175, "character": 8 } ], "signatures": [ { - "id": 39711, + "id": 561, "name": "batch", "variant": "signature", "kind": 4096, @@ -33070,14 +33078,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 175, "character": 8 } ], "parameters": [ { - "id": 39712, + "id": 562, "name": "body", "variant": "param", "kind": 32768, @@ -33101,7 +33109,7 @@ } }, { - "id": 39713, + "id": 563, "name": "query", "variant": "param", "kind": 32768, @@ -33127,7 +33135,7 @@ } }, { - "id": 39714, + "id": 564, "name": "headers", "variant": "param", "kind": 32768, @@ -33144,7 +33152,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -33174,21 +33182,21 @@ ] }, { - "id": 39715, + "id": 565, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 223, "character": 8 } ], "signatures": [ { - "id": 39716, + "id": 566, "name": "create", "variant": "signature", "kind": 4096, @@ -33223,14 +33231,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 223, "character": 8 } ], "parameters": [ { - "id": 39717, + "id": 567, "name": "body", "variant": "param", "kind": 32768, @@ -33254,7 +33262,7 @@ } }, { - "id": 39718, + "id": 568, "name": "query", "variant": "param", "kind": 32768, @@ -33280,7 +33288,7 @@ } }, { - "id": 39719, + "id": 569, "name": "headers", "variant": "param", "kind": 32768, @@ -33297,7 +33305,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -33327,21 +33335,21 @@ ] }, { - "id": 39720, + "id": 570, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 258, "character": 8 } ], "signatures": [ { - "id": 39721, + "id": 571, "name": "update", "variant": "signature", "kind": 4096, @@ -33376,14 +33384,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 258, "character": 8 } ], "parameters": [ { - "id": 39722, + "id": 572, "name": "id", "variant": "param", "kind": 32768, @@ -33402,7 +33410,7 @@ } }, { - "id": 39723, + "id": 573, "name": "body", "variant": "param", "kind": 32768, @@ -33426,7 +33434,7 @@ } }, { - "id": 39724, + "id": 574, "name": "query", "variant": "param", "kind": 32768, @@ -33452,7 +33460,7 @@ } }, { - "id": 39725, + "id": 575, "name": "headers", "variant": "param", "kind": 32768, @@ -33469,7 +33477,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -33499,21 +33507,21 @@ ] }, { - "id": 39726, + "id": 576, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 321, "character": 8 } ], "signatures": [ { - "id": 39727, + "id": 577, "name": "list", "variant": "signature", "kind": 4096, @@ -33604,20 +33612,28 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 321, "character": 8 } ], "parameters": [ { - "id": 39728, + "id": 578, "name": "queryParams", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters and pagination configurations." + } + ] + }, "type": { "type": "reference", "target": { @@ -33629,7 +33645,7 @@ } }, { - "id": 39729, + "id": 579, "name": "headers", "variant": "param", "kind": 32768, @@ -33646,7 +33662,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -33676,21 +33692,21 @@ ] }, { - "id": 39730, + "id": 580, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 367, "character": 8 } ], "signatures": [ { - "id": 39731, + "id": 581, "name": "retrieve", "variant": "signature", "kind": 4096, @@ -33749,14 +33765,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 367, "character": 8 } ], "parameters": [ { - "id": 39732, + "id": 582, "name": "id", "variant": "param", "kind": 32768, @@ -33775,7 +33791,7 @@ } }, { - "id": 39733, + "id": 583, "name": "query", "variant": "param", "kind": 32768, @@ -33801,7 +33817,7 @@ } }, { - "id": 39734, + "id": 584, "name": "headers", "variant": "param", "kind": 32768, @@ -33818,7 +33834,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -33848,21 +33864,21 @@ ] }, { - "id": 39735, + "id": 585, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 392, "character": 8 } ], "signatures": [ { - "id": 39736, + "id": 586, "name": "delete", "variant": "signature", "kind": 4096, @@ -33897,14 +33913,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 392, "character": 8 } ], "parameters": [ { - "id": 39737, + "id": 587, "name": "id", "variant": "param", "kind": 32768, @@ -33923,7 +33939,7 @@ } }, { - "id": 39738, + "id": 588, "name": "headers", "variant": "param", "kind": 32768, @@ -33940,7 +33956,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -33970,21 +33986,21 @@ ] }, { - "id": 39739, + "id": 589, "name": "batchVariants", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 436, "character": 8 } ], "signatures": [ { - "id": 39740, + "id": 590, "name": "batchVariants", "variant": "signature", "kind": 4096, @@ -34019,14 +34035,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 436, "character": 8 } ], "parameters": [ { - "id": 39741, + "id": 591, "name": "productId", "variant": "param", "kind": 32768, @@ -34045,7 +34061,7 @@ } }, { - "id": 39742, + "id": 592, "name": "body", "variant": "param", "kind": 32768, @@ -34069,7 +34085,7 @@ } }, { - "id": 39743, + "id": 593, "name": "query", "variant": "param", "kind": 32768, @@ -34095,7 +34111,7 @@ } }, { - "id": 39744, + "id": 594, "name": "headers", "variant": "param", "kind": 32768, @@ -34112,7 +34128,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -34142,21 +34158,21 @@ ] }, { - "id": 39745, + "id": 595, "name": "createVariant", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 481, "character": 8 } ], "signatures": [ { - "id": 39746, + "id": 596, "name": "createVariant", "variant": "signature", "kind": 4096, @@ -34191,14 +34207,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 481, "character": 8 } ], "parameters": [ { - "id": 39747, + "id": 597, "name": "productId", "variant": "param", "kind": 32768, @@ -34217,7 +34233,7 @@ } }, { - "id": 39748, + "id": 598, "name": "body", "variant": "param", "kind": 32768, @@ -34241,7 +34257,7 @@ } }, { - "id": 39749, + "id": 599, "name": "query", "variant": "param", "kind": 32768, @@ -34267,7 +34283,7 @@ } }, { - "id": 39750, + "id": 600, "name": "headers", "variant": "param", "kind": 32768, @@ -34284,7 +34300,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -34314,21 +34330,21 @@ ] }, { - "id": 39751, + "id": 601, "name": "updateVariant", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 522, "character": 8 } ], "signatures": [ { - "id": 39752, + "id": 602, "name": "updateVariant", "variant": "signature", "kind": 4096, @@ -34363,14 +34379,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 522, "character": 8 } ], "parameters": [ { - "id": 39753, + "id": 603, "name": "productId", "variant": "param", "kind": 32768, @@ -34389,7 +34405,7 @@ } }, { - "id": 39754, + "id": 604, "name": "id", "variant": "param", "kind": 32768, @@ -34408,7 +34424,7 @@ } }, { - "id": 39755, + "id": 605, "name": "body", "variant": "param", "kind": 32768, @@ -34432,7 +34448,7 @@ } }, { - "id": 39756, + "id": 606, "name": "query", "variant": "param", "kind": 32768, @@ -34458,7 +34474,7 @@ } }, { - "id": 39757, + "id": 607, "name": "headers", "variant": "param", "kind": 32768, @@ -34475,7 +34491,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -34505,21 +34521,21 @@ ] }, { - "id": 39758, + "id": 608, "name": "listVariants", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 587, "character": 8 } ], "signatures": [ { - "id": 39759, + "id": 609, "name": "listVariants", "variant": "signature", "kind": 4096, @@ -34610,14 +34626,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 587, "character": 8 } ], "parameters": [ { - "id": 39760, + "id": 610, "name": "productId", "variant": "param", "kind": 32768, @@ -34636,7 +34652,7 @@ } }, { - "id": 39761, + "id": 611, "name": "query", "variant": "param", "kind": 32768, @@ -34662,7 +34678,7 @@ } }, { - "id": 39762, + "id": 612, "name": "headers", "variant": "param", "kind": 32768, @@ -34679,7 +34695,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -34709,21 +34725,21 @@ ] }, { - "id": 39763, + "id": 613, "name": "retrieveVariant", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 642, "character": 8 } ], "signatures": [ { - "id": 39764, + "id": 614, "name": "retrieveVariant", "variant": "signature", "kind": 4096, @@ -34782,14 +34798,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 642, "character": 8 } ], "parameters": [ { - "id": 39765, + "id": 615, "name": "productId", "variant": "param", "kind": 32768, @@ -34808,7 +34824,7 @@ } }, { - "id": 39766, + "id": 616, "name": "id", "variant": "param", "kind": 32768, @@ -34827,7 +34843,7 @@ } }, { - "id": 39767, + "id": 617, "name": "query", "variant": "param", "kind": 32768, @@ -34853,7 +34869,7 @@ } }, { - "id": 39768, + "id": 618, "name": "headers", "variant": "param", "kind": 32768, @@ -34870,7 +34886,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -34900,21 +34916,21 @@ ] }, { - "id": 39769, + "id": 619, "name": "deleteVariant", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 673, "character": 8 } ], "signatures": [ { - "id": 39770, + "id": 620, "name": "deleteVariant", "variant": "signature", "kind": 4096, @@ -34949,14 +34965,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 673, "character": 8 } ], "parameters": [ { - "id": 39771, + "id": 621, "name": "productId", "variant": "param", "kind": 32768, @@ -34975,7 +34991,7 @@ } }, { - "id": 39772, + "id": 622, "name": "id", "variant": "param", "kind": 32768, @@ -34994,7 +35010,7 @@ } }, { - "id": 39773, + "id": 623, "name": "headers", "variant": "param", "kind": 32768, @@ -35011,7 +35027,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -35041,21 +35057,21 @@ ] }, { - "id": 39774, + "id": 624, "name": "batchVariantInventoryItems", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 727, "character": 8 } ], "signatures": [ { - "id": 39775, + "id": 625, "name": "batchVariantInventoryItems", "variant": "signature", "kind": 4096, @@ -35090,14 +35106,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 727, "character": 8 } ], "parameters": [ { - "id": 39776, + "id": 626, "name": "productId", "variant": "param", "kind": 32768, @@ -35116,7 +35132,7 @@ } }, { - "id": 39777, + "id": 627, "name": "body", "variant": "param", "kind": 32768, @@ -35140,7 +35156,7 @@ } }, { - "id": 39778, + "id": 628, "name": "query", "variant": "param", "kind": 32768, @@ -35166,7 +35182,7 @@ } }, { - "id": 39779, + "id": 629, "name": "headers", "variant": "param", "kind": 32768, @@ -35183,7 +35199,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -35213,21 +35229,21 @@ ] }, { - "id": 39780, + "id": 630, "name": "createOption", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 767, "character": 8 } ], "signatures": [ { - "id": 39781, + "id": 631, "name": "createOption", "variant": "signature", "kind": 4096, @@ -35262,14 +35278,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 767, "character": 8 } ], "parameters": [ { - "id": 39782, + "id": 632, "name": "productId", "variant": "param", "kind": 32768, @@ -35288,7 +35304,7 @@ } }, { - "id": 39783, + "id": 633, "name": "body", "variant": "param", "kind": 32768, @@ -35312,7 +35328,7 @@ } }, { - "id": 39784, + "id": 634, "name": "query", "variant": "param", "kind": 32768, @@ -35338,7 +35354,7 @@ } }, { - "id": 39785, + "id": 635, "name": "headers", "variant": "param", "kind": 32768, @@ -35355,7 +35371,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -35385,21 +35401,21 @@ ] }, { - "id": 39786, + "id": 636, "name": "updateOption", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 808, "character": 8 } ], "signatures": [ { - "id": 39787, + "id": 637, "name": "updateOption", "variant": "signature", "kind": 4096, @@ -35434,14 +35450,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 808, "character": 8 } ], "parameters": [ { - "id": 39788, + "id": 638, "name": "productId", "variant": "param", "kind": 32768, @@ -35460,7 +35476,7 @@ } }, { - "id": 39789, + "id": 639, "name": "id", "variant": "param", "kind": 32768, @@ -35479,7 +35495,7 @@ } }, { - "id": 39790, + "id": 640, "name": "body", "variant": "param", "kind": 32768, @@ -35503,7 +35519,7 @@ } }, { - "id": 39791, + "id": 641, "name": "query", "variant": "param", "kind": 32768, @@ -35529,7 +35545,7 @@ } }, { - "id": 39792, + "id": 642, "name": "headers", "variant": "param", "kind": 32768, @@ -35546,7 +35562,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -35576,21 +35592,21 @@ ] }, { - "id": 39793, + "id": 643, "name": "listOptions", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 873, "character": 8 } ], "signatures": [ { - "id": 39794, + "id": 644, "name": "listOptions", "variant": "signature", "kind": 4096, @@ -35681,14 +35697,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 873, "character": 8 } ], "parameters": [ { - "id": 39795, + "id": 645, "name": "productId", "variant": "param", "kind": 32768, @@ -35707,7 +35723,7 @@ } }, { - "id": 39796, + "id": 646, "name": "query", "variant": "param", "kind": 32768, @@ -35733,7 +35749,7 @@ } }, { - "id": 39797, + "id": 647, "name": "headers", "variant": "param", "kind": 32768, @@ -35750,7 +35766,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -35780,21 +35796,21 @@ ] }, { - "id": 39798, + "id": 648, "name": "retrieveOption", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 928, "character": 8 } ], "signatures": [ { - "id": 39799, + "id": 649, "name": "retrieveOption", "variant": "signature", "kind": 4096, @@ -35853,14 +35869,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 928, "character": 8 } ], "parameters": [ { - "id": 39800, + "id": 650, "name": "productId", "variant": "param", "kind": 32768, @@ -35879,7 +35895,7 @@ } }, { - "id": 39801, + "id": 651, "name": "id", "variant": "param", "kind": 32768, @@ -35898,7 +35914,7 @@ } }, { - "id": 39802, + "id": 652, "name": "query", "variant": "param", "kind": 32768, @@ -35924,7 +35940,7 @@ } }, { - "id": 39803, + "id": 653, "name": "headers", "variant": "param", "kind": 32768, @@ -35941,7 +35957,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -35971,21 +35987,21 @@ ] }, { - "id": 39804, + "id": 654, "name": "deleteOption", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 959, "character": 8 } ], "signatures": [ { - "id": 39805, + "id": 655, "name": "deleteOption", "variant": "signature", "kind": 4096, @@ -36020,14 +36036,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 959, "character": 8 } ], "parameters": [ { - "id": 39806, + "id": 656, "name": "productId", "variant": "param", "kind": 32768, @@ -36046,7 +36062,7 @@ } }, { - "id": 39807, + "id": 657, "name": "id", "variant": "param", "kind": 32768, @@ -36065,7 +36081,7 @@ } }, { - "id": 39808, + "id": 658, "name": "headers", "variant": "param", "kind": 32768, @@ -36082,7 +36098,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -36116,59 +36132,59 @@ { "title": "Constructors", "children": [ - 39688 + 538 ] }, { "title": "Properties", "children": [ - 39691 + 541 ] }, { "title": "Methods", "children": [ - 39692, - 39698, - 39705, - 39710, - 39715, - 39720, - 39726, - 39730, - 39735, - 39739, - 39745, - 39751, - 39758, - 39763, - 39769, - 39774, - 39780, - 39786, - 39793, - 39798, - 39804 + 542, + 548, + 555, + 560, + 565, + 570, + 576, + 580, + 585, + 589, + 595, + 601, + 608, + 613, + 619, + 624, + 630, + 636, + 643, + 648, + 654 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/product.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/product.ts", "line": 5, "character": 13 } ] }, { - "id": 41063, + "id": 1913, "name": "Promotion", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 41067, + "id": 1917, "name": "client", "variant": "declaration", "kind": 1024, @@ -36183,34 +36199,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/promotion.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/promotion.ts", "line": 9, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 41064, + "id": 1914, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/promotion.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/promotion.ts", "line": 13, "character": 2 } ], "signatures": [ { - "id": 41065, + "id": 1915, "name": "Promotion", "variant": "signature", "kind": 16384, @@ -36223,21 +36239,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/promotion.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/promotion.ts", "line": 13, "character": 2 } ], "parameters": [ { - "id": 41066, + "id": 1916, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -36245,7 +36261,7 @@ ], "type": { "type": "reference", - "target": 41063, + "target": 1913, "name": "Promotion", "package": "@medusajs/js-sdk" } @@ -36253,35 +36269,35 @@ ] }, { - "id": 41068, + "id": 1918, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/promotion.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/promotion.ts", "line": 17, "character": 8 } ], "signatures": [ { - "id": 41069, + "id": 1919, "name": "retrieve", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/promotion.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/promotion.ts", "line": 17, "character": 8 } ], "parameters": [ { - "id": 41070, + "id": 1920, "name": "id", "variant": "param", "kind": 32768, @@ -36292,7 +36308,7 @@ } }, { - "id": 41071, + "id": 1921, "name": "query", "variant": "param", "kind": 32768, @@ -36310,7 +36326,7 @@ } }, { - "id": 41072, + "id": 1922, "name": "headers", "variant": "param", "kind": 32768, @@ -36319,7 +36335,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -36349,35 +36365,35 @@ ] }, { - "id": 41073, + "id": 1923, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/promotion.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/promotion.ts", "line": 31, "character": 8 } ], "signatures": [ { - "id": 41074, + "id": 1924, "name": "list", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/promotion.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/promotion.ts", "line": 31, "character": 8 } ], "parameters": [ { - "id": 41075, + "id": 1925, "name": "query", "variant": "param", "kind": 32768, @@ -36395,7 +36411,7 @@ } }, { - "id": 41076, + "id": 1926, "name": "headers", "variant": "param", "kind": 32768, @@ -36404,7 +36420,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -36434,35 +36450,35 @@ ] }, { - "id": 41077, + "id": 1927, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/promotion.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/promotion.ts", "line": 44, "character": 8 } ], "signatures": [ { - "id": 41078, + "id": 1928, "name": "create", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/promotion.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/promotion.ts", "line": 44, "character": 8 } ], "parameters": [ { - "id": 41079, + "id": 1929, "name": "payload", "variant": "param", "kind": 32768, @@ -36478,7 +36494,7 @@ } }, { - "id": 41080, + "id": 1930, "name": "headers", "variant": "param", "kind": 32768, @@ -36487,7 +36503,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -36517,35 +36533,35 @@ ] }, { - "id": 41081, + "id": 1931, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/promotion.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/promotion.ts", "line": 58, "character": 8 } ], "signatures": [ { - "id": 41082, + "id": 1932, "name": "update", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/promotion.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/promotion.ts", "line": 58, "character": 8 } ], "parameters": [ { - "id": 41083, + "id": 1933, "name": "id", "variant": "param", "kind": 32768, @@ -36556,7 +36572,7 @@ } }, { - "id": 41084, + "id": 1934, "name": "payload", "variant": "param", "kind": 32768, @@ -36572,7 +36588,7 @@ } }, { - "id": 41085, + "id": 1935, "name": "headers", "variant": "param", "kind": 32768, @@ -36581,7 +36597,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -36611,35 +36627,35 @@ ] }, { - "id": 41086, + "id": 1936, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/promotion.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/promotion.ts", "line": 73, "character": 8 } ], "signatures": [ { - "id": 41087, + "id": 1937, "name": "delete", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/promotion.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/promotion.ts", "line": 73, "character": 8 } ], "parameters": [ { - "id": 41088, + "id": 1938, "name": "id", "variant": "param", "kind": 32768, @@ -36650,7 +36666,7 @@ } }, { - "id": 41089, + "id": 1939, "name": "headers", "variant": "param", "kind": 32768, @@ -36659,7 +36675,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -36695,35 +36711,35 @@ ] }, { - "id": 41090, + "id": 1940, "name": "addRules", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/promotion.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/promotion.ts", "line": 83, "character": 8 } ], "signatures": [ { - "id": 41091, + "id": 1941, "name": "addRules", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/promotion.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/promotion.ts", "line": 83, "character": 8 } ], "parameters": [ { - "id": 41092, + "id": 1942, "name": "id", "variant": "param", "kind": 32768, @@ -36734,7 +36750,7 @@ } }, { - "id": 41093, + "id": 1943, "name": "ruleType", "variant": "param", "kind": 32768, @@ -36745,7 +36761,7 @@ } }, { - "id": 41094, + "id": 1944, "name": "payload", "variant": "param", "kind": 32768, @@ -36761,7 +36777,7 @@ } }, { - "id": 41095, + "id": 1945, "name": "headers", "variant": "param", "kind": 32768, @@ -36770,7 +36786,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -36800,35 +36816,35 @@ ] }, { - "id": 41096, + "id": 1946, "name": "updateRules", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/promotion.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/promotion.ts", "line": 99, "character": 8 } ], "signatures": [ { - "id": 41097, + "id": 1947, "name": "updateRules", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/promotion.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/promotion.ts", "line": 99, "character": 8 } ], "parameters": [ { - "id": 41098, + "id": 1948, "name": "id", "variant": "param", "kind": 32768, @@ -36839,7 +36855,7 @@ } }, { - "id": 41099, + "id": 1949, "name": "ruleType", "variant": "param", "kind": 32768, @@ -36850,7 +36866,7 @@ } }, { - "id": 41100, + "id": 1950, "name": "payload", "variant": "param", "kind": 32768, @@ -36866,7 +36882,7 @@ } }, { - "id": 41101, + "id": 1951, "name": "headers", "variant": "param", "kind": 32768, @@ -36875,7 +36891,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -36905,35 +36921,35 @@ ] }, { - "id": 41102, + "id": 1952, "name": "removeRules", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/promotion.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/promotion.ts", "line": 115, "character": 8 } ], "signatures": [ { - "id": 41103, + "id": 1953, "name": "removeRules", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/promotion.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/promotion.ts", "line": 115, "character": 8 } ], "parameters": [ { - "id": 41104, + "id": 1954, "name": "id", "variant": "param", "kind": 32768, @@ -36944,7 +36960,7 @@ } }, { - "id": 41105, + "id": 1955, "name": "ruleType", "variant": "param", "kind": 32768, @@ -36955,7 +36971,7 @@ } }, { - "id": 41106, + "id": 1956, "name": "payload", "variant": "param", "kind": 32768, @@ -36971,7 +36987,7 @@ } }, { - "id": 41107, + "id": 1957, "name": "headers", "variant": "param", "kind": 32768, @@ -36980,7 +36996,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -37010,35 +37026,35 @@ ] }, { - "id": 41108, + "id": 1958, "name": "listRules", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/promotion.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/promotion.ts", "line": 131, "character": 8 } ], "signatures": [ { - "id": 41109, + "id": 1959, "name": "listRules", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/promotion.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/promotion.ts", "line": 131, "character": 8 } ], "parameters": [ { - "id": 41110, + "id": 1960, "name": "id", "variant": "param", "kind": 32768, @@ -37058,7 +37074,7 @@ } }, { - "id": 41111, + "id": 1961, "name": "ruleType", "variant": "param", "kind": 32768, @@ -37069,7 +37085,7 @@ } }, { - "id": 41112, + "id": 1962, "name": "query", "variant": "param", "kind": 32768, @@ -37087,7 +37103,7 @@ } }, { - "id": 41113, + "id": 1963, "name": "headers", "variant": "param", "kind": 32768, @@ -37096,7 +37112,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -37126,35 +37142,35 @@ ] }, { - "id": 41114, + "id": 1964, "name": "listRuleAttributes", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/promotion.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/promotion.ts", "line": 147, "character": 8 } ], "signatures": [ { - "id": 41115, + "id": 1965, "name": "listRuleAttributes", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/promotion.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/promotion.ts", "line": 147, "character": 8 } ], "parameters": [ { - "id": 41116, + "id": 1966, "name": "ruleType", "variant": "param", "kind": 32768, @@ -37165,7 +37181,7 @@ } }, { - "id": 41117, + "id": 1967, "name": "promotionType", "variant": "param", "kind": 32768, @@ -37178,7 +37194,7 @@ } }, { - "id": 41118, + "id": 1968, "name": "headers", "variant": "param", "kind": 32768, @@ -37187,7 +37203,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -37217,35 +37233,35 @@ ] }, { - "id": 41119, + "id": 1969, "name": "listRuleValues", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/promotion.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/promotion.ts", "line": 162, "character": 8 } ], "signatures": [ { - "id": 41120, + "id": 1970, "name": "listRuleValues", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/promotion.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/promotion.ts", "line": 162, "character": 8 } ], "parameters": [ { - "id": 41121, + "id": 1971, "name": "ruleType", "variant": "param", "kind": 32768, @@ -37256,7 +37272,7 @@ } }, { - "id": 41122, + "id": 1972, "name": "ruleValue", "variant": "param", "kind": 32768, @@ -37267,7 +37283,7 @@ } }, { - "id": 41123, + "id": 1973, "name": "query", "variant": "param", "kind": 32768, @@ -37285,7 +37301,7 @@ } }, { - "id": 41124, + "id": 1974, "name": "headers", "variant": "param", "kind": 32768, @@ -37294,7 +37310,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -37328,49 +37344,49 @@ { "title": "Constructors", "children": [ - 41064 + 1914 ] }, { "title": "Properties", "children": [ - 41067 + 1917 ] }, { "title": "Methods", "children": [ - 41068, - 41073, - 41077, - 41081, - 41086, - 41090, - 41096, - 41102, - 41108, - 41114, - 41119 + 1918, + 1923, + 1927, + 1931, + 1936, + 1940, + 1946, + 1952, + 1958, + 1964, + 1969 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/promotion.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/promotion.ts", "line": 5, "character": 13 } ] }, { - "id": 40921, + "id": 1771, "name": "RefundReason", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 40925, + "id": 1775, "name": "client", "variant": "declaration", "kind": 1024, @@ -37385,34 +37401,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/refund-reasons.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/refund-reasons.ts", "line": 9, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 40922, + "id": 1772, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/refund-reasons.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/refund-reasons.ts", "line": 13, "character": 2 } ], "signatures": [ { - "id": 40923, + "id": 1773, "name": "RefundReason", "variant": "signature", "kind": 16384, @@ -37425,21 +37441,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/refund-reasons.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/refund-reasons.ts", "line": 13, "character": 2 } ], "parameters": [ { - "id": 40924, + "id": 1774, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -37447,7 +37463,7 @@ ], "type": { "type": "reference", - "target": 40921, + "target": 1771, "name": "RefundReason", "package": "@medusajs/js-sdk" } @@ -37455,35 +37471,35 @@ ] }, { - "id": 40926, + "id": 1776, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/refund-reasons.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/refund-reasons.ts", "line": 17, "character": 8 } ], "signatures": [ { - "id": 40927, + "id": 1777, "name": "list", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/refund-reasons.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/refund-reasons.ts", "line": 17, "character": 8 } ], "parameters": [ { - "id": 40928, + "id": 1778, "name": "query", "variant": "param", "kind": 32768, @@ -37501,7 +37517,7 @@ } }, { - "id": 40929, + "id": 1779, "name": "headers", "variant": "param", "kind": 32768, @@ -37510,7 +37526,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -37544,39 +37560,39 @@ { "title": "Constructors", "children": [ - 40922 + 1772 ] }, { "title": "Properties", "children": [ - 40925 + 1775 ] }, { "title": "Methods", "children": [ - 40926 + 1776 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/refund-reasons.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/refund-reasons.ts", "line": 5, "character": 13 } ] }, { - "id": 39861, + "id": 711, "name": "Region", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 39865, + "id": 715, "name": "client", "variant": "declaration", "kind": 1024, @@ -37591,34 +37607,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/region.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/region.ts", "line": 14, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 39862, + "id": 712, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/region.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/region.ts", "line": 18, "character": 2 } ], "signatures": [ { - "id": 39863, + "id": 713, "name": "Region", "variant": "signature", "kind": 16384, @@ -37631,21 +37647,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/region.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/region.ts", "line": 18, "character": 2 } ], "parameters": [ { - "id": 39864, + "id": 714, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -37653,7 +37669,7 @@ ], "type": { "type": "reference", - "target": 39861, + "target": 711, "name": "Region", "package": "@medusajs/js-sdk" } @@ -37661,35 +37677,35 @@ ] }, { - "id": 39866, + "id": 716, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/region.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/region.ts", "line": 22, "character": 8 } ], "signatures": [ { - "id": 39867, + "id": 717, "name": "create", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/region.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/region.ts", "line": 22, "character": 8 } ], "parameters": [ { - "id": 39868, + "id": 718, "name": "body", "variant": "param", "kind": 32768, @@ -37705,7 +37721,7 @@ } }, { - "id": 39869, + "id": 719, "name": "query", "variant": "param", "kind": 32768, @@ -37723,7 +37739,7 @@ } }, { - "id": 39870, + "id": 720, "name": "headers", "variant": "param", "kind": 32768, @@ -37732,7 +37748,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -37748,21 +37764,21 @@ { "type": "reflection", "declaration": { - "id": 39871, + "id": 721, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 39872, + "id": 722, "name": "region", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/region.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/region.ts", "line": 27, "character": 37 } @@ -37782,13 +37798,13 @@ { "title": "Properties", "children": [ - 39872 + 722 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/region.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/region.ts", "line": 27, "character": 35 } @@ -37803,35 +37819,35 @@ ] }, { - "id": 39873, + "id": 723, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/region.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/region.ts", "line": 38, "character": 8 } ], "signatures": [ { - "id": 39874, + "id": 724, "name": "update", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/region.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/region.ts", "line": 38, "character": 8 } ], "parameters": [ { - "id": 39875, + "id": 725, "name": "id", "variant": "param", "kind": 32768, @@ -37842,7 +37858,7 @@ } }, { - "id": 39876, + "id": 726, "name": "body", "variant": "param", "kind": 32768, @@ -37858,7 +37874,7 @@ } }, { - "id": 39877, + "id": 727, "name": "query", "variant": "param", "kind": 32768, @@ -37876,7 +37892,7 @@ } }, { - "id": 39878, + "id": 728, "name": "headers", "variant": "param", "kind": 32768, @@ -37885,7 +37901,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -37901,21 +37917,21 @@ { "type": "reflection", "declaration": { - "id": 39879, + "id": 729, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 39880, + "id": 730, "name": "region", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/region.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/region.ts", "line": 44, "character": 37 } @@ -37935,13 +37951,13 @@ { "title": "Properties", "children": [ - 39880 + 730 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/region.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/region.ts", "line": 44, "character": 35 } @@ -37956,35 +37972,35 @@ ] }, { - "id": 39881, + "id": 731, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/region.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/region.ts", "line": 55, "character": 8 } ], "signatures": [ { - "id": 39882, + "id": 732, "name": "list", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/region.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/region.ts", "line": 55, "character": 8 } ], "parameters": [ { - "id": 39883, + "id": 733, "name": "queryParams", "variant": "param", "kind": 32768, @@ -38016,7 +38032,7 @@ } }, { - "id": 39884, + "id": 734, "name": "headers", "variant": "param", "kind": 32768, @@ -38025,7 +38041,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -38048,21 +38064,21 @@ { "type": "reflection", "declaration": { - "id": 39885, + "id": 735, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 39886, + "id": 736, "name": "regions", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/region.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/region.ts", "line": 60, "character": 26 } @@ -38085,13 +38101,13 @@ { "title": "Properties", "children": [ - 39886 + 736 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/region.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/region.ts", "line": 60, "character": 24 } @@ -38110,35 +38126,35 @@ ] }, { - "id": 39887, + "id": 737, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/region.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/region.ts", "line": 67, "character": 8 } ], "signatures": [ { - "id": 39888, + "id": 738, "name": "retrieve", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/region.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/region.ts", "line": 67, "character": 8 } ], "parameters": [ { - "id": 39889, + "id": 739, "name": "id", "variant": "param", "kind": 32768, @@ -38149,7 +38165,7 @@ } }, { - "id": 39890, + "id": 740, "name": "query", "variant": "param", "kind": 32768, @@ -38167,7 +38183,7 @@ } }, { - "id": 39891, + "id": 741, "name": "headers", "variant": "param", "kind": 32768, @@ -38176,7 +38192,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -38192,21 +38208,21 @@ { "type": "reflection", "declaration": { - "id": 39892, + "id": 742, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 39893, + "id": 743, "name": "region", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/region.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/region.ts", "line": 68, "character": 37 } @@ -38226,13 +38242,13 @@ { "title": "Properties", "children": [ - 39893 + 743 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/region.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/region.ts", "line": 68, "character": 35 } @@ -38247,35 +38263,35 @@ ] }, { - "id": 39894, + "id": 744, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/region.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/region.ts", "line": 77, "character": 8 } ], "signatures": [ { - "id": 39895, + "id": 745, "name": "delete", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/region.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/region.ts", "line": 77, "character": 8 } ], "parameters": [ { - "id": 39896, + "id": 746, "name": "id", "variant": "param", "kind": 32768, @@ -38286,7 +38302,7 @@ } }, { - "id": 39897, + "id": 747, "name": "headers", "variant": "param", "kind": 32768, @@ -38295,7 +38311,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -38329,43 +38345,43 @@ { "title": "Constructors", "children": [ - 39862 + 712 ] }, { "title": "Properties", "children": [ - 39865 + 715 ] }, { "title": "Methods", "children": [ - 39866, - 39873, - 39881, - 39887, - 39894 + 716, + 723, + 731, + 737, + 744 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/region.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/region.ts", "line": 10, "character": 13 } ] }, { - "id": 41000, + "id": 1850, "name": "Reservation", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 41004, + "id": 1854, "name": "client", "variant": "declaration", "kind": 1024, @@ -38380,34 +38396,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/reservation.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/reservation.ts", "line": 9, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 41001, + "id": 1851, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/reservation.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/reservation.ts", "line": 13, "character": 2 } ], "signatures": [ { - "id": 41002, + "id": 1852, "name": "Reservation", "variant": "signature", "kind": 16384, @@ -38420,21 +38436,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/reservation.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/reservation.ts", "line": 13, "character": 2 } ], "parameters": [ { - "id": 41003, + "id": 1853, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -38442,7 +38458,7 @@ ], "type": { "type": "reference", - "target": 41000, + "target": 1850, "name": "Reservation", "package": "@medusajs/js-sdk" } @@ -38450,35 +38466,35 @@ ] }, { - "id": 41005, + "id": 1855, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/reservation.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/reservation.ts", "line": 17, "character": 8 } ], "signatures": [ { - "id": 41006, + "id": 1856, "name": "retrieve", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/reservation.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/reservation.ts", "line": 17, "character": 8 } ], "parameters": [ { - "id": 41007, + "id": 1857, "name": "id", "variant": "param", "kind": 32768, @@ -38489,7 +38505,7 @@ } }, { - "id": 41008, + "id": 1858, "name": "query", "variant": "param", "kind": 32768, @@ -38507,7 +38523,7 @@ } }, { - "id": 41009, + "id": 1859, "name": "headers", "variant": "param", "kind": 32768, @@ -38516,7 +38532,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -38546,35 +38562,35 @@ ] }, { - "id": 41010, + "id": 1860, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/reservation.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/reservation.ts", "line": 32, "character": 8 } ], "signatures": [ { - "id": 41011, + "id": 1861, "name": "list", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/reservation.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/reservation.ts", "line": 32, "character": 8 } ], "parameters": [ { - "id": 41012, + "id": 1862, "name": "query", "variant": "param", "kind": 32768, @@ -38592,7 +38608,7 @@ } }, { - "id": 41013, + "id": 1863, "name": "headers", "variant": "param", "kind": 32768, @@ -38601,7 +38617,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -38631,35 +38647,35 @@ ] }, { - "id": 41014, + "id": 1864, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/reservation.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/reservation.ts", "line": 46, "character": 8 } ], "signatures": [ { - "id": 41015, + "id": 1865, "name": "create", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/reservation.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/reservation.ts", "line": 46, "character": 8 } ], "parameters": [ { - "id": 41016, + "id": 1866, "name": "body", "variant": "param", "kind": 32768, @@ -38675,7 +38691,7 @@ } }, { - "id": 41017, + "id": 1867, "name": "query", "variant": "param", "kind": 32768, @@ -38693,7 +38709,7 @@ } }, { - "id": 41018, + "id": 1868, "name": "headers", "variant": "param", "kind": 32768, @@ -38702,7 +38718,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -38732,35 +38748,35 @@ ] }, { - "id": 41019, + "id": 1869, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/reservation.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/reservation.ts", "line": 62, "character": 8 } ], "signatures": [ { - "id": 41020, + "id": 1870, "name": "update", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/reservation.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/reservation.ts", "line": 62, "character": 8 } ], "parameters": [ { - "id": 41021, + "id": 1871, "name": "id", "variant": "param", "kind": 32768, @@ -38771,7 +38787,7 @@ } }, { - "id": 41022, + "id": 1872, "name": "body", "variant": "param", "kind": 32768, @@ -38787,7 +38803,7 @@ } }, { - "id": 41023, + "id": 1873, "name": "query", "variant": "param", "kind": 32768, @@ -38805,7 +38821,7 @@ } }, { - "id": 41024, + "id": 1874, "name": "headers", "variant": "param", "kind": 32768, @@ -38814,7 +38830,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -38844,35 +38860,35 @@ ] }, { - "id": 41025, + "id": 1875, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/reservation.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/reservation.ts", "line": 79, "character": 8 } ], "signatures": [ { - "id": 41026, + "id": 1876, "name": "delete", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/reservation.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/reservation.ts", "line": 79, "character": 8 } ], "parameters": [ { - "id": 41027, + "id": 1877, "name": "id", "variant": "param", "kind": 32768, @@ -38883,7 +38899,7 @@ } }, { - "id": 41028, + "id": 1878, "name": "headers", "variant": "param", "kind": 32768, @@ -38892,7 +38908,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -38926,43 +38942,43 @@ { "title": "Constructors", "children": [ - 41001 + 1851 ] }, { "title": "Properties", "children": [ - 41004 + 1854 ] }, { "title": "Methods", "children": [ - 41005, - 41010, - 41014, - 41019, - 41025 + 1855, + 1860, + 1864, + 1869, + 1875 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/reservation.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/reservation.ts", "line": 5, "character": 6 } ] }, { - "id": 39898, + "id": 748, "name": "ReturnReason", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 39902, + "id": 752, "name": "client", "variant": "declaration", "kind": 1024, @@ -38977,34 +38993,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return-reason.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return-reason.ts", "line": 10, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 39899, + "id": 749, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return-reason.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return-reason.ts", "line": 14, "character": 2 } ], "signatures": [ { - "id": 39900, + "id": 750, "name": "ReturnReason", "variant": "signature", "kind": 16384, @@ -39017,21 +39033,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return-reason.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return-reason.ts", "line": 14, "character": 2 } ], "parameters": [ { - "id": 39901, + "id": 751, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -39039,7 +39055,7 @@ ], "type": { "type": "reference", - "target": 39898, + "target": 748, "name": "ReturnReason", "package": "@medusajs/js-sdk" } @@ -39047,35 +39063,35 @@ ] }, { - "id": 39903, + "id": 753, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return-reason.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return-reason.ts", "line": 18, "character": 8 } ], "signatures": [ { - "id": 39904, + "id": 754, "name": "list", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return-reason.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return-reason.ts", "line": 18, "character": 8 } ], "parameters": [ { - "id": 39905, + "id": 755, "name": "query", "variant": "param", "kind": 32768, @@ -39093,7 +39109,7 @@ } }, { - "id": 39906, + "id": 756, "name": "headers", "variant": "param", "kind": 32768, @@ -39102,7 +39118,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -39132,35 +39148,35 @@ ] }, { - "id": 39907, + "id": 757, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return-reason.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return-reason.ts", "line": 31, "character": 8 } ], "signatures": [ { - "id": 39908, + "id": 758, "name": "retrieve", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return-reason.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return-reason.ts", "line": 31, "character": 8 } ], "parameters": [ { - "id": 39909, + "id": 759, "name": "id", "variant": "param", "kind": 32768, @@ -39171,7 +39187,7 @@ } }, { - "id": 39910, + "id": 760, "name": "query", "variant": "param", "kind": 32768, @@ -39189,7 +39205,7 @@ } }, { - "id": 39911, + "id": 761, "name": "headers", "variant": "param", "kind": 32768, @@ -39198,7 +39214,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -39228,35 +39244,35 @@ ] }, { - "id": 39912, + "id": 762, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return-reason.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return-reason.ts", "line": 45, "character": 8 } ], "signatures": [ { - "id": 39913, + "id": 763, "name": "create", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return-reason.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return-reason.ts", "line": 45, "character": 8 } ], "parameters": [ { - "id": 39914, + "id": 764, "name": "body", "variant": "param", "kind": 32768, @@ -39272,7 +39288,7 @@ } }, { - "id": 39915, + "id": 765, "name": "query", "variant": "param", "kind": 32768, @@ -39290,7 +39306,7 @@ } }, { - "id": 39916, + "id": 766, "name": "headers", "variant": "param", "kind": 32768, @@ -39299,7 +39315,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -39329,35 +39345,35 @@ ] }, { - "id": 39917, + "id": 767, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return-reason.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return-reason.ts", "line": 61, "character": 8 } ], "signatures": [ { - "id": 39918, + "id": 768, "name": "update", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return-reason.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return-reason.ts", "line": 61, "character": 8 } ], "parameters": [ { - "id": 39919, + "id": 769, "name": "id", "variant": "param", "kind": 32768, @@ -39368,7 +39384,7 @@ } }, { - "id": 39920, + "id": 770, "name": "body", "variant": "param", "kind": 32768, @@ -39384,7 +39400,7 @@ } }, { - "id": 39921, + "id": 771, "name": "query", "variant": "param", "kind": 32768, @@ -39402,7 +39418,7 @@ } }, { - "id": 39922, + "id": 772, "name": "headers", "variant": "param", "kind": 32768, @@ -39411,7 +39427,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -39441,35 +39457,35 @@ ] }, { - "id": 39923, + "id": 773, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return-reason.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return-reason.ts", "line": 78, "character": 8 } ], "signatures": [ { - "id": 39924, + "id": 774, "name": "delete", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return-reason.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return-reason.ts", "line": 78, "character": 8 } ], "parameters": [ { - "id": 39925, + "id": 775, "name": "id", "variant": "param", "kind": 32768, @@ -39480,7 +39496,7 @@ } }, { - "id": 39926, + "id": 776, "name": "query", "variant": "param", "kind": 32768, @@ -39498,7 +39514,7 @@ } }, { - "id": 39927, + "id": 777, "name": "headers", "variant": "param", "kind": 32768, @@ -39507,7 +39523,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -39541,43 +39557,43 @@ { "title": "Constructors", "children": [ - 39899 + 749 ] }, { "title": "Properties", "children": [ - 39902 + 752 ] }, { "title": "Methods", "children": [ - 39903, - 39907, - 39912, - 39917, - 39923 + 753, + 757, + 762, + 767, + 773 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return-reason.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return-reason.ts", "line": 6, "character": 13 } ] }, { - "id": 40364, + "id": 1214, "name": "Return", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 40368, + "id": 1218, "name": "client", "variant": "declaration", "kind": 1024, @@ -39592,34 +39608,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 10, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 40365, + "id": 1215, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 14, "character": 2 } ], "signatures": [ { - "id": 40366, + "id": 1216, "name": "Return", "variant": "signature", "kind": 16384, @@ -39632,21 +39648,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 14, "character": 2 } ], "parameters": [ { - "id": 40367, + "id": 1217, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -39654,7 +39670,7 @@ ], "type": { "type": "reference", - "target": 40364, + "target": 1214, "name": "Return", "package": "@medusajs/js-sdk" } @@ -39662,35 +39678,35 @@ ] }, { - "id": 40369, + "id": 1219, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 18, "character": 8 } ], "signatures": [ { - "id": 40370, + "id": 1220, "name": "list", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 18, "character": 8 } ], "parameters": [ { - "id": 40371, + "id": 1221, "name": "query", "variant": "param", "kind": 32768, @@ -39708,7 +39724,7 @@ } }, { - "id": 40372, + "id": 1222, "name": "headers", "variant": "param", "kind": 32768, @@ -39717,7 +39733,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -39747,35 +39763,35 @@ ] }, { - "id": 40373, + "id": 1223, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 28, "character": 8 } ], "signatures": [ { - "id": 40374, + "id": 1224, "name": "retrieve", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 28, "character": 8 } ], "parameters": [ { - "id": 40375, + "id": 1225, "name": "id", "variant": "param", "kind": 32768, @@ -39786,7 +39802,7 @@ } }, { - "id": 40376, + "id": 1226, "name": "query", "variant": "param", "kind": 32768, @@ -39804,7 +39820,7 @@ } }, { - "id": 40377, + "id": 1227, "name": "headers", "variant": "param", "kind": 32768, @@ -39813,7 +39829,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -39843,35 +39859,35 @@ ] }, { - "id": 40378, + "id": 1228, "name": "initiateRequest", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 38, "character": 8 } ], "signatures": [ { - "id": 40379, + "id": 1229, "name": "initiateRequest", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 38, "character": 8 } ], "parameters": [ { - "id": 40380, + "id": 1230, "name": "body", "variant": "param", "kind": 32768, @@ -39887,7 +39903,7 @@ } }, { - "id": 40381, + "id": 1231, "name": "query", "variant": "param", "kind": 32768, @@ -39905,7 +39921,7 @@ } }, { - "id": 40382, + "id": 1232, "name": "headers", "variant": "param", "kind": 32768, @@ -39914,7 +39930,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -39944,35 +39960,35 @@ ] }, { - "id": 40383, + "id": 1233, "name": "cancel", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 54, "character": 8 } ], "signatures": [ { - "id": 40384, + "id": 1234, "name": "cancel", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 54, "character": 8 } ], "parameters": [ { - "id": 40385, + "id": 1235, "name": "id", "variant": "param", "kind": 32768, @@ -39983,7 +39999,7 @@ } }, { - "id": 40386, + "id": 1236, "name": "query", "variant": "param", "kind": 32768, @@ -40001,7 +40017,7 @@ } }, { - "id": 40387, + "id": 1237, "name": "headers", "variant": "param", "kind": 32768, @@ -40010,7 +40026,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -40040,35 +40056,35 @@ ] }, { - "id": 40388, + "id": 1238, "name": "cancelRequest", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 69, "character": 8 } ], "signatures": [ { - "id": 40389, + "id": 1239, "name": "cancelRequest", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 69, "character": 8 } ], "parameters": [ { - "id": 40390, + "id": 1240, "name": "id", "variant": "param", "kind": 32768, @@ -40079,7 +40095,7 @@ } }, { - "id": 40391, + "id": 1241, "name": "query", "variant": "param", "kind": 32768, @@ -40097,7 +40113,7 @@ } }, { - "id": 40392, + "id": 1242, "name": "headers", "variant": "param", "kind": 32768, @@ -40106,7 +40122,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -40136,35 +40152,35 @@ ] }, { - "id": 40393, + "id": 1243, "name": "addReturnItem", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 84, "character": 8 } ], "signatures": [ { - "id": 40394, + "id": 1244, "name": "addReturnItem", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 84, "character": 8 } ], "parameters": [ { - "id": 40395, + "id": 1245, "name": "id", "variant": "param", "kind": 32768, @@ -40175,7 +40191,7 @@ } }, { - "id": 40396, + "id": 1246, "name": "body", "variant": "param", "kind": 32768, @@ -40191,7 +40207,7 @@ } }, { - "id": 40397, + "id": 1247, "name": "query", "variant": "param", "kind": 32768, @@ -40209,7 +40225,7 @@ } }, { - "id": 40398, + "id": 1248, "name": "headers", "variant": "param", "kind": 32768, @@ -40218,7 +40234,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -40248,35 +40264,35 @@ ] }, { - "id": 40399, + "id": 1249, "name": "updateReturnItem", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 101, "character": 8 } ], "signatures": [ { - "id": 40400, + "id": 1250, "name": "updateReturnItem", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 101, "character": 8 } ], "parameters": [ { - "id": 40401, + "id": 1251, "name": "id", "variant": "param", "kind": 32768, @@ -40287,7 +40303,7 @@ } }, { - "id": 40402, + "id": 1252, "name": "actionId", "variant": "param", "kind": 32768, @@ -40298,7 +40314,7 @@ } }, { - "id": 40403, + "id": 1253, "name": "body", "variant": "param", "kind": 32768, @@ -40314,7 +40330,7 @@ } }, { - "id": 40404, + "id": 1254, "name": "query", "variant": "param", "kind": 32768, @@ -40332,7 +40348,7 @@ } }, { - "id": 40405, + "id": 1255, "name": "headers", "variant": "param", "kind": 32768, @@ -40341,7 +40357,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -40371,35 +40387,35 @@ ] }, { - "id": 40406, + "id": 1256, "name": "removeReturnItem", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 119, "character": 8 } ], "signatures": [ { - "id": 40407, + "id": 1257, "name": "removeReturnItem", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 119, "character": 8 } ], "parameters": [ { - "id": 40408, + "id": 1258, "name": "id", "variant": "param", "kind": 32768, @@ -40410,7 +40426,7 @@ } }, { - "id": 40409, + "id": 1259, "name": "actionId", "variant": "param", "kind": 32768, @@ -40421,7 +40437,7 @@ } }, { - "id": 40410, + "id": 1260, "name": "query", "variant": "param", "kind": 32768, @@ -40439,7 +40455,7 @@ } }, { - "id": 40411, + "id": 1261, "name": "headers", "variant": "param", "kind": 32768, @@ -40448,7 +40464,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -40478,35 +40494,35 @@ ] }, { - "id": 40412, + "id": 1262, "name": "addReturnShipping", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 135, "character": 8 } ], "signatures": [ { - "id": 40413, + "id": 1263, "name": "addReturnShipping", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 135, "character": 8 } ], "parameters": [ { - "id": 40414, + "id": 1264, "name": "id", "variant": "param", "kind": 32768, @@ -40517,7 +40533,7 @@ } }, { - "id": 40415, + "id": 1265, "name": "body", "variant": "param", "kind": 32768, @@ -40533,7 +40549,7 @@ } }, { - "id": 40416, + "id": 1266, "name": "query", "variant": "param", "kind": 32768, @@ -40551,7 +40567,7 @@ } }, { - "id": 40417, + "id": 1267, "name": "headers", "variant": "param", "kind": 32768, @@ -40560,7 +40576,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -40590,35 +40606,35 @@ ] }, { - "id": 40418, + "id": 1268, "name": "updateReturnShipping", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 152, "character": 8 } ], "signatures": [ { - "id": 40419, + "id": 1269, "name": "updateReturnShipping", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 152, "character": 8 } ], "parameters": [ { - "id": 40420, + "id": 1270, "name": "id", "variant": "param", "kind": 32768, @@ -40629,7 +40645,7 @@ } }, { - "id": 40421, + "id": 1271, "name": "actionId", "variant": "param", "kind": 32768, @@ -40640,7 +40656,7 @@ } }, { - "id": 40422, + "id": 1272, "name": "body", "variant": "param", "kind": 32768, @@ -40656,7 +40672,7 @@ } }, { - "id": 40423, + "id": 1273, "name": "query", "variant": "param", "kind": 32768, @@ -40674,7 +40690,7 @@ } }, { - "id": 40424, + "id": 1274, "name": "headers", "variant": "param", "kind": 32768, @@ -40683,7 +40699,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -40713,35 +40729,35 @@ ] }, { - "id": 40425, + "id": 1275, "name": "deleteReturnShipping", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 170, "character": 8 } ], "signatures": [ { - "id": 40426, + "id": 1276, "name": "deleteReturnShipping", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 170, "character": 8 } ], "parameters": [ { - "id": 40427, + "id": 1277, "name": "id", "variant": "param", "kind": 32768, @@ -40752,7 +40768,7 @@ } }, { - "id": 40428, + "id": 1278, "name": "actionId", "variant": "param", "kind": 32768, @@ -40763,7 +40779,7 @@ } }, { - "id": 40429, + "id": 1279, "name": "query", "variant": "param", "kind": 32768, @@ -40781,7 +40797,7 @@ } }, { - "id": 40430, + "id": 1280, "name": "headers", "variant": "param", "kind": 32768, @@ -40790,7 +40806,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -40820,35 +40836,35 @@ ] }, { - "id": 40431, + "id": 1281, "name": "updateRequest", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 186, "character": 8 } ], "signatures": [ { - "id": 40432, + "id": 1282, "name": "updateRequest", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 186, "character": 8 } ], "parameters": [ { - "id": 40433, + "id": 1283, "name": "id", "variant": "param", "kind": 32768, @@ -40859,7 +40875,7 @@ } }, { - "id": 40434, + "id": 1284, "name": "body", "variant": "param", "kind": 32768, @@ -40875,7 +40891,7 @@ } }, { - "id": 40435, + "id": 1285, "name": "query", "variant": "param", "kind": 32768, @@ -40893,7 +40909,7 @@ } }, { - "id": 40436, + "id": 1286, "name": "headers", "variant": "param", "kind": 32768, @@ -40902,7 +40918,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -40932,35 +40948,35 @@ ] }, { - "id": 40437, + "id": 1287, "name": "confirmRequest", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 203, "character": 8 } ], "signatures": [ { - "id": 40438, + "id": 1288, "name": "confirmRequest", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 203, "character": 8 } ], "parameters": [ { - "id": 40439, + "id": 1289, "name": "id", "variant": "param", "kind": 32768, @@ -40971,7 +40987,7 @@ } }, { - "id": 40440, + "id": 1290, "name": "body", "variant": "param", "kind": 32768, @@ -40987,7 +41003,7 @@ } }, { - "id": 40441, + "id": 1291, "name": "query", "variant": "param", "kind": 32768, @@ -41005,7 +41021,7 @@ } }, { - "id": 40442, + "id": 1292, "name": "headers", "variant": "param", "kind": 32768, @@ -41014,7 +41030,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -41044,35 +41060,35 @@ ] }, { - "id": 40443, + "id": 1293, "name": "initiateReceive", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 220, "character": 8 } ], "signatures": [ { - "id": 40444, + "id": 1294, "name": "initiateReceive", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 220, "character": 8 } ], "parameters": [ { - "id": 40445, + "id": 1295, "name": "id", "variant": "param", "kind": 32768, @@ -41083,7 +41099,7 @@ } }, { - "id": 40446, + "id": 1296, "name": "body", "variant": "param", "kind": 32768, @@ -41099,7 +41115,7 @@ } }, { - "id": 40447, + "id": 1297, "name": "query", "variant": "param", "kind": 32768, @@ -41117,7 +41133,7 @@ } }, { - "id": 40448, + "id": 1298, "name": "headers", "variant": "param", "kind": 32768, @@ -41126,7 +41142,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -41156,35 +41172,35 @@ ] }, { - "id": 40449, + "id": 1299, "name": "receiveItems", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 237, "character": 8 } ], "signatures": [ { - "id": 40450, + "id": 1300, "name": "receiveItems", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 237, "character": 8 } ], "parameters": [ { - "id": 40451, + "id": 1301, "name": "id", "variant": "param", "kind": 32768, @@ -41195,7 +41211,7 @@ } }, { - "id": 40452, + "id": 1302, "name": "body", "variant": "param", "kind": 32768, @@ -41211,7 +41227,7 @@ } }, { - "id": 40453, + "id": 1303, "name": "query", "variant": "param", "kind": 32768, @@ -41229,7 +41245,7 @@ } }, { - "id": 40454, + "id": 1304, "name": "headers", "variant": "param", "kind": 32768, @@ -41238,7 +41254,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -41268,35 +41284,35 @@ ] }, { - "id": 40455, + "id": 1305, "name": "updateReceiveItem", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 254, "character": 8 } ], "signatures": [ { - "id": 40456, + "id": 1306, "name": "updateReceiveItem", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 254, "character": 8 } ], "parameters": [ { - "id": 40457, + "id": 1307, "name": "id", "variant": "param", "kind": 32768, @@ -41307,7 +41323,7 @@ } }, { - "id": 40458, + "id": 1308, "name": "actionId", "variant": "param", "kind": 32768, @@ -41318,7 +41334,7 @@ } }, { - "id": 40459, + "id": 1309, "name": "body", "variant": "param", "kind": 32768, @@ -41334,7 +41350,7 @@ } }, { - "id": 40460, + "id": 1310, "name": "query", "variant": "param", "kind": 32768, @@ -41352,7 +41368,7 @@ } }, { - "id": 40461, + "id": 1311, "name": "headers", "variant": "param", "kind": 32768, @@ -41361,7 +41377,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -41391,35 +41407,35 @@ ] }, { - "id": 40462, + "id": 1312, "name": "removeReceiveItem", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 272, "character": 8 } ], "signatures": [ { - "id": 40463, + "id": 1313, "name": "removeReceiveItem", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 272, "character": 8 } ], "parameters": [ { - "id": 40464, + "id": 1314, "name": "id", "variant": "param", "kind": 32768, @@ -41430,7 +41446,7 @@ } }, { - "id": 40465, + "id": 1315, "name": "actionId", "variant": "param", "kind": 32768, @@ -41441,7 +41457,7 @@ } }, { - "id": 40466, + "id": 1316, "name": "query", "variant": "param", "kind": 32768, @@ -41459,7 +41475,7 @@ } }, { - "id": 40467, + "id": 1317, "name": "headers", "variant": "param", "kind": 32768, @@ -41468,7 +41484,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -41498,35 +41514,35 @@ ] }, { - "id": 40468, + "id": 1318, "name": "dismissItems", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 288, "character": 8 } ], "signatures": [ { - "id": 40469, + "id": 1319, "name": "dismissItems", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 288, "character": 8 } ], "parameters": [ { - "id": 40470, + "id": 1320, "name": "id", "variant": "param", "kind": 32768, @@ -41537,7 +41553,7 @@ } }, { - "id": 40471, + "id": 1321, "name": "body", "variant": "param", "kind": 32768, @@ -41553,7 +41569,7 @@ } }, { - "id": 40472, + "id": 1322, "name": "query", "variant": "param", "kind": 32768, @@ -41571,7 +41587,7 @@ } }, { - "id": 40473, + "id": 1323, "name": "headers", "variant": "param", "kind": 32768, @@ -41580,7 +41596,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -41610,35 +41626,35 @@ ] }, { - "id": 40474, + "id": 1324, "name": "updateDismissItem", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 305, "character": 8 } ], "signatures": [ { - "id": 40475, + "id": 1325, "name": "updateDismissItem", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 305, "character": 8 } ], "parameters": [ { - "id": 40476, + "id": 1326, "name": "id", "variant": "param", "kind": 32768, @@ -41649,7 +41665,7 @@ } }, { - "id": 40477, + "id": 1327, "name": "actionId", "variant": "param", "kind": 32768, @@ -41660,7 +41676,7 @@ } }, { - "id": 40478, + "id": 1328, "name": "body", "variant": "param", "kind": 32768, @@ -41676,7 +41692,7 @@ } }, { - "id": 40479, + "id": 1329, "name": "query", "variant": "param", "kind": 32768, @@ -41694,7 +41710,7 @@ } }, { - "id": 40480, + "id": 1330, "name": "headers", "variant": "param", "kind": 32768, @@ -41703,7 +41719,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -41733,35 +41749,35 @@ ] }, { - "id": 40481, + "id": 1331, "name": "removeDismissItem", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 323, "character": 8 } ], "signatures": [ { - "id": 40482, + "id": 1332, "name": "removeDismissItem", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 323, "character": 8 } ], "parameters": [ { - "id": 40483, + "id": 1333, "name": "id", "variant": "param", "kind": 32768, @@ -41772,7 +41788,7 @@ } }, { - "id": 40484, + "id": 1334, "name": "actionId", "variant": "param", "kind": 32768, @@ -41783,7 +41799,7 @@ } }, { - "id": 40485, + "id": 1335, "name": "query", "variant": "param", "kind": 32768, @@ -41801,7 +41817,7 @@ } }, { - "id": 40486, + "id": 1336, "name": "headers", "variant": "param", "kind": 32768, @@ -41810,7 +41826,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -41840,35 +41856,35 @@ ] }, { - "id": 40487, + "id": 1337, "name": "confirmReceive", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 339, "character": 8 } ], "signatures": [ { - "id": 40488, + "id": 1338, "name": "confirmReceive", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 339, "character": 8 } ], "parameters": [ { - "id": 40489, + "id": 1339, "name": "id", "variant": "param", "kind": 32768, @@ -41879,7 +41895,7 @@ } }, { - "id": 40490, + "id": 1340, "name": "body", "variant": "param", "kind": 32768, @@ -41895,7 +41911,7 @@ } }, { - "id": 40491, + "id": 1341, "name": "query", "variant": "param", "kind": 32768, @@ -41913,7 +41929,7 @@ } }, { - "id": 40492, + "id": 1342, "name": "headers", "variant": "param", "kind": 32768, @@ -41922,7 +41938,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -41952,35 +41968,35 @@ ] }, { - "id": 40493, + "id": 1343, "name": "cancelReceive", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 356, "character": 8 } ], "signatures": [ { - "id": 40494, + "id": 1344, "name": "cancelReceive", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 356, "character": 8 } ], "parameters": [ { - "id": 40495, + "id": 1345, "name": "id", "variant": "param", "kind": 32768, @@ -41991,7 +42007,7 @@ } }, { - "id": 40496, + "id": 1346, "name": "query", "variant": "param", "kind": 32768, @@ -42009,7 +42025,7 @@ } }, { - "id": 40497, + "id": 1347, "name": "headers", "variant": "param", "kind": 32768, @@ -42018,7 +42034,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -42052,60 +42068,60 @@ { "title": "Constructors", "children": [ - 40365 + 1215 ] }, { "title": "Properties", "children": [ - 40368 + 1218 ] }, { "title": "Methods", "children": [ - 40369, - 40373, - 40378, - 40383, - 40388, - 40393, - 40399, - 40406, - 40412, - 40418, - 40425, - 40431, - 40437, - 40443, - 40449, - 40455, - 40462, - 40468, - 40474, - 40481, - 40487, - 40493 + 1219, + 1223, + 1228, + 1233, + 1238, + 1243, + 1249, + 1256, + 1262, + 1268, + 1275, + 1281, + 1287, + 1293, + 1299, + 1305, + 1312, + 1318, + 1324, + 1331, + 1337, + 1343 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/return.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/return.ts", "line": 6, "character": 13 } ] }, { - "id": 39972, + "id": 822, "name": "SalesChannel", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 39976, + "id": 826, "name": "client", "variant": "declaration", "kind": 1024, @@ -42120,34 +42136,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/sales-channel.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/sales-channel.ts", "line": 9, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 39973, + "id": 823, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/sales-channel.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/sales-channel.ts", "line": 13, "character": 2 } ], "signatures": [ { - "id": 39974, + "id": 824, "name": "SalesChannel", "variant": "signature", "kind": 16384, @@ -42160,21 +42176,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/sales-channel.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/sales-channel.ts", "line": 13, "character": 2 } ], "parameters": [ { - "id": 39975, + "id": 825, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -42182,7 +42198,7 @@ ], "type": { "type": "reference", - "target": 39972, + "target": 822, "name": "SalesChannel", "package": "@medusajs/js-sdk" } @@ -42190,35 +42206,35 @@ ] }, { - "id": 39977, + "id": 827, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/sales-channel.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/sales-channel.ts", "line": 17, "character": 8 } ], "signatures": [ { - "id": 39978, + "id": 828, "name": "create", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/sales-channel.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/sales-channel.ts", "line": 17, "character": 8 } ], "parameters": [ { - "id": 39979, + "id": 829, "name": "body", "variant": "param", "kind": 32768, @@ -42234,7 +42250,7 @@ } }, { - "id": 39980, + "id": 830, "name": "query", "variant": "param", "kind": 32768, @@ -42252,7 +42268,7 @@ } }, { - "id": 39981, + "id": 831, "name": "headers", "variant": "param", "kind": 32768, @@ -42261,7 +42277,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -42291,35 +42307,35 @@ ] }, { - "id": 39982, + "id": 832, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/sales-channel.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/sales-channel.ts", "line": 33, "character": 8 } ], "signatures": [ { - "id": 39983, + "id": 833, "name": "update", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/sales-channel.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/sales-channel.ts", "line": 33, "character": 8 } ], "parameters": [ { - "id": 39984, + "id": 834, "name": "id", "variant": "param", "kind": 32768, @@ -42330,7 +42346,7 @@ } }, { - "id": 39985, + "id": 835, "name": "body", "variant": "param", "kind": 32768, @@ -42346,7 +42362,7 @@ } }, { - "id": 39986, + "id": 836, "name": "query", "variant": "param", "kind": 32768, @@ -42364,7 +42380,7 @@ } }, { - "id": 39987, + "id": 837, "name": "headers", "variant": "param", "kind": 32768, @@ -42373,7 +42389,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -42403,35 +42419,35 @@ ] }, { - "id": 39988, + "id": 838, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/sales-channel.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/sales-channel.ts", "line": 50, "character": 8 } ], "signatures": [ { - "id": 39989, + "id": 839, "name": "delete", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/sales-channel.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/sales-channel.ts", "line": 50, "character": 8 } ], "parameters": [ { - "id": 39990, + "id": 840, "name": "id", "variant": "param", "kind": 32768, @@ -42442,7 +42458,7 @@ } }, { - "id": 39991, + "id": 841, "name": "headers", "variant": "param", "kind": 32768, @@ -42451,7 +42467,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -42481,35 +42497,35 @@ ] }, { - "id": 39992, + "id": 842, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/sales-channel.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/sales-channel.ts", "line": 60, "character": 8 } ], "signatures": [ { - "id": 39993, + "id": 843, "name": "retrieve", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/sales-channel.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/sales-channel.ts", "line": 60, "character": 8 } ], "parameters": [ { - "id": 39994, + "id": 844, "name": "id", "variant": "param", "kind": 32768, @@ -42520,7 +42536,7 @@ } }, { - "id": 39995, + "id": 845, "name": "query", "variant": "param", "kind": 32768, @@ -42538,7 +42554,7 @@ } }, { - "id": 39996, + "id": 846, "name": "headers", "variant": "param", "kind": 32768, @@ -42547,7 +42563,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -42577,35 +42593,35 @@ ] }, { - "id": 39997, + "id": 847, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/sales-channel.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/sales-channel.ts", "line": 75, "character": 8 } ], "signatures": [ { - "id": 39998, + "id": 848, "name": "list", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/sales-channel.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/sales-channel.ts", "line": 75, "character": 8 } ], "parameters": [ { - "id": 39999, + "id": 849, "name": "query", "variant": "param", "kind": 32768, @@ -42623,7 +42639,7 @@ } }, { - "id": 40000, + "id": 850, "name": "headers", "variant": "param", "kind": 32768, @@ -42632,7 +42648,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -42662,35 +42678,35 @@ ] }, { - "id": 40001, + "id": 851, "name": "updateProducts", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/sales-channel.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/sales-channel.ts", "line": 89, "character": 8 } ], "signatures": [ { - "id": 40002, + "id": 852, "name": "updateProducts", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/sales-channel.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/sales-channel.ts", "line": 89, "character": 8 } ], "parameters": [ { - "id": 40003, + "id": 853, "name": "id", "variant": "param", "kind": 32768, @@ -42701,7 +42717,7 @@ } }, { - "id": 40004, + "id": 854, "name": "body", "variant": "param", "kind": 32768, @@ -42717,7 +42733,7 @@ } }, { - "id": 40005, + "id": 855, "name": "headers", "variant": "param", "kind": 32768, @@ -42726,7 +42742,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -42756,35 +42772,35 @@ ] }, { - "id": 40006, + "id": 856, "name": "batchProducts", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/sales-channel.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/sales-channel.ts", "line": 104, "character": 8 } ], "signatures": [ { - "id": 40007, + "id": 857, "name": "batchProducts", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/sales-channel.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/sales-channel.ts", "line": 104, "character": 8 } ], "parameters": [ { - "id": 40008, + "id": 858, "name": "id", "variant": "param", "kind": 32768, @@ -42795,7 +42811,7 @@ } }, { - "id": 40009, + "id": 859, "name": "body", "variant": "param", "kind": 32768, @@ -42811,7 +42827,7 @@ } }, { - "id": 40010, + "id": 860, "name": "headers", "variant": "param", "kind": 32768, @@ -42820,7 +42836,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -42854,45 +42870,45 @@ { "title": "Constructors", "children": [ - 39973 + 823 ] }, { "title": "Properties", "children": [ - 39976 + 826 ] }, { "title": "Methods", "children": [ - 39977, - 39982, - 39988, - 39992, - 39997, - 40001, - 40006 + 827, + 832, + 838, + 842, + 847, + 851, + 856 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/sales-channel.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/sales-channel.ts", "line": 5, "character": 13 } ] }, { - "id": 40078, + "id": 928, "name": "ShippingOption", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 40082, + "id": 932, "name": "client", "variant": "declaration", "kind": 1024, @@ -42907,34 +42923,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/shipping-option.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/shipping-option.ts", "line": 9, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 40079, + "id": 929, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/shipping-option.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/shipping-option.ts", "line": 13, "character": 2 } ], "signatures": [ { - "id": 40080, + "id": 930, "name": "ShippingOption", "variant": "signature", "kind": 16384, @@ -42947,21 +42963,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/shipping-option.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/shipping-option.ts", "line": 13, "character": 2 } ], "parameters": [ { - "id": 40081, + "id": 931, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -42969,7 +42985,7 @@ ], "type": { "type": "reference", - "target": 40078, + "target": 928, "name": "ShippingOption", "package": "@medusajs/js-sdk" } @@ -42977,35 +42993,35 @@ ] }, { - "id": 40083, + "id": 933, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/shipping-option.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/shipping-option.ts", "line": 17, "character": 8 } ], "signatures": [ { - "id": 40084, + "id": 934, "name": "create", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/shipping-option.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/shipping-option.ts", "line": 17, "character": 8 } ], "parameters": [ { - "id": 40085, + "id": 935, "name": "body", "variant": "param", "kind": 32768, @@ -43021,7 +43037,7 @@ } }, { - "id": 40086, + "id": 936, "name": "query", "variant": "param", "kind": 32768, @@ -43039,7 +43055,7 @@ } }, { - "id": 40087, + "id": 937, "name": "headers", "variant": "param", "kind": 32768, @@ -43048,7 +43064,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -43078,35 +43094,35 @@ ] }, { - "id": 40088, + "id": 938, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/shipping-option.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/shipping-option.ts", "line": 33, "character": 8 } ], "signatures": [ { - "id": 40089, + "id": 939, "name": "retrieve", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/shipping-option.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/shipping-option.ts", "line": 33, "character": 8 } ], "parameters": [ { - "id": 40090, + "id": 940, "name": "id", "variant": "param", "kind": 32768, @@ -43117,7 +43133,7 @@ } }, { - "id": 40091, + "id": 941, "name": "query", "variant": "param", "kind": 32768, @@ -43135,7 +43151,7 @@ } }, { - "id": 40092, + "id": 942, "name": "headers", "variant": "param", "kind": 32768, @@ -43144,7 +43160,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -43174,35 +43190,35 @@ ] }, { - "id": 40093, + "id": 943, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/shipping-option.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/shipping-option.ts", "line": 48, "character": 8 } ], "signatures": [ { - "id": 40094, + "id": 944, "name": "update", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/shipping-option.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/shipping-option.ts", "line": 48, "character": 8 } ], "parameters": [ { - "id": 40095, + "id": 945, "name": "id", "variant": "param", "kind": 32768, @@ -43213,7 +43229,7 @@ } }, { - "id": 40096, + "id": 946, "name": "body", "variant": "param", "kind": 32768, @@ -43229,7 +43245,7 @@ } }, { - "id": 40097, + "id": 947, "name": "query", "variant": "param", "kind": 32768, @@ -43247,7 +43263,7 @@ } }, { - "id": 40098, + "id": 948, "name": "headers", "variant": "param", "kind": 32768, @@ -43256,7 +43272,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -43286,35 +43302,35 @@ ] }, { - "id": 40099, + "id": 949, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/shipping-option.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/shipping-option.ts", "line": 65, "character": 8 } ], "signatures": [ { - "id": 40100, + "id": 950, "name": "delete", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/shipping-option.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/shipping-option.ts", "line": 65, "character": 8 } ], "parameters": [ { - "id": 40101, + "id": 951, "name": "id", "variant": "param", "kind": 32768, @@ -43325,7 +43341,7 @@ } }, { - "id": 40102, + "id": 952, "name": "headers", "variant": "param", "kind": 32768, @@ -43334,7 +43350,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -43364,35 +43380,35 @@ ] }, { - "id": 40103, + "id": 953, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/shipping-option.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/shipping-option.ts", "line": 75, "character": 8 } ], "signatures": [ { - "id": 40104, + "id": 954, "name": "list", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/shipping-option.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/shipping-option.ts", "line": 75, "character": 8 } ], "parameters": [ { - "id": 40105, + "id": 955, "name": "query", "variant": "param", "kind": 32768, @@ -43410,7 +43426,7 @@ } }, { - "id": 40106, + "id": 956, "name": "headers", "variant": "param", "kind": 32768, @@ -43419,7 +43435,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -43449,35 +43465,35 @@ ] }, { - "id": 40107, + "id": 957, "name": "updateRules", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/shipping-option.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/shipping-option.ts", "line": 89, "character": 8 } ], "signatures": [ { - "id": 40108, + "id": 958, "name": "updateRules", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/shipping-option.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/shipping-option.ts", "line": 89, "character": 8 } ], "parameters": [ { - "id": 40109, + "id": 959, "name": "id", "variant": "param", "kind": 32768, @@ -43488,7 +43504,7 @@ } }, { - "id": 40110, + "id": 960, "name": "body", "variant": "param", "kind": 32768, @@ -43504,7 +43520,7 @@ } }, { - "id": 40111, + "id": 961, "name": "headers", "variant": "param", "kind": 32768, @@ -43513,7 +43529,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -43547,44 +43563,44 @@ { "title": "Constructors", "children": [ - 40079 + 929 ] }, { "title": "Properties", "children": [ - 40082 + 932 ] }, { "title": "Methods", "children": [ - 40083, - 40088, - 40093, - 40099, - 40103, - 40107 + 933, + 938, + 943, + 949, + 953, + 957 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/shipping-option.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/shipping-option.ts", "line": 5, "character": 13 } ] }, { - "id": 40112, + "id": 962, "name": "ShippingProfile", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 40116, + "id": 966, "name": "client", "variant": "declaration", "kind": 1024, @@ -43599,34 +43615,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/shipping-profile.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/shipping-profile.ts", "line": 9, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 40113, + "id": 963, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/shipping-profile.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/shipping-profile.ts", "line": 13, "character": 2 } ], "signatures": [ { - "id": 40114, + "id": 964, "name": "ShippingProfile", "variant": "signature", "kind": 16384, @@ -43639,21 +43655,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/shipping-profile.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/shipping-profile.ts", "line": 13, "character": 2 } ], "parameters": [ { - "id": 40115, + "id": 965, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -43661,7 +43677,7 @@ ], "type": { "type": "reference", - "target": 40112, + "target": 962, "name": "ShippingProfile", "package": "@medusajs/js-sdk" } @@ -43669,35 +43685,35 @@ ] }, { - "id": 40117, + "id": 967, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/shipping-profile.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/shipping-profile.ts", "line": 17, "character": 8 } ], "signatures": [ { - "id": 40118, + "id": 968, "name": "create", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/shipping-profile.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/shipping-profile.ts", "line": 17, "character": 8 } ], "parameters": [ { - "id": 40119, + "id": 969, "name": "body", "variant": "param", "kind": 32768, @@ -43713,7 +43729,7 @@ } }, { - "id": 40120, + "id": 970, "name": "query", "variant": "param", "kind": 32768, @@ -43731,7 +43747,7 @@ } }, { - "id": 40121, + "id": 971, "name": "headers", "variant": "param", "kind": 32768, @@ -43740,7 +43756,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -43770,35 +43786,35 @@ ] }, { - "id": 40122, + "id": 972, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/shipping-profile.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/shipping-profile.ts", "line": 33, "character": 8 } ], "signatures": [ { - "id": 40123, + "id": 973, "name": "update", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/shipping-profile.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/shipping-profile.ts", "line": 33, "character": 8 } ], "parameters": [ { - "id": 40124, + "id": 974, "name": "id", "variant": "param", "kind": 32768, @@ -43809,7 +43825,7 @@ } }, { - "id": 40125, + "id": 975, "name": "body", "variant": "param", "kind": 32768, @@ -43825,7 +43841,7 @@ } }, { - "id": 40126, + "id": 976, "name": "query", "variant": "param", "kind": 32768, @@ -43843,7 +43859,7 @@ } }, { - "id": 40127, + "id": 977, "name": "headers", "variant": "param", "kind": 32768, @@ -43852,7 +43868,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -43882,35 +43898,35 @@ ] }, { - "id": 40128, + "id": 978, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/shipping-profile.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/shipping-profile.ts", "line": 50, "character": 8 } ], "signatures": [ { - "id": 40129, + "id": 979, "name": "delete", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/shipping-profile.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/shipping-profile.ts", "line": 50, "character": 8 } ], "parameters": [ { - "id": 40130, + "id": 980, "name": "id", "variant": "param", "kind": 32768, @@ -43921,7 +43937,7 @@ } }, { - "id": 40131, + "id": 981, "name": "headers", "variant": "param", "kind": 32768, @@ -43930,7 +43946,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -43960,35 +43976,35 @@ ] }, { - "id": 40132, + "id": 982, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/shipping-profile.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/shipping-profile.ts", "line": 60, "character": 8 } ], "signatures": [ { - "id": 40133, + "id": 983, "name": "list", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/shipping-profile.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/shipping-profile.ts", "line": 60, "character": 8 } ], "parameters": [ { - "id": 40134, + "id": 984, "name": "query", "variant": "param", "kind": 32768, @@ -44006,7 +44022,7 @@ } }, { - "id": 40135, + "id": 985, "name": "headers", "variant": "param", "kind": 32768, @@ -44015,7 +44031,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -44045,35 +44061,35 @@ ] }, { - "id": 40136, + "id": 986, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/shipping-profile.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/shipping-profile.ts", "line": 74, "character": 8 } ], "signatures": [ { - "id": 40137, + "id": 987, "name": "retrieve", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/shipping-profile.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/shipping-profile.ts", "line": 74, "character": 8 } ], "parameters": [ { - "id": 40138, + "id": 988, "name": "id", "variant": "param", "kind": 32768, @@ -44084,7 +44100,7 @@ } }, { - "id": 40139, + "id": 989, "name": "query", "variant": "param", "kind": 32768, @@ -44102,7 +44118,7 @@ } }, { - "id": 40140, + "id": 990, "name": "headers", "variant": "param", "kind": 32768, @@ -44111,7 +44127,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -44145,43 +44161,43 @@ { "title": "Constructors", "children": [ - 40113 + 963 ] }, { "title": "Properties", "children": [ - 40116 + 966 ] }, { "title": "Methods", "children": [ - 40117, - 40122, - 40128, - 40132, - 40136 + 967, + 972, + 978, + 982, + 986 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/shipping-profile.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/shipping-profile.ts", "line": 5, "character": 13 } ] }, { - "id": 39928, + "id": 778, "name": "StockLocation", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 39932, + "id": 782, "name": "client", "variant": "declaration", "kind": 1024, @@ -44196,34 +44212,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/stock-location.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/stock-location.ts", "line": 9, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 39929, + "id": 779, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/stock-location.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/stock-location.ts", "line": 13, "character": 2 } ], "signatures": [ { - "id": 39930, + "id": 780, "name": "StockLocation", "variant": "signature", "kind": 16384, @@ -44236,21 +44252,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/stock-location.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/stock-location.ts", "line": 13, "character": 2 } ], "parameters": [ { - "id": 39931, + "id": 781, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -44258,7 +44274,7 @@ ], "type": { "type": "reference", - "target": 39928, + "target": 778, "name": "StockLocation", "package": "@medusajs/js-sdk" } @@ -44266,35 +44282,35 @@ ] }, { - "id": 39933, + "id": 783, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/stock-location.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/stock-location.ts", "line": 17, "character": 8 } ], "signatures": [ { - "id": 39934, + "id": 784, "name": "create", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/stock-location.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/stock-location.ts", "line": 17, "character": 8 } ], "parameters": [ { - "id": 39935, + "id": 785, "name": "body", "variant": "param", "kind": 32768, @@ -44310,7 +44326,7 @@ } }, { - "id": 39936, + "id": 786, "name": "query", "variant": "param", "kind": 32768, @@ -44328,7 +44344,7 @@ } }, { - "id": 39937, + "id": 787, "name": "headers", "variant": "param", "kind": 32768, @@ -44337,7 +44353,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -44367,35 +44383,35 @@ ] }, { - "id": 39938, + "id": 788, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/stock-location.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/stock-location.ts", "line": 33, "character": 8 } ], "signatures": [ { - "id": 39939, + "id": 789, "name": "update", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/stock-location.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/stock-location.ts", "line": 33, "character": 8 } ], "parameters": [ { - "id": 39940, + "id": 790, "name": "id", "variant": "param", "kind": 32768, @@ -44406,7 +44422,7 @@ } }, { - "id": 39941, + "id": 791, "name": "body", "variant": "param", "kind": 32768, @@ -44422,7 +44438,7 @@ } }, { - "id": 39942, + "id": 792, "name": "query", "variant": "param", "kind": 32768, @@ -44440,7 +44456,7 @@ } }, { - "id": 39943, + "id": 793, "name": "headers", "variant": "param", "kind": 32768, @@ -44449,7 +44465,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -44479,35 +44495,35 @@ ] }, { - "id": 39944, + "id": 794, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/stock-location.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/stock-location.ts", "line": 50, "character": 8 } ], "signatures": [ { - "id": 39945, + "id": 795, "name": "delete", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/stock-location.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/stock-location.ts", "line": 50, "character": 8 } ], "parameters": [ { - "id": 39946, + "id": 796, "name": "id", "variant": "param", "kind": 32768, @@ -44518,7 +44534,7 @@ } }, { - "id": 39947, + "id": 797, "name": "headers", "variant": "param", "kind": 32768, @@ -44527,7 +44543,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -44557,35 +44573,35 @@ ] }, { - "id": 39948, + "id": 798, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/stock-location.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/stock-location.ts", "line": 60, "character": 8 } ], "signatures": [ { - "id": 39949, + "id": 799, "name": "retrieve", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/stock-location.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/stock-location.ts", "line": 60, "character": 8 } ], "parameters": [ { - "id": 39950, + "id": 800, "name": "id", "variant": "param", "kind": 32768, @@ -44596,7 +44612,7 @@ } }, { - "id": 39951, + "id": 801, "name": "query", "variant": "param", "kind": 32768, @@ -44614,7 +44630,7 @@ } }, { - "id": 39952, + "id": 802, "name": "headers", "variant": "param", "kind": 32768, @@ -44623,7 +44639,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -44653,35 +44669,35 @@ ] }, { - "id": 39953, + "id": 803, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/stock-location.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/stock-location.ts", "line": 71, "character": 8 } ], "signatures": [ { - "id": 39954, + "id": 804, "name": "list", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/stock-location.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/stock-location.ts", "line": 71, "character": 8 } ], "parameters": [ { - "id": 39955, + "id": 805, "name": "query", "variant": "param", "kind": 32768, @@ -44699,7 +44715,7 @@ } }, { - "id": 39956, + "id": 806, "name": "headers", "variant": "param", "kind": 32768, @@ -44708,7 +44724,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -44738,35 +44754,35 @@ ] }, { - "id": 39957, + "id": 807, "name": "updateSalesChannels", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/stock-location.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/stock-location.ts", "line": 85, "character": 8 } ], "signatures": [ { - "id": 39958, + "id": 808, "name": "updateSalesChannels", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/stock-location.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/stock-location.ts", "line": 85, "character": 8 } ], "parameters": [ { - "id": 39959, + "id": 809, "name": "id", "variant": "param", "kind": 32768, @@ -44777,7 +44793,7 @@ } }, { - "id": 39960, + "id": 810, "name": "body", "variant": "param", "kind": 32768, @@ -44793,7 +44809,7 @@ } }, { - "id": 39961, + "id": 811, "name": "headers", "variant": "param", "kind": 32768, @@ -44802,7 +44818,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -44832,35 +44848,35 @@ ] }, { - "id": 39962, + "id": 812, "name": "createFulfillmentSet", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/stock-location.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/stock-location.ts", "line": 100, "character": 8 } ], "signatures": [ { - "id": 39963, + "id": 813, "name": "createFulfillmentSet", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/stock-location.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/stock-location.ts", "line": 100, "character": 8 } ], "parameters": [ { - "id": 39964, + "id": 814, "name": "id", "variant": "param", "kind": 32768, @@ -44871,7 +44887,7 @@ } }, { - "id": 39965, + "id": 815, "name": "body", "variant": "param", "kind": 32768, @@ -44887,7 +44903,7 @@ } }, { - "id": 39966, + "id": 816, "name": "headers", "variant": "param", "kind": 32768, @@ -44896,7 +44912,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -44926,35 +44942,35 @@ ] }, { - "id": 39967, + "id": 817, "name": "updateFulfillmentProviders", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/stock-location.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/stock-location.ts", "line": 115, "character": 8 } ], "signatures": [ { - "id": 39968, + "id": 818, "name": "updateFulfillmentProviders", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/stock-location.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/stock-location.ts", "line": 115, "character": 8 } ], "parameters": [ { - "id": 39969, + "id": 819, "name": "id", "variant": "param", "kind": 32768, @@ -44965,7 +44981,7 @@ } }, { - "id": 39970, + "id": 820, "name": "body", "variant": "param", "kind": 32768, @@ -44981,7 +44997,7 @@ } }, { - "id": 39971, + "id": 821, "name": "headers", "variant": "param", "kind": 32768, @@ -44990,7 +45006,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -45024,46 +45040,46 @@ { "title": "Constructors", "children": [ - 39929 + 779 ] }, { "title": "Properties", "children": [ - 39932 + 782 ] }, { "title": "Methods", "children": [ - 39933, - 39938, - 39944, - 39948, - 39953, - 39957, - 39962, - 39967 + 783, + 788, + 794, + 798, + 803, + 807, + 812, + 817 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/stock-location.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/stock-location.ts", "line": 5, "character": 13 } ] }, { - "id": 40791, + "id": 1641, "name": "Store", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 40795, + "id": 1645, "name": "client", "variant": "declaration", "kind": 1024, @@ -45078,34 +45094,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/store.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/store.ts", "line": 9, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 40792, + "id": 1642, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/store.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/store.ts", "line": 13, "character": 2 } ], "signatures": [ { - "id": 40793, + "id": 1643, "name": "Store", "variant": "signature", "kind": 16384, @@ -45118,21 +45134,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/store.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/store.ts", "line": 13, "character": 2 } ], "parameters": [ { - "id": 40794, + "id": 1644, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -45140,7 +45156,7 @@ ], "type": { "type": "reference", - "target": 40791, + "target": 1641, "name": "Store", "package": "@medusajs/js-sdk" } @@ -45148,35 +45164,35 @@ ] }, { - "id": 40796, + "id": 1646, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/store.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/store.ts", "line": 17, "character": 8 } ], "signatures": [ { - "id": 40797, + "id": 1647, "name": "retrieve", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/store.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/store.ts", "line": 17, "character": 8 } ], "parameters": [ { - "id": 40798, + "id": 1648, "name": "id", "variant": "param", "kind": 32768, @@ -45187,7 +45203,7 @@ } }, { - "id": 40799, + "id": 1649, "name": "query", "variant": "param", "kind": 32768, @@ -45205,7 +45221,7 @@ } }, { - "id": 40800, + "id": 1650, "name": "headers", "variant": "param", "kind": 32768, @@ -45214,7 +45230,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -45244,35 +45260,35 @@ ] }, { - "id": 40801, + "id": 1651, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/store.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/store.ts", "line": 32, "character": 8 } ], "signatures": [ { - "id": 40802, + "id": 1652, "name": "list", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/store.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/store.ts", "line": 32, "character": 8 } ], "parameters": [ { - "id": 40803, + "id": 1653, "name": "query", "variant": "param", "kind": 32768, @@ -45290,7 +45306,7 @@ } }, { - "id": 40804, + "id": 1654, "name": "headers", "variant": "param", "kind": 32768, @@ -45299,7 +45315,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -45329,35 +45345,35 @@ ] }, { - "id": 40805, + "id": 1655, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/store.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/store.ts", "line": 43, "character": 8 } ], "signatures": [ { - "id": 40806, + "id": 1656, "name": "update", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/store.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/store.ts", "line": 43, "character": 8 } ], "parameters": [ { - "id": 40807, + "id": 1657, "name": "id", "variant": "param", "kind": 32768, @@ -45368,7 +45384,7 @@ } }, { - "id": 40808, + "id": 1658, "name": "body", "variant": "param", "kind": 32768, @@ -45384,7 +45400,7 @@ } }, { - "id": 40809, + "id": 1659, "name": "query", "variant": "param", "kind": 32768, @@ -45402,7 +45418,7 @@ } }, { - "id": 40810, + "id": 1660, "name": "headers", "variant": "param", "kind": 32768, @@ -45411,7 +45427,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -45445,41 +45461,41 @@ { "title": "Constructors", "children": [ - 40792 + 1642 ] }, { "title": "Properties", "children": [ - 40795 + 1645 ] }, { "title": "Methods", "children": [ - 40796, - 40801, - 40805 + 1646, + 1651, + 1655 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/store.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/store.ts", "line": 5, "character": 13 } ] }, { - "id": 40739, + "id": 1589, "name": "TaxRate", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 40743, + "id": 1593, "name": "client", "variant": "declaration", "kind": 1024, @@ -45494,34 +45510,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/tax-rate.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/tax-rate.ts", "line": 11, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 40740, + "id": 1590, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/tax-rate.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/tax-rate.ts", "line": 15, "character": 2 } ], "signatures": [ { - "id": 40741, + "id": 1591, "name": "TaxRate", "variant": "signature", "kind": 16384, @@ -45534,21 +45550,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/tax-rate.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/tax-rate.ts", "line": 15, "character": 2 } ], "parameters": [ { - "id": 40742, + "id": 1592, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -45556,7 +45572,7 @@ ], "type": { "type": "reference", - "target": 40739, + "target": 1589, "name": "TaxRate", "package": "@medusajs/js-sdk" } @@ -45564,35 +45580,35 @@ ] }, { - "id": 40744, + "id": 1594, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/tax-rate.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/tax-rate.ts", "line": 19, "character": 8 } ], "signatures": [ { - "id": 40745, + "id": 1595, "name": "create", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/tax-rate.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/tax-rate.ts", "line": 19, "character": 8 } ], "parameters": [ { - "id": 40746, + "id": 1596, "name": "body", "variant": "param", "kind": 32768, @@ -45608,7 +45624,7 @@ } }, { - "id": 40747, + "id": 1597, "name": "query", "variant": "param", "kind": 32768, @@ -45626,7 +45642,7 @@ } }, { - "id": 40748, + "id": 1598, "name": "headers", "variant": "param", "kind": 32768, @@ -45635,7 +45651,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -45665,35 +45681,35 @@ ] }, { - "id": 40749, + "id": 1599, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/tax-rate.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/tax-rate.ts", "line": 32, "character": 8 } ], "signatures": [ { - "id": 40750, + "id": 1600, "name": "update", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/tax-rate.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/tax-rate.ts", "line": 32, "character": 8 } ], "parameters": [ { - "id": 40751, + "id": 1601, "name": "id", "variant": "param", "kind": 32768, @@ -45704,7 +45720,7 @@ } }, { - "id": 40752, + "id": 1602, "name": "body", "variant": "param", "kind": 32768, @@ -45720,7 +45736,7 @@ } }, { - "id": 40753, + "id": 1603, "name": "query", "variant": "param", "kind": 32768, @@ -45738,7 +45754,7 @@ } }, { - "id": 40754, + "id": 1604, "name": "headers", "variant": "param", "kind": 32768, @@ -45747,7 +45763,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -45777,35 +45793,35 @@ ] }, { - "id": 40755, + "id": 1605, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/tax-rate.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/tax-rate.ts", "line": 49, "character": 8 } ], "signatures": [ { - "id": 40756, + "id": 1606, "name": "delete", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/tax-rate.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/tax-rate.ts", "line": 49, "character": 8 } ], "parameters": [ { - "id": 40757, + "id": 1607, "name": "id", "variant": "param", "kind": 32768, @@ -45816,7 +45832,7 @@ } }, { - "id": 40758, + "id": 1608, "name": "headers", "variant": "param", "kind": 32768, @@ -45825,7 +45841,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -45855,35 +45871,35 @@ ] }, { - "id": 40759, + "id": 1609, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/tax-rate.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/tax-rate.ts", "line": 59, "character": 8 } ], "signatures": [ { - "id": 40760, + "id": 1610, "name": "retrieve", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/tax-rate.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/tax-rate.ts", "line": 59, "character": 8 } ], "parameters": [ { - "id": 40761, + "id": 1611, "name": "id", "variant": "param", "kind": 32768, @@ -45894,7 +45910,7 @@ } }, { - "id": 40762, + "id": 1612, "name": "query", "variant": "param", "kind": 32768, @@ -45912,7 +45928,7 @@ } }, { - "id": 40763, + "id": 1613, "name": "headers", "variant": "param", "kind": 32768, @@ -45921,7 +45937,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -45951,35 +45967,35 @@ ] }, { - "id": 40764, + "id": 1614, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/tax-rate.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/tax-rate.ts", "line": 74, "character": 8 } ], "signatures": [ { - "id": 40765, + "id": 1615, "name": "list", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/tax-rate.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/tax-rate.ts", "line": 74, "character": 8 } ], "parameters": [ { - "id": 40766, + "id": 1616, "name": "query", "variant": "param", "kind": 32768, @@ -45997,7 +46013,7 @@ } }, { - "id": 40767, + "id": 1617, "name": "headers", "variant": "param", "kind": 32768, @@ -46006,7 +46022,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -46040,43 +46056,43 @@ { "title": "Constructors", "children": [ - 40740 + 1590 ] }, { "title": "Properties", "children": [ - 40743 + 1593 ] }, { "title": "Methods", "children": [ - 40744, - 40749, - 40755, - 40759, - 40764 + 1594, + 1599, + 1605, + 1609, + 1614 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/tax-rate.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/tax-rate.ts", "line": 7, "character": 13 } ] }, { - "id": 40768, + "id": 1618, "name": "TaxRegion", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 40772, + "id": 1622, "name": "client", "variant": "declaration", "kind": 1024, @@ -46091,34 +46107,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/tax-region.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/tax-region.ts", "line": 12, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 40769, + "id": 1619, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/tax-region.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/tax-region.ts", "line": 16, "character": 2 } ], "signatures": [ { - "id": 40770, + "id": 1620, "name": "TaxRegion", "variant": "signature", "kind": 16384, @@ -46131,21 +46147,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/tax-region.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/tax-region.ts", "line": 16, "character": 2 } ], "parameters": [ { - "id": 40771, + "id": 1621, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -46153,7 +46169,7 @@ ], "type": { "type": "reference", - "target": 40768, + "target": 1618, "name": "TaxRegion", "package": "@medusajs/js-sdk" } @@ -46161,35 +46177,35 @@ ] }, { - "id": 40773, + "id": 1623, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/tax-region.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/tax-region.ts", "line": 20, "character": 8 } ], "signatures": [ { - "id": 40774, + "id": 1624, "name": "create", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/tax-region.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/tax-region.ts", "line": 20, "character": 8 } ], "parameters": [ { - "id": 40775, + "id": 1625, "name": "body", "variant": "param", "kind": 32768, @@ -46205,7 +46221,7 @@ } }, { - "id": 40776, + "id": 1626, "name": "query", "variant": "param", "kind": 32768, @@ -46223,7 +46239,7 @@ } }, { - "id": 40777, + "id": 1627, "name": "headers", "variant": "param", "kind": 32768, @@ -46232,7 +46248,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -46262,35 +46278,35 @@ ] }, { - "id": 40778, + "id": 1628, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/tax-region.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/tax-region.ts", "line": 36, "character": 8 } ], "signatures": [ { - "id": 40779, + "id": 1629, "name": "delete", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/tax-region.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/tax-region.ts", "line": 36, "character": 8 } ], "parameters": [ { - "id": 40780, + "id": 1630, "name": "id", "variant": "param", "kind": 32768, @@ -46301,7 +46317,7 @@ } }, { - "id": 40781, + "id": 1631, "name": "headers", "variant": "param", "kind": 32768, @@ -46310,7 +46326,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -46340,35 +46356,35 @@ ] }, { - "id": 40782, + "id": 1632, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/tax-region.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/tax-region.ts", "line": 46, "character": 8 } ], "signatures": [ { - "id": 40783, + "id": 1633, "name": "retrieve", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/tax-region.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/tax-region.ts", "line": 46, "character": 8 } ], "parameters": [ { - "id": 40784, + "id": 1634, "name": "id", "variant": "param", "kind": 32768, @@ -46379,7 +46395,7 @@ } }, { - "id": 40785, + "id": 1635, "name": "query", "variant": "param", "kind": 32768, @@ -46397,7 +46413,7 @@ } }, { - "id": 40786, + "id": 1636, "name": "headers", "variant": "param", "kind": 32768, @@ -46406,7 +46422,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -46436,35 +46452,35 @@ ] }, { - "id": 40787, + "id": 1637, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/tax-region.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/tax-region.ts", "line": 61, "character": 8 } ], "signatures": [ { - "id": 40788, + "id": 1638, "name": "list", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/tax-region.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/tax-region.ts", "line": 61, "character": 8 } ], "parameters": [ { - "id": 40789, + "id": 1639, "name": "query", "variant": "param", "kind": 32768, @@ -46482,7 +46498,7 @@ } }, { - "id": 40790, + "id": 1640, "name": "headers", "variant": "param", "kind": 32768, @@ -46491,7 +46507,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -46525,42 +46541,42 @@ { "title": "Constructors", "children": [ - 40769 + 1619 ] }, { "title": "Properties", "children": [ - 40772 + 1622 ] }, { "title": "Methods", "children": [ - 40773, - 40778, - 40782, - 40787 + 1623, + 1628, + 1632, + 1637 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/tax-region.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/tax-region.ts", "line": 8, "character": 13 } ] }, { - "id": 39838, + "id": 688, "name": "Upload", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 39842, + "id": 692, "name": "client", "variant": "declaration", "kind": 1024, @@ -46575,34 +46591,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/upload.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/upload.ts", "line": 9, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 39839, + "id": 689, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/upload.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/upload.ts", "line": 13, "character": 2 } ], "signatures": [ { - "id": 39840, + "id": 690, "name": "Upload", "variant": "signature", "kind": 16384, @@ -46615,21 +46631,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/upload.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/upload.ts", "line": 13, "character": 2 } ], "parameters": [ { - "id": 39841, + "id": 691, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -46637,7 +46653,7 @@ ], "type": { "type": "reference", - "target": 39838, + "target": 688, "name": "Upload", "package": "@medusajs/js-sdk" } @@ -46645,35 +46661,35 @@ ] }, { - "id": 39843, + "id": 693, "name": "create", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/upload.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/upload.ts", "line": 18, "character": 8 } ], "signatures": [ { - "id": 39844, + "id": 694, "name": "create", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/upload.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/upload.ts", "line": 18, "character": 8 } ], "parameters": [ { - "id": 39845, + "id": 695, "name": "body", "variant": "param", "kind": 32768, @@ -46689,7 +46705,7 @@ } }, { - "id": 39846, + "id": 696, "name": "query", "variant": "param", "kind": 32768, @@ -46707,7 +46723,7 @@ } }, { - "id": 39847, + "id": 697, "name": "headers", "variant": "param", "kind": 32768, @@ -46716,7 +46732,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -46732,21 +46748,21 @@ { "type": "reflection", "declaration": { - "id": 39848, + "id": 698, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 39849, + "id": 699, "name": "files", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/upload.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/upload.ts", "line": 42, "character": 31 } @@ -46769,13 +46785,13 @@ { "title": "Properties", "children": [ - 39849 + 699 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/upload.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/upload.ts", "line": 42, "character": 29 } @@ -46790,35 +46806,35 @@ ] }, { - "id": 39850, + "id": 700, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/upload.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/upload.ts", "line": 57, "character": 8 } ], "signatures": [ { - "id": 39851, + "id": 701, "name": "retrieve", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/upload.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/upload.ts", "line": 57, "character": 8 } ], "parameters": [ { - "id": 39852, + "id": 702, "name": "id", "variant": "param", "kind": 32768, @@ -46829,7 +46845,7 @@ } }, { - "id": 39853, + "id": 703, "name": "query", "variant": "param", "kind": 32768, @@ -46847,7 +46863,7 @@ } }, { - "id": 39854, + "id": 704, "name": "headers", "variant": "param", "kind": 32768, @@ -46856,7 +46872,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -46872,21 +46888,21 @@ { "type": "reflection", "declaration": { - "id": 39855, + "id": 705, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 39856, + "id": 706, "name": "file", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/upload.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/upload.ts", "line": 58, "character": 31 } @@ -46906,13 +46922,13 @@ { "title": "Properties", "children": [ - 39856 + 706 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/upload.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/upload.ts", "line": 58, "character": 29 } @@ -46927,35 +46943,35 @@ ] }, { - "id": 39857, + "id": 707, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/upload.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/upload.ts", "line": 67, "character": 8 } ], "signatures": [ { - "id": 39858, + "id": 708, "name": "delete", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/upload.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/upload.ts", "line": 67, "character": 8 } ], "parameters": [ { - "id": 39859, + "id": 709, "name": "id", "variant": "param", "kind": 32768, @@ -46966,7 +46982,7 @@ } }, { - "id": 39860, + "id": 710, "name": "headers", "variant": "param", "kind": 32768, @@ -46975,7 +46991,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -47009,41 +47025,41 @@ { "title": "Constructors", "children": [ - 39839 + 689 ] }, { "title": "Properties", "children": [ - 39842 + 692 ] }, { "title": "Methods", "children": [ - 39843, - 39850, - 39857 + 693, + 700, + 707 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/upload.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/upload.ts", "line": 5, "character": 13 } ] }, { - "id": 40840, + "id": 1690, "name": "User", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 40844, + "id": 1694, "name": "client", "variant": "declaration", "kind": 1024, @@ -47058,34 +47074,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/user.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/user.ts", "line": 9, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 40841, + "id": 1691, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/user.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/user.ts", "line": 13, "character": 2 } ], "signatures": [ { - "id": 40842, + "id": 1692, "name": "User", "variant": "signature", "kind": 16384, @@ -47098,21 +47114,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/user.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/user.ts", "line": 13, "character": 2 } ], "parameters": [ { - "id": 40843, + "id": 1693, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -47120,7 +47136,7 @@ ], "type": { "type": "reference", - "target": 40840, + "target": 1690, "name": "User", "package": "@medusajs/js-sdk" } @@ -47128,35 +47144,35 @@ ] }, { - "id": 40845, + "id": 1695, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/user.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/user.ts", "line": 17, "character": 8 } ], "signatures": [ { - "id": 40846, + "id": 1696, "name": "update", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/user.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/user.ts", "line": 17, "character": 8 } ], "parameters": [ { - "id": 40847, + "id": 1697, "name": "id", "variant": "param", "kind": 32768, @@ -47167,7 +47183,7 @@ } }, { - "id": 40848, + "id": 1698, "name": "body", "variant": "param", "kind": 32768, @@ -47183,7 +47199,7 @@ } }, { - "id": 40849, + "id": 1699, "name": "query", "variant": "param", "kind": 32768, @@ -47201,7 +47217,7 @@ } }, { - "id": 40850, + "id": 1700, "name": "headers", "variant": "param", "kind": 32768, @@ -47210,7 +47226,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -47240,35 +47256,35 @@ ] }, { - "id": 40851, + "id": 1701, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/user.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/user.ts", "line": 34, "character": 8 } ], "signatures": [ { - "id": 40852, + "id": 1702, "name": "list", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/user.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/user.ts", "line": 34, "character": 8 } ], "parameters": [ { - "id": 40853, + "id": 1703, "name": "queryParams", "variant": "param", "kind": 32768, @@ -47286,7 +47302,7 @@ } }, { - "id": 40854, + "id": 1704, "name": "headers", "variant": "param", "kind": 32768, @@ -47295,7 +47311,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -47325,35 +47341,35 @@ ] }, { - "id": 40855, + "id": 1705, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/user.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/user.ts", "line": 44, "character": 8 } ], "signatures": [ { - "id": 40856, + "id": 1706, "name": "retrieve", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/user.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/user.ts", "line": 44, "character": 8 } ], "parameters": [ { - "id": 40857, + "id": 1707, "name": "id", "variant": "param", "kind": 32768, @@ -47364,7 +47380,7 @@ } }, { - "id": 40858, + "id": 1708, "name": "query", "variant": "param", "kind": 32768, @@ -47382,7 +47398,7 @@ } }, { - "id": 40859, + "id": 1709, "name": "headers", "variant": "param", "kind": 32768, @@ -47391,7 +47407,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -47421,35 +47437,35 @@ ] }, { - "id": 40860, + "id": 1710, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/user.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/user.ts", "line": 58, "character": 8 } ], "signatures": [ { - "id": 40861, + "id": 1711, "name": "delete", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/user.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/user.ts", "line": 58, "character": 8 } ], "parameters": [ { - "id": 40862, + "id": 1712, "name": "id", "variant": "param", "kind": 32768, @@ -47460,7 +47476,7 @@ } }, { - "id": 40863, + "id": 1713, "name": "headers", "variant": "param", "kind": 32768, @@ -47469,7 +47485,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -47499,35 +47515,35 @@ ] }, { - "id": 40864, + "id": 1714, "name": "me", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/user.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/user.ts", "line": 68, "character": 8 } ], "signatures": [ { - "id": 40865, + "id": 1715, "name": "me", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/user.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/user.ts", "line": 68, "character": 8 } ], "parameters": [ { - "id": 40866, + "id": 1716, "name": "query", "variant": "param", "kind": 32768, @@ -47545,7 +47561,7 @@ } }, { - "id": 40867, + "id": 1717, "name": "headers", "variant": "param", "kind": 32768, @@ -47554,7 +47570,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -47588,43 +47604,43 @@ { "title": "Constructors", "children": [ - 40841 + 1691 ] }, { "title": "Properties", "children": [ - 40844 + 1694 ] }, { "title": "Methods", "children": [ - 40845, - 40851, - 40855, - 40860, - 40864 + 1695, + 1701, + 1705, + 1710, + 1714 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/user.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/user.ts", "line": 5, "character": 13 } ] }, { - "id": 40987, + "id": 1837, "name": "WorkflowExecution", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 40991, + "id": 1841, "name": "client", "variant": "declaration", "kind": 1024, @@ -47639,34 +47655,34 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/workflow-execution.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/workflow-execution.ts", "line": 9, "character": 10 } ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 40988, + "id": 1838, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/workflow-execution.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/workflow-execution.ts", "line": 13, "character": 2 } ], "signatures": [ { - "id": 40989, + "id": 1839, "name": "WorkflowExecution", "variant": "signature", "kind": 16384, @@ -47679,21 +47695,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/workflow-execution.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/workflow-execution.ts", "line": 13, "character": 2 } ], "parameters": [ { - "id": 40990, + "id": 1840, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -47701,7 +47717,7 @@ ], "type": { "type": "reference", - "target": 40987, + "target": 1837, "name": "WorkflowExecution", "package": "@medusajs/js-sdk" } @@ -47709,35 +47725,35 @@ ] }, { - "id": 40992, + "id": 1842, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/workflow-execution.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/workflow-execution.ts", "line": 17, "character": 8 } ], "signatures": [ { - "id": 40993, + "id": 1843, "name": "list", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/workflow-execution.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/workflow-execution.ts", "line": 17, "character": 8 } ], "parameters": [ { - "id": 40994, + "id": 1844, "name": "queryParams", "variant": "param", "kind": 32768, @@ -47755,7 +47771,7 @@ } }, { - "id": 40995, + "id": 1845, "name": "headers", "variant": "param", "kind": 32768, @@ -47764,7 +47780,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -47794,35 +47810,35 @@ ] }, { - "id": 40996, + "id": 1846, "name": "retrieve", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/workflow-execution.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/workflow-execution.ts", "line": 30, "character": 8 } ], "signatures": [ { - "id": 40997, + "id": 1847, "name": "retrieve", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/workflow-execution.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/workflow-execution.ts", "line": 30, "character": 8 } ], "parameters": [ { - "id": 40998, + "id": 1848, "name": "id", "variant": "param", "kind": 32768, @@ -47833,7 +47849,7 @@ } }, { - "id": 40999, + "id": 1849, "name": "headers", "variant": "param", "kind": 32768, @@ -47842,7 +47858,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -47876,40 +47892,40 @@ { "title": "Constructors", "children": [ - 40988 + 1838 ] }, { "title": "Properties", "children": [ - 40991 + 1841 ] }, { "title": "Methods", "children": [ - 40992, - 40996 + 1842, + 1846 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/admin/workflow-execution.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/admin/workflow-execution.ts", "line": 5, "character": 13 } ] }, { - "id": 41157, + "id": 2007, "name": "Client", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 41161, + "id": 2011, "name": "fetch_", "variant": "declaration", "kind": 1024, @@ -47918,20 +47934,20 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 108, "character": 9 } ], "type": { "type": "reference", - "target": 41230, + "target": 2080, "name": "ClientFetch", "package": "@medusajs/js-sdk" } }, { - "id": 41162, + "id": 2012, "name": "config", "variant": "declaration", "kind": 1024, @@ -47940,20 +47956,20 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 109, "character": 10 } ], "type": { "type": "reference", - "target": 41215, + "target": 2065, "name": "Config", "package": "@medusajs/js-sdk" } }, { - "id": 41163, + "id": 2013, "name": "logger", "variant": "declaration", "kind": 1024, @@ -47962,20 +47978,20 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 110, "character": 10 } ], "type": { "type": "reference", - "target": 41235, + "target": 2085, "name": "Logger", "package": "@medusajs/js-sdk" } }, { - "id": 41164, + "id": 2014, "name": "DEFAULT_JWT_STORAGE_KEY", "variant": "declaration", "kind": 1024, @@ -47984,7 +48000,7 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 112, "character": 10 } @@ -47996,7 +48012,7 @@ "defaultValue": "\"medusa_auth_token\"" }, { - "id": 41165, + "id": 2015, "name": "token", "variant": "declaration", "kind": 1024, @@ -48005,7 +48021,7 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 113, "character": 10 } @@ -48017,42 +48033,42 @@ "defaultValue": "\"\"" }, { - "id": 41158, + "id": 2008, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 115, "character": 2 } ], "signatures": [ { - "id": 41159, + "id": 2009, "name": "Client", "variant": "signature", "kind": 16384, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 115, "character": 2 } ], "parameters": [ { - "id": 41160, + "id": 2010, "name": "config", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41215, + "target": 2065, "name": "Config", "package": "@medusajs/js-sdk" } @@ -48060,7 +48076,7 @@ ], "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } @@ -48068,21 +48084,21 @@ ] }, { - "id": 41166, + "id": 2016, "name": "fetch", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 144, "character": 2 } ], "signatures": [ { - "id": 41167, + "id": 2017, "name": "fetch", "variant": "signature", "kind": 4096, @@ -48176,14 +48192,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 144, "character": 2 } ], "typeParameters": [ { - "id": 41168, + "id": 2018, "name": "T", "variant": "typeParam", "kind": 131072, @@ -48196,7 +48212,7 @@ ], "parameters": [ { - "id": 41169, + "id": 2019, "name": "input", "variant": "param", "kind": 32768, @@ -48230,7 +48246,7 @@ } }, { - "id": 41170, + "id": 2020, "name": "init", "variant": "param", "kind": 32768, @@ -48239,7 +48255,7 @@ }, "type": { "type": "reference", - "target": 41253, + "target": 2103, "name": "FetchArgs", "package": "@medusajs/js-sdk" } @@ -48254,7 +48270,7 @@ "typeArguments": [ { "type": "reference", - "target": 41168, + "target": 2018, "name": "T", "package": "@medusajs/js-sdk", "refersToTypeParameter": true @@ -48267,21 +48283,21 @@ ] }, { - "id": 41171, + "id": 2021, "name": "fetchStream", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 158, "character": 8 } ], "signatures": [ { - "id": 41172, + "id": 2022, "name": "fetchStream", "variant": "signature", "kind": 4096, @@ -48335,14 +48351,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 158, "character": 8 } ], "parameters": [ { - "id": 41173, + "id": 2023, "name": "input", "variant": "param", "kind": 32768, @@ -48376,7 +48392,7 @@ } }, { - "id": 41174, + "id": 2024, "name": "init", "variant": "param", "kind": 32768, @@ -48385,7 +48401,7 @@ }, "type": { "type": "reference", - "target": 41253, + "target": 2103, "name": "FetchArgs", "package": "@medusajs/js-sdk" } @@ -48400,7 +48416,7 @@ "typeArguments": [ { "type": "reference", - "target": 41258, + "target": 2108, "name": "FetchStreamResponse", "package": "@medusajs/js-sdk" } @@ -48412,35 +48428,35 @@ ] }, { - "id": 41175, + "id": 2025, "name": "setToken", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 178, "character": 8 } ], "signatures": [ { - "id": 41176, + "id": 2026, "name": "setToken", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 178, "character": 8 } ], "parameters": [ { - "id": 41177, + "id": 2027, "name": "token", "variant": "param", "kind": 32768, @@ -48470,28 +48486,28 @@ ] }, { - "id": 41178, + "id": 2028, "name": "clearToken", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 182, "character": 8 } ], "signatures": [ { - "id": 41179, + "id": 2029, "name": "clearToken", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 182, "character": 8 } @@ -48515,7 +48531,7 @@ ] }, { - "id": 41180, + "id": 2030, "name": "clearToken_", "variant": "declaration", "kind": 2048, @@ -48524,21 +48540,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 186, "character": 18 } ], "signatures": [ { - "id": 41181, + "id": 2031, "name": "clearToken_", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 186, "character": 18 } @@ -48562,7 +48578,7 @@ ] }, { - "id": 41182, + "id": 2032, "name": "initClient", "variant": "declaration", "kind": 2048, @@ -48571,28 +48587,28 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 208, "character": 12 } ], "signatures": [ { - "id": 41183, + "id": 2033, "name": "initClient", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 208, "character": 12 } ], "type": { "type": "reference", - "target": 41230, + "target": 2080, "name": "ClientFetch", "package": "@medusajs/js-sdk" } @@ -48600,7 +48616,7 @@ ] }, { - "id": 41184, + "id": 2034, "name": "getApiKeyHeader_", "variant": "declaration", "kind": 2048, @@ -48609,21 +48625,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 271, "character": 12 } ], "signatures": [ { - "id": 41185, + "id": 2035, "name": "getApiKeyHeader_", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 271, "character": 31 } @@ -48634,7 +48650,7 @@ { "type": "reflection", "declaration": { - "id": 41186, + "id": 2036, "name": "__type", "variant": "declaration", "kind": 65536, @@ -48644,21 +48660,21 @@ { "type": "reflection", "declaration": { - "id": 41187, + "id": 2037, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 41188, + "id": 2038, "name": "Authorization", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 271, "character": 37 } @@ -48673,13 +48689,13 @@ { "title": "Properties", "children": [ - 41188 + 2038 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 271, "character": 35 } @@ -48692,7 +48708,7 @@ ] }, { - "id": 41189, + "id": 2039, "name": "getPublishableKeyHeader_", "variant": "declaration", "kind": 2048, @@ -48701,21 +48717,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 277, "character": 12 } ], "signatures": [ { - "id": 41190, + "id": 2040, "name": "getPublishableKeyHeader_", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 277, "character": 39 } @@ -48726,7 +48742,7 @@ { "type": "reflection", "declaration": { - "id": 41191, + "id": 2041, "name": "__type", "variant": "declaration", "kind": 65536, @@ -48736,21 +48752,21 @@ { "type": "reflection", "declaration": { - "id": 41192, + "id": 2042, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 41193, + "id": 2043, "name": "x-publishable-api-key", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 278, "character": 8 } @@ -48765,13 +48781,13 @@ { "title": "Properties", "children": [ - 41193 + 2043 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 278, "character": 6 } @@ -48784,7 +48800,7 @@ ] }, { - "id": 41194, + "id": 2044, "name": "getJwtHeader_", "variant": "declaration", "kind": 2048, @@ -48793,21 +48809,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 285, "character": 18 } ], "signatures": [ { - "id": 41195, + "id": 2045, "name": "getJwtHeader_", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 285, "character": 18 } @@ -48825,7 +48841,7 @@ { "type": "reflection", "declaration": { - "id": 41196, + "id": 2046, "name": "__type", "variant": "declaration", "kind": 65536, @@ -48835,21 +48851,21 @@ { "type": "reflection", "declaration": { - "id": 41197, + "id": 2047, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 41198, + "id": 2048, "name": "Authorization", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 285, "character": 45 } @@ -48864,13 +48880,13 @@ { "title": "Properties", "children": [ - 41198 + 2048 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 285, "character": 43 } @@ -48887,7 +48903,7 @@ ] }, { - "id": 41199, + "id": 2049, "name": "setToken_", "variant": "declaration", "kind": 2048, @@ -48896,28 +48912,28 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 295, "character": 18 } ], "signatures": [ { - "id": 41200, + "id": 2050, "name": "setToken_", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 295, "character": 18 } ], "parameters": [ { - "id": 41201, + "id": 2051, "name": "token", "variant": "param", "kind": 32768, @@ -48947,7 +48963,7 @@ ] }, { - "id": 41202, + "id": 2052, "name": "getToken_", "variant": "declaration", "kind": 2048, @@ -48956,21 +48972,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 317, "character": 18 } ], "signatures": [ { - "id": 41203, + "id": 2053, "name": "getToken_", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 317, "character": 18 } @@ -49007,7 +49023,7 @@ ] }, { - "id": 41204, + "id": 2054, "name": "getTokenStorageInfo_", "variant": "declaration", "kind": 2048, @@ -49016,21 +49032,21 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 337, "character": 12 } ], "signatures": [ { - "id": 41205, + "id": 2055, "name": "getTokenStorageInfo_", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 337, "character": 35 } @@ -49038,21 +49054,21 @@ "type": { "type": "reflection", "declaration": { - "id": 41206, + "id": 2056, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 41207, + "id": 2057, "name": "storageMethod", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 359, "character": 6 } @@ -49084,14 +49100,14 @@ } }, { - "id": 41208, + "id": 2058, "name": "storageKey", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 360, "character": 6 } @@ -49106,14 +49122,14 @@ { "title": "Properties", "children": [ - 41207, - 41208 + 2057, + 2058 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 358, "character": 11 } @@ -49124,7 +49140,7 @@ ] }, { - "id": 41209, + "id": 2059, "name": "throwError_", "variant": "declaration", "kind": 2048, @@ -49133,28 +49149,28 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 364, "character": 12 } ], "signatures": [ { - "id": 41210, + "id": 2060, "name": "throwError_", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 364, "character": 12 } ], "parameters": [ { - "id": 41211, + "id": 2061, "name": "message", "variant": "param", "kind": 32768, @@ -49177,55 +49193,55 @@ { "title": "Constructors", "children": [ - 41158 + 2008 ] }, { "title": "Properties", "children": [ - 41161, - 41162, - 41163, - 41164, - 41165 + 2011, + 2012, + 2013, + 2014, + 2015 ] }, { "title": "Methods", "children": [ - 41166, - 41171, - 41175, - 41178, - 41180, - 41182, - 41184, - 41189, - 41194, - 41199, - 41202, - 41204, - 41209 + 2016, + 2021, + 2025, + 2028, + 2030, + 2032, + 2034, + 2039, + 2044, + 2049, + 2052, + 2054, + 2059 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/client.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/client.ts", "line": 107, "character": 13 } ] }, { - "id": 41235, + "id": 2085, "name": "Logger", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 1, "character": 12 } @@ -49233,21 +49249,21 @@ "type": { "type": "reflection", "declaration": { - "id": 41236, + "id": 2086, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 41237, + "id": 2087, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 2, "character": 2 } @@ -49255,28 +49271,28 @@ "type": { "type": "reflection", "declaration": { - "id": 41238, + "id": 2088, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 2, "character": 9 } ], "signatures": [ { - "id": 41239, + "id": 2089, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 41240, + "id": 2090, "name": "messages", "variant": "param", "kind": 32768, @@ -49302,14 +49318,14 @@ } }, { - "id": 41241, + "id": 2091, "name": "warn", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 3, "character": 2 } @@ -49317,28 +49333,28 @@ "type": { "type": "reflection", "declaration": { - "id": 41242, + "id": 2092, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 3, "character": 8 } ], "signatures": [ { - "id": 41243, + "id": 2093, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 41244, + "id": 2094, "name": "messages", "variant": "param", "kind": 32768, @@ -49364,14 +49380,14 @@ } }, { - "id": 41245, + "id": 2095, "name": "info", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 4, "character": 2 } @@ -49379,28 +49395,28 @@ "type": { "type": "reflection", "declaration": { - "id": 41246, + "id": 2096, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 4, "character": 8 } ], "signatures": [ { - "id": 41247, + "id": 2097, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 41248, + "id": 2098, "name": "messages", "variant": "param", "kind": 32768, @@ -49426,14 +49442,14 @@ } }, { - "id": 41249, + "id": 2099, "name": "debug", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 5, "character": 2 } @@ -49441,28 +49457,28 @@ "type": { "type": "reflection", "declaration": { - "id": 41250, + "id": 2100, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 5, "character": 9 } ], "signatures": [ { - "id": 41251, + "id": 2101, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 41252, + "id": 2102, "name": "messages", "variant": "param", "kind": 32768, @@ -49492,16 +49508,16 @@ { "title": "Properties", "children": [ - 41237, - 41241, - 41245, - 41249 + 2087, + 2091, + 2095, + 2099 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 1, "character": 21 } @@ -49510,14 +49526,14 @@ } }, { - "id": 41215, + "id": 2065, "name": "Config", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 8, "character": 12 } @@ -49525,21 +49541,21 @@ "type": { "type": "reflection", "declaration": { - "id": 41216, + "id": 2066, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 41217, + "id": 2067, "name": "baseUrl", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 9, "character": 2 } @@ -49550,7 +49566,7 @@ } }, { - "id": 41218, + "id": 2068, "name": "globalHeaders", "variant": "declaration", "kind": 1024, @@ -49559,20 +49575,20 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 10, "character": 2 } ], "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } }, { - "id": 41219, + "id": 2069, "name": "publishableKey", "variant": "declaration", "kind": 1024, @@ -49581,7 +49597,7 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 11, "character": 2 } @@ -49592,7 +49608,7 @@ } }, { - "id": 41220, + "id": 2070, "name": "apiKey", "variant": "declaration", "kind": 1024, @@ -49601,7 +49617,7 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 12, "character": 2 } @@ -49612,7 +49628,7 @@ } }, { - "id": 41221, + "id": 2071, "name": "auth", "variant": "declaration", "kind": 1024, @@ -49621,7 +49637,7 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 13, "character": 2 } @@ -49629,14 +49645,14 @@ "type": { "type": "reflection", "declaration": { - "id": 41222, + "id": 2072, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 41223, + "id": 2073, "name": "type", "variant": "declaration", "kind": 1024, @@ -49645,7 +49661,7 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 14, "character": 4 } @@ -49665,7 +49681,7 @@ } }, { - "id": 41224, + "id": 2074, "name": "jwtTokenStorageKey", "variant": "declaration", "kind": 1024, @@ -49674,7 +49690,7 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 15, "character": 4 } @@ -49685,7 +49701,7 @@ } }, { - "id": 41225, + "id": 2075, "name": "jwtTokenStorageMethod", "variant": "declaration", "kind": 1024, @@ -49694,7 +49710,7 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 16, "character": 4 } @@ -49726,7 +49742,7 @@ } }, { - "id": 41226, + "id": 2076, "name": "fetchCredentials", "variant": "declaration", "kind": 1024, @@ -49735,7 +49751,7 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 17, "character": 4 } @@ -49759,7 +49775,7 @@ } }, { - "id": 41227, + "id": 2077, "name": "storage", "variant": "declaration", "kind": 1024, @@ -49768,14 +49784,14 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 18, "character": 4 } ], "type": { "type": "reference", - "target": 41263, + "target": 2113, "name": "CustomStorage", "package": "@medusajs/js-sdk" } @@ -49785,17 +49801,17 @@ { "title": "Properties", "children": [ - 41223, - 41224, - 41225, - 41226, - 41227 + 2073, + 2074, + 2075, + 2076, + 2077 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 13, "character": 9 } @@ -49804,7 +49820,7 @@ } }, { - "id": 41228, + "id": 2078, "name": "logger", "variant": "declaration", "kind": 1024, @@ -49813,20 +49829,20 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 20, "character": 2 } ], "type": { "type": "reference", - "target": 41235, + "target": 2085, "name": "Logger", "package": "@medusajs/js-sdk" } }, { - "id": 41229, + "id": 2079, "name": "debug", "variant": "declaration", "kind": 1024, @@ -49835,7 +49851,7 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 21, "character": 2 } @@ -49850,19 +49866,19 @@ { "title": "Properties", "children": [ - 41217, - 41218, - 41219, - 41220, - 41221, - 41228, - 41229 + 2067, + 2068, + 2069, + 2070, + 2071, + 2078, + 2079 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 8, "character": 21 } @@ -49871,21 +49887,21 @@ } }, { - "id": 41281, + "id": 2131, "name": "Awaitable", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 24, "character": 12 } ], "typeParameters": [ { - "id": 41282, + "id": 2132, "name": "T", "variant": "typeParam", "kind": 131072, @@ -49897,7 +49913,7 @@ "types": [ { "type": "reference", - "target": 41282, + "target": 2132, "name": "T", "package": "@medusajs/js-sdk", "refersToTypeParameter": true @@ -49911,7 +49927,7 @@ "typeArguments": [ { "type": "reference", - "target": 41282, + "target": 2132, "name": "T", "package": "@medusajs/js-sdk", "refersToTypeParameter": true @@ -49924,42 +49940,42 @@ } }, { - "id": 41263, + "id": 2113, "name": "CustomStorage", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 41264, + "id": 2114, "name": "getItem", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 27, "character": 2 } ], "signatures": [ { - "id": 41265, + "id": 2115, "name": "getItem", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 27, "character": 2 } ], "parameters": [ { - "id": 41266, + "id": 2116, "name": "key", "variant": "param", "kind": 32768, @@ -49972,7 +49988,7 @@ ], "type": { "type": "reference", - "target": 41281, + "target": 2131, "typeArguments": [ { "type": "union", @@ -49995,35 +50011,35 @@ ] }, { - "id": 41267, + "id": 2117, "name": "setItem", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 28, "character": 2 } ], "signatures": [ { - "id": 41268, + "id": 2118, "name": "setItem", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 28, "character": 2 } ], "parameters": [ { - "id": 41269, + "id": 2119, "name": "key", "variant": "param", "kind": 32768, @@ -50034,7 +50050,7 @@ } }, { - "id": 41270, + "id": 2120, "name": "value", "variant": "param", "kind": 32768, @@ -50047,7 +50063,7 @@ ], "type": { "type": "reference", - "target": 41281, + "target": 2131, "typeArguments": [ { "type": "intrinsic", @@ -50061,35 +50077,35 @@ ] }, { - "id": 41271, + "id": 2121, "name": "removeItem", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 29, "character": 2 } ], "signatures": [ { - "id": 41272, + "id": 2122, "name": "removeItem", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 29, "character": 2 } ], "parameters": [ { - "id": 41273, + "id": 2123, "name": "key", "variant": "param", "kind": 32768, @@ -50102,7 +50118,7 @@ ], "type": { "type": "reference", - "target": 41281, + "target": 2131, "typeArguments": [ { "type": "intrinsic", @@ -50120,29 +50136,29 @@ { "title": "Methods", "children": [ - 41264, - 41267, - 41271 + 2114, + 2117, + 2121 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 26, "character": 17 } ] }, { - "id": 41283, + "id": 2133, "name": "FetchParams", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 32, "character": 12 } @@ -50173,14 +50189,14 @@ } }, { - "id": 41212, + "id": 2062, "name": "ClientHeaders", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 34, "character": 12 } @@ -50210,14 +50226,14 @@ { "type": "reflection", "declaration": { - "id": 41213, + "id": 2063, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 41214, + "id": 2064, "name": "tags", "variant": "declaration", "kind": 1024, @@ -50232,7 +50248,7 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 44, "character": 6 } @@ -50250,13 +50266,13 @@ { "title": "Properties", "children": [ - 41214 + 2064 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 38, "character": 4 } @@ -50271,14 +50287,14 @@ } }, { - "id": 41274, + "id": 2124, "name": "FetchInput", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 48, "character": 12 } @@ -50291,21 +50307,21 @@ }, "objectType": { "type": "reference", - "target": 41283, + "target": 2133, "name": "FetchParams", "package": "@medusajs/js-sdk" } } }, { - "id": 41253, + "id": 2103, "name": "FetchArgs", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 50, "character": 12 } @@ -50349,14 +50365,14 @@ { "type": "reflection", "declaration": { - "id": 41254, + "id": 2104, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 41255, + "id": 2105, "name": "query", "variant": "declaration", "kind": 1024, @@ -50365,7 +50381,7 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 51, "character": 2 } @@ -50391,7 +50407,7 @@ } }, { - "id": 41256, + "id": 2106, "name": "headers", "variant": "declaration", "kind": 1024, @@ -50400,20 +50416,20 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 52, "character": 2 } ], "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } }, { - "id": 41257, + "id": 2107, "name": "body", "variant": "declaration", "kind": 1024, @@ -50422,7 +50438,7 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 53, "character": 2 } @@ -50473,15 +50489,15 @@ { "title": "Properties", "children": [ - 41255, - 41256, - 41257 + 2105, + 2106, + 2107 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 50, "character": 64 } @@ -50492,14 +50508,14 @@ } }, { - "id": 41230, + "id": 2080, "name": "ClientFetch", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 56, "character": 12 } @@ -50507,41 +50523,41 @@ "type": { "type": "reflection", "declaration": { - "id": 41231, + "id": 2081, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 56, "character": 26 } ], "signatures": [ { - "id": 41232, + "id": 2082, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 41233, + "id": 2083, "name": "input", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41274, + "target": 2124, "name": "FetchInput", "package": "@medusajs/js-sdk" } }, { - "id": 41234, + "id": 2084, "name": "init", "variant": "param", "kind": 32768, @@ -50550,7 +50566,7 @@ }, "type": { "type": "reference", - "target": 41253, + "target": 2103, "name": "FetchArgs", "package": "@medusajs/js-sdk" } @@ -50582,14 +50598,14 @@ } }, { - "id": 41275, + "id": 2125, "name": "ServerSentEventMessage", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 41276, + "id": 2126, "name": "comment", "variant": "declaration", "kind": 1024, @@ -50606,7 +50622,7 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 64, "character": 2 } @@ -50617,7 +50633,7 @@ } }, { - "id": 41277, + "id": 2127, "name": "event", "variant": "declaration", "kind": 1024, @@ -50634,7 +50650,7 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 66, "character": 2 } @@ -50645,7 +50661,7 @@ } }, { - "id": 41278, + "id": 2128, "name": "data", "variant": "declaration", "kind": 1024, @@ -50662,7 +50678,7 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 68, "character": 2 } @@ -50673,7 +50689,7 @@ } }, { - "id": 41279, + "id": 2129, "name": "id", "variant": "declaration", "kind": 1024, @@ -50703,7 +50719,7 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 70, "character": 2 } @@ -50723,7 +50739,7 @@ } }, { - "id": 41280, + "id": 2130, "name": "retry", "variant": "declaration", "kind": 1024, @@ -50740,7 +50756,7 @@ }, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 72, "character": 2 } @@ -50755,38 +50771,38 @@ { "title": "Properties", "children": [ - 41276, - 41277, - 41278, - 41279, - 41280 + 2126, + 2127, + 2128, + 2129, + 2130 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 62, "character": 17 } ] }, { - "id": 41258, + "id": 2108, "name": "FetchStreamResponse", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 41259, + "id": 2109, "name": "stream", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 76, "character": 2 } @@ -50807,7 +50823,7 @@ "typeArguments": [ { "type": "reference", - "target": 41275, + "target": 2125, "name": "ServerSentEventMessage", "package": "@medusajs/js-sdk" }, @@ -50827,14 +50843,14 @@ } }, { - "id": 41260, + "id": 2110, "name": "abort", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 77, "character": 2 } @@ -50842,28 +50858,28 @@ "type": { "type": "reflection", "declaration": { - "id": 41261, + "id": 2111, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 77, "character": 9 } ], "signatures": [ { - "id": 41262, + "id": 2112, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 77, "character": 9 } @@ -50882,14 +50898,14 @@ { "title": "Properties", "children": [ - 41259, - 41260 + 2109, + 2110 ] } ], "sources": [ { - "fileName": "/home/runner/work/medusa/medusa/packages/core/js-sdk/src/types.ts", + "fileName": "/Users/shahednasser/medusa/packages/core/js-sdk/src/types.ts", "line": 75, "character": 17 } @@ -50900,71 +50916,71 @@ { "title": "Classes", "children": [ - 40950, - 41125, - 40498, - 40868, - 41029, - 39514, - 40288, - 40628, - 40065, - 40011, - 40044, - 39152, - 40141, - 39480, - 40202, - 40313, - 40216, - 40930, - 40882, - 39617, - 39658, - 39582, - 39548, - 40811, - 39809, - 40912, - 39687, - 41063, - 40921, - 39861, - 41000, - 39898, - 40364, - 39972, - 40078, - 40112, - 39928, - 40791, - 40739, - 40768, - 39838, - 40840, - 40987, - 41157 + 1800, + 1975, + 1348, + 1718, + 1879, + 364, + 1138, + 1478, + 915, + 861, + 894, + 2, + 991, + 330, + 1052, + 1163, + 1066, + 1780, + 1732, + 467, + 508, + 432, + 398, + 1661, + 659, + 1762, + 537, + 1913, + 1771, + 711, + 1850, + 748, + 1214, + 822, + 928, + 962, + 778, + 1641, + 1589, + 1618, + 688, + 1690, + 1837, + 2007 ] }, { "title": "Interfaces", "children": [ - 41263, - 41275, - 41258 + 2113, + 2125, + 2108 ] }, { "title": "Type Aliases", "children": [ - 41235, - 41215, - 41281, - 41283, - 41212, - 41274, - 41253, - 41230 + 2085, + 2065, + 2131, + 2133, + 2062, + 2124, + 2103, + 2080 ] } ], @@ -50973,26 +50989,26 @@ "fileName": "admin/index.ts", "line": 1, "character": 0, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/admin/index.ts#L1" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/admin/index.ts#L1" } ] }, { - "id": 39198, + "id": 48, "name": "auth", "variant": "declaration", "kind": 2, "flags": {}, "children": [ { - "id": 39199, + "id": 49, "name": "Auth", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 39200, + "id": 50, "name": "constructor", "variant": "declaration", "kind": 512, @@ -51002,12 +51018,12 @@ "fileName": "auth/index.ts", "line": 9, "character": 2, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/auth/index.ts#L9" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/auth/index.ts#L9" } ], "signatures": [ { - "id": 39201, + "id": 51, "name": "Auth", "variant": "signature", "kind": 16384, @@ -51017,32 +51033,32 @@ "fileName": "auth/index.ts", "line": 9, "character": 2, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/auth/index.ts#L9" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/auth/index.ts#L9" } ], "parameters": [ { - "id": 39202, + "id": 52, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41157, + "target": 2007, "name": "Client", "package": "@medusajs/js-sdk" } }, { - "id": 39203, + "id": 53, "name": "config", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 41215, + "target": 2065, "name": "Config", "package": "@medusajs/js-sdk" } @@ -51050,7 +51066,7 @@ ], "type": { "type": "reference", - "target": 39199, + "target": 49, "name": "Auth", "package": "@medusajs/js-sdk" } @@ -51058,7 +51074,7 @@ ] }, { - "id": 39206, + "id": 56, "name": "register", "variant": "declaration", "kind": 2048, @@ -51068,12 +51084,12 @@ "fileName": "auth/index.ts", "line": 38, "character": 2, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/auth/index.ts#L38" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/auth/index.ts#L38" } ], "signatures": [ { - "id": 39207, + "id": 57, "name": "register", "variant": "signature", "kind": 4096, @@ -51120,12 +51136,12 @@ "fileName": "auth/index.ts", "line": 38, "character": 13, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/auth/index.ts#L38" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/auth/index.ts#L38" } ], "parameters": [ { - "id": 39208, + "id": 58, "name": "actor", "variant": "param", "kind": 32768, @@ -51160,7 +51176,7 @@ } }, { - "id": 39209, + "id": 59, "name": "method", "variant": "param", "kind": 32768, @@ -51195,7 +51211,7 @@ } }, { - "id": 39210, + "id": 60, "name": "payload", "variant": "param", "kind": 32768, @@ -51246,7 +51262,7 @@ ] }, { - "id": 39211, + "id": 61, "name": "login", "variant": "declaration", "kind": 2048, @@ -51256,12 +51272,12 @@ "fileName": "auth/index.ts", "line": 86, "character": 2, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/auth/index.ts#L86" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/auth/index.ts#L86" } ], "signatures": [ { - "id": 39212, + "id": 62, "name": "login", "variant": "signature", "kind": 4096, @@ -51324,12 +51340,12 @@ "fileName": "auth/index.ts", "line": 86, "character": 10, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/auth/index.ts#L86" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/auth/index.ts#L86" } ], "parameters": [ { - "id": 39213, + "id": 63, "name": "actor", "variant": "param", "kind": 32768, @@ -51364,7 +51380,7 @@ } }, { - "id": 39214, + "id": 64, "name": "method", "variant": "param", "kind": 32768, @@ -51399,7 +51415,7 @@ } }, { - "id": 39215, + "id": 65, "name": "payload", "variant": "param", "kind": 32768, @@ -51472,14 +51488,14 @@ { "type": "reflection", "declaration": { - "id": 39216, + "id": 66, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 39217, + "id": 67, "name": "location", "variant": "declaration", "kind": 1024, @@ -51489,7 +51505,7 @@ "fileName": "auth/index.ts", "line": 103, "character": 15, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/auth/index.ts#L103" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/auth/index.ts#L103" } ], "type": { @@ -51502,7 +51518,7 @@ { "title": "Properties", "children": [ - 39217 + 67 ] } ], @@ -51511,7 +51527,7 @@ "fileName": "auth/index.ts", "line": 103, "character": 13, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/auth/index.ts#L103" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/auth/index.ts#L103" } ] } @@ -51526,7 +51542,7 @@ ] }, { - "id": 39218, + "id": 68, "name": "callback", "variant": "declaration", "kind": 2048, @@ -51536,12 +51552,12 @@ "fileName": "auth/index.ts", "line": 139, "character": 2, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/auth/index.ts#L139" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/auth/index.ts#L139" } ], "signatures": [ { - "id": 39219, + "id": 69, "name": "callback", "variant": "signature", "kind": 4096, @@ -51588,12 +51604,12 @@ "fileName": "auth/index.ts", "line": 139, "character": 13, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/auth/index.ts#L139" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/auth/index.ts#L139" } ], "parameters": [ { - "id": 39220, + "id": 70, "name": "actor", "variant": "param", "kind": 32768, @@ -51628,7 +51644,7 @@ } }, { - "id": 39221, + "id": 71, "name": "method", "variant": "param", "kind": 32768, @@ -51655,7 +51671,7 @@ } }, { - "id": 39222, + "id": 72, "name": "query", "variant": "param", "kind": 32768, @@ -51726,7 +51742,7 @@ ] }, { - "id": 39223, + "id": 73, "name": "refresh", "variant": "declaration", "kind": 2048, @@ -51736,12 +51752,12 @@ "fileName": "auth/index.ts", "line": 170, "character": 2, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/auth/index.ts#L170" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/auth/index.ts#L170" } ], "signatures": [ { - "id": 39224, + "id": 74, "name": "refresh", "variant": "signature", "kind": 4096, @@ -51756,7 +51772,7 @@ "kind": "inline-tag", "tag": "@link", "text": "callback", - "target": 39218 + "target": 68 }, { "kind": "text", @@ -51798,7 +51814,7 @@ "fileName": "auth/index.ts", "line": 170, "character": 12, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/auth/index.ts#L170" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/auth/index.ts#L170" } ], "type": { @@ -51820,7 +51836,7 @@ ] }, { - "id": 39225, + "id": 75, "name": "logout", "variant": "declaration", "kind": 2048, @@ -51830,12 +51846,12 @@ "fileName": "auth/index.ts", "line": 196, "character": 2, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/auth/index.ts#L196" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/auth/index.ts#L196" } ], "signatures": [ { - "id": 39226, + "id": 76, "name": "logout", "variant": "signature", "kind": 4096, @@ -51873,7 +51889,7 @@ "fileName": "auth/index.ts", "line": 196, "character": 11, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/auth/index.ts#L196" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/auth/index.ts#L196" } ], "type": { @@ -51895,7 +51911,7 @@ ] }, { - "id": 39227, + "id": 77, "name": "resetPassword", "variant": "declaration", "kind": 2048, @@ -51905,12 +51921,12 @@ "fileName": "auth/index.ts", "line": 232, "character": 2, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/auth/index.ts#L232" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/auth/index.ts#L232" } ], "signatures": [ { - "id": 39228, + "id": 78, "name": "resetPassword", "variant": "signature", "kind": 4096, @@ -51925,7 +51941,7 @@ "kind": "inline-tag", "tag": "@link", "text": "updateProvider", - "target": 39234 + "target": 84 }, { "kind": "text", @@ -51958,12 +51974,12 @@ "fileName": "auth/index.ts", "line": 232, "character": 18, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/auth/index.ts#L232" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/auth/index.ts#L232" } ], "parameters": [ { - "id": 39229, + "id": 79, "name": "actor", "variant": "param", "kind": 32768, @@ -51998,7 +52014,7 @@ } }, { - "id": 39230, + "id": 80, "name": "provider", "variant": "param", "kind": 32768, @@ -52025,7 +52041,7 @@ } }, { - "id": 39231, + "id": 81, "name": "body", "variant": "param", "kind": 32768, @@ -52041,14 +52057,14 @@ "type": { "type": "reflection", "declaration": { - "id": 39232, + "id": 82, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 39233, + "id": 83, "name": "identifier", "variant": "declaration", "kind": 1024, @@ -52074,7 +52090,7 @@ "fileName": "auth/index.ts", "line": 240, "character": 6, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/auth/index.ts#L240" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/auth/index.ts#L240" } ], "type": { @@ -52087,7 +52103,7 @@ { "title": "Properties", "children": [ - 39233 + 83 ] } ], @@ -52096,7 +52112,7 @@ "fileName": "auth/index.ts", "line": 235, "character": 10, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/auth/index.ts#L235" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/auth/index.ts#L235" } ] } @@ -52122,7 +52138,7 @@ ] }, { - "id": 39234, + "id": 84, "name": "updateProvider", "variant": "declaration", "kind": 2048, @@ -52132,12 +52148,12 @@ "fileName": "auth/index.ts", "line": 280, "character": 2, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/auth/index.ts#L280" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/auth/index.ts#L280" } ], "signatures": [ { - "id": 39235, + "id": 85, "name": "updateProvider", "variant": "signature", "kind": 4096, @@ -52152,7 +52168,7 @@ "kind": "inline-tag", "tag": "@link", "text": "resetPassword", - "target": 39227 + "target": 77 }, { "kind": "text", @@ -52185,12 +52201,12 @@ "fileName": "auth/index.ts", "line": 280, "character": 19, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/auth/index.ts#L280" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/auth/index.ts#L280" } ], "parameters": [ { - "id": 39236, + "id": 86, "name": "actor", "variant": "param", "kind": 32768, @@ -52225,7 +52241,7 @@ } }, { - "id": 39237, + "id": 87, "name": "provider", "variant": "param", "kind": 32768, @@ -52252,7 +52268,7 @@ } }, { - "id": 39238, + "id": 88, "name": "body", "variant": "param", "kind": 32768, @@ -52284,7 +52300,7 @@ } }, { - "id": 39239, + "id": 89, "name": "token", "variant": "param", "kind": 32768, @@ -52318,19 +52334,19 @@ { "title": "Constructors", "children": [ - 39200 + 50 ] }, { "title": "Methods", "children": [ - 39206, - 39211, - 39218, - 39223, - 39225, - 39227, - 39234 + 56, + 61, + 68, + 73, + 75, + 77, + 84 ] } ], @@ -52339,7 +52355,7 @@ "fileName": "auth/index.ts", "line": 5, "character": 13, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/auth/index.ts#L5" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/auth/index.ts#L5" } ] } @@ -52348,7 +52364,7 @@ { "title": "Classes", "children": [ - 39199 + 49 ] } ], @@ -52357,26 +52373,26 @@ "fileName": "auth/index.ts", "line": 1, "character": 0, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/auth/index.ts#L1" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/auth/index.ts#L1" } ] }, { - "id": 39243, + "id": 93, "name": "store", "variant": "declaration", "kind": 2, "flags": {}, "children": [ { - "id": 39244, + "id": 94, "name": "Store", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { - "id": 39249, + "id": 99, "name": "region", "variant": "declaration", "kind": 1024, @@ -52402,20 +52418,20 @@ "fileName": "store/index.ts", "line": 21, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L21" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L21" } ], "type": { "type": "reflection", "declaration": { - "id": 39250, + "id": 100, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 39251, + "id": 101, "name": "list", "variant": "declaration", "kind": 1024, @@ -52500,13 +52516,13 @@ "fileName": "store/index.ts", "line": 70, "character": 4, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L70" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L70" } ], "type": { "type": "reflection", "declaration": { - "id": 39252, + "id": 102, "name": "__type", "variant": "declaration", "kind": 65536, @@ -52516,12 +52532,12 @@ "fileName": "store/index.ts", "line": 70, "character": 10, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L70" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L70" } ], "signatures": [ { - "id": 39253, + "id": 103, "name": "__type", "variant": "signature", "kind": 4096, @@ -52545,12 +52561,12 @@ "fileName": "store/index.ts", "line": 70, "character": 10, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L70" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L70" } ], "parameters": [ { - "id": 39254, + "id": 104, "name": "query", "variant": "param", "kind": 32768, @@ -52590,7 +52606,7 @@ } }, { - "id": 39255, + "id": 105, "name": "headers", "variant": "param", "kind": 32768, @@ -52607,7 +52623,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -52640,7 +52656,7 @@ "defaultValue": "..." }, { - "id": 39256, + "id": 106, "name": "retrieve", "variant": "declaration", "kind": 1024, @@ -52693,13 +52709,13 @@ "fileName": "store/index.ts", "line": 119, "character": 4, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L119" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L119" } ], "type": { "type": "reflection", "declaration": { - "id": 39257, + "id": 107, "name": "__type", "variant": "declaration", "kind": 65536, @@ -52709,12 +52725,12 @@ "fileName": "store/index.ts", "line": 119, "character": 14, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L119" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L119" } ], "signatures": [ { - "id": 39258, + "id": 108, "name": "__type", "variant": "signature", "kind": 4096, @@ -52738,12 +52754,12 @@ "fileName": "store/index.ts", "line": 119, "character": 14, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L119" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L119" } ], "parameters": [ { - "id": 39259, + "id": 109, "name": "id", "variant": "param", "kind": 32768, @@ -52762,7 +52778,7 @@ } }, { - "id": 39260, + "id": 110, "name": "query", "variant": "param", "kind": 32768, @@ -52788,7 +52804,7 @@ } }, { - "id": 39261, + "id": 111, "name": "headers", "variant": "param", "kind": 32768, @@ -52805,7 +52821,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -52842,8 +52858,8 @@ { "title": "Properties", "children": [ - 39251, - 39256 + 101, + 106 ] } ], @@ -52852,7 +52868,7 @@ "fileName": "store/index.ts", "line": 21, "character": 18, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L21" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L21" } ] } @@ -52860,7 +52876,7 @@ "defaultValue": "..." }, { - "id": 39262, + "id": 112, "name": "collection", "variant": "declaration", "kind": 1024, @@ -52886,20 +52902,20 @@ "fileName": "store/index.ts", "line": 137, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L137" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L137" } ], "type": { "type": "reflection", "declaration": { - "id": 39263, + "id": 113, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 39264, + "id": 114, "name": "list", "variant": "declaration", "kind": 1024, @@ -52984,13 +53000,13 @@ "fileName": "store/index.ts", "line": 186, "character": 4, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L186" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L186" } ], "type": { "type": "reflection", "declaration": { - "id": 39265, + "id": 115, "name": "__type", "variant": "declaration", "kind": 65536, @@ -53000,12 +53016,12 @@ "fileName": "store/index.ts", "line": 186, "character": 10, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L186" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L186" } ], "signatures": [ { - "id": 39266, + "id": 116, "name": "__type", "variant": "signature", "kind": 4096, @@ -53029,12 +53045,12 @@ "fileName": "store/index.ts", "line": 186, "character": 10, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L186" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L186" } ], "parameters": [ { - "id": 39267, + "id": 117, "name": "query", "variant": "param", "kind": 32768, @@ -53074,7 +53090,7 @@ } }, { - "id": 39268, + "id": 118, "name": "headers", "variant": "param", "kind": 32768, @@ -53091,7 +53107,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -53124,7 +53140,7 @@ "defaultValue": "..." }, { - "id": 39269, + "id": 119, "name": "retrieve", "variant": "declaration", "kind": 1024, @@ -53177,13 +53193,13 @@ "fileName": "store/index.ts", "line": 232, "character": 4, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L232" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L232" } ], "type": { "type": "reflection", "declaration": { - "id": 39270, + "id": 120, "name": "__type", "variant": "declaration", "kind": 65536, @@ -53193,12 +53209,12 @@ "fileName": "store/index.ts", "line": 232, "character": 14, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L232" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L232" } ], "signatures": [ { - "id": 39271, + "id": 121, "name": "__type", "variant": "signature", "kind": 4096, @@ -53222,12 +53238,12 @@ "fileName": "store/index.ts", "line": 232, "character": 14, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L232" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L232" } ], "parameters": [ { - "id": 39272, + "id": 122, "name": "id", "variant": "param", "kind": 32768, @@ -53246,7 +53262,7 @@ } }, { - "id": 39273, + "id": 123, "name": "query", "variant": "param", "kind": 32768, @@ -53272,7 +53288,7 @@ } }, { - "id": 39274, + "id": 124, "name": "headers", "variant": "param", "kind": 32768, @@ -53289,7 +53305,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -53326,8 +53342,8 @@ { "title": "Properties", "children": [ - 39264, - 39269 + 114, + 119 ] } ], @@ -53336,7 +53352,7 @@ "fileName": "store/index.ts", "line": 137, "character": 22, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L137" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L137" } ] } @@ -53344,7 +53360,7 @@ "defaultValue": "..." }, { - "id": 39275, + "id": 125, "name": "category", "variant": "declaration", "kind": 1024, @@ -53370,20 +53386,20 @@ "fileName": "store/index.ts", "line": 250, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L250" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L250" } ], "type": { "type": "reflection", "declaration": { - "id": 39276, + "id": 126, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 39277, + "id": 127, "name": "list", "variant": "declaration", "kind": 1024, @@ -53468,13 +53484,13 @@ "fileName": "store/index.ts", "line": 299, "character": 4, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L299" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L299" } ], "type": { "type": "reflection", "declaration": { - "id": 39278, + "id": 128, "name": "__type", "variant": "declaration", "kind": 65536, @@ -53484,12 +53500,12 @@ "fileName": "store/index.ts", "line": 299, "character": 10, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L299" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L299" } ], "signatures": [ { - "id": 39279, + "id": 129, "name": "__type", "variant": "signature", "kind": 4096, @@ -53513,12 +53529,12 @@ "fileName": "store/index.ts", "line": 299, "character": 10, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L299" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L299" } ], "parameters": [ { - "id": 39280, + "id": 130, "name": "query", "variant": "param", "kind": 32768, @@ -53558,7 +53574,7 @@ } }, { - "id": 39281, + "id": 131, "name": "headers", "variant": "param", "kind": 32768, @@ -53575,7 +53591,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -53608,7 +53624,7 @@ "defaultValue": "..." }, { - "id": 39282, + "id": 132, "name": "retrieve", "variant": "declaration", "kind": 1024, @@ -53661,13 +53677,13 @@ "fileName": "store/index.ts", "line": 345, "character": 4, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L345" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L345" } ], "type": { "type": "reflection", "declaration": { - "id": 39283, + "id": 133, "name": "__type", "variant": "declaration", "kind": 65536, @@ -53677,12 +53693,12 @@ "fileName": "store/index.ts", "line": 345, "character": 14, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L345" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L345" } ], "signatures": [ { - "id": 39284, + "id": 134, "name": "__type", "variant": "signature", "kind": 4096, @@ -53706,12 +53722,12 @@ "fileName": "store/index.ts", "line": 345, "character": 14, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L345" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L345" } ], "parameters": [ { - "id": 39285, + "id": 135, "name": "id", "variant": "param", "kind": 32768, @@ -53730,7 +53746,7 @@ } }, { - "id": 39286, + "id": 136, "name": "query", "variant": "param", "kind": 32768, @@ -53756,7 +53772,7 @@ } }, { - "id": 39287, + "id": 137, "name": "headers", "variant": "param", "kind": 32768, @@ -53773,7 +53789,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -53810,8 +53826,8 @@ { "title": "Properties", "children": [ - 39277, - 39282 + 127, + 132 ] } ], @@ -53820,7 +53836,7 @@ "fileName": "store/index.ts", "line": 250, "character": 20, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L250" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L250" } ] } @@ -53828,7 +53844,7 @@ "defaultValue": "..." }, { - "id": 39288, + "id": 138, "name": "product", "variant": "declaration", "kind": 1024, @@ -53854,20 +53870,20 @@ "fileName": "store/index.ts", "line": 363, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L363" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L363" } ], "type": { "type": "reflection", "declaration": { - "id": 39289, + "id": 139, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 39290, + "id": 140, "name": "list", "variant": "declaration", "kind": 1024, @@ -53952,13 +53968,13 @@ "fileName": "store/index.ts", "line": 415, "character": 4, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L415" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L415" } ], "type": { "type": "reflection", "declaration": { - "id": 39291, + "id": 141, "name": "__type", "variant": "declaration", "kind": 65536, @@ -53968,12 +53984,12 @@ "fileName": "store/index.ts", "line": 415, "character": 10, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L415" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L415" } ], "signatures": [ { - "id": 39292, + "id": 142, "name": "__type", "variant": "signature", "kind": 4096, @@ -53997,12 +54013,12 @@ "fileName": "store/index.ts", "line": 415, "character": 10, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L415" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L415" } ], "parameters": [ { - "id": 39293, + "id": 143, "name": "query", "variant": "param", "kind": 32768, @@ -54028,7 +54044,7 @@ } }, { - "id": 39294, + "id": 144, "name": "headers", "variant": "param", "kind": 32768, @@ -54045,7 +54061,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -54078,7 +54094,7 @@ "defaultValue": "..." }, { - "id": 39295, + "id": 145, "name": "retrieve", "variant": "declaration", "kind": 1024, @@ -54131,13 +54147,13 @@ "fileName": "store/index.ts", "line": 464, "character": 4, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L464" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L464" } ], "type": { "type": "reflection", "declaration": { - "id": 39296, + "id": 146, "name": "__type", "variant": "declaration", "kind": 65536, @@ -54147,12 +54163,12 @@ "fileName": "store/index.ts", "line": 464, "character": 14, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L464" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L464" } ], "signatures": [ { - "id": 39297, + "id": 147, "name": "__type", "variant": "signature", "kind": 4096, @@ -54176,12 +54192,12 @@ "fileName": "store/index.ts", "line": 464, "character": 14, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L464" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L464" } ], "parameters": [ { - "id": 39298, + "id": 148, "name": "id", "variant": "param", "kind": 32768, @@ -54200,7 +54216,7 @@ } }, { - "id": 39299, + "id": 149, "name": "query", "variant": "param", "kind": 32768, @@ -54226,7 +54242,7 @@ } }, { - "id": 39300, + "id": 150, "name": "headers", "variant": "param", "kind": 32768, @@ -54243,7 +54259,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -54280,8 +54296,8 @@ { "title": "Properties", "children": [ - 39290, - 39295 + 140, + 145 ] } ], @@ -54290,7 +54306,7 @@ "fileName": "store/index.ts", "line": 363, "character": 19, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L363" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L363" } ] } @@ -54298,7 +54314,7 @@ "defaultValue": "..." }, { - "id": 39301, + "id": 151, "name": "cart", "variant": "declaration", "kind": 1024, @@ -54329,20 +54345,20 @@ "fileName": "store/index.ts", "line": 484, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L484" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L484" } ], "type": { "type": "reflection", "declaration": { - "id": 39302, + "id": 152, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 39303, + "id": 153, "name": "create", "variant": "declaration", "kind": 1024, @@ -54371,13 +54387,13 @@ "fileName": "store/index.ts", "line": 504, "character": 4, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L504" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L504" } ], "type": { "type": "reflection", "declaration": { - "id": 39304, + "id": 154, "name": "__type", "variant": "declaration", "kind": 65536, @@ -54387,12 +54403,12 @@ "fileName": "store/index.ts", "line": 504, "character": 12, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L504" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L504" } ], "signatures": [ { - "id": 39305, + "id": 155, "name": "__type", "variant": "signature", "kind": 4096, @@ -54416,12 +54432,12 @@ "fileName": "store/index.ts", "line": 504, "character": 12, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L504" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L504" } ], "parameters": [ { - "id": 39306, + "id": 156, "name": "body", "variant": "param", "kind": 32768, @@ -54445,7 +54461,7 @@ } }, { - "id": 39307, + "id": 157, "name": "query", "variant": "param", "kind": 32768, @@ -54471,7 +54487,7 @@ } }, { - "id": 39308, + "id": 158, "name": "headers", "variant": "param", "kind": 32768, @@ -54488,7 +54504,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -54521,7 +54537,7 @@ "defaultValue": "..." }, { - "id": 39309, + "id": 159, "name": "update", "variant": "declaration", "kind": 1024, @@ -54550,13 +54566,13 @@ "fileName": "store/index.ts", "line": 536, "character": 4, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L536" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L536" } ], "type": { "type": "reflection", "declaration": { - "id": 39310, + "id": 160, "name": "__type", "variant": "declaration", "kind": 65536, @@ -54566,12 +54582,12 @@ "fileName": "store/index.ts", "line": 536, "character": 12, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L536" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L536" } ], "signatures": [ { - "id": 39311, + "id": 161, "name": "__type", "variant": "signature", "kind": 4096, @@ -54595,12 +54611,12 @@ "fileName": "store/index.ts", "line": 536, "character": 12, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L536" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L536" } ], "parameters": [ { - "id": 39312, + "id": 162, "name": "id", "variant": "param", "kind": 32768, @@ -54619,7 +54635,7 @@ } }, { - "id": 39313, + "id": 163, "name": "body", "variant": "param", "kind": 32768, @@ -54643,7 +54659,7 @@ } }, { - "id": 39314, + "id": 164, "name": "query", "variant": "param", "kind": 32768, @@ -54669,7 +54685,7 @@ } }, { - "id": 39315, + "id": 165, "name": "headers", "variant": "param", "kind": 32768, @@ -54686,7 +54702,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -54719,7 +54735,7 @@ "defaultValue": "..." }, { - "id": 39316, + "id": 166, "name": "retrieve", "variant": "declaration", "kind": 1024, @@ -54772,13 +54788,13 @@ "fileName": "store/index.ts", "line": 586, "character": 4, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L586" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L586" } ], "type": { "type": "reflection", "declaration": { - "id": 39317, + "id": 167, "name": "__type", "variant": "declaration", "kind": 65536, @@ -54788,12 +54804,12 @@ "fileName": "store/index.ts", "line": 586, "character": 14, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L586" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L586" } ], "signatures": [ { - "id": 39318, + "id": 168, "name": "__type", "variant": "signature", "kind": 4096, @@ -54817,12 +54833,12 @@ "fileName": "store/index.ts", "line": 586, "character": 14, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L586" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L586" } ], "parameters": [ { - "id": 39319, + "id": 169, "name": "id", "variant": "param", "kind": 32768, @@ -54841,7 +54857,7 @@ } }, { - "id": 39320, + "id": 170, "name": "query", "variant": "param", "kind": 32768, @@ -54867,7 +54883,7 @@ } }, { - "id": 39321, + "id": 171, "name": "headers", "variant": "param", "kind": 32768, @@ -54884,7 +54900,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -54917,7 +54933,7 @@ "defaultValue": "..." }, { - "id": 39322, + "id": 172, "name": "createLineItem", "variant": "declaration", "kind": 1024, @@ -54946,13 +54962,13 @@ "fileName": "store/index.ts", "line": 620, "character": 4, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L620" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L620" } ], "type": { "type": "reflection", "declaration": { - "id": 39323, + "id": 173, "name": "__type", "variant": "declaration", "kind": 65536, @@ -54962,12 +54978,12 @@ "fileName": "store/index.ts", "line": 620, "character": 20, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L620" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L620" } ], "signatures": [ { - "id": 39324, + "id": 174, "name": "__type", "variant": "signature", "kind": 4096, @@ -54991,12 +55007,12 @@ "fileName": "store/index.ts", "line": 620, "character": 20, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L620" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L620" } ], "parameters": [ { - "id": 39325, + "id": 175, "name": "cartId", "variant": "param", "kind": 32768, @@ -55015,7 +55031,7 @@ } }, { - "id": 39326, + "id": 176, "name": "body", "variant": "param", "kind": 32768, @@ -55039,7 +55055,7 @@ } }, { - "id": 39327, + "id": 177, "name": "query", "variant": "param", "kind": 32768, @@ -55065,7 +55081,7 @@ } }, { - "id": 39328, + "id": 178, "name": "headers", "variant": "param", "kind": 32768, @@ -55082,7 +55098,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -55115,7 +55131,7 @@ "defaultValue": "..." }, { - "id": 39329, + "id": 179, "name": "updateLineItem", "variant": "declaration", "kind": 1024, @@ -55144,13 +55160,13 @@ "fileName": "store/index.ts", "line": 661, "character": 4, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L661" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L661" } ], "type": { "type": "reflection", "declaration": { - "id": 39330, + "id": 180, "name": "__type", "variant": "declaration", "kind": 65536, @@ -55160,12 +55176,12 @@ "fileName": "store/index.ts", "line": 661, "character": 20, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L661" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L661" } ], "signatures": [ { - "id": 39331, + "id": 181, "name": "__type", "variant": "signature", "kind": 4096, @@ -55189,12 +55205,12 @@ "fileName": "store/index.ts", "line": 661, "character": 20, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L661" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L661" } ], "parameters": [ { - "id": 39332, + "id": 182, "name": "cartId", "variant": "param", "kind": 32768, @@ -55213,7 +55229,7 @@ } }, { - "id": 39333, + "id": 183, "name": "lineItemId", "variant": "param", "kind": 32768, @@ -55232,7 +55248,7 @@ } }, { - "id": 39334, + "id": 184, "name": "body", "variant": "param", "kind": 32768, @@ -55256,7 +55272,7 @@ } }, { - "id": 39335, + "id": 185, "name": "query", "variant": "param", "kind": 32768, @@ -55282,7 +55298,7 @@ } }, { - "id": 39336, + "id": 186, "name": "headers", "variant": "param", "kind": 32768, @@ -55299,7 +55315,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -55332,7 +55348,7 @@ "defaultValue": "..." }, { - "id": 39337, + "id": 187, "name": "deleteLineItem", "variant": "declaration", "kind": 1024, @@ -55361,13 +55377,13 @@ "fileName": "store/index.ts", "line": 698, "character": 4, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L698" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L698" } ], "type": { "type": "reflection", "declaration": { - "id": 39338, + "id": 188, "name": "__type", "variant": "declaration", "kind": 65536, @@ -55377,12 +55393,12 @@ "fileName": "store/index.ts", "line": 698, "character": 20, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L698" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L698" } ], "signatures": [ { - "id": 39339, + "id": 189, "name": "__type", "variant": "signature", "kind": 4096, @@ -55406,12 +55422,12 @@ "fileName": "store/index.ts", "line": 698, "character": 20, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L698" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L698" } ], "parameters": [ { - "id": 39340, + "id": 190, "name": "cartId", "variant": "param", "kind": 32768, @@ -55430,7 +55446,7 @@ } }, { - "id": 39341, + "id": 191, "name": "lineItemId", "variant": "param", "kind": 32768, @@ -55449,7 +55465,7 @@ } }, { - "id": 39342, + "id": 192, "name": "headers", "variant": "param", "kind": 32768, @@ -55466,7 +55482,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -55499,7 +55515,7 @@ "defaultValue": "..." }, { - "id": 39343, + "id": 193, "name": "addShippingMethod", "variant": "declaration", "kind": 1024, @@ -55528,13 +55544,13 @@ "fileName": "store/index.ts", "line": 734, "character": 4, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L734" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L734" } ], "type": { "type": "reflection", "declaration": { - "id": 39344, + "id": 194, "name": "__type", "variant": "declaration", "kind": 65536, @@ -55544,12 +55560,12 @@ "fileName": "store/index.ts", "line": 734, "character": 23, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L734" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L734" } ], "signatures": [ { - "id": 39345, + "id": 195, "name": "__type", "variant": "signature", "kind": 4096, @@ -55573,12 +55589,12 @@ "fileName": "store/index.ts", "line": 734, "character": 23, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L734" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L734" } ], "parameters": [ { - "id": 39346, + "id": 196, "name": "cartId", "variant": "param", "kind": 32768, @@ -55597,7 +55613,7 @@ } }, { - "id": 39347, + "id": 197, "name": "body", "variant": "param", "kind": 32768, @@ -55621,7 +55637,7 @@ } }, { - "id": 39348, + "id": 198, "name": "query", "variant": "param", "kind": 32768, @@ -55647,7 +55663,7 @@ } }, { - "id": 39349, + "id": 199, "name": "headers", "variant": "param", "kind": 32768, @@ -55664,7 +55680,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -55697,7 +55713,7 @@ "defaultValue": "..." }, { - "id": 39350, + "id": 200, "name": "complete", "variant": "declaration", "kind": 1024, @@ -55726,13 +55742,13 @@ "fileName": "store/index.ts", "line": 774, "character": 4, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L774" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L774" } ], "type": { "type": "reflection", "declaration": { - "id": 39351, + "id": 201, "name": "__type", "variant": "declaration", "kind": 65536, @@ -55742,12 +55758,12 @@ "fileName": "store/index.ts", "line": 774, "character": 14, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L774" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L774" } ], "signatures": [ { - "id": 39352, + "id": 202, "name": "__type", "variant": "signature", "kind": 4096, @@ -55771,12 +55787,12 @@ "fileName": "store/index.ts", "line": 774, "character": 14, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L774" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L774" } ], "parameters": [ { - "id": 39353, + "id": 203, "name": "cartId", "variant": "param", "kind": 32768, @@ -55795,7 +55811,7 @@ } }, { - "id": 39354, + "id": 204, "name": "query", "variant": "param", "kind": 32768, @@ -55821,7 +55837,7 @@ } }, { - "id": 39355, + "id": 205, "name": "headers", "variant": "param", "kind": 32768, @@ -55838,7 +55854,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -55871,7 +55887,7 @@ "defaultValue": "..." }, { - "id": 39356, + "id": 206, "name": "transferCart", "variant": "declaration", "kind": 1024, @@ -55900,13 +55916,13 @@ "fileName": "store/index.ts", "line": 803, "character": 4, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L803" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L803" } ], "type": { "type": "reflection", "declaration": { - "id": 39357, + "id": 207, "name": "__type", "variant": "declaration", "kind": 65536, @@ -55916,12 +55932,12 @@ "fileName": "store/index.ts", "line": 803, "character": 18, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L803" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L803" } ], "signatures": [ { - "id": 39358, + "id": 208, "name": "__type", "variant": "signature", "kind": 4096, @@ -55945,12 +55961,12 @@ "fileName": "store/index.ts", "line": 803, "character": 18, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L803" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L803" } ], "parameters": [ { - "id": 39359, + "id": 209, "name": "id", "variant": "param", "kind": 32768, @@ -55969,7 +55985,7 @@ } }, { - "id": 39360, + "id": 210, "name": "query", "variant": "param", "kind": 32768, @@ -55995,7 +56011,7 @@ } }, { - "id": 39361, + "id": 211, "name": "headers", "variant": "param", "kind": 32768, @@ -56012,7 +56028,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -56049,15 +56065,15 @@ { "title": "Properties", "children": [ - 39303, - 39309, - 39316, - 39322, - 39329, - 39337, - 39343, - 39350, - 39356 + 153, + 159, + 166, + 172, + 179, + 187, + 193, + 200, + 206 ] } ], @@ -56066,7 +56082,7 @@ "fileName": "store/index.ts", "line": 484, "character": 16, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L484" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L484" } ] } @@ -56074,7 +56090,7 @@ "defaultValue": "..." }, { - "id": 39362, + "id": 212, "name": "fulfillment", "variant": "declaration", "kind": 1024, @@ -56100,20 +56116,20 @@ "fileName": "store/index.ts", "line": 822, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L822" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L822" } ], "type": { "type": "reflection", "declaration": { - "id": 39363, + "id": 213, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 39364, + "id": 214, "name": "listCartOptions", "variant": "declaration", "kind": 1024, @@ -56142,13 +56158,13 @@ "fileName": "store/index.ts", "line": 842, "character": 4, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L842" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L842" } ], "type": { "type": "reflection", "declaration": { - "id": 39365, + "id": 215, "name": "__type", "variant": "declaration", "kind": 65536, @@ -56158,12 +56174,12 @@ "fileName": "store/index.ts", "line": 842, "character": 21, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L842" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L842" } ], "signatures": [ { - "id": 39366, + "id": 216, "name": "__type", "variant": "signature", "kind": 4096, @@ -56187,12 +56203,12 @@ "fileName": "store/index.ts", "line": 842, "character": 21, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L842" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L842" } ], "parameters": [ { - "id": 39367, + "id": 217, "name": "query", "variant": "param", "kind": 32768, @@ -56218,7 +56234,7 @@ } }, { - "id": 39368, + "id": 218, "name": "headers", "variant": "param", "kind": 32768, @@ -56235,7 +56251,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -56268,7 +56284,7 @@ "defaultValue": "..." }, { - "id": 39369, + "id": 219, "name": "calculate", "variant": "declaration", "kind": 1024, @@ -56278,13 +56294,13 @@ "fileName": "store/index.ts", "line": 855, "character": 4, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L855" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L855" } ], "type": { "type": "reflection", "declaration": { - "id": 39370, + "id": 220, "name": "__type", "variant": "declaration", "kind": 65536, @@ -56294,12 +56310,12 @@ "fileName": "store/index.ts", "line": 855, "character": 15, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L855" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L855" } ], "signatures": [ { - "id": 39371, + "id": 221, "name": "__type", "variant": "signature", "kind": 4096, @@ -56309,12 +56325,12 @@ "fileName": "store/index.ts", "line": 855, "character": 15, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L855" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L855" } ], "parameters": [ { - "id": 39372, + "id": 222, "name": "id", "variant": "param", "kind": 32768, @@ -56325,7 +56341,7 @@ } }, { - "id": 39373, + "id": 223, "name": "body", "variant": "param", "kind": 32768, @@ -56341,7 +56357,7 @@ } }, { - "id": 39374, + "id": 224, "name": "query", "variant": "param", "kind": 32768, @@ -56359,7 +56375,7 @@ } }, { - "id": 39375, + "id": 225, "name": "headers", "variant": "param", "kind": 32768, @@ -56368,7 +56384,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -56405,8 +56421,8 @@ { "title": "Properties", "children": [ - 39364, - 39369 + 214, + 219 ] } ], @@ -56415,7 +56431,7 @@ "fileName": "store/index.ts", "line": 822, "character": 23, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L822" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L822" } ] } @@ -56423,7 +56439,7 @@ "defaultValue": "..." }, { - "id": 39376, + "id": 226, "name": "payment", "variant": "declaration", "kind": 1024, @@ -56449,20 +56465,20 @@ "fileName": "store/index.ts", "line": 876, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L876" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L876" } ], "type": { "type": "reflection", "declaration": { - "id": 39377, + "id": 227, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 39378, + "id": 228, "name": "listPaymentProviders", "variant": "declaration", "kind": 1024, @@ -56547,13 +56563,13 @@ "fileName": "store/index.ts", "line": 933, "character": 4, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L933" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L933" } ], "type": { "type": "reflection", "declaration": { - "id": 39379, + "id": 229, "name": "__type", "variant": "declaration", "kind": 65536, @@ -56563,12 +56579,12 @@ "fileName": "store/index.ts", "line": 933, "character": 26, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L933" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L933" } ], "signatures": [ { - "id": 39380, + "id": 230, "name": "__type", "variant": "signature", "kind": 4096, @@ -56592,12 +56608,12 @@ "fileName": "store/index.ts", "line": 933, "character": 26, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L933" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L933" } ], "parameters": [ { - "id": 39381, + "id": 231, "name": "query", "variant": "param", "kind": 32768, @@ -56637,7 +56653,7 @@ } }, { - "id": 39382, + "id": 232, "name": "headers", "variant": "param", "kind": 32768, @@ -56654,7 +56670,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -56687,7 +56703,7 @@ "defaultValue": "..." }, { - "id": 39383, + "id": 233, "name": "initiatePaymentSession", "variant": "declaration", "kind": 1024, @@ -56716,13 +56732,13 @@ "fileName": "store/index.ts", "line": 977, "character": 4, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L977" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L977" } ], "type": { "type": "reflection", "declaration": { - "id": 39384, + "id": 234, "name": "__type", "variant": "declaration", "kind": 65536, @@ -56732,12 +56748,12 @@ "fileName": "store/index.ts", "line": 977, "character": 28, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L977" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L977" } ], "signatures": [ { - "id": 39385, + "id": 235, "name": "__type", "variant": "signature", "kind": 4096, @@ -56761,12 +56777,12 @@ "fileName": "store/index.ts", "line": 977, "character": 28, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L977" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L977" } ], "parameters": [ { - "id": 39386, + "id": 236, "name": "cart", "variant": "param", "kind": 32768, @@ -56790,7 +56806,7 @@ } }, { - "id": 39387, + "id": 237, "name": "body", "variant": "param", "kind": 32768, @@ -56814,7 +56830,7 @@ } }, { - "id": 39388, + "id": 238, "name": "query", "variant": "param", "kind": 32768, @@ -56840,7 +56856,7 @@ } }, { - "id": 39389, + "id": 239, "name": "headers", "variant": "param", "kind": 32768, @@ -56857,7 +56873,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -56894,8 +56910,8 @@ { "title": "Properties", "children": [ - 39378, - 39383 + 228, + 233 ] } ], @@ -56904,7 +56920,7 @@ "fileName": "store/index.ts", "line": 876, "character": 19, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L876" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L876" } ] } @@ -56912,7 +56928,7 @@ "defaultValue": "..." }, { - "id": 39390, + "id": 240, "name": "order", "variant": "declaration", "kind": 1024, @@ -56938,20 +56954,20 @@ "fileName": "store/index.ts", "line": 1015, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1015" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1015" } ], "type": { "type": "reflection", "declaration": { - "id": 39391, + "id": 241, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 39392, + "id": 242, "name": "list", "variant": "declaration", "kind": 1024, @@ -57036,13 +57052,13 @@ "fileName": "store/index.ts", "line": 1063, "character": 4, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1063" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1063" } ], "type": { "type": "reflection", "declaration": { - "id": 39393, + "id": 243, "name": "__type", "variant": "declaration", "kind": 65536, @@ -57052,12 +57068,12 @@ "fileName": "store/index.ts", "line": 1063, "character": 10, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1063" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1063" } ], "signatures": [ { - "id": 39394, + "id": 244, "name": "__type", "variant": "signature", "kind": 4096, @@ -57081,12 +57097,12 @@ "fileName": "store/index.ts", "line": 1063, "character": 10, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1063" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1063" } ], "parameters": [ { - "id": 39395, + "id": 245, "name": "query", "variant": "param", "kind": 32768, @@ -57112,7 +57128,7 @@ } }, { - "id": 39396, + "id": 246, "name": "headers", "variant": "param", "kind": 32768, @@ -57129,7 +57145,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -57162,7 +57178,7 @@ "defaultValue": "..." }, { - "id": 39397, + "id": 247, "name": "retrieve", "variant": "declaration", "kind": 1024, @@ -57215,13 +57231,13 @@ "fileName": "store/index.ts", "line": 1107, "character": 4, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1107" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1107" } ], "type": { "type": "reflection", "declaration": { - "id": 39398, + "id": 248, "name": "__type", "variant": "declaration", "kind": 65536, @@ -57231,12 +57247,12 @@ "fileName": "store/index.ts", "line": 1107, "character": 14, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1107" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1107" } ], "signatures": [ { - "id": 39399, + "id": 249, "name": "__type", "variant": "signature", "kind": 4096, @@ -57260,12 +57276,12 @@ "fileName": "store/index.ts", "line": 1107, "character": 14, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1107" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1107" } ], "parameters": [ { - "id": 39400, + "id": 250, "name": "id", "variant": "param", "kind": 32768, @@ -57284,7 +57300,7 @@ } }, { - "id": 39401, + "id": 251, "name": "query", "variant": "param", "kind": 32768, @@ -57310,7 +57326,7 @@ } }, { - "id": 39402, + "id": 252, "name": "headers", "variant": "param", "kind": 32768, @@ -57327,7 +57343,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -57343,14 +57359,14 @@ { "type": "reflection", "declaration": { - "id": 39403, + "id": 253, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 39404, + "id": 254, "name": "order", "variant": "declaration", "kind": 1024, @@ -57360,7 +57376,7 @@ "fileName": "store/index.ts", "line": 1112, "character": 33, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1112" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1112" } ], "type": { @@ -57378,7 +57394,7 @@ { "title": "Properties", "children": [ - 39404 + 254 ] } ], @@ -57387,7 +57403,7 @@ "fileName": "store/index.ts", "line": 1112, "character": 31, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1112" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1112" } ] } @@ -57403,7 +57419,7 @@ "defaultValue": "..." }, { - "id": 39405, + "id": 255, "name": "requestTransfer", "variant": "declaration", "kind": 1024, @@ -57432,13 +57448,13 @@ "fileName": "store/index.ts", "line": 1146, "character": 4, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1146" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1146" } ], "type": { "type": "reflection", "declaration": { - "id": 39406, + "id": 256, "name": "__type", "variant": "declaration", "kind": 65536, @@ -57448,12 +57464,12 @@ "fileName": "store/index.ts", "line": 1146, "character": 21, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1146" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1146" } ], "signatures": [ { - "id": 39407, + "id": 257, "name": "__type", "variant": "signature", "kind": 4096, @@ -57477,12 +57493,12 @@ "fileName": "store/index.ts", "line": 1146, "character": 21, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1146" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1146" } ], "parameters": [ { - "id": 39408, + "id": 258, "name": "id", "variant": "param", "kind": 32768, @@ -57493,7 +57509,7 @@ } }, { - "id": 39409, + "id": 259, "name": "body", "variant": "param", "kind": 32768, @@ -57517,7 +57533,7 @@ } }, { - "id": 39410, + "id": 260, "name": "query", "variant": "param", "kind": 32768, @@ -57543,7 +57559,7 @@ } }, { - "id": 39411, + "id": 261, "name": "headers", "variant": "param", "kind": 32768, @@ -57560,7 +57576,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -57593,7 +57609,7 @@ "defaultValue": "..." }, { - "id": 39412, + "id": 262, "name": "cancelTransfer", "variant": "declaration", "kind": 1024, @@ -57622,13 +57638,13 @@ "fileName": "store/index.ts", "line": 1184, "character": 4, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1184" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1184" } ], "type": { "type": "reflection", "declaration": { - "id": 39413, + "id": 263, "name": "__type", "variant": "declaration", "kind": 65536, @@ -57638,12 +57654,12 @@ "fileName": "store/index.ts", "line": 1184, "character": 20, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1184" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1184" } ], "signatures": [ { - "id": 39414, + "id": 264, "name": "__type", "variant": "signature", "kind": 4096, @@ -57667,12 +57683,12 @@ "fileName": "store/index.ts", "line": 1184, "character": 20, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1184" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1184" } ], "parameters": [ { - "id": 39415, + "id": 265, "name": "id", "variant": "param", "kind": 32768, @@ -57691,7 +57707,7 @@ } }, { - "id": 39416, + "id": 266, "name": "query", "variant": "param", "kind": 32768, @@ -57717,7 +57733,7 @@ } }, { - "id": 39417, + "id": 267, "name": "headers", "variant": "param", "kind": 32768, @@ -57734,7 +57750,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -57767,7 +57783,7 @@ "defaultValue": "..." }, { - "id": 39418, + "id": 268, "name": "acceptTransfer", "variant": "declaration", "kind": 1024, @@ -57796,13 +57812,13 @@ "fileName": "store/index.ts", "line": 1221, "character": 4, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1221" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1221" } ], "type": { "type": "reflection", "declaration": { - "id": 39419, + "id": 269, "name": "__type", "variant": "declaration", "kind": 65536, @@ -57812,12 +57828,12 @@ "fileName": "store/index.ts", "line": 1221, "character": 20, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1221" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1221" } ], "signatures": [ { - "id": 39420, + "id": 270, "name": "__type", "variant": "signature", "kind": 4096, @@ -57841,12 +57857,12 @@ "fileName": "store/index.ts", "line": 1221, "character": 20, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1221" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1221" } ], "parameters": [ { - "id": 39421, + "id": 271, "name": "id", "variant": "param", "kind": 32768, @@ -57865,7 +57881,7 @@ } }, { - "id": 39422, + "id": 272, "name": "body", "variant": "param", "kind": 32768, @@ -57889,7 +57905,7 @@ } }, { - "id": 39423, + "id": 273, "name": "query", "variant": "param", "kind": 32768, @@ -57915,7 +57931,7 @@ } }, { - "id": 39424, + "id": 274, "name": "headers", "variant": "param", "kind": 32768, @@ -57932,7 +57948,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -57965,7 +57981,7 @@ "defaultValue": "..." }, { - "id": 39425, + "id": 275, "name": "declineTransfer", "variant": "declaration", "kind": 1024, @@ -57994,13 +58010,13 @@ "fileName": "store/index.ts", "line": 1260, "character": 4, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1260" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1260" } ], "type": { "type": "reflection", "declaration": { - "id": 39426, + "id": 276, "name": "__type", "variant": "declaration", "kind": 65536, @@ -58010,12 +58026,12 @@ "fileName": "store/index.ts", "line": 1260, "character": 21, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1260" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1260" } ], "signatures": [ { - "id": 39427, + "id": 277, "name": "__type", "variant": "signature", "kind": 4096, @@ -58039,12 +58055,12 @@ "fileName": "store/index.ts", "line": 1260, "character": 21, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1260" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1260" } ], "parameters": [ { - "id": 39428, + "id": 278, "name": "id", "variant": "param", "kind": 32768, @@ -58063,7 +58079,7 @@ } }, { - "id": 39429, + "id": 279, "name": "body", "variant": "param", "kind": 32768, @@ -58087,7 +58103,7 @@ } }, { - "id": 39430, + "id": 280, "name": "query", "variant": "param", "kind": 32768, @@ -58113,7 +58129,7 @@ } }, { - "id": 39431, + "id": 281, "name": "headers", "variant": "param", "kind": 32768, @@ -58130,7 +58146,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -58167,12 +58183,12 @@ { "title": "Properties", "children": [ - 39392, - 39397, - 39405, - 39412, - 39418, - 39425 + 242, + 247, + 255, + 262, + 268, + 275 ] } ], @@ -58181,7 +58197,7 @@ "fileName": "store/index.ts", "line": 1015, "character": 17, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1015" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1015" } ] } @@ -58189,7 +58205,7 @@ "defaultValue": "..." }, { - "id": 39432, + "id": 282, "name": "customer", "variant": "declaration", "kind": 1024, @@ -58215,20 +58231,20 @@ "fileName": "store/index.ts", "line": 1281, "character": 9, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1281" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1281" } ], "type": { "type": "reflection", "declaration": { - "id": 39433, + "id": 283, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 39434, + "id": 284, "name": "create", "variant": "declaration", "kind": 1024, @@ -58274,13 +58290,13 @@ "fileName": "store/index.ts", "line": 1315, "character": 4, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1315" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1315" } ], "type": { "type": "reflection", "declaration": { - "id": 39435, + "id": 285, "name": "__type", "variant": "declaration", "kind": 65536, @@ -58290,12 +58306,12 @@ "fileName": "store/index.ts", "line": 1315, "character": 12, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1315" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1315" } ], "signatures": [ { - "id": 39436, + "id": 286, "name": "__type", "variant": "signature", "kind": 4096, @@ -58319,12 +58335,12 @@ "fileName": "store/index.ts", "line": 1315, "character": 12, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1315" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1315" } ], "parameters": [ { - "id": 39437, + "id": 287, "name": "body", "variant": "param", "kind": 32768, @@ -58348,7 +58364,7 @@ } }, { - "id": 39438, + "id": 288, "name": "query", "variant": "param", "kind": 32768, @@ -58374,7 +58390,7 @@ } }, { - "id": 39439, + "id": 289, "name": "headers", "variant": "param", "kind": 32768, @@ -58391,7 +58407,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -58424,7 +58440,7 @@ "defaultValue": "..." }, { - "id": 39440, + "id": 290, "name": "update", "variant": "declaration", "kind": 1024, @@ -58462,13 +58478,13 @@ "fileName": "store/index.ts", "line": 1352, "character": 4, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1352" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1352" } ], "type": { "type": "reflection", "declaration": { - "id": 39441, + "id": 291, "name": "__type", "variant": "declaration", "kind": 65536, @@ -58478,12 +58494,12 @@ "fileName": "store/index.ts", "line": 1352, "character": 12, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1352" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1352" } ], "signatures": [ { - "id": 39442, + "id": 292, "name": "__type", "variant": "signature", "kind": 4096, @@ -58507,12 +58523,12 @@ "fileName": "store/index.ts", "line": 1352, "character": 12, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1352" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1352" } ], "parameters": [ { - "id": 39443, + "id": 293, "name": "body", "variant": "param", "kind": 32768, @@ -58536,7 +58552,7 @@ } }, { - "id": 39444, + "id": 294, "name": "query", "variant": "param", "kind": 32768, @@ -58562,7 +58578,7 @@ } }, { - "id": 39445, + "id": 295, "name": "headers", "variant": "param", "kind": 32768, @@ -58579,7 +58595,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -58612,7 +58628,7 @@ "defaultValue": "..." }, { - "id": 39446, + "id": 296, "name": "retrieve", "variant": "declaration", "kind": 1024, @@ -58650,13 +58666,13 @@ "fileName": "store/index.ts", "line": 1384, "character": 4, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1384" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1384" } ], "type": { "type": "reflection", "declaration": { - "id": 39447, + "id": 297, "name": "__type", "variant": "declaration", "kind": 65536, @@ -58666,12 +58682,12 @@ "fileName": "store/index.ts", "line": 1384, "character": 14, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1384" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1384" } ], "signatures": [ { - "id": 39448, + "id": 298, "name": "__type", "variant": "signature", "kind": 4096, @@ -58695,12 +58711,12 @@ "fileName": "store/index.ts", "line": 1384, "character": 14, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1384" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1384" } ], "parameters": [ { - "id": 39449, + "id": 299, "name": "query", "variant": "param", "kind": 32768, @@ -58726,7 +58742,7 @@ } }, { - "id": 39450, + "id": 300, "name": "headers", "variant": "param", "kind": 32768, @@ -58743,7 +58759,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -58776,7 +58792,7 @@ "defaultValue": "..." }, { - "id": 39451, + "id": 301, "name": "createAddress", "variant": "declaration", "kind": 1024, @@ -58814,13 +58830,13 @@ "fileName": "store/index.ts", "line": 1415, "character": 4, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1415" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1415" } ], "type": { "type": "reflection", "declaration": { - "id": 39452, + "id": 302, "name": "__type", "variant": "declaration", "kind": 65536, @@ -58830,12 +58846,12 @@ "fileName": "store/index.ts", "line": 1415, "character": 19, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1415" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1415" } ], "signatures": [ { - "id": 39453, + "id": 303, "name": "__type", "variant": "signature", "kind": 4096, @@ -58859,12 +58875,12 @@ "fileName": "store/index.ts", "line": 1415, "character": 19, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1415" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1415" } ], "parameters": [ { - "id": 39454, + "id": 304, "name": "body", "variant": "param", "kind": 32768, @@ -58888,7 +58904,7 @@ } }, { - "id": 39455, + "id": 305, "name": "query", "variant": "param", "kind": 32768, @@ -58914,7 +58930,7 @@ } }, { - "id": 39456, + "id": 306, "name": "headers", "variant": "param", "kind": 32768, @@ -58931,7 +58947,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -58964,7 +58980,7 @@ "defaultValue": "..." }, { - "id": 39457, + "id": 307, "name": "updateAddress", "variant": "declaration", "kind": 1024, @@ -59002,13 +59018,13 @@ "fileName": "store/index.ts", "line": 1456, "character": 4, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1456" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1456" } ], "type": { "type": "reflection", "declaration": { - "id": 39458, + "id": 308, "name": "__type", "variant": "declaration", "kind": 65536, @@ -59018,12 +59034,12 @@ "fileName": "store/index.ts", "line": 1456, "character": 19, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1456" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1456" } ], "signatures": [ { - "id": 39459, + "id": 309, "name": "__type", "variant": "signature", "kind": 4096, @@ -59047,12 +59063,12 @@ "fileName": "store/index.ts", "line": 1456, "character": 19, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1456" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1456" } ], "parameters": [ { - "id": 39460, + "id": 310, "name": "addressId", "variant": "param", "kind": 32768, @@ -59071,7 +59087,7 @@ } }, { - "id": 39461, + "id": 311, "name": "body", "variant": "param", "kind": 32768, @@ -59095,7 +59111,7 @@ } }, { - "id": 39462, + "id": 312, "name": "query", "variant": "param", "kind": 32768, @@ -59121,7 +59137,7 @@ } }, { - "id": 39463, + "id": 313, "name": "headers", "variant": "param", "kind": 32768, @@ -59138,7 +59154,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -59171,7 +59187,7 @@ "defaultValue": "..." }, { - "id": 39464, + "id": 314, "name": "listAddress", "variant": "declaration", "kind": 1024, @@ -59265,13 +59281,13 @@ "fileName": "store/index.ts", "line": 1523, "character": 4, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1523" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1523" } ], "type": { "type": "reflection", "declaration": { - "id": 39465, + "id": 315, "name": "__type", "variant": "declaration", "kind": 65536, @@ -59281,12 +59297,12 @@ "fileName": "store/index.ts", "line": 1523, "character": 17, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1523" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1523" } ], "signatures": [ { - "id": 39466, + "id": 316, "name": "__type", "variant": "signature", "kind": 4096, @@ -59310,12 +59326,12 @@ "fileName": "store/index.ts", "line": 1523, "character": 17, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1523" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1523" } ], "parameters": [ { - "id": 39467, + "id": 317, "name": "query", "variant": "param", "kind": 32768, @@ -59355,7 +59371,7 @@ } }, { - "id": 39468, + "id": 318, "name": "headers", "variant": "param", "kind": 32768, @@ -59372,7 +59388,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -59405,7 +59421,7 @@ "defaultValue": "..." }, { - "id": 39469, + "id": 319, "name": "retrieveAddress", "variant": "declaration", "kind": 1024, @@ -59467,13 +59483,13 @@ "fileName": "store/index.ts", "line": 1577, "character": 4, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1577" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1577" } ], "type": { "type": "reflection", "declaration": { - "id": 39470, + "id": 320, "name": "__type", "variant": "declaration", "kind": 65536, @@ -59483,12 +59499,12 @@ "fileName": "store/index.ts", "line": 1577, "character": 21, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1577" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1577" } ], "signatures": [ { - "id": 39471, + "id": 321, "name": "__type", "variant": "signature", "kind": 4096, @@ -59512,12 +59528,12 @@ "fileName": "store/index.ts", "line": 1577, "character": 21, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1577" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1577" } ], "parameters": [ { - "id": 39472, + "id": 322, "name": "addressId", "variant": "param", "kind": 32768, @@ -59536,7 +59552,7 @@ } }, { - "id": 39473, + "id": 323, "name": "query", "variant": "param", "kind": 32768, @@ -59562,7 +59578,7 @@ } }, { - "id": 39474, + "id": 324, "name": "headers", "variant": "param", "kind": 32768, @@ -59579,7 +59595,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -59612,7 +59628,7 @@ "defaultValue": "..." }, { - "id": 39475, + "id": 325, "name": "deleteAddress", "variant": "declaration", "kind": 1024, @@ -59650,13 +59666,13 @@ "fileName": "store/index.ts", "line": 1609, "character": 4, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1609" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1609" } ], "type": { "type": "reflection", "declaration": { - "id": 39476, + "id": 326, "name": "__type", "variant": "declaration", "kind": 65536, @@ -59666,12 +59682,12 @@ "fileName": "store/index.ts", "line": 1609, "character": 19, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1609" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1609" } ], "signatures": [ { - "id": 39477, + "id": 327, "name": "__type", "variant": "signature", "kind": 4096, @@ -59695,12 +59711,12 @@ "fileName": "store/index.ts", "line": 1609, "character": 19, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1609" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1609" } ], "parameters": [ { - "id": 39478, + "id": 328, "name": "addressId", "variant": "param", "kind": 32768, @@ -59719,7 +59735,7 @@ } }, { - "id": 39479, + "id": 329, "name": "headers", "variant": "param", "kind": 32768, @@ -59736,7 +59752,7 @@ }, "type": { "type": "reference", - "target": 41212, + "target": 2062, "name": "ClientHeaders", "package": "@medusajs/js-sdk" } @@ -59773,14 +59789,14 @@ { "title": "Properties", "children": [ - 39434, - 39440, - 39446, - 39451, - 39457, - 39464, - 39469, - 39475 + 284, + 290, + 296, + 301, + 307, + 314, + 319, + 325 ] } ], @@ -59789,7 +59805,7 @@ "fileName": "store/index.ts", "line": 1281, "character": 20, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1281" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1281" } ] } @@ -59801,15 +59817,15 @@ { "title": "Properties", "children": [ - 39249, - 39262, - 39275, - 39288, - 39301, - 39362, - 39376, - 39390, - 39432 + 99, + 112, + 125, + 138, + 151, + 212, + 226, + 240, + 282 ] } ], @@ -59818,7 +59834,7 @@ "fileName": "store/index.ts", "line": 5, "character": 13, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L5" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L5" } ] } @@ -59827,7 +59843,7 @@ { "title": "Classes", "children": [ - 39244 + 94 ] } ], @@ -59836,7 +59852,7 @@ "fileName": "store/index.ts", "line": 1, "character": 0, - "url": "https://github.com/medusajs/medusa/blob/9e410be04a62c50f8ca8cd772f567640c60a3d0e/packages/core/js-sdk/src/store/index.ts#L1" + "url": "https://github.com/medusajs/medusa/blob/16d7294de805e314f36b302c7b3bbdb126ae5c96/packages/core/js-sdk/src/store/index.ts#L1" } ] } @@ -59845,8507 +59861,8507 @@ { "title": "Modules", "children": [ - 39151, - 39198, - 39243 + 1, + 48, + 93 ] } ], "packageName": "@medusajs/js-sdk", "symbolIdMap": { - "39151": { + "1": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "" }, - "39152": { + "2": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin" }, - "39153": { + "3": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.__constructor" }, - "39154": { + "4": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin" }, - "39155": { + "5": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "client" }, - "39156": { + "6": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.invite" }, - "39157": { + "7": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.customer" }, - "39158": { + "8": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.productCollection" }, - "39159": { + "9": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.productCategory" }, - "39160": { + "10": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.priceList" }, - "39161": { + "11": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.pricePreference" }, - "39162": { + "12": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.product" }, - "39163": { + "13": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.productType" }, - "39164": { + "14": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.upload" }, - "39165": { + "15": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.region" }, - "39166": { + "16": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.returnReason" }, - "39167": { + "17": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.stockLocation" }, - "39168": { + "18": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.salesChannel" }, - "39169": { + "19": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.fulfillmentSet" }, - "39170": { + "20": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.fulfillment" }, - "39171": { + "21": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.fulfillmentProvider" }, - "39172": { + "22": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.shippingOption" }, - "39173": { + "23": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.shippingProfile" }, - "39174": { + "24": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.inventoryItem" }, - "39175": { + "25": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.notification" }, - "39176": { + "26": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.order" }, - "39177": { + "27": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.draftOrder" }, - "39178": { + "28": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.orderEdit" }, - "39179": { + "29": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.return" }, - "39180": { + "30": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.claim" }, - "39181": { + "31": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.exchange" }, - "39182": { + "32": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.taxRate" }, - "39183": { + "33": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.taxRegion" }, - "39184": { + "34": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.store" }, - "39185": { + "35": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.productTag" }, - "39186": { + "36": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.user" }, - "39187": { + "37": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.currency" }, - "39188": { + "38": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.payment" }, - "39189": { + "39": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.productVariant" }, - "39190": { + "40": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.refundReason" }, - "39191": { + "41": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.paymentCollection" }, - "39192": { + "42": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.apiKey" }, - "39193": { + "43": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.workflowExecution" }, - "39194": { + "44": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.reservation" }, - "39195": { + "45": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.customerGroup" }, - "39196": { + "46": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.promotion" }, - "39197": { + "47": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/index.ts", "qualifiedName": "Admin.campaign" }, - "39198": { + "48": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "" }, - "39199": { + "49": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "Auth" }, - "39200": { + "50": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "Auth.__constructor" }, - "39201": { + "51": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "Auth" }, - "39202": { + "52": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "client" }, - "39203": { + "53": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "config" }, - "39206": { + "56": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "Auth.register" }, - "39207": { + "57": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "Auth.register" }, - "39208": { + "58": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "actor" }, - "39209": { + "59": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "method" }, - "39210": { + "60": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "payload" }, - "39211": { + "61": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "Auth.login" }, - "39212": { + "62": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "Auth.login" }, - "39213": { + "63": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "actor" }, - "39214": { + "64": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "method" }, - "39215": { + "65": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "payload" }, - "39216": { + "66": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "__object" }, - "39217": { + "67": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "__object.location" }, - "39218": { + "68": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "Auth.callback" }, - "39219": { + "69": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "Auth.callback" }, - "39220": { + "70": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "actor" }, - "39221": { + "71": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "method" }, - "39222": { + "72": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "query" }, - "39223": { + "73": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "Auth.refresh" }, - "39224": { + "74": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "Auth.refresh" }, - "39225": { + "75": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "Auth.logout" }, - "39226": { + "76": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "Auth.logout" }, - "39227": { + "77": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "Auth.resetPassword" }, - "39228": { + "78": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "Auth.resetPassword" }, - "39229": { + "79": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "actor" }, - "39230": { + "80": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "provider" }, - "39231": { + "81": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "body" }, - "39232": { + "82": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "__type" }, - "39233": { + "83": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "__type.identifier" }, - "39234": { + "84": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "Auth.updateProvider" }, - "39235": { + "85": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "Auth.updateProvider" }, - "39236": { + "86": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "actor" }, - "39237": { + "87": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "provider" }, - "39238": { + "88": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "body" }, - "39239": { + "89": { "sourceFileName": "../../../../packages/core/js-sdk/src/auth/index.ts", "qualifiedName": "token" }, - "39243": { + "93": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "" }, - "39244": { + "94": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "Store" }, - "39249": { + "99": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "Store.region" }, - "39250": { + "100": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object" }, - "39251": { + "101": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object.list" }, - "39252": { + "102": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39253": { + "103": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39254": { + "104": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "query" }, - "39255": { + "105": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "headers" }, - "39256": { + "106": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object.retrieve" }, - "39257": { + "107": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39258": { + "108": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39259": { + "109": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "id" }, - "39260": { + "110": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "query" }, - "39261": { + "111": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "headers" }, - "39262": { + "112": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "Store.collection" }, - "39263": { + "113": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object" }, - "39264": { + "114": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object.list" }, - "39265": { + "115": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39266": { + "116": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39267": { + "117": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "query" }, - "39268": { + "118": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "headers" }, - "39269": { + "119": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object.retrieve" }, - "39270": { + "120": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39271": { + "121": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39272": { + "122": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "id" }, - "39273": { + "123": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "query" }, - "39274": { + "124": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "headers" }, - "39275": { + "125": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "Store.category" }, - "39276": { + "126": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object" }, - "39277": { + "127": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object.list" }, - "39278": { + "128": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39279": { + "129": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39280": { + "130": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "query" }, - "39281": { + "131": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "headers" }, - "39282": { + "132": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object.retrieve" }, - "39283": { + "133": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39284": { + "134": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39285": { + "135": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "id" }, - "39286": { + "136": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "query" }, - "39287": { + "137": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "headers" }, - "39288": { + "138": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "Store.product" }, - "39289": { + "139": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object" }, - "39290": { + "140": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object.list" }, - "39291": { + "141": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39292": { + "142": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39293": { + "143": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "query" }, - "39294": { + "144": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "headers" }, - "39295": { + "145": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object.retrieve" }, - "39296": { + "146": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39297": { + "147": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39298": { + "148": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "id" }, - "39299": { + "149": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "query" }, - "39300": { + "150": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "headers" }, - "39301": { + "151": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "Store.cart" }, - "39302": { + "152": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object" }, - "39303": { + "153": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object.create" }, - "39304": { + "154": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39305": { + "155": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39306": { + "156": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "body" }, - "39307": { + "157": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "query" }, - "39308": { + "158": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "headers" }, - "39309": { + "159": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object.update" }, - "39310": { + "160": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39311": { + "161": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39312": { + "162": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "id" }, - "39313": { + "163": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "body" }, - "39314": { + "164": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "query" }, - "39315": { + "165": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "headers" }, - "39316": { + "166": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object.retrieve" }, - "39317": { + "167": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39318": { + "168": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39319": { + "169": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "id" }, - "39320": { + "170": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "query" }, - "39321": { + "171": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "headers" }, - "39322": { + "172": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object.createLineItem" }, - "39323": { + "173": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39324": { + "174": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39325": { + "175": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "cartId" }, - "39326": { + "176": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "body" }, - "39327": { + "177": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "query" }, - "39328": { + "178": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "headers" }, - "39329": { + "179": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object.updateLineItem" }, - "39330": { + "180": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39331": { + "181": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39332": { + "182": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "cartId" }, - "39333": { + "183": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "lineItemId" }, - "39334": { + "184": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "body" }, - "39335": { + "185": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "query" }, - "39336": { + "186": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "headers" }, - "39337": { + "187": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object.deleteLineItem" }, - "39338": { + "188": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39339": { + "189": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39340": { + "190": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "cartId" }, - "39341": { + "191": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "lineItemId" }, - "39342": { + "192": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "headers" }, - "39343": { + "193": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object.addShippingMethod" }, - "39344": { + "194": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39345": { + "195": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39346": { + "196": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "cartId" }, - "39347": { + "197": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "body" }, - "39348": { + "198": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "query" }, - "39349": { + "199": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "headers" }, - "39350": { + "200": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object.complete" }, - "39351": { + "201": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39352": { + "202": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39353": { + "203": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "cartId" }, - "39354": { + "204": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "query" }, - "39355": { + "205": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "headers" }, - "39356": { + "206": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object.transferCart" }, - "39357": { + "207": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39358": { + "208": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39359": { + "209": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "id" }, - "39360": { + "210": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "query" }, - "39361": { + "211": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "headers" }, - "39362": { + "212": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "Store.fulfillment" }, - "39363": { + "213": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object" }, - "39364": { + "214": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object.listCartOptions" }, - "39365": { + "215": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39366": { + "216": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39367": { + "217": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "query" }, - "39368": { + "218": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "headers" }, - "39369": { + "219": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object.calculate" }, - "39370": { + "220": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39371": { + "221": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39372": { + "222": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "id" }, - "39373": { + "223": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "body" }, - "39374": { + "224": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "query" }, - "39375": { + "225": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "headers" }, - "39376": { + "226": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "Store.payment" }, - "39377": { + "227": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object" }, - "39378": { + "228": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object.listPaymentProviders" }, - "39379": { + "229": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39380": { + "230": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39381": { + "231": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "query" }, - "39382": { + "232": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "headers" }, - "39383": { + "233": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object.initiatePaymentSession" }, - "39384": { + "234": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39385": { + "235": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39386": { + "236": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "cart" }, - "39387": { + "237": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "body" }, - "39388": { + "238": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "query" }, - "39389": { + "239": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "headers" }, - "39390": { + "240": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "Store.order" }, - "39391": { + "241": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object" }, - "39392": { + "242": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object.list" }, - "39393": { + "243": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39394": { + "244": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39395": { + "245": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "query" }, - "39396": { + "246": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "headers" }, - "39397": { + "247": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object.retrieve" }, - "39398": { + "248": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39399": { + "249": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39400": { + "250": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "id" }, - "39401": { + "251": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "query" }, - "39402": { + "252": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "headers" }, - "39403": { + "253": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__type" }, - "39404": { + "254": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__type.order" }, - "39405": { + "255": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object.requestTransfer" }, - "39406": { + "256": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39407": { + "257": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39408": { + "258": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "id" }, - "39409": { + "259": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "body" }, - "39410": { + "260": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "query" }, - "39411": { + "261": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "headers" }, - "39412": { + "262": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object.cancelTransfer" }, - "39413": { + "263": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39414": { + "264": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39415": { + "265": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "id" }, - "39416": { + "266": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "query" }, - "39417": { + "267": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "headers" }, - "39418": { + "268": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object.acceptTransfer" }, - "39419": { + "269": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39420": { + "270": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39421": { + "271": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "id" }, - "39422": { + "272": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "body" }, - "39423": { + "273": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "query" }, - "39424": { + "274": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "headers" }, - "39425": { + "275": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object.declineTransfer" }, - "39426": { + "276": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39427": { + "277": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39428": { + "278": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "id" }, - "39429": { + "279": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "body" }, - "39430": { + "280": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "query" }, - "39431": { + "281": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "headers" }, - "39432": { + "282": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "Store.customer" }, - "39433": { + "283": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object" }, - "39434": { + "284": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object.create" }, - "39435": { + "285": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39436": { + "286": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39437": { + "287": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "body" }, - "39438": { + "288": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "query" }, - "39439": { + "289": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "headers" }, - "39440": { + "290": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object.update" }, - "39441": { + "291": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39442": { + "292": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39443": { + "293": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "body" }, - "39444": { + "294": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "query" }, - "39445": { + "295": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "headers" }, - "39446": { + "296": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object.retrieve" }, - "39447": { + "297": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39448": { + "298": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39449": { + "299": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "query" }, - "39450": { + "300": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "headers" }, - "39451": { + "301": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object.createAddress" }, - "39452": { + "302": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39453": { + "303": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39454": { + "304": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "body" }, - "39455": { + "305": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "query" }, - "39456": { + "306": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "headers" }, - "39457": { + "307": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object.updateAddress" }, - "39458": { + "308": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39459": { + "309": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39460": { + "310": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "addressId" }, - "39461": { + "311": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "body" }, - "39462": { + "312": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "query" }, - "39463": { + "313": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "headers" }, - "39464": { + "314": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object.listAddress" }, - "39465": { + "315": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39466": { + "316": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39467": { + "317": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "query" }, - "39468": { + "318": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "headers" }, - "39469": { + "319": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object.retrieveAddress" }, - "39470": { + "320": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39471": { + "321": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39472": { + "322": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "addressId" }, - "39473": { + "323": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "query" }, - "39474": { + "324": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "headers" }, - "39475": { + "325": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__object.deleteAddress" }, - "39476": { + "326": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39477": { + "327": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "__function" }, - "39478": { + "328": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "addressId" }, - "39479": { + "329": { "sourceFileName": "../../../../packages/core/js-sdk/src/store/index.ts", "qualifiedName": "headers" }, - "39480": { + "330": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", "qualifiedName": "Invite" }, - "39481": { + "331": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", "qualifiedName": "Invite.__constructor" }, - "39482": { + "332": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", "qualifiedName": "Invite" }, - "39483": { + "333": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", "qualifiedName": "client" }, - "39484": { + "334": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", "qualifiedName": "Invite.client" }, - "39485": { + "335": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", "qualifiedName": "Invite.accept" }, - "39486": { + "336": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", "qualifiedName": "Invite.accept" }, - "39487": { + "337": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", "qualifiedName": "input" }, - "39488": { + "338": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", "qualifiedName": "__type" }, - "39489": { + "339": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", "qualifiedName": "__type.invite_token" }, - "39490": { + "340": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", "qualifiedName": "query" }, - "39491": { + "341": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", "qualifiedName": "headers" }, - "39492": { + "342": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", "qualifiedName": "Invite.create" }, - "39493": { + "343": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", "qualifiedName": "Invite.create" }, - "39494": { + "344": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", "qualifiedName": "body" }, - "39495": { + "345": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", "qualifiedName": "query" }, - "39496": { + "346": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", "qualifiedName": "headers" }, - "39497": { + "347": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", "qualifiedName": "Invite.retrieve" }, - "39498": { + "348": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", "qualifiedName": "Invite.retrieve" }, - "39499": { + "349": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", "qualifiedName": "id" }, - "39500": { + "350": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", "qualifiedName": "query" }, - "39501": { + "351": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", "qualifiedName": "headers" }, - "39502": { + "352": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", "qualifiedName": "Invite.list" }, - "39503": { + "353": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", "qualifiedName": "Invite.list" }, - "39504": { + "354": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", "qualifiedName": "queryParams" }, - "39505": { + "355": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", "qualifiedName": "headers" }, - "39506": { + "356": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", "qualifiedName": "Invite.resend" }, - "39507": { + "357": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", "qualifiedName": "Invite.resend" }, - "39508": { + "358": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", "qualifiedName": "id" }, - "39509": { + "359": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", "qualifiedName": "headers" }, - "39510": { + "360": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", "qualifiedName": "Invite.delete" }, - "39511": { + "361": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", "qualifiedName": "Invite.delete" }, - "39512": { + "362": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", "qualifiedName": "id" }, - "39513": { + "363": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/invite.ts", "qualifiedName": "headers" }, - "39514": { + "364": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", "qualifiedName": "Customer" }, - "39515": { + "365": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", "qualifiedName": "Customer.__constructor" }, - "39516": { + "366": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", "qualifiedName": "Customer" }, - "39517": { + "367": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", "qualifiedName": "client" }, - "39518": { + "368": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", "qualifiedName": "Customer.client" }, - "39519": { + "369": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", "qualifiedName": "Customer.create" }, - "39520": { + "370": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", "qualifiedName": "Customer.create" }, - "39521": { + "371": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", "qualifiedName": "body" }, - "39522": { + "372": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", "qualifiedName": "query" }, - "39523": { + "373": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", "qualifiedName": "headers" }, - "39524": { + "374": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", "qualifiedName": "Customer.update" }, - "39525": { + "375": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", "qualifiedName": "Customer.update" }, - "39526": { + "376": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", "qualifiedName": "id" }, - "39527": { + "377": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", "qualifiedName": "body" }, - "39528": { + "378": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", "qualifiedName": "query" }, - "39529": { + "379": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", "qualifiedName": "headers" }, - "39530": { + "380": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", "qualifiedName": "Customer.list" }, - "39531": { + "381": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", "qualifiedName": "Customer.list" }, - "39532": { + "382": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", "qualifiedName": "queryParams" }, - "39533": { + "383": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", "qualifiedName": "headers" }, - "39534": { + "384": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", "qualifiedName": "Customer.retrieve" }, - "39535": { + "385": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", "qualifiedName": "Customer.retrieve" }, - "39536": { + "386": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", "qualifiedName": "id" }, - "39537": { + "387": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", "qualifiedName": "query" }, - "39538": { + "388": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", "qualifiedName": "headers" }, - "39539": { + "389": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", "qualifiedName": "Customer.delete" }, - "39540": { + "390": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", "qualifiedName": "Customer.delete" }, - "39541": { + "391": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", "qualifiedName": "id" }, - "39542": { + "392": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", "qualifiedName": "headers" }, - "39543": { + "393": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", "qualifiedName": "Customer.batchCustomerGroups" }, - "39544": { + "394": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", "qualifiedName": "Customer.batchCustomerGroups" }, - "39545": { + "395": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", "qualifiedName": "id" }, - "39546": { + "396": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", "qualifiedName": "body" }, - "39547": { + "397": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer.ts", "qualifiedName": "headers" }, - "39548": { + "398": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", "qualifiedName": "ProductCollection" }, - "39549": { + "399": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", "qualifiedName": "ProductCollection.__constructor" }, - "39550": { + "400": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", "qualifiedName": "ProductCollection" }, - "39551": { + "401": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", "qualifiedName": "client" }, - "39552": { + "402": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", "qualifiedName": "ProductCollection.client" }, - "39553": { + "403": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", "qualifiedName": "ProductCollection.create" }, - "39554": { + "404": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", "qualifiedName": "ProductCollection.create" }, - "39555": { + "405": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", "qualifiedName": "body" }, - "39556": { + "406": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", "qualifiedName": "query" }, - "39557": { + "407": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", "qualifiedName": "headers" }, - "39558": { + "408": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", "qualifiedName": "ProductCollection.update" }, - "39559": { + "409": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", "qualifiedName": "ProductCollection.update" }, - "39560": { + "410": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", "qualifiedName": "id" }, - "39561": { + "411": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", "qualifiedName": "body" }, - "39562": { + "412": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", "qualifiedName": "query" }, - "39563": { + "413": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", "qualifiedName": "headers" }, - "39564": { + "414": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", "qualifiedName": "ProductCollection.list" }, - "39565": { + "415": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", "qualifiedName": "ProductCollection.list" }, - "39566": { + "416": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", "qualifiedName": "queryParams" }, - "39567": { + "417": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", "qualifiedName": "headers" }, - "39568": { + "418": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", "qualifiedName": "ProductCollection.retrieve" }, - "39569": { + "419": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", "qualifiedName": "ProductCollection.retrieve" }, - "39570": { + "420": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", "qualifiedName": "id" }, - "39571": { + "421": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", "qualifiedName": "query" }, - "39572": { + "422": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", "qualifiedName": "headers" }, - "39573": { + "423": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", "qualifiedName": "ProductCollection.delete" }, - "39574": { + "424": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", "qualifiedName": "ProductCollection.delete" }, - "39575": { + "425": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", "qualifiedName": "id" }, - "39576": { + "426": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", "qualifiedName": "headers" }, - "39577": { + "427": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", "qualifiedName": "ProductCollection.updateProducts" }, - "39578": { + "428": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", "qualifiedName": "ProductCollection.updateProducts" }, - "39579": { + "429": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", "qualifiedName": "id" }, - "39580": { + "430": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", "qualifiedName": "body" }, - "39581": { + "431": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-collection.ts", "qualifiedName": "headers" }, - "39582": { + "432": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", "qualifiedName": "ProductCategory" }, - "39583": { + "433": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", "qualifiedName": "ProductCategory.__constructor" }, - "39584": { + "434": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", "qualifiedName": "ProductCategory" }, - "39585": { + "435": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", "qualifiedName": "client" }, - "39586": { + "436": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", "qualifiedName": "ProductCategory.client" }, - "39587": { + "437": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", "qualifiedName": "ProductCategory.create" }, - "39588": { + "438": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", "qualifiedName": "ProductCategory.create" }, - "39589": { + "439": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", "qualifiedName": "body" }, - "39590": { + "440": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", "qualifiedName": "query" }, - "39591": { + "441": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", "qualifiedName": "headers" }, - "39592": { + "442": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", "qualifiedName": "ProductCategory.update" }, - "39593": { + "443": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", "qualifiedName": "ProductCategory.update" }, - "39594": { + "444": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", "qualifiedName": "id" }, - "39595": { + "445": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", "qualifiedName": "body" }, - "39596": { + "446": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", "qualifiedName": "query" }, - "39597": { + "447": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", "qualifiedName": "headers" }, - "39598": { + "448": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", "qualifiedName": "ProductCategory.list" }, - "39599": { + "449": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", "qualifiedName": "ProductCategory.list" }, - "39600": { + "450": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", "qualifiedName": "query" }, - "39601": { + "451": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", "qualifiedName": "headers" }, - "39602": { + "452": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", "qualifiedName": "ProductCategory.retrieve" }, - "39603": { + "453": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", "qualifiedName": "ProductCategory.retrieve" }, - "39604": { + "454": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", "qualifiedName": "id" }, - "39605": { + "455": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", "qualifiedName": "query" }, - "39606": { + "456": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", "qualifiedName": "headers" }, - "39607": { + "457": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", "qualifiedName": "ProductCategory.delete" }, - "39608": { + "458": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", "qualifiedName": "ProductCategory.delete" }, - "39609": { + "459": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", "qualifiedName": "id" }, - "39610": { + "460": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", "qualifiedName": "headers" }, - "39611": { + "461": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", "qualifiedName": "ProductCategory.updateProducts" }, - "39612": { + "462": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", "qualifiedName": "ProductCategory.updateProducts" }, - "39613": { + "463": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", "qualifiedName": "id" }, - "39614": { + "464": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", "qualifiedName": "body" }, - "39615": { + "465": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", "qualifiedName": "query" }, - "39616": { + "466": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-category.ts", "qualifiedName": "headers" }, - "39617": { + "467": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "PriceList" }, - "39618": { + "468": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "PriceList.__constructor" }, - "39619": { + "469": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "PriceList" }, - "39620": { + "470": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "client" }, - "39621": { + "471": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "PriceList.client" }, - "39622": { + "472": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "PriceList.retrieve" }, - "39623": { + "473": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "PriceList.retrieve" }, - "39624": { + "474": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "id" }, - "39625": { + "475": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "query" }, - "39626": { + "476": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "headers" }, - "39627": { + "477": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "PriceList.list" }, - "39628": { + "478": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "PriceList.list" }, - "39629": { + "479": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "query" }, - "39630": { + "480": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "headers" }, - "39631": { + "481": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "PriceList.create" }, - "39632": { + "482": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "PriceList.create" }, - "39633": { + "483": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "body" }, - "39634": { + "484": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "query" }, - "39635": { + "485": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "headers" }, - "39636": { + "486": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "PriceList.update" }, - "39637": { + "487": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "PriceList.update" }, - "39638": { + "488": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "id" }, - "39639": { + "489": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "body" }, - "39640": { + "490": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "query" }, - "39641": { + "491": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "headers" }, - "39642": { + "492": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "PriceList.delete" }, - "39643": { + "493": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "PriceList.delete" }, - "39644": { + "494": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "id" }, - "39645": { + "495": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "headers" }, - "39646": { + "496": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "PriceList.batchPrices" }, - "39647": { + "497": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "PriceList.batchPrices" }, - "39648": { + "498": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "id" }, - "39649": { + "499": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "body" }, - "39650": { + "500": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "query" }, - "39651": { + "501": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "headers" }, - "39652": { + "502": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "PriceList.linkProducts" }, - "39653": { + "503": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "PriceList.linkProducts" }, - "39654": { + "504": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "id" }, - "39655": { + "505": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "body" }, - "39656": { + "506": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "query" }, - "39657": { + "507": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-list.ts", "qualifiedName": "headers" }, - "39658": { + "508": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", "qualifiedName": "PricePreference" }, - "39659": { + "509": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", "qualifiedName": "PricePreference.__constructor" }, - "39660": { + "510": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", "qualifiedName": "PricePreference" }, - "39661": { + "511": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", "qualifiedName": "client" }, - "39662": { + "512": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", "qualifiedName": "PricePreference.client" }, - "39663": { + "513": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", "qualifiedName": "PricePreference.retrieve" }, - "39664": { + "514": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", "qualifiedName": "PricePreference.retrieve" }, - "39665": { + "515": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", "qualifiedName": "id" }, - "39666": { + "516": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", "qualifiedName": "query" }, - "39667": { + "517": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", "qualifiedName": "headers" }, - "39668": { + "518": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", "qualifiedName": "PricePreference.list" }, - "39669": { + "519": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", "qualifiedName": "PricePreference.list" }, - "39670": { + "520": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", "qualifiedName": "query" }, - "39671": { + "521": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", "qualifiedName": "headers" }, - "39672": { + "522": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", "qualifiedName": "PricePreference.create" }, - "39673": { + "523": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", "qualifiedName": "PricePreference.create" }, - "39674": { + "524": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", "qualifiedName": "body" }, - "39675": { + "525": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", "qualifiedName": "query" }, - "39676": { + "526": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", "qualifiedName": "headers" }, - "39677": { + "527": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", "qualifiedName": "PricePreference.update" }, - "39678": { + "528": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", "qualifiedName": "PricePreference.update" }, - "39679": { + "529": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", "qualifiedName": "id" }, - "39680": { + "530": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", "qualifiedName": "body" }, - "39681": { + "531": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", "qualifiedName": "query" }, - "39682": { + "532": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", "qualifiedName": "headers" }, - "39683": { + "533": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", "qualifiedName": "PricePreference.delete" }, - "39684": { + "534": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", "qualifiedName": "PricePreference.delete" }, - "39685": { + "535": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", "qualifiedName": "id" }, - "39686": { + "536": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/price-preference.ts", "qualifiedName": "headers" }, - "39687": { + "537": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product" }, - "39688": { + "538": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.__constructor" }, - "39689": { + "539": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product" }, - "39690": { + "540": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "client" }, - "39691": { + "541": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.client" }, - "39692": { + "542": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.import" }, - "39693": { + "543": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.import" }, - "39694": { + "544": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "body" }, - "39695": { + "545": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "query" }, - "39696": { + "546": { "sourceFileName": "", "qualifiedName": "__type" }, - "39697": { + "547": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "headers" }, - "39698": { + "548": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.confirmImport" }, - "39699": { + "549": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.confirmImport" }, - "39700": { + "550": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "transactionId" }, - "39701": { + "551": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "query" }, - "39702": { + "552": { "sourceFileName": "", "qualifiedName": "__type" }, - "39703": { + "553": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "headers" }, - "39704": { + "554": { "sourceFileName": "", "qualifiedName": "__type" }, - "39705": { + "555": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.export" }, - "39706": { + "556": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.export" }, - "39707": { + "557": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "body" }, - "39708": { + "558": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "query" }, - "39709": { + "559": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "headers" }, - "39710": { + "560": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.batch" }, - "39711": { + "561": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.batch" }, - "39712": { + "562": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "body" }, - "39713": { + "563": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "query" }, - "39714": { + "564": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "headers" }, - "39715": { + "565": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.create" }, - "39716": { + "566": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.create" }, - "39717": { + "567": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "body" }, - "39718": { + "568": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "query" }, - "39719": { + "569": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "headers" }, - "39720": { + "570": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.update" }, - "39721": { + "571": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.update" }, - "39722": { + "572": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "id" }, - "39723": { + "573": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "body" }, - "39724": { + "574": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "query" }, - "39725": { + "575": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "headers" }, - "39726": { + "576": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.list" }, - "39727": { + "577": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.list" }, - "39728": { + "578": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "queryParams" }, - "39729": { + "579": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "headers" }, - "39730": { + "580": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.retrieve" }, - "39731": { + "581": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.retrieve" }, - "39732": { + "582": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "id" }, - "39733": { + "583": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "query" }, - "39734": { + "584": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "headers" }, - "39735": { + "585": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.delete" }, - "39736": { + "586": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.delete" }, - "39737": { + "587": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "id" }, - "39738": { + "588": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "headers" }, - "39739": { + "589": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.batchVariants" }, - "39740": { + "590": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.batchVariants" }, - "39741": { + "591": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "productId" }, - "39742": { + "592": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "body" }, - "39743": { + "593": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "query" }, - "39744": { + "594": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "headers" }, - "39745": { + "595": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.createVariant" }, - "39746": { + "596": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.createVariant" }, - "39747": { + "597": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "productId" }, - "39748": { + "598": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "body" }, - "39749": { + "599": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "query" }, - "39750": { + "600": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "headers" }, - "39751": { + "601": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.updateVariant" }, - "39752": { + "602": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.updateVariant" }, - "39753": { + "603": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "productId" }, - "39754": { + "604": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "id" }, - "39755": { + "605": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "body" }, - "39756": { + "606": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "query" }, - "39757": { + "607": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "headers" }, - "39758": { + "608": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.listVariants" }, - "39759": { + "609": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.listVariants" }, - "39760": { + "610": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "productId" }, - "39761": { + "611": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "query" }, - "39762": { + "612": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "headers" }, - "39763": { + "613": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.retrieveVariant" }, - "39764": { + "614": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.retrieveVariant" }, - "39765": { + "615": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "productId" }, - "39766": { + "616": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "id" }, - "39767": { + "617": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "query" }, - "39768": { + "618": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "headers" }, - "39769": { + "619": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.deleteVariant" }, - "39770": { + "620": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.deleteVariant" }, - "39771": { + "621": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "productId" }, - "39772": { + "622": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "id" }, - "39773": { + "623": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "headers" }, - "39774": { + "624": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.batchVariantInventoryItems" }, - "39775": { + "625": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.batchVariantInventoryItems" }, - "39776": { + "626": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "productId" }, - "39777": { + "627": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "body" }, - "39778": { + "628": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "query" }, - "39779": { + "629": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "headers" }, - "39780": { + "630": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.createOption" }, - "39781": { + "631": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.createOption" }, - "39782": { + "632": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "productId" }, - "39783": { + "633": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "body" }, - "39784": { + "634": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "query" }, - "39785": { + "635": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "headers" }, - "39786": { + "636": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.updateOption" }, - "39787": { + "637": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.updateOption" }, - "39788": { + "638": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "productId" }, - "39789": { + "639": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "id" }, - "39790": { + "640": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "body" }, - "39791": { + "641": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "query" }, - "39792": { + "642": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "headers" }, - "39793": { + "643": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.listOptions" }, - "39794": { + "644": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.listOptions" }, - "39795": { + "645": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "productId" }, - "39796": { + "646": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "query" }, - "39797": { + "647": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "headers" }, - "39798": { + "648": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.retrieveOption" }, - "39799": { + "649": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.retrieveOption" }, - "39800": { + "650": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "productId" }, - "39801": { + "651": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "id" }, - "39802": { + "652": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "query" }, - "39803": { + "653": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "headers" }, - "39804": { + "654": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.deleteOption" }, - "39805": { + "655": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "Product.deleteOption" }, - "39806": { + "656": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "productId" }, - "39807": { + "657": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "id" }, - "39808": { + "658": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product.ts", "qualifiedName": "headers" }, - "39809": { + "659": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", "qualifiedName": "ProductType" }, - "39810": { + "660": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", "qualifiedName": "ProductType.__constructor" }, - "39811": { + "661": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", "qualifiedName": "ProductType" }, - "39812": { + "662": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", "qualifiedName": "client" }, - "39813": { + "663": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", "qualifiedName": "ProductType.client" }, - "39814": { + "664": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", "qualifiedName": "ProductType.create" }, - "39815": { + "665": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", "qualifiedName": "ProductType.create" }, - "39816": { + "666": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", "qualifiedName": "body" }, - "39817": { + "667": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", "qualifiedName": "query" }, - "39818": { + "668": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", "qualifiedName": "headers" }, - "39819": { + "669": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", "qualifiedName": "ProductType.update" }, - "39820": { + "670": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", "qualifiedName": "ProductType.update" }, - "39821": { + "671": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", "qualifiedName": "id" }, - "39822": { + "672": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", "qualifiedName": "body" }, - "39823": { + "673": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", "qualifiedName": "query" }, - "39824": { + "674": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", "qualifiedName": "headers" }, - "39825": { + "675": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", "qualifiedName": "ProductType.list" }, - "39826": { + "676": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", "qualifiedName": "ProductType.list" }, - "39827": { + "677": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", "qualifiedName": "query" }, - "39828": { + "678": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", "qualifiedName": "headers" }, - "39829": { + "679": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", "qualifiedName": "ProductType.retrieve" }, - "39830": { + "680": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", "qualifiedName": "ProductType.retrieve" }, - "39831": { + "681": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", "qualifiedName": "id" }, - "39832": { + "682": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", "qualifiedName": "query" }, - "39833": { + "683": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", "qualifiedName": "headers" }, - "39834": { + "684": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", "qualifiedName": "ProductType.delete" }, - "39835": { + "685": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", "qualifiedName": "ProductType.delete" }, - "39836": { + "686": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", "qualifiedName": "id" }, - "39837": { + "687": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-type.ts", "qualifiedName": "headers" }, - "39838": { + "688": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", "qualifiedName": "Upload" }, - "39839": { + "689": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", "qualifiedName": "Upload.__constructor" }, - "39840": { + "690": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", "qualifiedName": "Upload" }, - "39841": { + "691": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", "qualifiedName": "client" }, - "39842": { + "692": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", "qualifiedName": "Upload.client" }, - "39843": { + "693": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", "qualifiedName": "Upload.create" }, - "39844": { + "694": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", "qualifiedName": "Upload.create" }, - "39845": { + "695": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", "qualifiedName": "body" }, - "39846": { + "696": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", "qualifiedName": "query" }, - "39847": { + "697": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", "qualifiedName": "headers" }, - "39848": { + "698": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", "qualifiedName": "__type" }, - "39849": { + "699": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", "qualifiedName": "__type.files" }, - "39850": { + "700": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", "qualifiedName": "Upload.retrieve" }, - "39851": { + "701": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", "qualifiedName": "Upload.retrieve" }, - "39852": { + "702": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", "qualifiedName": "id" }, - "39853": { + "703": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", "qualifiedName": "query" }, - "39854": { + "704": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", "qualifiedName": "headers" }, - "39855": { + "705": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", "qualifiedName": "__type" }, - "39856": { + "706": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", "qualifiedName": "__type.file" }, - "39857": { + "707": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", "qualifiedName": "Upload.delete" }, - "39858": { + "708": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", "qualifiedName": "Upload.delete" }, - "39859": { + "709": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", "qualifiedName": "id" }, - "39860": { + "710": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/upload.ts", "qualifiedName": "headers" }, - "39861": { + "711": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", "qualifiedName": "Region" }, - "39862": { + "712": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", "qualifiedName": "Region.__constructor" }, - "39863": { + "713": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", "qualifiedName": "Region" }, - "39864": { + "714": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", "qualifiedName": "client" }, - "39865": { + "715": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", "qualifiedName": "Region.client" }, - "39866": { + "716": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", "qualifiedName": "Region.create" }, - "39867": { + "717": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", "qualifiedName": "Region.create" }, - "39868": { + "718": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", "qualifiedName": "body" }, - "39869": { + "719": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", "qualifiedName": "query" }, - "39870": { + "720": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", "qualifiedName": "headers" }, - "39871": { + "721": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", "qualifiedName": "__type" }, - "39872": { + "722": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", "qualifiedName": "__type.region" }, - "39873": { + "723": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", "qualifiedName": "Region.update" }, - "39874": { + "724": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", "qualifiedName": "Region.update" }, - "39875": { + "725": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", "qualifiedName": "id" }, - "39876": { + "726": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", "qualifiedName": "body" }, - "39877": { + "727": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", "qualifiedName": "query" }, - "39878": { + "728": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", "qualifiedName": "headers" }, - "39879": { + "729": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", "qualifiedName": "__type" }, - "39880": { + "730": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", "qualifiedName": "__type.region" }, - "39881": { + "731": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", "qualifiedName": "Region.list" }, - "39882": { + "732": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", "qualifiedName": "Region.list" }, - "39883": { + "733": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", "qualifiedName": "queryParams" }, - "39884": { + "734": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", "qualifiedName": "headers" }, - "39885": { + "735": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", "qualifiedName": "__type" }, - "39886": { + "736": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", "qualifiedName": "__type.regions" }, - "39887": { + "737": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", "qualifiedName": "Region.retrieve" }, - "39888": { + "738": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", "qualifiedName": "Region.retrieve" }, - "39889": { + "739": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", "qualifiedName": "id" }, - "39890": { + "740": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", "qualifiedName": "query" }, - "39891": { + "741": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", "qualifiedName": "headers" }, - "39892": { + "742": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", "qualifiedName": "__type" }, - "39893": { + "743": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", "qualifiedName": "__type.region" }, - "39894": { + "744": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", "qualifiedName": "Region.delete" }, - "39895": { + "745": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", "qualifiedName": "Region.delete" }, - "39896": { + "746": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", "qualifiedName": "id" }, - "39897": { + "747": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/region.ts", "qualifiedName": "headers" }, - "39898": { + "748": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", "qualifiedName": "ReturnReason" }, - "39899": { + "749": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", "qualifiedName": "ReturnReason.__constructor" }, - "39900": { + "750": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", "qualifiedName": "ReturnReason" }, - "39901": { + "751": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", "qualifiedName": "client" }, - "39902": { + "752": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", "qualifiedName": "ReturnReason.client" }, - "39903": { + "753": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", "qualifiedName": "ReturnReason.list" }, - "39904": { + "754": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", "qualifiedName": "ReturnReason.list" }, - "39905": { + "755": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", "qualifiedName": "query" }, - "39906": { + "756": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", "qualifiedName": "headers" }, - "39907": { + "757": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", "qualifiedName": "ReturnReason.retrieve" }, - "39908": { + "758": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", "qualifiedName": "ReturnReason.retrieve" }, - "39909": { + "759": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", "qualifiedName": "id" }, - "39910": { + "760": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", "qualifiedName": "query" }, - "39911": { + "761": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", "qualifiedName": "headers" }, - "39912": { + "762": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", "qualifiedName": "ReturnReason.create" }, - "39913": { + "763": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", "qualifiedName": "ReturnReason.create" }, - "39914": { + "764": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", "qualifiedName": "body" }, - "39915": { + "765": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", "qualifiedName": "query" }, - "39916": { + "766": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", "qualifiedName": "headers" }, - "39917": { + "767": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", "qualifiedName": "ReturnReason.update" }, - "39918": { + "768": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", "qualifiedName": "ReturnReason.update" }, - "39919": { + "769": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", "qualifiedName": "id" }, - "39920": { + "770": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", "qualifiedName": "body" }, - "39921": { + "771": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", "qualifiedName": "query" }, - "39922": { + "772": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", "qualifiedName": "headers" }, - "39923": { + "773": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", "qualifiedName": "ReturnReason.delete" }, - "39924": { + "774": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", "qualifiedName": "ReturnReason.delete" }, - "39925": { + "775": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", "qualifiedName": "id" }, - "39926": { + "776": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", "qualifiedName": "query" }, - "39927": { + "777": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return-reason.ts", "qualifiedName": "headers" }, - "39928": { + "778": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "StockLocation" }, - "39929": { + "779": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "StockLocation.__constructor" }, - "39930": { + "780": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "StockLocation" }, - "39931": { + "781": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "client" }, - "39932": { + "782": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "StockLocation.client" }, - "39933": { + "783": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "StockLocation.create" }, - "39934": { + "784": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "StockLocation.create" }, - "39935": { + "785": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "body" }, - "39936": { + "786": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "query" }, - "39937": { + "787": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "headers" }, - "39938": { + "788": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "StockLocation.update" }, - "39939": { + "789": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "StockLocation.update" }, - "39940": { + "790": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "id" }, - "39941": { + "791": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "body" }, - "39942": { + "792": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "query" }, - "39943": { + "793": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "headers" }, - "39944": { + "794": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "StockLocation.delete" }, - "39945": { + "795": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "StockLocation.delete" }, - "39946": { + "796": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "id" }, - "39947": { + "797": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "headers" }, - "39948": { + "798": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "StockLocation.retrieve" }, - "39949": { + "799": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "StockLocation.retrieve" }, - "39950": { + "800": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "id" }, - "39951": { + "801": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "query" }, - "39952": { + "802": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "headers" }, - "39953": { + "803": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "StockLocation.list" }, - "39954": { + "804": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "StockLocation.list" }, - "39955": { + "805": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "query" }, - "39956": { + "806": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "headers" }, - "39957": { + "807": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "StockLocation.updateSalesChannels" }, - "39958": { + "808": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "StockLocation.updateSalesChannels" }, - "39959": { + "809": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "id" }, - "39960": { + "810": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "body" }, - "39961": { + "811": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "headers" }, - "39962": { + "812": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "StockLocation.createFulfillmentSet" }, - "39963": { + "813": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "StockLocation.createFulfillmentSet" }, - "39964": { + "814": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "id" }, - "39965": { + "815": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "body" }, - "39966": { + "816": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "headers" }, - "39967": { + "817": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "StockLocation.updateFulfillmentProviders" }, - "39968": { + "818": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "StockLocation.updateFulfillmentProviders" }, - "39969": { + "819": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "id" }, - "39970": { + "820": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "body" }, - "39971": { + "821": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/stock-location.ts", "qualifiedName": "headers" }, - "39972": { + "822": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "SalesChannel" }, - "39973": { + "823": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "SalesChannel.__constructor" }, - "39974": { + "824": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "SalesChannel" }, - "39975": { + "825": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "client" }, - "39976": { + "826": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "SalesChannel.client" }, - "39977": { + "827": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "SalesChannel.create" }, - "39978": { + "828": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "SalesChannel.create" }, - "39979": { + "829": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "body" }, - "39980": { + "830": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "query" }, - "39981": { + "831": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "headers" }, - "39982": { + "832": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "SalesChannel.update" }, - "39983": { + "833": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "SalesChannel.update" }, - "39984": { + "834": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "id" }, - "39985": { + "835": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "body" }, - "39986": { + "836": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "query" }, - "39987": { + "837": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "headers" }, - "39988": { + "838": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "SalesChannel.delete" }, - "39989": { + "839": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "SalesChannel.delete" }, - "39990": { + "840": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "id" }, - "39991": { + "841": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "headers" }, - "39992": { + "842": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "SalesChannel.retrieve" }, - "39993": { + "843": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "SalesChannel.retrieve" }, - "39994": { + "844": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "id" }, - "39995": { + "845": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "query" }, - "39996": { + "846": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "headers" }, - "39997": { + "847": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "SalesChannel.list" }, - "39998": { + "848": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "SalesChannel.list" }, - "39999": { + "849": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "query" }, - "40000": { + "850": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "headers" }, - "40001": { + "851": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "SalesChannel.updateProducts" }, - "40002": { + "852": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "SalesChannel.updateProducts" }, - "40003": { + "853": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "id" }, - "40004": { + "854": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "body" }, - "40005": { + "855": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "headers" }, - "40006": { + "856": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "SalesChannel.batchProducts" }, - "40007": { + "857": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "SalesChannel.batchProducts" }, - "40008": { + "858": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "id" }, - "40009": { + "859": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "body" }, - "40010": { + "860": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/sales-channel.ts", "qualifiedName": "headers" }, - "40011": { + "861": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", "qualifiedName": "FulfillmentSet" }, - "40012": { + "862": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", "qualifiedName": "FulfillmentSet.__constructor" }, - "40013": { + "863": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", "qualifiedName": "FulfillmentSet" }, - "40014": { + "864": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", "qualifiedName": "client" }, - "40015": { + "865": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", "qualifiedName": "FulfillmentSet.client" }, - "40016": { + "866": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", "qualifiedName": "FulfillmentSet.delete" }, - "40017": { + "867": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", "qualifiedName": "FulfillmentSet.delete" }, - "40018": { + "868": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", "qualifiedName": "id" }, - "40019": { + "869": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", "qualifiedName": "headers" }, - "40020": { + "870": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", "qualifiedName": "FulfillmentSet.createServiceZone" }, - "40021": { + "871": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", "qualifiedName": "FulfillmentSet.createServiceZone" }, - "40022": { + "872": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", "qualifiedName": "id" }, - "40023": { + "873": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", "qualifiedName": "body" }, - "40024": { + "874": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", "qualifiedName": "query" }, - "40025": { + "875": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", "qualifiedName": "headers" }, - "40026": { + "876": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", "qualifiedName": "FulfillmentSet.retrieveServiceZone" }, - "40027": { + "877": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", "qualifiedName": "FulfillmentSet.retrieveServiceZone" }, - "40028": { + "878": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", "qualifiedName": "fulfillmentSetId" }, - "40029": { + "879": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", "qualifiedName": "serviceZoneId" }, - "40030": { + "880": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", "qualifiedName": "query" }, - "40031": { + "881": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", "qualifiedName": "headers" }, - "40032": { + "882": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", "qualifiedName": "FulfillmentSet.updateServiceZone" }, - "40033": { + "883": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", "qualifiedName": "FulfillmentSet.updateServiceZone" }, - "40034": { + "884": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", "qualifiedName": "fulfillmentSetId" }, - "40035": { + "885": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", "qualifiedName": "serviceZoneId" }, - "40036": { + "886": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", "qualifiedName": "body" }, - "40037": { + "887": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", "qualifiedName": "query" }, - "40038": { + "888": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", "qualifiedName": "headers" }, - "40039": { + "889": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", "qualifiedName": "FulfillmentSet.deleteServiceZone" }, - "40040": { + "890": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", "qualifiedName": "FulfillmentSet.deleteServiceZone" }, - "40041": { + "891": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", "qualifiedName": "fulfillmentSetId" }, - "40042": { + "892": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", "qualifiedName": "serviceZoneId" }, - "40043": { + "893": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-set.ts", "qualifiedName": "headers" }, - "40044": { + "894": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", "qualifiedName": "Fulfillment" }, - "40045": { + "895": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", "qualifiedName": "Fulfillment.__constructor" }, - "40046": { + "896": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", "qualifiedName": "Fulfillment" }, - "40047": { + "897": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", "qualifiedName": "client" }, - "40048": { + "898": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", "qualifiedName": "Fulfillment.client" }, - "40049": { + "899": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", "qualifiedName": "Fulfillment.create" }, - "40050": { + "900": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", "qualifiedName": "Fulfillment.create" }, - "40051": { + "901": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", "qualifiedName": "body" }, - "40052": { + "902": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", "qualifiedName": "query" }, - "40053": { + "903": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", "qualifiedName": "headers" }, - "40054": { + "904": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", "qualifiedName": "Fulfillment.cancel" }, - "40055": { + "905": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", "qualifiedName": "Fulfillment.cancel" }, - "40056": { + "906": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", "qualifiedName": "id" }, - "40057": { + "907": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", "qualifiedName": "query" }, - "40058": { + "908": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", "qualifiedName": "headers" }, - "40059": { + "909": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", "qualifiedName": "Fulfillment.createShipment" }, - "40060": { + "910": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", "qualifiedName": "Fulfillment.createShipment" }, - "40061": { + "911": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", "qualifiedName": "id" }, - "40062": { + "912": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", "qualifiedName": "body" }, - "40063": { + "913": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", "qualifiedName": "query" }, - "40064": { + "914": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment.ts", "qualifiedName": "headers" }, - "40065": { + "915": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-provider.ts", "qualifiedName": "FulfillmentProvider" }, - "40066": { + "916": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-provider.ts", "qualifiedName": "FulfillmentProvider.__constructor" }, - "40067": { + "917": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-provider.ts", "qualifiedName": "FulfillmentProvider" }, - "40068": { + "918": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-provider.ts", "qualifiedName": "client" }, - "40069": { + "919": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-provider.ts", "qualifiedName": "FulfillmentProvider.client" }, - "40070": { + "920": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-provider.ts", "qualifiedName": "FulfillmentProvider.list" }, - "40071": { + "921": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-provider.ts", "qualifiedName": "FulfillmentProvider.list" }, - "40072": { + "922": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-provider.ts", "qualifiedName": "query" }, - "40073": { + "923": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-provider.ts", "qualifiedName": "headers" }, - "40074": { + "924": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-provider.ts", "qualifiedName": "FulfillmentProvider.listFulfillmentOptions" }, - "40075": { + "925": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-provider.ts", "qualifiedName": "FulfillmentProvider.listFulfillmentOptions" }, - "40076": { + "926": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-provider.ts", "qualifiedName": "id" }, - "40077": { + "927": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/fulfillment-provider.ts", "qualifiedName": "headers" }, - "40078": { + "928": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", "qualifiedName": "ShippingOption" }, - "40079": { + "929": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", "qualifiedName": "ShippingOption.__constructor" }, - "40080": { + "930": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", "qualifiedName": "ShippingOption" }, - "40081": { + "931": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", "qualifiedName": "client" }, - "40082": { + "932": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", "qualifiedName": "ShippingOption.client" }, - "40083": { + "933": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", "qualifiedName": "ShippingOption.create" }, - "40084": { + "934": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", "qualifiedName": "ShippingOption.create" }, - "40085": { + "935": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", "qualifiedName": "body" }, - "40086": { + "936": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", "qualifiedName": "query" }, - "40087": { + "937": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", "qualifiedName": "headers" }, - "40088": { + "938": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", "qualifiedName": "ShippingOption.retrieve" }, - "40089": { + "939": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", "qualifiedName": "ShippingOption.retrieve" }, - "40090": { + "940": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", "qualifiedName": "id" }, - "40091": { + "941": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", "qualifiedName": "query" }, - "40092": { + "942": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", "qualifiedName": "headers" }, - "40093": { + "943": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", "qualifiedName": "ShippingOption.update" }, - "40094": { + "944": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", "qualifiedName": "ShippingOption.update" }, - "40095": { + "945": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", "qualifiedName": "id" }, - "40096": { + "946": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", "qualifiedName": "body" }, - "40097": { + "947": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", "qualifiedName": "query" }, - "40098": { + "948": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", "qualifiedName": "headers" }, - "40099": { + "949": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", "qualifiedName": "ShippingOption.delete" }, - "40100": { + "950": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", "qualifiedName": "ShippingOption.delete" }, - "40101": { + "951": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", "qualifiedName": "id" }, - "40102": { + "952": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", "qualifiedName": "headers" }, - "40103": { + "953": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", "qualifiedName": "ShippingOption.list" }, - "40104": { + "954": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", "qualifiedName": "ShippingOption.list" }, - "40105": { + "955": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", "qualifiedName": "query" }, - "40106": { + "956": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", "qualifiedName": "headers" }, - "40107": { + "957": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", "qualifiedName": "ShippingOption.updateRules" }, - "40108": { + "958": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", "qualifiedName": "ShippingOption.updateRules" }, - "40109": { + "959": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", "qualifiedName": "id" }, - "40110": { + "960": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", "qualifiedName": "body" }, - "40111": { + "961": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-option.ts", "qualifiedName": "headers" }, - "40112": { + "962": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", "qualifiedName": "ShippingProfile" }, - "40113": { + "963": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", "qualifiedName": "ShippingProfile.__constructor" }, - "40114": { + "964": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", "qualifiedName": "ShippingProfile" }, - "40115": { + "965": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", "qualifiedName": "client" }, - "40116": { + "966": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", "qualifiedName": "ShippingProfile.client" }, - "40117": { + "967": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", "qualifiedName": "ShippingProfile.create" }, - "40118": { + "968": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", "qualifiedName": "ShippingProfile.create" }, - "40119": { + "969": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", "qualifiedName": "body" }, - "40120": { + "970": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", "qualifiedName": "query" }, - "40121": { + "971": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", "qualifiedName": "headers" }, - "40122": { + "972": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", "qualifiedName": "ShippingProfile.update" }, - "40123": { + "973": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", "qualifiedName": "ShippingProfile.update" }, - "40124": { + "974": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", "qualifiedName": "id" }, - "40125": { + "975": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", "qualifiedName": "body" }, - "40126": { + "976": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", "qualifiedName": "query" }, - "40127": { + "977": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", "qualifiedName": "headers" }, - "40128": { + "978": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", "qualifiedName": "ShippingProfile.delete" }, - "40129": { + "979": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", "qualifiedName": "ShippingProfile.delete" }, - "40130": { + "980": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", "qualifiedName": "id" }, - "40131": { + "981": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", "qualifiedName": "headers" }, - "40132": { + "982": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", "qualifiedName": "ShippingProfile.list" }, - "40133": { + "983": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", "qualifiedName": "ShippingProfile.list" }, - "40134": { + "984": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", "qualifiedName": "query" }, - "40135": { + "985": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", "qualifiedName": "headers" }, - "40136": { + "986": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", "qualifiedName": "ShippingProfile.retrieve" }, - "40137": { + "987": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", "qualifiedName": "ShippingProfile.retrieve" }, - "40138": { + "988": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", "qualifiedName": "id" }, - "40139": { + "989": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", "qualifiedName": "query" }, - "40140": { + "990": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/shipping-profile.ts", "qualifiedName": "headers" }, - "40141": { + "991": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "InventoryItem" }, - "40142": { + "992": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "InventoryItem.__constructor" }, - "40143": { + "993": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "InventoryItem" }, - "40144": { + "994": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "client" }, - "40145": { + "995": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "InventoryItem.client" }, - "40146": { + "996": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "InventoryItem.create" }, - "40147": { + "997": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "InventoryItem.create" }, - "40148": { + "998": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "body" }, - "40149": { + "999": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "query" }, - "40150": { + "1000": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "headers" }, - "40151": { + "1001": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "InventoryItem.update" }, - "40152": { + "1002": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "InventoryItem.update" }, - "40153": { + "1003": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "id" }, - "40154": { + "1004": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "body" }, - "40155": { + "1005": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "query" }, - "40156": { + "1006": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "headers" }, - "40157": { + "1007": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "InventoryItem.list" }, - "40158": { + "1008": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "InventoryItem.list" }, - "40159": { + "1009": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "query" }, - "40160": { + "1010": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "headers" }, - "40161": { + "1011": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "InventoryItem.retrieve" }, - "40162": { + "1012": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "InventoryItem.retrieve" }, - "40163": { + "1013": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "id" }, - "40164": { + "1014": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "query" }, - "40165": { + "1015": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "headers" }, - "40166": { + "1016": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "InventoryItem.delete" }, - "40167": { + "1017": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "InventoryItem.delete" }, - "40168": { + "1018": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "id" }, - "40169": { + "1019": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "headers" }, - "40170": { + "1020": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "InventoryItem.listLevels" }, - "40171": { + "1021": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "InventoryItem.listLevels" }, - "40172": { + "1022": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "id" }, - "40173": { + "1023": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "query" }, - "40174": { + "1024": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "headers" }, - "40175": { + "1025": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "InventoryItem.updateLevel" }, - "40176": { + "1026": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "InventoryItem.updateLevel" }, - "40177": { + "1027": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "id" }, - "40178": { + "1028": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "locationId" }, - "40179": { + "1029": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "body" }, - "40180": { + "1030": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "query" }, - "40181": { + "1031": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "headers" }, - "40182": { + "1032": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "InventoryItem.deleteLevel" }, - "40183": { + "1033": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "InventoryItem.deleteLevel" }, - "40184": { + "1034": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "id" }, - "40185": { + "1035": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "locationId" }, - "40186": { + "1036": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "headers" }, - "40187": { + "1037": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "InventoryItem.batchUpdateLevels" }, - "40188": { + "1038": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "InventoryItem.batchUpdateLevels" }, - "40189": { + "1039": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "id" }, - "40190": { + "1040": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "body" }, - "40191": { + "1041": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "query" }, - "40192": { + "1042": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "headers" }, - "40193": { + "1043": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "InventoryItem.batchInventoryItemLocationLevels" }, - "40194": { + "1044": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "InventoryItem.batchInventoryItemLocationLevels" }, - "40195": { + "1045": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "id" }, - "40196": { + "1046": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "body" }, - "40197": { + "1047": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "headers" }, - "40198": { + "1048": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "InventoryItem.batchInventoryItemsLocationLevels" }, - "40199": { + "1049": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "InventoryItem.batchInventoryItemsLocationLevels" }, - "40200": { + "1050": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "body" }, - "40201": { + "1051": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/inventory-item.ts", "qualifiedName": "headers" }, - "40202": { + "1052": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/notification.ts", "qualifiedName": "Notification" }, - "40203": { + "1053": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/notification.ts", "qualifiedName": "Notification.__constructor" }, - "40204": { + "1054": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/notification.ts", "qualifiedName": "Notification" }, - "40205": { + "1055": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/notification.ts", "qualifiedName": "client" }, - "40206": { + "1056": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/notification.ts", "qualifiedName": "Notification.client" }, - "40207": { + "1057": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/notification.ts", "qualifiedName": "Notification.retrieve" }, - "40208": { + "1058": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/notification.ts", "qualifiedName": "Notification.retrieve" }, - "40209": { + "1059": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/notification.ts", "qualifiedName": "id" }, - "40210": { + "1060": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/notification.ts", "qualifiedName": "query" }, - "40211": { + "1061": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/notification.ts", "qualifiedName": "headers" }, - "40212": { + "1062": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/notification.ts", "qualifiedName": "Notification.list" }, - "40213": { + "1063": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/notification.ts", "qualifiedName": "Notification.list" }, - "40214": { + "1064": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/notification.ts", "qualifiedName": "query" }, - "40215": { + "1065": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/notification.ts", "qualifiedName": "headers" }, - "40216": { + "1066": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "Order" }, - "40217": { + "1067": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "Order.__constructor" }, - "40218": { + "1068": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "Order" }, - "40219": { + "1069": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "client" }, - "40220": { + "1070": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "Order.client" }, - "40221": { + "1071": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "Order.retrieve" }, - "40222": { + "1072": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "Order.retrieve" }, - "40223": { + "1073": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "id" }, - "40224": { + "1074": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "query" }, - "40225": { + "1075": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "headers" }, - "40226": { + "1076": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "Order.update" }, - "40227": { + "1077": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "Order.update" }, - "40228": { + "1078": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "id" }, - "40229": { + "1079": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "body" }, - "40230": { + "1080": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "headers" }, - "40231": { + "1081": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "Order.retrievePreview" }, - "40232": { + "1082": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "Order.retrievePreview" }, - "40233": { + "1083": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "id" }, - "40234": { + "1084": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "query" }, - "40235": { + "1085": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "headers" }, - "40236": { + "1086": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "Order.list" }, - "40237": { + "1087": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "Order.list" }, - "40238": { + "1088": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "queryParams" }, - "40239": { + "1089": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "headers" }, - "40240": { + "1090": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "Order.cancel" }, - "40241": { + "1091": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "Order.cancel" }, - "40242": { + "1092": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "id" }, - "40243": { + "1093": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "headers" }, - "40244": { + "1094": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "Order.requestTransfer" }, - "40245": { + "1095": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "Order.requestTransfer" }, - "40246": { + "1096": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "id" }, - "40247": { + "1097": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "body" }, - "40248": { + "1098": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "headers" }, - "40249": { + "1099": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "Order.cancelTransfer" }, - "40250": { + "1100": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "Order.cancelTransfer" }, - "40251": { + "1101": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "id" }, - "40252": { + "1102": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "headers" }, - "40253": { + "1103": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "Order.createFulfillment" }, - "40254": { + "1104": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "Order.createFulfillment" }, - "40255": { + "1105": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "id" }, - "40256": { + "1106": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "body" }, - "40257": { + "1107": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "query" }, - "40258": { + "1108": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "headers" }, - "40259": { + "1109": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "Order.cancelFulfillment" }, - "40260": { + "1110": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "Order.cancelFulfillment" }, - "40261": { + "1111": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "id" }, - "40262": { + "1112": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "fulfillmentId" }, - "40263": { + "1113": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "body" }, - "40264": { + "1114": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "headers" }, - "40265": { + "1115": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "Order.createShipment" }, - "40266": { + "1116": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "Order.createShipment" }, - "40267": { + "1117": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "id" }, - "40268": { + "1118": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "fulfillmentId" }, - "40269": { + "1119": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "body" }, - "40270": { + "1120": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "query" }, - "40271": { + "1121": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "headers" }, - "40272": { + "1122": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "Order.markAsDelivered" }, - "40273": { + "1123": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "Order.markAsDelivered" }, - "40274": { + "1124": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "id" }, - "40275": { + "1125": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "fulfillmentId" }, - "40276": { + "1126": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "query" }, - "40277": { + "1127": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "headers" }, - "40278": { + "1128": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "Order.listChanges" }, - "40279": { + "1129": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "Order.listChanges" }, - "40280": { + "1130": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "id" }, - "40281": { + "1131": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "queryParams" }, - "40282": { + "1132": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "headers" }, - "40283": { + "1133": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "Order.listLineItems" }, - "40284": { + "1134": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "Order.listLineItems" }, - "40285": { + "1135": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "id" }, - "40286": { + "1136": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "queryParams" }, - "40287": { + "1137": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order.ts", "qualifiedName": "headers" }, - "40288": { + "1138": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/draft-order.ts", "qualifiedName": "DraftOrder" }, - "40289": { + "1139": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/draft-order.ts", "qualifiedName": "DraftOrder.__constructor" }, - "40290": { + "1140": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/draft-order.ts", "qualifiedName": "DraftOrder" }, - "40291": { + "1141": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/draft-order.ts", "qualifiedName": "client" }, - "40292": { + "1142": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/draft-order.ts", "qualifiedName": "DraftOrder.client" }, - "40293": { + "1143": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/draft-order.ts", "qualifiedName": "DraftOrder.retrieve" }, - "40294": { + "1144": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/draft-order.ts", "qualifiedName": "DraftOrder.retrieve" }, - "40295": { + "1145": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/draft-order.ts", "qualifiedName": "id" }, - "40296": { + "1146": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/draft-order.ts", "qualifiedName": "query" }, - "40297": { + "1147": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/draft-order.ts", "qualifiedName": "headers" }, - "40298": { + "1148": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/draft-order.ts", "qualifiedName": "DraftOrder.list" }, - "40299": { + "1149": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/draft-order.ts", "qualifiedName": "DraftOrder.list" }, - "40300": { + "1150": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/draft-order.ts", "qualifiedName": "queryParams" }, - "40301": { + "1151": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/draft-order.ts", "qualifiedName": "headers" }, - "40302": { + "1152": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/draft-order.ts", "qualifiedName": "DraftOrder.create" }, - "40303": { + "1153": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/draft-order.ts", "qualifiedName": "DraftOrder.create" }, - "40304": { + "1154": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/draft-order.ts", "qualifiedName": "body" }, - "40305": { + "1155": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/draft-order.ts", "qualifiedName": "query" }, - "40306": { + "1156": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/draft-order.ts", "qualifiedName": "headers" }, - "40307": { + "1157": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/draft-order.ts", "qualifiedName": "DraftOrder.update" }, - "40308": { + "1158": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/draft-order.ts", "qualifiedName": "DraftOrder.update" }, - "40309": { + "1159": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/draft-order.ts", "qualifiedName": "id" }, - "40310": { + "1160": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/draft-order.ts", "qualifiedName": "body" }, - "40311": { + "1161": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/draft-order.ts", "qualifiedName": "query" }, - "40312": { + "1162": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/draft-order.ts", "qualifiedName": "headers" }, - "40313": { + "1163": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "OrderEdit" }, - "40314": { + "1164": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "OrderEdit.__constructor" }, - "40315": { + "1165": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "OrderEdit" }, - "40316": { + "1166": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "client" }, - "40317": { + "1167": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "OrderEdit.client" }, - "40318": { + "1168": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "OrderEdit.initiateRequest" }, - "40319": { + "1169": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "OrderEdit.initiateRequest" }, - "40320": { + "1170": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "body" }, - "40321": { + "1171": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "query" }, - "40322": { + "1172": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "headers" }, - "40323": { + "1173": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "OrderEdit.request" }, - "40324": { + "1174": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "OrderEdit.request" }, - "40325": { + "1175": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "id" }, - "40326": { + "1176": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "query" }, - "40327": { + "1177": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "headers" }, - "40328": { + "1178": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "OrderEdit.confirm" }, - "40329": { + "1179": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "OrderEdit.confirm" }, - "40330": { + "1180": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "id" }, - "40331": { + "1181": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "query" }, - "40332": { + "1182": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "headers" }, - "40333": { + "1183": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "OrderEdit.cancelRequest" }, - "40334": { + "1184": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "OrderEdit.cancelRequest" }, - "40335": { + "1185": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "id" }, - "40336": { + "1186": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "query" }, - "40337": { + "1187": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "headers" }, - "40338": { + "1188": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "OrderEdit.addItems" }, - "40339": { + "1189": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "OrderEdit.addItems" }, - "40340": { + "1190": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "id" }, - "40341": { + "1191": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "body" }, - "40342": { + "1192": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "query" }, - "40343": { + "1193": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "headers" }, - "40344": { + "1194": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "OrderEdit.updateOriginalItem" }, - "40345": { + "1195": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "OrderEdit.updateOriginalItem" }, - "40346": { + "1196": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "id" }, - "40347": { + "1197": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "itemId" }, - "40348": { + "1198": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "body" }, - "40349": { + "1199": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "query" }, - "40350": { + "1200": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "headers" }, - "40351": { + "1201": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "OrderEdit.updateAddedItem" }, - "40352": { + "1202": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "OrderEdit.updateAddedItem" }, - "40353": { + "1203": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "id" }, - "40354": { + "1204": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "actionId" }, - "40355": { + "1205": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "body" }, - "40356": { + "1206": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "query" }, - "40357": { + "1207": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "headers" }, - "40358": { + "1208": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "OrderEdit.removeAddedItem" }, - "40359": { + "1209": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "OrderEdit.removeAddedItem" }, - "40360": { + "1210": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "id" }, - "40361": { + "1211": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "actionId" }, - "40362": { + "1212": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "query" }, - "40363": { + "1213": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/order-edit.ts", "qualifiedName": "headers" }, - "40364": { + "1214": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return" }, - "40365": { + "1215": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.__constructor" }, - "40366": { + "1216": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return" }, - "40367": { + "1217": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "client" }, - "40368": { + "1218": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.client" }, - "40369": { + "1219": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.list" }, - "40370": { + "1220": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.list" }, - "40371": { + "1221": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "query" }, - "40372": { + "1222": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "headers" }, - "40373": { + "1223": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.retrieve" }, - "40374": { + "1224": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.retrieve" }, - "40375": { + "1225": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "id" }, - "40376": { + "1226": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "query" }, - "40377": { + "1227": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "headers" }, - "40378": { + "1228": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.initiateRequest" }, - "40379": { + "1229": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.initiateRequest" }, - "40380": { + "1230": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "body" }, - "40381": { + "1231": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "query" }, - "40382": { + "1232": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "headers" }, - "40383": { + "1233": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.cancel" }, - "40384": { + "1234": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.cancel" }, - "40385": { + "1235": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "id" }, - "40386": { + "1236": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "query" }, - "40387": { + "1237": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "headers" }, - "40388": { + "1238": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.cancelRequest" }, - "40389": { + "1239": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.cancelRequest" }, - "40390": { + "1240": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "id" }, - "40391": { + "1241": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "query" }, - "40392": { + "1242": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "headers" }, - "40393": { + "1243": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.addReturnItem" }, - "40394": { + "1244": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.addReturnItem" }, - "40395": { + "1245": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "id" }, - "40396": { + "1246": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "body" }, - "40397": { + "1247": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "query" }, - "40398": { + "1248": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "headers" }, - "40399": { + "1249": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.updateReturnItem" }, - "40400": { + "1250": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.updateReturnItem" }, - "40401": { + "1251": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "id" }, - "40402": { + "1252": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "actionId" }, - "40403": { + "1253": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "body" }, - "40404": { + "1254": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "query" }, - "40405": { + "1255": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "headers" }, - "40406": { + "1256": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.removeReturnItem" }, - "40407": { + "1257": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.removeReturnItem" }, - "40408": { + "1258": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "id" }, - "40409": { + "1259": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "actionId" }, - "40410": { + "1260": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "query" }, - "40411": { + "1261": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "headers" }, - "40412": { + "1262": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.addReturnShipping" }, - "40413": { + "1263": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.addReturnShipping" }, - "40414": { + "1264": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "id" }, - "40415": { + "1265": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "body" }, - "40416": { + "1266": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "query" }, - "40417": { + "1267": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "headers" }, - "40418": { + "1268": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.updateReturnShipping" }, - "40419": { + "1269": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.updateReturnShipping" }, - "40420": { + "1270": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "id" }, - "40421": { + "1271": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "actionId" }, - "40422": { + "1272": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "body" }, - "40423": { + "1273": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "query" }, - "40424": { + "1274": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "headers" }, - "40425": { + "1275": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.deleteReturnShipping" }, - "40426": { + "1276": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.deleteReturnShipping" }, - "40427": { + "1277": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "id" }, - "40428": { + "1278": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "actionId" }, - "40429": { + "1279": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "query" }, - "40430": { + "1280": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "headers" }, - "40431": { + "1281": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.updateRequest" }, - "40432": { + "1282": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.updateRequest" }, - "40433": { + "1283": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "id" }, - "40434": { + "1284": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "body" }, - "40435": { + "1285": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "query" }, - "40436": { + "1286": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "headers" }, - "40437": { + "1287": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.confirmRequest" }, - "40438": { + "1288": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.confirmRequest" }, - "40439": { + "1289": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "id" }, - "40440": { + "1290": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "body" }, - "40441": { + "1291": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "query" }, - "40442": { + "1292": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "headers" }, - "40443": { + "1293": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.initiateReceive" }, - "40444": { + "1294": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.initiateReceive" }, - "40445": { + "1295": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "id" }, - "40446": { + "1296": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "body" }, - "40447": { + "1297": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "query" }, - "40448": { + "1298": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "headers" }, - "40449": { + "1299": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.receiveItems" }, - "40450": { + "1300": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.receiveItems" }, - "40451": { + "1301": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "id" }, - "40452": { + "1302": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "body" }, - "40453": { + "1303": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "query" }, - "40454": { + "1304": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "headers" }, - "40455": { + "1305": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.updateReceiveItem" }, - "40456": { + "1306": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.updateReceiveItem" }, - "40457": { + "1307": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "id" }, - "40458": { + "1308": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "actionId" }, - "40459": { + "1309": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "body" }, - "40460": { + "1310": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "query" }, - "40461": { + "1311": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "headers" }, - "40462": { + "1312": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.removeReceiveItem" }, - "40463": { + "1313": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.removeReceiveItem" }, - "40464": { + "1314": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "id" }, - "40465": { + "1315": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "actionId" }, - "40466": { + "1316": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "query" }, - "40467": { + "1317": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "headers" }, - "40468": { + "1318": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.dismissItems" }, - "40469": { + "1319": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.dismissItems" }, - "40470": { + "1320": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "id" }, - "40471": { + "1321": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "body" }, - "40472": { + "1322": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "query" }, - "40473": { + "1323": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "headers" }, - "40474": { + "1324": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.updateDismissItem" }, - "40475": { + "1325": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.updateDismissItem" }, - "40476": { + "1326": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "id" }, - "40477": { + "1327": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "actionId" }, - "40478": { + "1328": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "body" }, - "40479": { + "1329": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "query" }, - "40480": { + "1330": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "headers" }, - "40481": { + "1331": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.removeDismissItem" }, - "40482": { + "1332": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.removeDismissItem" }, - "40483": { + "1333": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "id" }, - "40484": { + "1334": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "actionId" }, - "40485": { + "1335": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "query" }, - "40486": { + "1336": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "headers" }, - "40487": { + "1337": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.confirmReceive" }, - "40488": { + "1338": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.confirmReceive" }, - "40489": { + "1339": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "id" }, - "40490": { + "1340": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "body" }, - "40491": { + "1341": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "query" }, - "40492": { + "1342": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "headers" }, - "40493": { + "1343": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.cancelReceive" }, - "40494": { + "1344": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "Return.cancelReceive" }, - "40495": { + "1345": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "id" }, - "40496": { + "1346": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "query" }, - "40497": { + "1347": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/return.ts", "qualifiedName": "headers" }, - "40498": { + "1348": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim" }, - "40499": { + "1349": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.__constructor" }, - "40500": { + "1350": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim" }, - "40501": { + "1351": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "client" }, - "40502": { + "1352": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.client" }, - "40503": { + "1353": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.list" }, - "40504": { + "1354": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.list" }, - "40505": { + "1355": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "query" }, - "40506": { + "1356": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "headers" }, - "40507": { + "1357": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.retrieve" }, - "40508": { + "1358": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.retrieve" }, - "40509": { + "1359": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "id" }, - "40510": { + "1360": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "query" }, - "40511": { + "1361": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "headers" }, - "40512": { + "1362": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.create" }, - "40513": { + "1363": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.create" }, - "40514": { + "1364": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "body" }, - "40515": { + "1365": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "query" }, - "40516": { + "1366": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "headers" }, - "40517": { + "1367": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.cancel" }, - "40518": { + "1368": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.cancel" }, - "40519": { + "1369": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "id" }, - "40520": { + "1370": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "query" }, - "40521": { + "1371": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "headers" }, - "40522": { + "1372": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.addItems" }, - "40523": { + "1373": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.addItems" }, - "40524": { + "1374": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "id" }, - "40525": { + "1375": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "body" }, - "40526": { + "1376": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "query" }, - "40527": { + "1377": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "headers" }, - "40528": { + "1378": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.updateItem" }, - "40529": { + "1379": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.updateItem" }, - "40530": { + "1380": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "id" }, - "40531": { + "1381": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "actionId" }, - "40532": { + "1382": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "body" }, - "40533": { + "1383": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "query" }, - "40534": { + "1384": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "headers" }, - "40535": { + "1385": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.removeItem" }, - "40536": { + "1386": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.removeItem" }, - "40537": { + "1387": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "id" }, - "40538": { + "1388": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "actionId" }, - "40539": { + "1389": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "query" }, - "40540": { + "1390": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "headers" }, - "40541": { + "1391": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.addInboundItems" }, - "40542": { + "1392": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.addInboundItems" }, - "40543": { + "1393": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "id" }, - "40544": { + "1394": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "body" }, - "40545": { + "1395": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "query" }, - "40546": { + "1396": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "headers" }, - "40547": { + "1397": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.updateInboundItem" }, - "40548": { + "1398": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.updateInboundItem" }, - "40549": { + "1399": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "id" }, - "40550": { + "1400": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "actionId" }, - "40551": { + "1401": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "body" }, - "40552": { + "1402": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "query" }, - "40553": { + "1403": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "headers" }, - "40554": { + "1404": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.removeInboundItem" }, - "40555": { + "1405": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.removeInboundItem" }, - "40556": { + "1406": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "id" }, - "40557": { + "1407": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "actionId" }, - "40558": { + "1408": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "query" }, - "40559": { + "1409": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "headers" }, - "40560": { + "1410": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.addInboundShipping" }, - "40561": { + "1411": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.addInboundShipping" }, - "40562": { + "1412": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "id" }, - "40563": { + "1413": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "body" }, - "40564": { + "1414": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "query" }, - "40565": { + "1415": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "headers" }, - "40566": { + "1416": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.updateInboundShipping" }, - "40567": { + "1417": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.updateInboundShipping" }, - "40568": { + "1418": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "id" }, - "40569": { + "1419": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "actionId" }, - "40570": { + "1420": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "body" }, - "40571": { + "1421": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "query" }, - "40572": { + "1422": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "headers" }, - "40573": { + "1423": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.deleteInboundShipping" }, - "40574": { + "1424": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.deleteInboundShipping" }, - "40575": { + "1425": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "id" }, - "40576": { + "1426": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "actionId" }, - "40577": { + "1427": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "query" }, - "40578": { + "1428": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "headers" }, - "40579": { + "1429": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.addOutboundItems" }, - "40580": { + "1430": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.addOutboundItems" }, - "40581": { + "1431": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "id" }, - "40582": { + "1432": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "body" }, - "40583": { + "1433": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "query" }, - "40584": { + "1434": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "headers" }, - "40585": { + "1435": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.updateOutboundItem" }, - "40586": { + "1436": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.updateOutboundItem" }, - "40587": { + "1437": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "id" }, - "40588": { + "1438": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "actionId" }, - "40589": { + "1439": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "body" }, - "40590": { + "1440": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "query" }, - "40591": { + "1441": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "headers" }, - "40592": { + "1442": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.removeOutboundItem" }, - "40593": { + "1443": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.removeOutboundItem" }, - "40594": { + "1444": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "id" }, - "40595": { + "1445": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "actionId" }, - "40596": { + "1446": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "query" }, - "40597": { + "1447": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "headers" }, - "40598": { + "1448": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.addOutboundShipping" }, - "40599": { + "1449": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.addOutboundShipping" }, - "40600": { + "1450": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "id" }, - "40601": { + "1451": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "body" }, - "40602": { + "1452": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "query" }, - "40603": { + "1453": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "headers" }, - "40604": { + "1454": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.updateOutboundShipping" }, - "40605": { + "1455": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.updateOutboundShipping" }, - "40606": { + "1456": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "id" }, - "40607": { + "1457": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "actionId" }, - "40608": { + "1458": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "body" }, - "40609": { + "1459": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "query" }, - "40610": { + "1460": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "headers" }, - "40611": { + "1461": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.deleteOutboundShipping" }, - "40612": { + "1462": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.deleteOutboundShipping" }, - "40613": { + "1463": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "id" }, - "40614": { + "1464": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "actionId" }, - "40615": { + "1465": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "query" }, - "40616": { + "1466": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "headers" }, - "40617": { + "1467": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.request" }, - "40618": { + "1468": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.request" }, - "40619": { + "1469": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "id" }, - "40620": { + "1470": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "body" }, - "40621": { + "1471": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "query" }, - "40622": { + "1472": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "headers" }, - "40623": { + "1473": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.cancelRequest" }, - "40624": { + "1474": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "Claim.cancelRequest" }, - "40625": { + "1475": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "id" }, - "40626": { + "1476": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "query" }, - "40627": { + "1477": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/claim.ts", "qualifiedName": "headers" }, - "40628": { + "1478": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange" }, - "40629": { + "1479": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange.__constructor" }, - "40630": { + "1480": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange" }, - "40631": { + "1481": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "client" }, - "40632": { + "1482": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange.client" }, - "40633": { + "1483": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange.list" }, - "40634": { + "1484": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange.list" }, - "40635": { + "1485": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "query" }, - "40636": { + "1486": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "headers" }, - "40637": { + "1487": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange.retrieve" }, - "40638": { + "1488": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange.retrieve" }, - "40639": { + "1489": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "id" }, - "40640": { + "1490": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "query" }, - "40641": { + "1491": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "headers" }, - "40642": { + "1492": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange.create" }, - "40643": { + "1493": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange.create" }, - "40644": { + "1494": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "body" }, - "40645": { + "1495": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "query" }, - "40646": { + "1496": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "headers" }, - "40647": { + "1497": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange.cancel" }, - "40648": { + "1498": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange.cancel" }, - "40649": { + "1499": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "id" }, - "40650": { + "1500": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "query" }, - "40651": { + "1501": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "headers" }, - "40652": { + "1502": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange.addInboundItems" }, - "40653": { + "1503": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange.addInboundItems" }, - "40654": { + "1504": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "id" }, - "40655": { + "1505": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "body" }, - "40656": { + "1506": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "query" }, - "40657": { + "1507": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "headers" }, - "40658": { + "1508": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange.updateInboundItem" }, - "40659": { + "1509": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange.updateInboundItem" }, - "40660": { + "1510": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "id" }, - "40661": { + "1511": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "actionId" }, - "40662": { + "1512": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "body" }, - "40663": { + "1513": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "query" }, - "40664": { + "1514": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "headers" }, - "40665": { + "1515": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange.removeInboundItem" }, - "40666": { + "1516": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange.removeInboundItem" }, - "40667": { + "1517": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "id" }, - "40668": { + "1518": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "actionId" }, - "40669": { + "1519": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "query" }, - "40670": { + "1520": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "headers" }, - "40671": { + "1521": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange.addInboundShipping" }, - "40672": { + "1522": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange.addInboundShipping" }, - "40673": { + "1523": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "id" }, - "40674": { + "1524": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "body" }, - "40675": { + "1525": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "query" }, - "40676": { + "1526": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "headers" }, - "40677": { + "1527": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange.updateInboundShipping" }, - "40678": { + "1528": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange.updateInboundShipping" }, - "40679": { + "1529": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "id" }, - "40680": { + "1530": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "actionId" }, - "40681": { + "1531": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "body" }, - "40682": { + "1532": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "query" }, - "40683": { + "1533": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "headers" }, - "40684": { + "1534": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange.deleteInboundShipping" }, - "40685": { + "1535": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange.deleteInboundShipping" }, - "40686": { + "1536": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "id" }, - "40687": { + "1537": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "actionId" }, - "40688": { + "1538": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "query" }, - "40689": { + "1539": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "headers" }, - "40690": { + "1540": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange.addOutboundItems" }, - "40691": { + "1541": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange.addOutboundItems" }, - "40692": { + "1542": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "id" }, - "40693": { + "1543": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "body" }, - "40694": { + "1544": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "query" }, - "40695": { + "1545": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "headers" }, - "40696": { + "1546": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange.updateOutboundItem" }, - "40697": { + "1547": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange.updateOutboundItem" }, - "40698": { + "1548": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "id" }, - "40699": { + "1549": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "actionId" }, - "40700": { + "1550": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "body" }, - "40701": { + "1551": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "query" }, - "40702": { + "1552": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "headers" }, - "40703": { + "1553": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange.removeOutboundItem" }, - "40704": { + "1554": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange.removeOutboundItem" }, - "40705": { + "1555": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "id" }, - "40706": { + "1556": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "actionId" }, - "40707": { + "1557": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "query" }, - "40708": { + "1558": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "headers" }, - "40709": { + "1559": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange.addOutboundShipping" }, - "40710": { + "1560": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange.addOutboundShipping" }, - "40711": { + "1561": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "id" }, - "40712": { + "1562": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "body" }, - "40713": { + "1563": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "query" }, - "40714": { + "1564": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "headers" }, - "40715": { + "1565": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange.updateOutboundShipping" }, - "40716": { + "1566": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange.updateOutboundShipping" }, - "40717": { + "1567": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "id" }, - "40718": { + "1568": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "actionId" }, - "40719": { + "1569": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "body" }, - "40720": { + "1570": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "query" }, - "40721": { + "1571": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "headers" }, - "40722": { + "1572": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange.deleteOutboundShipping" }, - "40723": { + "1573": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange.deleteOutboundShipping" }, - "40724": { + "1574": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "id" }, - "40725": { + "1575": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "actionId" }, - "40726": { + "1576": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "query" }, - "40727": { + "1577": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "headers" }, - "40728": { + "1578": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange.request" }, - "40729": { + "1579": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange.request" }, - "40730": { + "1580": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "id" }, - "40731": { + "1581": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "body" }, - "40732": { + "1582": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "query" }, - "40733": { + "1583": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "headers" }, - "40734": { + "1584": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange.cancelRequest" }, - "40735": { + "1585": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "Exchange.cancelRequest" }, - "40736": { + "1586": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "id" }, - "40737": { + "1587": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "query" }, - "40738": { + "1588": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/exchange.ts", "qualifiedName": "headers" }, - "40739": { + "1589": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", "qualifiedName": "TaxRate" }, - "40740": { + "1590": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", "qualifiedName": "TaxRate.__constructor" }, - "40741": { + "1591": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", "qualifiedName": "TaxRate" }, - "40742": { + "1592": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", "qualifiedName": "client" }, - "40743": { + "1593": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", "qualifiedName": "TaxRate.client" }, - "40744": { + "1594": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", "qualifiedName": "TaxRate.create" }, - "40745": { + "1595": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", "qualifiedName": "TaxRate.create" }, - "40746": { + "1596": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", "qualifiedName": "body" }, - "40747": { + "1597": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", "qualifiedName": "query" }, - "40748": { + "1598": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", "qualifiedName": "headers" }, - "40749": { + "1599": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", "qualifiedName": "TaxRate.update" }, - "40750": { + "1600": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", "qualifiedName": "TaxRate.update" }, - "40751": { + "1601": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", "qualifiedName": "id" }, - "40752": { + "1602": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", "qualifiedName": "body" }, - "40753": { + "1603": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", "qualifiedName": "query" }, - "40754": { + "1604": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", "qualifiedName": "headers" }, - "40755": { + "1605": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", "qualifiedName": "TaxRate.delete" }, - "40756": { + "1606": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", "qualifiedName": "TaxRate.delete" }, - "40757": { + "1607": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", "qualifiedName": "id" }, - "40758": { + "1608": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", "qualifiedName": "headers" }, - "40759": { + "1609": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", "qualifiedName": "TaxRate.retrieve" }, - "40760": { + "1610": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", "qualifiedName": "TaxRate.retrieve" }, - "40761": { + "1611": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", "qualifiedName": "id" }, - "40762": { + "1612": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", "qualifiedName": "query" }, - "40763": { + "1613": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", "qualifiedName": "headers" }, - "40764": { + "1614": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", "qualifiedName": "TaxRate.list" }, - "40765": { + "1615": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", "qualifiedName": "TaxRate.list" }, - "40766": { + "1616": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", "qualifiedName": "query" }, - "40767": { + "1617": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-rate.ts", "qualifiedName": "headers" }, - "40768": { + "1618": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", "qualifiedName": "TaxRegion" }, - "40769": { + "1619": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", "qualifiedName": "TaxRegion.__constructor" }, - "40770": { + "1620": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", "qualifiedName": "TaxRegion" }, - "40771": { + "1621": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", "qualifiedName": "client" }, - "40772": { + "1622": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", "qualifiedName": "TaxRegion.client" }, - "40773": { + "1623": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", "qualifiedName": "TaxRegion.create" }, - "40774": { + "1624": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", "qualifiedName": "TaxRegion.create" }, - "40775": { + "1625": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", "qualifiedName": "body" }, - "40776": { + "1626": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", "qualifiedName": "query" }, - "40777": { + "1627": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", "qualifiedName": "headers" }, - "40778": { + "1628": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", "qualifiedName": "TaxRegion.delete" }, - "40779": { + "1629": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", "qualifiedName": "TaxRegion.delete" }, - "40780": { + "1630": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", "qualifiedName": "id" }, - "40781": { + "1631": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", "qualifiedName": "headers" }, - "40782": { + "1632": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", "qualifiedName": "TaxRegion.retrieve" }, - "40783": { + "1633": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", "qualifiedName": "TaxRegion.retrieve" }, - "40784": { + "1634": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", "qualifiedName": "id" }, - "40785": { + "1635": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", "qualifiedName": "query" }, - "40786": { + "1636": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", "qualifiedName": "headers" }, - "40787": { + "1637": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", "qualifiedName": "TaxRegion.list" }, - "40788": { + "1638": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", "qualifiedName": "TaxRegion.list" }, - "40789": { + "1639": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", "qualifiedName": "query" }, - "40790": { + "1640": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/tax-region.ts", "qualifiedName": "headers" }, - "40791": { + "1641": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", "qualifiedName": "Store" }, - "40792": { + "1642": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", "qualifiedName": "Store.__constructor" }, - "40793": { + "1643": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", "qualifiedName": "Store" }, - "40794": { + "1644": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", "qualifiedName": "client" }, - "40795": { + "1645": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", "qualifiedName": "Store.client" }, - "40796": { + "1646": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", "qualifiedName": "Store.retrieve" }, - "40797": { + "1647": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", "qualifiedName": "Store.retrieve" }, - "40798": { + "1648": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", "qualifiedName": "id" }, - "40799": { + "1649": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", "qualifiedName": "query" }, - "40800": { + "1650": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", "qualifiedName": "headers" }, - "40801": { + "1651": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", "qualifiedName": "Store.list" }, - "40802": { + "1652": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", "qualifiedName": "Store.list" }, - "40803": { + "1653": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", "qualifiedName": "query" }, - "40804": { + "1654": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", "qualifiedName": "headers" }, - "40805": { + "1655": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", "qualifiedName": "Store.update" }, - "40806": { + "1656": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", "qualifiedName": "Store.update" }, - "40807": { + "1657": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", "qualifiedName": "id" }, - "40808": { + "1658": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", "qualifiedName": "body" }, - "40809": { + "1659": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", "qualifiedName": "query" }, - "40810": { + "1660": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/store.ts", "qualifiedName": "headers" }, - "40811": { + "1661": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", "qualifiedName": "ProductTag" }, - "40812": { + "1662": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", "qualifiedName": "ProductTag.__constructor" }, - "40813": { + "1663": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", "qualifiedName": "ProductTag" }, - "40814": { + "1664": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", "qualifiedName": "client" }, - "40815": { + "1665": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", "qualifiedName": "ProductTag.client" }, - "40816": { + "1666": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", "qualifiedName": "ProductTag.create" }, - "40817": { + "1667": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", "qualifiedName": "ProductTag.create" }, - "40818": { + "1668": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", "qualifiedName": "body" }, - "40819": { + "1669": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", "qualifiedName": "query" }, - "40820": { + "1670": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", "qualifiedName": "headers" }, - "40821": { + "1671": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", "qualifiedName": "ProductTag.update" }, - "40822": { + "1672": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", "qualifiedName": "ProductTag.update" }, - "40823": { + "1673": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", "qualifiedName": "id" }, - "40824": { + "1674": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", "qualifiedName": "body" }, - "40825": { + "1675": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", "qualifiedName": "query" }, - "40826": { + "1676": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", "qualifiedName": "headers" }, - "40827": { + "1677": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", "qualifiedName": "ProductTag.list" }, - "40828": { + "1678": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", "qualifiedName": "ProductTag.list" }, - "40829": { + "1679": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", "qualifiedName": "query" }, - "40830": { + "1680": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", "qualifiedName": "headers" }, - "40831": { + "1681": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", "qualifiedName": "ProductTag.retrieve" }, - "40832": { + "1682": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", "qualifiedName": "ProductTag.retrieve" }, - "40833": { + "1683": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", "qualifiedName": "id" }, - "40834": { + "1684": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", "qualifiedName": "query" }, - "40835": { + "1685": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", "qualifiedName": "headers" }, - "40836": { + "1686": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", "qualifiedName": "ProductTag.delete" }, - "40837": { + "1687": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", "qualifiedName": "ProductTag.delete" }, - "40838": { + "1688": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", "qualifiedName": "id" }, - "40839": { + "1689": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-tag.ts", "qualifiedName": "headers" }, - "40840": { + "1690": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", "qualifiedName": "User" }, - "40841": { + "1691": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", "qualifiedName": "User.__constructor" }, - "40842": { + "1692": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", "qualifiedName": "User" }, - "40843": { + "1693": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", "qualifiedName": "client" }, - "40844": { + "1694": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", "qualifiedName": "User.client" }, - "40845": { + "1695": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", "qualifiedName": "User.update" }, - "40846": { + "1696": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", "qualifiedName": "User.update" }, - "40847": { + "1697": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", "qualifiedName": "id" }, - "40848": { + "1698": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", "qualifiedName": "body" }, - "40849": { + "1699": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", "qualifiedName": "query" }, - "40850": { + "1700": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", "qualifiedName": "headers" }, - "40851": { + "1701": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", "qualifiedName": "User.list" }, - "40852": { + "1702": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", "qualifiedName": "User.list" }, - "40853": { + "1703": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", "qualifiedName": "queryParams" }, - "40854": { + "1704": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", "qualifiedName": "headers" }, - "40855": { + "1705": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", "qualifiedName": "User.retrieve" }, - "40856": { + "1706": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", "qualifiedName": "User.retrieve" }, - "40857": { + "1707": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", "qualifiedName": "id" }, - "40858": { + "1708": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", "qualifiedName": "query" }, - "40859": { + "1709": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", "qualifiedName": "headers" }, - "40860": { + "1710": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", "qualifiedName": "User.delete" }, - "40861": { + "1711": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", "qualifiedName": "User.delete" }, - "40862": { + "1712": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", "qualifiedName": "id" }, - "40863": { + "1713": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", "qualifiedName": "headers" }, - "40864": { + "1714": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", "qualifiedName": "User.me" }, - "40865": { + "1715": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", "qualifiedName": "User.me" }, - "40866": { + "1716": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", "qualifiedName": "query" }, - "40867": { + "1717": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/user.ts", "qualifiedName": "headers" }, - "40868": { + "1718": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/currency.ts", "qualifiedName": "Currency" }, - "40869": { + "1719": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/currency.ts", "qualifiedName": "Currency.__constructor" }, - "40870": { + "1720": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/currency.ts", "qualifiedName": "Currency" }, - "40871": { + "1721": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/currency.ts", "qualifiedName": "client" }, - "40872": { + "1722": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/currency.ts", "qualifiedName": "Currency.client" }, - "40873": { + "1723": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/currency.ts", "qualifiedName": "Currency.list" }, - "40874": { + "1724": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/currency.ts", "qualifiedName": "Currency.list" }, - "40875": { + "1725": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/currency.ts", "qualifiedName": "query" }, - "40876": { + "1726": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/currency.ts", "qualifiedName": "headers" }, - "40877": { + "1727": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/currency.ts", "qualifiedName": "Currency.retrieve" }, - "40878": { + "1728": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/currency.ts", "qualifiedName": "Currency.retrieve" }, - "40879": { + "1729": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/currency.ts", "qualifiedName": "code" }, - "40880": { + "1730": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/currency.ts", "qualifiedName": "query" }, - "40881": { + "1731": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/currency.ts", "qualifiedName": "headers" }, - "40882": { + "1732": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", "qualifiedName": "Payment" }, - "40883": { + "1733": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", "qualifiedName": "Payment.__constructor" }, - "40884": { + "1734": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", "qualifiedName": "Payment" }, - "40885": { + "1735": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", "qualifiedName": "client" }, - "40886": { + "1736": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", "qualifiedName": "Payment.client" }, - "40887": { + "1737": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", "qualifiedName": "Payment.list" }, - "40888": { + "1738": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", "qualifiedName": "Payment.list" }, - "40889": { + "1739": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", "qualifiedName": "query" }, - "40890": { + "1740": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", "qualifiedName": "headers" }, - "40891": { + "1741": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", "qualifiedName": "Payment.listPaymentProviders" }, - "40892": { + "1742": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", "qualifiedName": "Payment.listPaymentProviders" }, - "40893": { + "1743": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", "qualifiedName": "query" }, - "40894": { + "1744": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", "qualifiedName": "headers" }, - "40895": { + "1745": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", "qualifiedName": "Payment.retrieve" }, - "40896": { + "1746": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", "qualifiedName": "Payment.retrieve" }, - "40897": { + "1747": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", "qualifiedName": "id" }, - "40898": { + "1748": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", "qualifiedName": "query" }, - "40899": { + "1749": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", "qualifiedName": "headers" }, - "40900": { + "1750": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", "qualifiedName": "Payment.capture" }, - "40901": { + "1751": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", "qualifiedName": "Payment.capture" }, - "40902": { + "1752": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", "qualifiedName": "id" }, - "40903": { + "1753": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", "qualifiedName": "body" }, - "40904": { + "1754": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", "qualifiedName": "query" }, - "40905": { + "1755": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", "qualifiedName": "headers" }, - "40906": { + "1756": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", "qualifiedName": "Payment.refund" }, - "40907": { + "1757": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", "qualifiedName": "Payment.refund" }, - "40908": { + "1758": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", "qualifiedName": "id" }, - "40909": { + "1759": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", "qualifiedName": "body" }, - "40910": { + "1760": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", "qualifiedName": "query" }, - "40911": { + "1761": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment.ts", "qualifiedName": "headers" }, - "40912": { + "1762": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-variant.ts", "qualifiedName": "ProductVariant" }, - "40913": { + "1763": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-variant.ts", "qualifiedName": "ProductVariant.__constructor" }, - "40914": { + "1764": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-variant.ts", "qualifiedName": "ProductVariant" }, - "40915": { + "1765": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-variant.ts", "qualifiedName": "client" }, - "40916": { + "1766": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-variant.ts", "qualifiedName": "ProductVariant.client" }, - "40917": { + "1767": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-variant.ts", "qualifiedName": "ProductVariant.list" }, - "40918": { + "1768": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-variant.ts", "qualifiedName": "ProductVariant.list" }, - "40919": { + "1769": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-variant.ts", "qualifiedName": "query" }, - "40920": { + "1770": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/product-variant.ts", "qualifiedName": "headers" }, - "40921": { + "1771": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/refund-reasons.ts", "qualifiedName": "RefundReason" }, - "40922": { + "1772": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/refund-reasons.ts", "qualifiedName": "RefundReason.__constructor" }, - "40923": { + "1773": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/refund-reasons.ts", "qualifiedName": "RefundReason" }, - "40924": { + "1774": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/refund-reasons.ts", "qualifiedName": "client" }, - "40925": { + "1775": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/refund-reasons.ts", "qualifiedName": "RefundReason.client" }, - "40926": { + "1776": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/refund-reasons.ts", "qualifiedName": "RefundReason.list" }, - "40927": { + "1777": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/refund-reasons.ts", "qualifiedName": "RefundReason.list" }, - "40928": { + "1778": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/refund-reasons.ts", "qualifiedName": "query" }, - "40929": { + "1779": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/refund-reasons.ts", "qualifiedName": "headers" }, - "40930": { + "1780": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", "qualifiedName": "PaymentCollection" }, - "40931": { + "1781": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", "qualifiedName": "PaymentCollection.__constructor" }, - "40932": { + "1782": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", "qualifiedName": "PaymentCollection" }, - "40933": { + "1783": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", "qualifiedName": "client" }, - "40934": { + "1784": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", "qualifiedName": "PaymentCollection.client" }, - "40935": { + "1785": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", "qualifiedName": "PaymentCollection.create" }, - "40936": { + "1786": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", "qualifiedName": "PaymentCollection.create" }, - "40937": { + "1787": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", "qualifiedName": "body" }, - "40938": { + "1788": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", "qualifiedName": "query" }, - "40939": { + "1789": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", "qualifiedName": "headers" }, - "40940": { + "1790": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", "qualifiedName": "PaymentCollection.delete" }, - "40941": { + "1791": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", "qualifiedName": "PaymentCollection.delete" }, - "40942": { + "1792": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", "qualifiedName": "id" }, - "40943": { + "1793": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", "qualifiedName": "headers" }, - "40944": { + "1794": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", "qualifiedName": "PaymentCollection.markAsPaid" }, - "40945": { + "1795": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", "qualifiedName": "PaymentCollection.markAsPaid" }, - "40946": { + "1796": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", "qualifiedName": "id" }, - "40947": { + "1797": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", "qualifiedName": "body" }, - "40948": { + "1798": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", "qualifiedName": "query" }, - "40949": { + "1799": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/payment-collection.ts", "qualifiedName": "headers" }, - "40950": { + "1800": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", "qualifiedName": "ApiKey" }, - "40951": { + "1801": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", "qualifiedName": "ApiKey.__constructor" }, - "40952": { + "1802": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", "qualifiedName": "ApiKey" }, - "40953": { + "1803": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", "qualifiedName": "client" }, - "40954": { + "1804": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", "qualifiedName": "ApiKey.client" }, - "40955": { + "1805": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", "qualifiedName": "ApiKey.list" }, - "40956": { + "1806": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", "qualifiedName": "ApiKey.list" }, - "40957": { + "1807": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", "qualifiedName": "queryParams" }, - "40958": { + "1808": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", "qualifiedName": "headers" }, - "40959": { + "1809": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", "qualifiedName": "ApiKey.create" }, - "40960": { + "1810": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", "qualifiedName": "ApiKey.create" }, - "40961": { + "1811": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", "qualifiedName": "body" }, - "40962": { + "1812": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", "qualifiedName": "query" }, - "40963": { + "1813": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", "qualifiedName": "headers" }, - "40964": { + "1814": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", "qualifiedName": "ApiKey.revoke" }, - "40965": { + "1815": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", "qualifiedName": "ApiKey.revoke" }, - "40966": { + "1816": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", "qualifiedName": "id" }, - "40967": { + "1817": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", "qualifiedName": "headers" }, - "40968": { + "1818": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", "qualifiedName": "ApiKey.retrieve" }, - "40969": { + "1819": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", "qualifiedName": "ApiKey.retrieve" }, - "40970": { + "1820": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", "qualifiedName": "id" }, - "40971": { + "1821": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", "qualifiedName": "headers" }, - "40972": { + "1822": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", "qualifiedName": "ApiKey.update" }, - "40973": { + "1823": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", "qualifiedName": "ApiKey.update" }, - "40974": { + "1824": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", "qualifiedName": "id" }, - "40975": { + "1825": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", "qualifiedName": "body" }, - "40976": { + "1826": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", "qualifiedName": "query" }, - "40977": { + "1827": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", "qualifiedName": "headers" }, - "40978": { + "1828": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", "qualifiedName": "ApiKey.delete" }, - "40979": { + "1829": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", "qualifiedName": "ApiKey.delete" }, - "40980": { + "1830": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", "qualifiedName": "id" }, - "40981": { + "1831": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", "qualifiedName": "headers" }, - "40982": { + "1832": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", "qualifiedName": "ApiKey.batchSalesChannels" }, - "40983": { + "1833": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", "qualifiedName": "ApiKey.batchSalesChannels" }, - "40984": { + "1834": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", "qualifiedName": "id" }, - "40985": { + "1835": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", "qualifiedName": "body" }, - "40986": { + "1836": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/api-key.ts", "qualifiedName": "headers" }, - "40987": { + "1837": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/workflow-execution.ts", "qualifiedName": "WorkflowExecution" }, - "40988": { + "1838": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/workflow-execution.ts", "qualifiedName": "WorkflowExecution.__constructor" }, - "40989": { + "1839": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/workflow-execution.ts", "qualifiedName": "WorkflowExecution" }, - "40990": { + "1840": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/workflow-execution.ts", "qualifiedName": "client" }, - "40991": { + "1841": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/workflow-execution.ts", "qualifiedName": "WorkflowExecution.client" }, - "40992": { + "1842": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/workflow-execution.ts", "qualifiedName": "WorkflowExecution.list" }, - "40993": { + "1843": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/workflow-execution.ts", "qualifiedName": "WorkflowExecution.list" }, - "40994": { + "1844": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/workflow-execution.ts", "qualifiedName": "queryParams" }, - "40995": { + "1845": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/workflow-execution.ts", "qualifiedName": "headers" }, - "40996": { + "1846": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/workflow-execution.ts", "qualifiedName": "WorkflowExecution.retrieve" }, - "40997": { + "1847": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/workflow-execution.ts", "qualifiedName": "WorkflowExecution.retrieve" }, - "40998": { + "1848": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/workflow-execution.ts", "qualifiedName": "id" }, - "40999": { + "1849": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/workflow-execution.ts", "qualifiedName": "headers" }, - "41000": { + "1850": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", "qualifiedName": "Reservation" }, - "41001": { + "1851": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", "qualifiedName": "Reservation.__constructor" }, - "41002": { + "1852": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", "qualifiedName": "Reservation" }, - "41003": { + "1853": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", "qualifiedName": "client" }, - "41004": { + "1854": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", "qualifiedName": "Reservation.client" }, - "41005": { + "1855": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", "qualifiedName": "Reservation.retrieve" }, - "41006": { + "1856": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", "qualifiedName": "Reservation.retrieve" }, - "41007": { + "1857": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", "qualifiedName": "id" }, - "41008": { + "1858": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", "qualifiedName": "query" }, - "41009": { + "1859": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", "qualifiedName": "headers" }, - "41010": { + "1860": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", "qualifiedName": "Reservation.list" }, - "41011": { + "1861": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", "qualifiedName": "Reservation.list" }, - "41012": { + "1862": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", "qualifiedName": "query" }, - "41013": { + "1863": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", "qualifiedName": "headers" }, - "41014": { + "1864": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", "qualifiedName": "Reservation.create" }, - "41015": { + "1865": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", "qualifiedName": "Reservation.create" }, - "41016": { + "1866": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", "qualifiedName": "body" }, - "41017": { + "1867": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", "qualifiedName": "query" }, - "41018": { + "1868": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", "qualifiedName": "headers" }, - "41019": { + "1869": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", "qualifiedName": "Reservation.update" }, - "41020": { + "1870": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", "qualifiedName": "Reservation.update" }, - "41021": { + "1871": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", "qualifiedName": "id" }, - "41022": { + "1872": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", "qualifiedName": "body" }, - "41023": { + "1873": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", "qualifiedName": "query" }, - "41024": { + "1874": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", "qualifiedName": "headers" }, - "41025": { + "1875": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", "qualifiedName": "Reservation.delete" }, - "41026": { + "1876": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", "qualifiedName": "Reservation.delete" }, - "41027": { + "1877": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", "qualifiedName": "id" }, - "41028": { + "1878": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/reservation.ts", "qualifiedName": "headers" }, - "41029": { + "1879": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", "qualifiedName": "CustomerGroup" }, - "41030": { + "1880": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", "qualifiedName": "CustomerGroup.__constructor" }, - "41031": { + "1881": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", "qualifiedName": "CustomerGroup" }, - "41032": { + "1882": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", "qualifiedName": "client" }, - "41033": { + "1883": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", "qualifiedName": "CustomerGroup.client" }, - "41034": { + "1884": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", "qualifiedName": "CustomerGroup.retrieve" }, - "41035": { + "1885": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", "qualifiedName": "CustomerGroup.retrieve" }, - "41036": { + "1886": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", "qualifiedName": "id" }, - "41037": { + "1887": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", "qualifiedName": "query" }, - "41038": { + "1888": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", "qualifiedName": "headers" }, - "41039": { + "1889": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", "qualifiedName": "CustomerGroup.list" }, - "41040": { + "1890": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", "qualifiedName": "CustomerGroup.list" }, - "41041": { + "1891": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", "qualifiedName": "query" }, - "41042": { + "1892": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", "qualifiedName": "headers" }, - "41043": { + "1893": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", "qualifiedName": "CustomerGroup.create" }, - "41044": { + "1894": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", "qualifiedName": "CustomerGroup.create" }, - "41045": { + "1895": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", "qualifiedName": "body" }, - "41046": { + "1896": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", "qualifiedName": "query" }, - "41047": { + "1897": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", "qualifiedName": "headers" }, - "41048": { + "1898": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", "qualifiedName": "CustomerGroup.update" }, - "41049": { + "1899": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", "qualifiedName": "CustomerGroup.update" }, - "41050": { + "1900": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", "qualifiedName": "id" }, - "41051": { + "1901": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", "qualifiedName": "body" }, - "41052": { + "1902": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", "qualifiedName": "query" }, - "41053": { + "1903": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", "qualifiedName": "headers" }, - "41054": { + "1904": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", "qualifiedName": "CustomerGroup.delete" }, - "41055": { + "1905": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", "qualifiedName": "CustomerGroup.delete" }, - "41056": { + "1906": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", "qualifiedName": "id" }, - "41057": { + "1907": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", "qualifiedName": "headers" }, - "41058": { + "1908": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", "qualifiedName": "CustomerGroup.batchCustomers" }, - "41059": { + "1909": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", "qualifiedName": "CustomerGroup.batchCustomers" }, - "41060": { + "1910": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", "qualifiedName": "id" }, - "41061": { + "1911": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", "qualifiedName": "body" }, - "41062": { + "1912": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/customer-group.ts", "qualifiedName": "headers" }, - "41063": { + "1913": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "Promotion" }, - "41064": { + "1914": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "Promotion.__constructor" }, - "41065": { + "1915": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "Promotion" }, - "41066": { + "1916": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "client" }, - "41067": { + "1917": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "Promotion.client" }, - "41068": { + "1918": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "Promotion.retrieve" }, - "41069": { + "1919": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "Promotion.retrieve" }, - "41070": { + "1920": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "id" }, - "41071": { + "1921": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "query" }, - "41072": { + "1922": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "headers" }, - "41073": { + "1923": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "Promotion.list" }, - "41074": { + "1924": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "Promotion.list" }, - "41075": { + "1925": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "query" }, - "41076": { + "1926": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "headers" }, - "41077": { + "1927": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "Promotion.create" }, - "41078": { + "1928": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "Promotion.create" }, - "41079": { + "1929": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "payload" }, - "41080": { + "1930": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "headers" }, - "41081": { + "1931": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "Promotion.update" }, - "41082": { + "1932": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "Promotion.update" }, - "41083": { + "1933": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "id" }, - "41084": { + "1934": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "payload" }, - "41085": { + "1935": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "headers" }, - "41086": { + "1936": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "Promotion.delete" }, - "41087": { + "1937": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "Promotion.delete" }, - "41088": { + "1938": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "id" }, - "41089": { + "1939": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "headers" }, - "41090": { + "1940": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "Promotion.addRules" }, - "41091": { + "1941": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "Promotion.addRules" }, - "41092": { + "1942": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "id" }, - "41093": { + "1943": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "ruleType" }, - "41094": { + "1944": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "payload" }, - "41095": { + "1945": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "headers" }, - "41096": { + "1946": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "Promotion.updateRules" }, - "41097": { + "1947": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "Promotion.updateRules" }, - "41098": { + "1948": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "id" }, - "41099": { + "1949": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "ruleType" }, - "41100": { + "1950": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "payload" }, - "41101": { + "1951": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "headers" }, - "41102": { + "1952": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "Promotion.removeRules" }, - "41103": { + "1953": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "Promotion.removeRules" }, - "41104": { + "1954": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "id" }, - "41105": { + "1955": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "ruleType" }, - "41106": { + "1956": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "payload" }, - "41107": { + "1957": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "headers" }, - "41108": { + "1958": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "Promotion.listRules" }, - "41109": { + "1959": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "Promotion.listRules" }, - "41110": { + "1960": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "id" }, - "41111": { + "1961": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "ruleType" }, - "41112": { + "1962": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "query" }, - "41113": { + "1963": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "headers" }, - "41114": { + "1964": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "Promotion.listRuleAttributes" }, - "41115": { + "1965": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "Promotion.listRuleAttributes" }, - "41116": { + "1966": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "ruleType" }, - "41117": { + "1967": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "promotionType" }, - "41118": { + "1968": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "headers" }, - "41119": { + "1969": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "Promotion.listRuleValues" }, - "41120": { + "1970": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "Promotion.listRuleValues" }, - "41121": { + "1971": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "ruleType" }, - "41122": { + "1972": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "ruleValue" }, - "41123": { + "1973": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "query" }, - "41124": { + "1974": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/promotion.ts", "qualifiedName": "headers" }, - "41125": { + "1975": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", "qualifiedName": "Campaign" }, - "41126": { + "1976": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", "qualifiedName": "Campaign.__constructor" }, - "41127": { + "1977": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", "qualifiedName": "Campaign" }, - "41128": { + "1978": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", "qualifiedName": "client" }, - "41129": { + "1979": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", "qualifiedName": "Campaign.client" }, - "41130": { + "1980": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", "qualifiedName": "Campaign.retrieve" }, - "41131": { + "1981": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", "qualifiedName": "Campaign.retrieve" }, - "41132": { + "1982": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", "qualifiedName": "id" }, - "41133": { + "1983": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", "qualifiedName": "query" }, - "41134": { + "1984": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", "qualifiedName": "headers" }, - "41135": { + "1985": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", "qualifiedName": "Campaign.list" }, - "41136": { + "1986": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", "qualifiedName": "Campaign.list" }, - "41137": { + "1987": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", "qualifiedName": "query" }, - "41138": { + "1988": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", "qualifiedName": "headers" }, - "41139": { + "1989": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", "qualifiedName": "Campaign.create" }, - "41140": { + "1990": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", "qualifiedName": "Campaign.create" }, - "41141": { + "1991": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", "qualifiedName": "payload" }, - "41142": { + "1992": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", "qualifiedName": "headers" }, - "41143": { + "1993": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", "qualifiedName": "Campaign.update" }, - "41144": { + "1994": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", "qualifiedName": "Campaign.update" }, - "41145": { + "1995": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", "qualifiedName": "id" }, - "41146": { + "1996": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", "qualifiedName": "payload" }, - "41147": { + "1997": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", "qualifiedName": "headers" }, - "41148": { + "1998": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", "qualifiedName": "Campaign.delete" }, - "41149": { + "1999": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", "qualifiedName": "Campaign.delete" }, - "41150": { + "2000": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", "qualifiedName": "id" }, - "41151": { + "2001": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", "qualifiedName": "headers" }, - "41152": { + "2002": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", "qualifiedName": "Campaign.batchPromotions" }, - "41153": { + "2003": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", "qualifiedName": "Campaign.batchPromotions" }, - "41154": { + "2004": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", "qualifiedName": "id" }, - "41155": { + "2005": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", "qualifiedName": "payload" }, - "41156": { + "2006": { "sourceFileName": "../../../../packages/core/js-sdk/src/admin/campaign.ts", "qualifiedName": "headers" }, - "41157": { + "2007": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "Client" }, - "41158": { + "2008": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "Client.__constructor" }, - "41159": { + "2009": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "Client" }, - "41160": { + "2010": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "config" }, - "41161": { + "2011": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "Client.fetch_" }, - "41162": { + "2012": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "Client.config" }, - "41163": { + "2013": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "Client.logger" }, - "41164": { + "2014": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "Client.DEFAULT_JWT_STORAGE_KEY" }, - "41165": { + "2015": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "Client.token" }, - "41166": { + "2016": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "Client.fetch" }, - "41167": { + "2017": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "Client.fetch" }, - "41168": { + "2018": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "T" }, - "41169": { + "2019": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "input" }, - "41170": { + "2020": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "init" }, - "41171": { + "2021": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "Client.fetchStream" }, - "41172": { + "2022": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "Client.fetchStream" }, - "41173": { + "2023": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "input" }, - "41174": { + "2024": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "init" }, - "41175": { + "2025": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "Client.setToken" }, - "41176": { + "2026": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "Client.setToken" }, - "41177": { + "2027": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "token" }, - "41178": { + "2028": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "Client.clearToken" }, - "41179": { + "2029": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "Client.clearToken" }, - "41180": { + "2030": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "Client.clearToken_" }, - "41181": { + "2031": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "Client.clearToken_" }, - "41182": { + "2032": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "Client.initClient" }, - "41183": { + "2033": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "Client.initClient" }, - "41184": { + "2034": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "Client.getApiKeyHeader_" }, - "41185": { + "2035": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "Client.getApiKeyHeader_" }, - "41186": { + "2036": { "sourceFileName": "", "qualifiedName": "__type" }, - "41187": { + "2037": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "__type" }, - "41188": { + "2038": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "__type.Authorization" }, - "41189": { + "2039": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "Client.getPublishableKeyHeader_" }, - "41190": { + "2040": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "Client.getPublishableKeyHeader_" }, - "41191": { + "2041": { "sourceFileName": "", "qualifiedName": "__type" }, - "41192": { + "2042": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "__type" }, - "41193": { + "2043": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "__type.x-publishable-api-key" }, - "41194": { + "2044": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "Client.getJwtHeader_" }, - "41195": { + "2045": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "Client.getJwtHeader_" }, - "41196": { + "2046": { "sourceFileName": "", "qualifiedName": "__type" }, - "41197": { + "2047": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "__type" }, - "41198": { + "2048": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "__type.Authorization" }, - "41199": { + "2049": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "Client.setToken_" }, - "41200": { + "2050": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "Client.setToken_" }, - "41201": { + "2051": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "token" }, - "41202": { + "2052": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "Client.getToken_" }, - "41203": { + "2053": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "Client.getToken_" }, - "41204": { + "2054": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "Client.getTokenStorageInfo_" }, - "41205": { + "2055": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "Client.getTokenStorageInfo_" }, - "41206": { + "2056": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "__object" }, - "41207": { + "2057": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "__object.storageMethod" }, - "41208": { + "2058": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "__object.storageKey" }, - "41209": { + "2059": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "Client.throwError_" }, - "41210": { + "2060": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "Client.throwError_" }, - "41211": { + "2061": { "sourceFileName": "../../../../packages/core/js-sdk/src/client.ts", "qualifiedName": "message" }, - "41212": { + "2062": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "ClientHeaders" }, - "41213": { + "2063": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "__type" }, - "41214": { + "2064": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "__type.tags" }, - "41215": { + "2065": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "Config" }, - "41216": { + "2066": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "__type" }, - "41217": { + "2067": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "__type.baseUrl" }, - "41218": { + "2068": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "__type.globalHeaders" }, - "41219": { + "2069": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "__type.publishableKey" }, - "41220": { + "2070": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "__type.apiKey" }, - "41221": { + "2071": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "__type.auth" }, - "41222": { + "2072": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "__type" }, - "41223": { + "2073": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "__type.type" }, - "41224": { + "2074": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "__type.jwtTokenStorageKey" }, - "41225": { + "2075": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "__type.jwtTokenStorageMethod" }, - "41226": { + "2076": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "__type.fetchCredentials" }, - "41227": { + "2077": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "__type.storage" }, - "41228": { + "2078": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "__type.logger" }, - "41229": { + "2079": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "__type.debug" }, - "41230": { + "2080": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "ClientFetch" }, - "41231": { + "2081": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "__type" }, - "41232": { + "2082": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "__type" }, - "41233": { + "2083": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "input" }, - "41234": { + "2084": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "init" }, - "41235": { + "2085": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "Logger" }, - "41236": { + "2086": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "__type" }, - "41237": { + "2087": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "__type.error" }, - "41238": { + "2088": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "__type" }, - "41239": { + "2089": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "__type" }, - "41240": { + "2090": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "messages" }, - "41241": { + "2091": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "__type.warn" }, - "41242": { + "2092": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "__type" }, - "41243": { + "2093": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "__type" }, - "41244": { + "2094": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "messages" }, - "41245": { + "2095": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "__type.info" }, - "41246": { + "2096": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "__type" }, - "41247": { + "2097": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "__type" }, - "41248": { + "2098": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "messages" }, - "41249": { + "2099": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "__type.debug" }, - "41250": { + "2100": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "__type" }, - "41251": { + "2101": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "__type" }, - "41252": { + "2102": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "messages" }, - "41253": { + "2103": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "FetchArgs" }, - "41254": { + "2104": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "__type" }, - "41255": { + "2105": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "__type.query" }, - "41256": { + "2106": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "__type.headers" }, - "41257": { + "2107": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "__type.body" }, - "41258": { + "2108": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "FetchStreamResponse" }, - "41259": { + "2109": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "FetchStreamResponse.stream" }, - "41260": { + "2110": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "FetchStreamResponse.abort" }, - "41261": { + "2111": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "__type" }, - "41262": { + "2112": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "__type" }, - "41263": { + "2113": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "CustomStorage" }, - "41264": { + "2114": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "CustomStorage.getItem" }, - "41265": { + "2115": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "CustomStorage.getItem" }, - "41266": { + "2116": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "key" }, - "41267": { + "2117": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "CustomStorage.setItem" }, - "41268": { + "2118": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "CustomStorage.setItem" }, - "41269": { + "2119": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "key" }, - "41270": { + "2120": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "value" }, - "41271": { + "2121": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "CustomStorage.removeItem" }, - "41272": { + "2122": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "CustomStorage.removeItem" }, - "41273": { + "2123": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "key" }, - "41274": { + "2124": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "FetchInput" }, - "41275": { + "2125": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "ServerSentEventMessage" }, - "41276": { + "2126": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "ServerSentEventMessage.comment" }, - "41277": { + "2127": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "ServerSentEventMessage.event" }, - "41278": { + "2128": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "ServerSentEventMessage.data" }, - "41279": { + "2129": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "ServerSentEventMessage.id" }, - "41280": { + "2130": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "ServerSentEventMessage.retry" }, - "41281": { + "2131": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "Awaitable" }, - "41282": { + "2132": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "T" }, - "41283": { + "2133": { "sourceFileName": "../../../../packages/core/js-sdk/src/types.ts", "qualifiedName": "FetchParams" } @@ -68357,9 +68373,9 @@ "3": "../../../../packages/core/js-sdk/src/store/index.ts" }, "reflections": { - "1": 39151, - "2": 39198, - "3": 39243 + "1": 1, + "2": 48, + "3": 93 } } } diff --git a/www/utils/packages/docs-generator/src/classes/kinds/oas.ts b/www/utils/packages/docs-generator/src/classes/kinds/oas.ts index e02a8a6f91..10db39fed3 100644 --- a/www/utils/packages/docs-generator/src/classes/kinds/oas.ts +++ b/www/utils/packages/docs-generator/src/classes/kinds/oas.ts @@ -52,6 +52,8 @@ type AuthRequests = { exact?: string startsWith?: string requiresAuthentication: boolean + allowedAuthTypes?: string[] + httpMethods?: string[] } /** @@ -99,6 +101,21 @@ class OasKindGenerator extends FunctionKindGenerator { exact: "store/orders/[id]/transfer/cancel", requiresAuthentication: true, }, + { + exact: "admin/invites/accept", + httpMethods: ["post"], + requiresAuthentication: true, + allowedAuthTypes: ["cookie_auth", "jwt_token"], + }, + { + startsWith: "admin/invites", + requiresAuthentication: true, + }, + { + startsWith: "admin/users", + requiresAuthentication: true, + allowedAuthTypes: ["cookie_auth", "jwt_token"], + }, ] readonly RESPONSE_TYPE_NAMES = ["MedusaResponse"] readonly FIELD_QUERY_PARAMS = ["fields", "expand"] @@ -275,8 +292,12 @@ class OasKindGenerator extends FunctionKindGenerator { const { oasPath, normalized: normalizedOasPath } = this.getOasPath(node) const splitOasPath = oasPath.split("/") const oasPrefix = this.getOasPrefix(methodName, normalizedOasPath) - const { isAdminAuthenticated, isStoreAuthenticated, isAuthenticated } = - this.getAuthenticationDetails(node, oasPath) + const { + isAdminAuthenticated, + isStoreAuthenticated, + isAuthenticated, + allowedAuthTypes, + } = this.getAuthenticationDetails(node, oasPath, methodName) const tagName = this.getTagName(splitOasPath) const { summary, description } = this.knowledgeBaseFactory.tryToGetOasMethodSummaryAndDescription({ @@ -370,7 +391,11 @@ class OasKindGenerator extends FunctionKindGenerator { } // add security details if applicable - oas.security = this.getSecurity({ isAdminAuthenticated, isAuthenticated }) + oas.security = this.getSecurity({ + isAdminAuthenticated, + isAuthenticated, + auth_types: allowedAuthTypes, + }) if (tagName) { oas.tags = [tagName] @@ -484,11 +509,19 @@ class OasKindGenerator extends FunctionKindGenerator { } // check if authentication details (including security) should be updated - const { isAdminAuthenticated, isStoreAuthenticated, isAuthenticated } = - this.getAuthenticationDetails(node, oasPath) + const { + isAdminAuthenticated, + isStoreAuthenticated, + isAuthenticated, + allowedAuthTypes, + } = this.getAuthenticationDetails(node, oasPath, methodName) oas["x-authenticated"] = isAuthenticated - oas.security = this.getSecurity({ isAdminAuthenticated, isAuthenticated }) + oas.security = this.getSecurity({ + isAdminAuthenticated, + isAuthenticated, + auth_types: allowedAuthTypes, + }) let parametersUpdated = false @@ -815,7 +848,8 @@ class OasKindGenerator extends FunctionKindGenerator { */ getAuthenticationDetails( node: FunctionNode, - oasPath: string + oasPath: string, + httpMethod: string ): { /** * Whether the OAS operation requires admin authentication. @@ -829,34 +863,42 @@ class OasKindGenerator extends FunctionKindGenerator { * Whether the OAS operation requires authentication in genral. */ isAuthenticated: boolean + /** + * Override the default security requirements. + */ + allowedAuthTypes?: string[] } { const isAuthenticationDisabled = node .getSourceFile() .statements.some((statement) => statement.getText().includes("AUTHENTICATE = false") ) - const hasAuthenticationOverride = - this.AUTH_REQUESTS.find((authRequest) => { - return ( - authRequest.exact === oasPath || - (authRequest.startsWith && oasPath.startsWith(authRequest.startsWith)) - ) - })?.requiresAuthentication === true + const hasAuthenticationOverride = this.AUTH_REQUESTS.find((authRequest) => { + const pathMatch = + authRequest.exact === oasPath || + (authRequest.startsWith && oasPath.startsWith(authRequest.startsWith)) + const httpMethodMatch = + !authRequest.httpMethods || authRequest.httpMethods.includes(httpMethod) + return pathMatch && httpMethodMatch + }) + const isAuthRequired = + hasAuthenticationOverride?.requiresAuthentication === true const isAdminAuthenticated = - (!isAuthenticationDisabled || hasAuthenticationOverride) && + (!isAuthenticationDisabled || isAuthRequired) && oasPath.startsWith("admin") - const isStoreAuthenticated = hasAuthenticationOverride + const isStoreAuthenticated = isAuthRequired ? oasPath.startsWith("store") : !isAuthenticationDisabled && - hasAuthenticationOverride && + isAuthRequired && oasPath.startsWith("store") const isAuthenticated = - isAdminAuthenticated || isStoreAuthenticated || hasAuthenticationOverride + isAdminAuthenticated || isStoreAuthenticated || isAuthRequired return { isAdminAuthenticated, isStoreAuthenticated, isAuthenticated, + allowedAuthTypes: hasAuthenticationOverride?.allowedAuthTypes, } } @@ -903,6 +945,7 @@ class OasKindGenerator extends FunctionKindGenerator { getSecurity({ isAdminAuthenticated, isAuthenticated, + auth_types, }: { /** * Whether the operation requires admin authentication. @@ -912,22 +955,35 @@ class OasKindGenerator extends FunctionKindGenerator { * Whether the operation requires general authentication. */ isAuthenticated: boolean + /** + * Override the default security requirements. + */ + auth_types?: string[] }): OpenAPIV3.SecurityRequirementObject[] | undefined { const security: OpenAPIV3.SecurityRequirementObject[] = [] - if (isAdminAuthenticated) { + const allowed_auth_types = + auth_types || + [ + "cookie_auth", + "jwt_token", + isAdminAuthenticated ? "api_token" : undefined, + ].filter(Boolean) + if (isAdminAuthenticated && allowed_auth_types.includes("api_token")) { security.push({ api_token: [], }) } if (isAuthenticated) { - security.push( - { + if (allowed_auth_types.includes("cookie_auth")) { + security.push({ cookie_auth: [], - }, - { + }) + } + if (allowed_auth_types.includes("jwt_token")) { + security.push({ jwt_token: [], - } - ) + }) + } } return security.length ? security : undefined diff --git a/www/vale/get-files.sh b/www/vale/get-files.sh index 6fe96147a1..3ffea96ed7 100755 --- a/www/vale/get-files.sh +++ b/www/vale/get-files.sh @@ -2,8 +2,8 @@ list="" app="www/" -path="../apps/$1/$2" -exceptions=("${@:3}") +path="../apps/$1" +exceptions=("${@:2}") exceptionsCommand="" for index in ${!exceptions[@]} diff --git a/www/vale/run-vale.sh b/www/vale/run-vale.sh index 71419f288a..9151b7debe 100755 --- a/www/vale/run-vale.sh +++ b/www/vale/run-vale.sh @@ -2,9 +2,9 @@ list="" app="www/" -path="../apps/$1/$2" -alertLevel=$3 -exceptions=("${@:4}") +path="../apps/$1" +alertLevel=$2 +exceptions=("${@:3}") exceptionsCommand="" for index in ${!exceptions[@]} diff --git a/www/yarn.lock b/www/yarn.lock index 6ec3d12337..2513b62813 100644 --- a/www/yarn.lock +++ b/www/yarn.lock @@ -1639,6 +1639,15 @@ __metadata: languageName: node linkType: hard +"@medusajs/icons@npm:2.6.0": + version: 2.6.0 + resolution: "@medusajs/icons@npm:2.6.0" + peerDependencies: + react: ^16.8.0 || ^17.0.0 || ^18.0.0 || ^19.0.0 || ^19.0.0-rc + checksum: cb8628018398aba010bb7b1f653cb7dc91d9bd59a40f1e7ee4cdc7732559e75062db790fb609fd3f748a9b80ccc0f421267a414ed9f5a7a4e079ef643e65333e + languageName: node + linkType: hard + "@medusajs/icons@npm:^2.5.1, @medusajs/icons@npm:~2.5.1": version: 2.5.1 resolution: "@medusajs/icons@npm:2.5.1" @@ -1648,19 +1657,19 @@ __metadata: languageName: node linkType: hard -"@medusajs/ui-preset@npm:~2.5.1": - version: 2.5.1 - resolution: "@medusajs/ui-preset@npm:2.5.1" +"@medusajs/ui-preset@npm:2.6.0": + version: 2.6.0 + resolution: "@medusajs/ui-preset@npm:2.6.0" dependencies: "@tailwindcss/forms": ^0.5.3 tailwindcss-animate: ^1.0.6 peerDependencies: tailwindcss: ">=3.0.0" - checksum: 7aee7a7e9f0acc8f6329434f1b502d1c5eabecb3a60b3207f435da17ce8c681e85cb0466a1f861f98eb0bd89e7f8363b5865c0f70ad546dfb6aaacb22887b182 + checksum: 8ea576d2f2f8b2805c943b28636800c8d950b4df3e3fe785476dbeceb04735d4ce618cf9acdf34dca0ec0c2fec2334d522bdeca24e535ceed065bab961617114 languageName: node linkType: hard -"@medusajs/ui@npm:~4.0.6": +"@medusajs/ui@npm:4.0.6": version: 4.0.6 resolution: "@medusajs/ui@npm:4.0.6" dependencies: @@ -5871,8 +5880,8 @@ __metadata: dependencies: "@mdx-js/loader": ^3.1.0 "@mdx-js/react": ^3.1.0 - "@medusajs/icons": ~2.5.1 - "@medusajs/ui": ~4.0.6 + "@medusajs/icons": 2.6.0 + "@medusajs/ui": 4.0.6 "@next/bundle-analyzer": 15.0.4 "@next/mdx": 15.0.4 "@react-hook/resize-observer": ^2.0.2 @@ -7508,8 +7517,8 @@ __metadata: resolution: "docs-ui@workspace:packages/docs-ui" dependencies: "@emotion/is-prop-valid": ^1.3.1 - "@medusajs/icons": ~2.5.1 - "@medusajs/ui": ~4.0.6 + "@medusajs/icons": 2.6.0 + "@medusajs/ui": 4.0.6 "@next/third-parties": 15.0.4 "@octokit/request": ^8.1.1 "@react-hook/resize-observer": ^1.2.6 @@ -14819,7 +14828,7 @@ __metadata: version: 0.0.0-use.local resolution: "tailwind@workspace:packages/tailwind" dependencies: - "@medusajs/ui-preset": ~2.5.1 + "@medusajs/ui-preset": 2.6.0 tailwindcss-animate: ^1.0.7 peerDependencies: docs-ui: "*" @@ -15376,7 +15385,7 @@ turbo@latest: version: 0.0.0-use.local resolution: "types@workspace:packages/types" dependencies: - "@medusajs/icons": ~2.5.1 + "@medusajs/icons": 2.6.0 "@types/node": ^20.11.20 rimraf: ^5.0.5 tsconfig: "*" @@ -15464,9 +15473,9 @@ turbo@latest: dependencies: "@faker-js/faker": ^8.0.2 "@mdx-js/react": ^3.1.0 - "@medusajs/icons": ~2.5.1 - "@medusajs/ui": ~4.0.6 - "@medusajs/ui-preset": ~2.5.1 + "@medusajs/icons": 2.6.0 + "@medusajs/ui": 4.0.6 + "@medusajs/ui-preset": 2.6.0 "@types/node": 20.4.9 "@types/react": "npm:types-react@rc" "@types/react-dom": "npm:types-react@rc" diff --git a/yarn.lock b/yarn.lock index 093603bee7..f96e803dd3 100644 --- a/yarn.lock +++ b/yarn.lock @@ -5259,14 +5259,14 @@ __metadata: languageName: node linkType: hard -"@medusajs/admin-bundler@^2.6.0, @medusajs/admin-bundler@workspace:packages/admin/admin-bundler": +"@medusajs/admin-bundler@2.6.0, @medusajs/admin-bundler@workspace:packages/admin/admin-bundler": version: 0.0.0-use.local resolution: "@medusajs/admin-bundler@workspace:packages/admin/admin-bundler" dependencies: "@medusajs/admin-shared": 2.6.0 "@medusajs/admin-vite-plugin": 2.6.0 "@medusajs/dashboard": 2.6.0 - "@medusajs/types": ^2.6.0 + "@medusajs/types": 2.6.0 "@rollup/plugin-node-resolve": ^16.0.0 "@types/compression": ^1.7.5 "@vitejs/plugin-react": ^4.2.1 @@ -5290,7 +5290,7 @@ __metadata: version: 0.0.0-use.local resolution: "@medusajs/admin-sdk@workspace:packages/admin/admin-sdk" dependencies: - "@medusajs/admin-shared": ^2.6.0 + "@medusajs/admin-shared": 2.6.0 "@types/react": ^18.3.2 tsup: ^8.0.1 typescript: ^5.3.3 @@ -5298,7 +5298,7 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/admin-shared@2.6.0, @medusajs/admin-shared@^2.6.0, @medusajs/admin-shared@workspace:packages/admin/admin-shared": +"@medusajs/admin-shared@2.6.0, @medusajs/admin-shared@workspace:packages/admin/admin-shared": version: 0.0.0-use.local resolution: "@medusajs/admin-shared@workspace:packages/admin/admin-shared" dependencies: @@ -5308,7 +5308,7 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/admin-vite-plugin@2.6.0, @medusajs/admin-vite-plugin@^2.6.0, @medusajs/admin-vite-plugin@workspace:packages/admin/admin-vite-plugin": +"@medusajs/admin-vite-plugin@2.6.0, @medusajs/admin-vite-plugin@workspace:packages/admin/admin-vite-plugin": version: 0.0.0-use.local resolution: "@medusajs/admin-vite-plugin@workspace:packages/admin/admin-vite-plugin" dependencies: @@ -5331,12 +5331,12 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/api-key@^2.6.0, @medusajs/api-key@workspace:^, @medusajs/api-key@workspace:packages/modules/api-key": +"@medusajs/api-key@2.6.0, @medusajs/api-key@workspace:^, @medusajs/api-key@workspace:packages/modules/api-key": version: 0.0.0-use.local resolution: "@medusajs/api-key@workspace:packages/modules/api-key" dependencies: - "@medusajs/framework": ^2.6.0 - "@medusajs/test-utils": ^2.6.0 + "@medusajs/framework": 2.6.0 + "@medusajs/test-utils": 2.6.0 "@mikro-orm/cli": 6.4.3 "@swc/core": ^1.7.28 "@swc/jest": ^0.2.36 @@ -5345,7 +5345,7 @@ __metadata: tsc-alias: ^1.8.6 typescript: ^5.6.2 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 "@mikro-orm/postgresql": 6.4.3 @@ -5353,11 +5353,11 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/auth-emailpass@^2.6.0, @medusajs/auth-emailpass@workspace:packages/modules/providers/auth-emailpass": +"@medusajs/auth-emailpass@2.6.0, @medusajs/auth-emailpass@workspace:packages/modules/providers/auth-emailpass": version: 0.0.0-use.local resolution: "@medusajs/auth-emailpass@workspace:packages/modules/providers/auth-emailpass" dependencies: - "@medusajs/framework": ^2.6.0 + "@medusajs/framework": 2.6.0 "@swc/core": ^1.7.28 "@swc/jest": ^0.2.36 jest: ^29.7.0 @@ -5365,15 +5365,15 @@ __metadata: scrypt-kdf: ^2.0.1 typescript: ^5.6.2 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 languageName: unknown linkType: soft -"@medusajs/auth-github@^2.6.0, @medusajs/auth-github@workspace:packages/modules/providers/auth-github": +"@medusajs/auth-github@2.6.0, @medusajs/auth-github@workspace:packages/modules/providers/auth-github": version: 0.0.0-use.local resolution: "@medusajs/auth-github@workspace:packages/modules/providers/auth-github" dependencies: - "@medusajs/framework": ^2.6.0 + "@medusajs/framework": 2.6.0 "@swc/core": ^1.7.28 "@swc/jest": ^0.2.36 jest: ^29.7.0 @@ -5381,15 +5381,15 @@ __metadata: rimraf: ^5.0.1 typescript: ^5.6.2 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 languageName: unknown linkType: soft -"@medusajs/auth-google@^2.6.0, @medusajs/auth-google@workspace:packages/modules/providers/auth-google": +"@medusajs/auth-google@2.6.0, @medusajs/auth-google@workspace:packages/modules/providers/auth-google": version: 0.0.0-use.local resolution: "@medusajs/auth-google@workspace:packages/modules/providers/auth-google" dependencies: - "@medusajs/framework": ^2.6.0 + "@medusajs/framework": 2.6.0 "@swc/core": ^1.7.28 "@swc/jest": ^0.2.36 jest: ^29.7.0 @@ -5398,16 +5398,16 @@ __metadata: rimraf: ^5.0.1 typescript: ^5.6.2 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 languageName: unknown linkType: soft -"@medusajs/auth@^2.6.0, @medusajs/auth@workspace:*, @medusajs/auth@workspace:packages/modules/auth": +"@medusajs/auth@2.6.0, @medusajs/auth@workspace:*, @medusajs/auth@workspace:packages/modules/auth": version: 0.0.0-use.local resolution: "@medusajs/auth@workspace:packages/modules/auth" dependencies: - "@medusajs/framework": ^2.6.0 - "@medusajs/test-utils": ^2.6.0 + "@medusajs/framework": 2.6.0 + "@medusajs/test-utils": 2.6.0 "@mikro-orm/cli": 6.4.3 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 @@ -5419,7 +5419,7 @@ __metadata: tsc-alias: ^1.8.6 typescript: ^5.6.2 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 "@mikro-orm/postgresql": 6.4.3 @@ -5427,26 +5427,26 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/cache-inmemory@^2.6.0, @medusajs/cache-inmemory@workspace:*, @medusajs/cache-inmemory@workspace:packages/modules/cache-inmemory": +"@medusajs/cache-inmemory@2.6.0, @medusajs/cache-inmemory@workspace:*, @medusajs/cache-inmemory@workspace:packages/modules/cache-inmemory": version: 0.0.0-use.local resolution: "@medusajs/cache-inmemory@workspace:packages/modules/cache-inmemory" dependencies: - "@medusajs/framework": ^2.6.0 + "@medusajs/framework": 2.6.0 "@swc/core": ^1.7.28 "@swc/jest": ^0.2.36 jest: ^29.7.0 rimraf: ^5.0.1 typescript: ^5.6.2 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 languageName: unknown linkType: soft -"@medusajs/cache-redis@^2.6.0, @medusajs/cache-redis@workspace:packages/modules/cache-redis": +"@medusajs/cache-redis@2.6.0, @medusajs/cache-redis@workspace:packages/modules/cache-redis": version: 0.0.0-use.local resolution: "@medusajs/cache-redis@workspace:packages/modules/cache-redis" dependencies: - "@medusajs/framework": ^2.6.0 + "@medusajs/framework": 2.6.0 "@swc/core": ^1.7.28 "@swc/jest": ^0.2.36 ioredis: ^5.4.1 @@ -5454,17 +5454,17 @@ __metadata: rimraf: ^5.0.1 typescript: ^5.6.2 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 awilix: ^8.0.1 languageName: unknown linkType: soft -"@medusajs/cart@^2.6.0, @medusajs/cart@workspace:packages/modules/cart": +"@medusajs/cart@2.6.0, @medusajs/cart@workspace:packages/modules/cart": version: 0.0.0-use.local resolution: "@medusajs/cart@workspace:packages/modules/cart" dependencies: - "@medusajs/framework": ^2.6.0 - "@medusajs/test-utils": ^2.6.0 + "@medusajs/framework": 2.6.0 + "@medusajs/test-utils": 2.6.0 "@mikro-orm/cli": 6.4.3 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 @@ -5476,7 +5476,7 @@ __metadata: tsc-alias: ^1.8.6 typescript: ^5.6.2 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 "@mikro-orm/postgresql": 6.4.3 @@ -5484,11 +5484,11 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/cli@^2.6.0, @medusajs/cli@workspace:packages/cli/medusa-cli": +"@medusajs/cli@2.6.0, @medusajs/cli@workspace:packages/cli/medusa-cli": version: 0.0.0-use.local resolution: "@medusajs/cli@workspace:packages/cli/medusa-cli" dependencies: - "@medusajs/telemetry": ^2.6.0 + "@medusajs/telemetry": 2.6.0 "@medusajs/utils": 2.6.0 "@mikro-orm/core": 6.4.3 "@mikro-orm/knex": 6.4.3 @@ -5535,11 +5535,11 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/core-flows@^2.6.0, @medusajs/core-flows@workspace:*, @medusajs/core-flows@workspace:^, @medusajs/core-flows@workspace:packages/core/core-flows": +"@medusajs/core-flows@2.6.0, @medusajs/core-flows@workspace:*, @medusajs/core-flows@workspace:^, @medusajs/core-flows@workspace:packages/core/core-flows": version: 0.0.0-use.local resolution: "@medusajs/core-flows@workspace:packages/core/core-flows" dependencies: - "@medusajs/framework": ^2.6.0 + "@medusajs/framework": 2.6.0 "@mikro-orm/core": 6.4.3 "@mikro-orm/knex": 6.4.3 "@mikro-orm/migrations": 6.4.3 @@ -5554,17 +5554,17 @@ __metadata: rimraf: ^5.0.1 typescript: ^5.6.2 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 awilix: ^8.0.1 languageName: unknown linkType: soft -"@medusajs/currency@^2.6.0, @medusajs/currency@workspace:^, @medusajs/currency@workspace:packages/modules/currency": +"@medusajs/currency@2.6.0, @medusajs/currency@workspace:^, @medusajs/currency@workspace:packages/modules/currency": version: 0.0.0-use.local resolution: "@medusajs/currency@workspace:packages/modules/currency" dependencies: - "@medusajs/framework": ^2.6.0 - "@medusajs/test-utils": ^2.6.0 + "@medusajs/framework": 2.6.0 + "@medusajs/test-utils": 2.6.0 "@mikro-orm/cli": 6.4.3 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 @@ -5576,7 +5576,7 @@ __metadata: tsc-alias: ^1.8.6 typescript: ^5.6.2 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 "@mikro-orm/postgresql": 6.4.3 @@ -5584,12 +5584,12 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/customer@^2.6.0, @medusajs/customer@workspace:^, @medusajs/customer@workspace:packages/modules/customer": +"@medusajs/customer@2.6.0, @medusajs/customer@workspace:^, @medusajs/customer@workspace:packages/modules/customer": version: 0.0.0-use.local resolution: "@medusajs/customer@workspace:packages/modules/customer" dependencies: - "@medusajs/framework": ^2.6.0 - "@medusajs/test-utils": ^2.6.0 + "@medusajs/framework": 2.6.0 + "@medusajs/test-utils": 2.6.0 "@mikro-orm/cli": 6.4.3 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 @@ -5601,7 +5601,7 @@ __metadata: tsc-alias: ^1.8.6 typescript: ^5.6.2 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 "@mikro-orm/postgresql": 6.4.3 @@ -5618,13 +5618,13 @@ __metadata: "@dnd-kit/sortable": ^8.0.0 "@hookform/error-message": ^2.0.1 "@hookform/resolvers": 3.4.2 - "@medusajs/admin-shared": ^2.6.0 - "@medusajs/admin-vite-plugin": ^2.6.0 - "@medusajs/icons": ^2.6.0 - "@medusajs/js-sdk": ^2.6.0 - "@medusajs/types": ^2.6.0 - "@medusajs/ui": ~4.0.6 - "@medusajs/ui-preset": ^2.6.0 + "@medusajs/admin-shared": 2.6.0 + "@medusajs/admin-vite-plugin": 2.6.0 + "@medusajs/icons": 2.6.0 + "@medusajs/js-sdk": 2.6.0 + "@medusajs/types": 2.6.0 + "@medusajs/ui": 4.0.6 + "@medusajs/ui-preset": 2.6.0 "@tanstack/react-query": 5.64.2 "@tanstack/react-table": 8.20.5 "@tanstack/react-virtual": ^3.8.3 @@ -5666,11 +5666,11 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/event-bus-local@^2.6.0, @medusajs/event-bus-local@workspace:*, @medusajs/event-bus-local@workspace:packages/modules/event-bus-local": +"@medusajs/event-bus-local@2.6.0, @medusajs/event-bus-local@workspace:*, @medusajs/event-bus-local@workspace:packages/modules/event-bus-local": version: 0.0.0-use.local resolution: "@medusajs/event-bus-local@workspace:packages/modules/event-bus-local" dependencies: - "@medusajs/framework": ^2.6.0 + "@medusajs/framework": 2.6.0 "@swc/core": ^1.7.28 "@swc/jest": ^0.2.36 jest: ^29.7.0 @@ -5678,15 +5678,15 @@ __metadata: typescript: ^5.6.2 ulid: ^2.3.0 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 languageName: unknown linkType: soft -"@medusajs/event-bus-redis@^2.6.0, @medusajs/event-bus-redis@workspace:packages/modules/event-bus-redis": +"@medusajs/event-bus-redis@2.6.0, @medusajs/event-bus-redis@workspace:packages/modules/event-bus-redis": version: 0.0.0-use.local resolution: "@medusajs/event-bus-redis@workspace:packages/modules/event-bus-redis" dependencies: - "@medusajs/framework": ^2.6.0 + "@medusajs/framework": 2.6.0 "@swc/core": ^1.7.28 "@swc/jest": ^0.2.36 bullmq: 5.13.0 @@ -5695,33 +5695,33 @@ __metadata: rimraf: ^5.0.1 typescript: ^5.6.2 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 awilix: ^8.0.1 languageName: unknown linkType: soft -"@medusajs/file-local@^2.6.0, @medusajs/file-local@workspace:packages/modules/providers/file-local": +"@medusajs/file-local@2.6.0, @medusajs/file-local@workspace:packages/modules/providers/file-local": version: 0.0.0-use.local resolution: "@medusajs/file-local@workspace:packages/modules/providers/file-local" dependencies: - "@medusajs/framework": ^2.6.0 + "@medusajs/framework": 2.6.0 "@swc/core": ^1.7.28 "@swc/jest": ^0.2.36 jest: ^29.7.0 rimraf: ^5.0.1 typescript: ^5.6.2 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 languageName: unknown linkType: soft -"@medusajs/file-s3@^2.6.0, @medusajs/file-s3@workspace:packages/modules/providers/file-s3": +"@medusajs/file-s3@2.6.0, @medusajs/file-s3@workspace:packages/modules/providers/file-s3": version: 0.0.0-use.local resolution: "@medusajs/file-s3@workspace:packages/modules/providers/file-s3" dependencies: "@aws-sdk/client-s3": ^3.556.0 "@aws-sdk/s3-request-presigner": ^3.556.0 - "@medusajs/framework": ^2.6.0 + "@medusajs/framework": 2.6.0 "@swc/core": ^1.7.28 "@swc/jest": ^0.2.36 axios: ^1.6.8 @@ -5730,16 +5730,16 @@ __metadata: typescript: ^5.6.2 ulid: ^2.3.0 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 languageName: unknown linkType: soft -"@medusajs/file@^2.6.0, @medusajs/file@workspace:packages/modules/file": +"@medusajs/file@2.6.0, @medusajs/file@workspace:packages/modules/file": version: 0.0.0-use.local resolution: "@medusajs/file@workspace:packages/modules/file" dependencies: - "@medusajs/framework": ^2.6.0 - "@medusajs/test-utils": ^2.6.0 + "@medusajs/framework": 2.6.0 + "@medusajs/test-utils": 2.6.0 "@mikro-orm/cli": 6.4.3 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 @@ -5751,23 +5751,23 @@ __metadata: tsc-alias: ^1.8.6 typescript: ^5.6.2 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 awilix: ^8.0.1 languageName: unknown linkType: soft -"@medusajs/framework@^2.6.0, @medusajs/framework@workspace:^, @medusajs/framework@workspace:packages/core/framework": +"@medusajs/framework@2.6.0, @medusajs/framework@workspace:^, @medusajs/framework@workspace:packages/core/framework": version: 0.0.0-use.local resolution: "@medusajs/framework@workspace:packages/core/framework" dependencies: "@jercle/yargonaut": ^1.1.5 - "@medusajs/cli": ^2.6.0 - "@medusajs/modules-sdk": ^2.6.0 - "@medusajs/orchestration": ^2.6.0 - "@medusajs/telemetry": ^2.6.0 - "@medusajs/types": ^2.6.0 - "@medusajs/utils": ^2.6.0 - "@medusajs/workflows-sdk": ^2.6.0 + "@medusajs/cli": 2.6.0 + "@medusajs/modules-sdk": 2.6.0 + "@medusajs/orchestration": 2.6.0 + "@medusajs/telemetry": 2.6.0 + "@medusajs/types": 2.6.0 + "@medusajs/utils": 2.6.0 + "@medusajs/workflows-sdk": 2.6.0 "@mikro-orm/core": 6.4.3 "@mikro-orm/knex": 6.4.3 "@mikro-orm/migrations": 6.4.3 @@ -5801,7 +5801,7 @@ __metadata: vite: ^5.4.14 zod: 3.22.4 peerDependencies: - "@medusajs/cli": ^2.4.0 + "@medusajs/cli": 2.6.0 "@mikro-orm/cli": 6.4.3 "@mikro-orm/core": 6.4.3 "@mikro-orm/knex": 6.4.3 @@ -5823,27 +5823,27 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/fulfillment-manual@^2.6.0, @medusajs/fulfillment-manual@workspace:^, @medusajs/fulfillment-manual@workspace:packages/modules/providers/fulfillment-manual": +"@medusajs/fulfillment-manual@2.6.0, @medusajs/fulfillment-manual@workspace:^, @medusajs/fulfillment-manual@workspace:packages/modules/providers/fulfillment-manual": version: 0.0.0-use.local resolution: "@medusajs/fulfillment-manual@workspace:packages/modules/providers/fulfillment-manual" dependencies: - "@medusajs/framework": ^2.6.0 + "@medusajs/framework": 2.6.0 "@swc/core": ^1.7.28 "@swc/jest": ^0.2.36 jest: ^29.7.0 rimraf: ^5.0.1 typescript: ^5.6.2 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 languageName: unknown linkType: soft -"@medusajs/fulfillment@^2.6.0, @medusajs/fulfillment@workspace:^, @medusajs/fulfillment@workspace:packages/modules/fulfillment": +"@medusajs/fulfillment@2.6.0, @medusajs/fulfillment@workspace:^, @medusajs/fulfillment@workspace:packages/modules/fulfillment": version: 0.0.0-use.local resolution: "@medusajs/fulfillment@workspace:packages/modules/fulfillment" dependencies: - "@medusajs/framework": ^2.6.0 - "@medusajs/test-utils": ^2.6.0 + "@medusajs/framework": 2.6.0 + "@medusajs/test-utils": 2.6.0 "@mikro-orm/cli": 6.4.3 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 @@ -5855,7 +5855,7 @@ __metadata: tsc-alias: ^1.8.6 typescript: ^5.6.2 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 "@mikro-orm/postgresql": 6.4.3 @@ -5863,12 +5863,12 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/icons@^2.5.1, @medusajs/icons@^2.6.0, @medusajs/icons@workspace:packages/design-system/icons": +"@medusajs/icons@2.6.0, @medusajs/icons@workspace:packages/design-system/icons": version: 0.0.0-use.local resolution: "@medusajs/icons@workspace:packages/design-system/icons" dependencies: "@atomico/rollup-plugin-sizes": ^1.1.4 - "@medusajs/toolbox": ^2.6.0 + "@medusajs/toolbox": 2.6.0 "@rollup/plugin-node-resolve": ^15.1.0 "@rollup/plugin-replace": ^5.0.2 "@testing-library/dom": ^9.3.1 @@ -5897,12 +5897,12 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/index@^2.6.0, @medusajs/index@workspace:packages/modules/index": +"@medusajs/index@2.6.0, @medusajs/index@workspace:packages/modules/index": version: 0.0.0-use.local resolution: "@medusajs/index@workspace:packages/modules/index" dependencies: - "@medusajs/framework": ^2.6.0 - "@medusajs/test-utils": ^2.6.0 + "@medusajs/framework": 2.6.0 + "@medusajs/test-utils": 2.6.0 "@mikro-orm/cli": 6.4.3 "@mikro-orm/core": 6.4.3 "@mikro-orm/knex": 6.4.3 @@ -5915,7 +5915,7 @@ __metadata: tsc-alias: ^1.8.6 typescript: ^5.6.2 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 "@mikro-orm/core": 6.4.3 "@mikro-orm/knex": 6.4.3 "@mikro-orm/migrations": 6.4.3 @@ -5924,12 +5924,12 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/inventory@^2.6.0, @medusajs/inventory@workspace:^, @medusajs/inventory@workspace:packages/modules/inventory": +"@medusajs/inventory@2.6.0, @medusajs/inventory@workspace:^, @medusajs/inventory@workspace:packages/modules/inventory": version: 0.0.0-use.local resolution: "@medusajs/inventory@workspace:packages/modules/inventory" dependencies: - "@medusajs/framework": ^2.6.0 - "@medusajs/test-utils": ^2.6.0 + "@medusajs/framework": 2.6.0 + "@medusajs/test-utils": 2.6.0 "@mikro-orm/cli": 6.4.3 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 @@ -5941,7 +5941,7 @@ __metadata: tsc-alias: ^1.8.6 typescript: ^5.6.2 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 "@mikro-orm/postgresql": 6.4.3 @@ -5949,11 +5949,11 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/js-sdk@^2.6.0, @medusajs/js-sdk@workspace:packages/core/js-sdk": +"@medusajs/js-sdk@2.6.0, @medusajs/js-sdk@workspace:packages/core/js-sdk": version: 0.0.0-use.local resolution: "@medusajs/js-sdk@workspace:packages/core/js-sdk" dependencies: - "@medusajs/types": ^2.6.0 + "@medusajs/types": 2.6.0 fetch-event-stream: ^0.1.5 jest: ^29.7.0 msw: ^2.3.0 @@ -5963,12 +5963,12 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/link-modules@^2.6.0, @medusajs/link-modules@workspace:^, @medusajs/link-modules@workspace:packages/modules/link-modules": +"@medusajs/link-modules@2.6.0, @medusajs/link-modules@workspace:^, @medusajs/link-modules@workspace:packages/modules/link-modules": version: 0.0.0-use.local resolution: "@medusajs/link-modules@workspace:packages/modules/link-modules" dependencies: - "@medusajs/framework": ^2.6.0 - "@medusajs/test-utils": ^2.6.0 + "@medusajs/framework": 2.6.0 + "@medusajs/test-utils": 2.6.0 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 "@mikro-orm/postgresql": 6.4.3 @@ -5980,7 +5980,7 @@ __metadata: tsc-alias: ^1.8.6 typescript: ^5.6.2 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 "@mikro-orm/postgresql": 6.4.3 @@ -5988,11 +5988,11 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/locking-postgres@^2.6.0, @medusajs/locking-postgres@workspace:packages/modules/providers/locking-postgres": +"@medusajs/locking-postgres@2.6.0, @medusajs/locking-postgres@workspace:packages/modules/providers/locking-postgres": version: 0.0.0-use.local resolution: "@medusajs/locking-postgres@workspace:packages/modules/providers/locking-postgres" dependencies: - "@medusajs/framework": ^2.6.0 + "@medusajs/framework": 2.6.0 "@mikro-orm/cli": 6.4.3 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 @@ -6003,15 +6003,15 @@ __metadata: rimraf: ^5.0.1 typescript: ^5.6.2 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 languageName: unknown linkType: soft -"@medusajs/locking-redis@^2.6.0, @medusajs/locking-redis@workspace:packages/modules/providers/locking-redis": +"@medusajs/locking-redis@2.6.0, @medusajs/locking-redis@workspace:packages/modules/providers/locking-redis": version: 0.0.0-use.local resolution: "@medusajs/locking-redis@workspace:packages/modules/providers/locking-redis" dependencies: - "@medusajs/framework": ^2.6.0 + "@medusajs/framework": 2.6.0 "@swc/core": ^1.7.28 "@swc/jest": ^0.2.36 ioredis: ^5.4.1 @@ -6019,16 +6019,16 @@ __metadata: rimraf: ^5.0.1 typescript: ^5.6.2 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 languageName: unknown linkType: soft -"@medusajs/locking@^2.6.0, @medusajs/locking@workspace:packages/modules/locking": +"@medusajs/locking@2.6.0, @medusajs/locking@workspace:packages/modules/locking": version: 0.0.0-use.local resolution: "@medusajs/locking@workspace:packages/modules/locking" dependencies: - "@medusajs/framework": ^2.6.0 - "@medusajs/test-utils": ^2.6.0 + "@medusajs/framework": 2.6.0 + "@medusajs/test-utils": 2.6.0 "@mikro-orm/cli": 6.4.3 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 @@ -6040,7 +6040,7 @@ __metadata: tsc-alias: ^1.8.6 typescript: ^5.6.2 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 "@mikro-orm/postgresql": 6.4.3 @@ -6052,9 +6052,9 @@ __metadata: version: 0.0.0-use.local resolution: "@medusajs/medusa-oas-cli@workspace:packages/cli/oas/medusa-oas-cli" dependencies: - "@medusajs/medusa": ^2.6.0 - "@medusajs/types": ^2.6.0 - "@medusajs/utils": ^2.6.0 + "@medusajs/medusa": 2.6.0 + "@medusajs/types": 2.6.0 + "@medusajs/utils": 2.6.0 "@readme/json-schema-ref-parser": ^1.2.0 "@readme/openapi-parser": ^2.4.0 "@redocly/cli": ^1.7.0 @@ -6077,64 +6077,64 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/medusa@^2.6.0, @medusajs/medusa@workspace:*, @medusajs/medusa@workspace:packages/medusa": +"@medusajs/medusa@2.6.0, @medusajs/medusa@workspace:*, @medusajs/medusa@workspace:packages/medusa": version: 0.0.0-use.local resolution: "@medusajs/medusa@workspace:packages/medusa" dependencies: "@inquirer/checkbox": ^2.3.11 "@inquirer/input": ^2.2.9 - "@medusajs/admin-bundler": ^2.6.0 - "@medusajs/api-key": ^2.6.0 - "@medusajs/auth": ^2.6.0 - "@medusajs/auth-emailpass": ^2.6.0 - "@medusajs/auth-github": ^2.6.0 - "@medusajs/auth-google": ^2.6.0 - "@medusajs/cache-inmemory": ^2.6.0 - "@medusajs/cache-redis": ^2.6.0 - "@medusajs/cart": ^2.6.0 - "@medusajs/core-flows": ^2.6.0 - "@medusajs/currency": ^2.6.0 - "@medusajs/customer": ^2.6.0 - "@medusajs/event-bus-local": ^2.6.0 - "@medusajs/event-bus-redis": ^2.6.0 - "@medusajs/file": ^2.6.0 - "@medusajs/file-local": ^2.6.0 - "@medusajs/file-s3": ^2.6.0 - "@medusajs/framework": ^2.6.0 - "@medusajs/fulfillment": ^2.6.0 - "@medusajs/fulfillment-manual": ^2.6.0 - "@medusajs/index": ^2.6.0 - "@medusajs/inventory": ^2.6.0 - "@medusajs/link-modules": ^2.6.0 - "@medusajs/locking": ^2.6.0 - "@medusajs/locking-postgres": ^2.6.0 - "@medusajs/locking-redis": ^2.6.0 - "@medusajs/notification": ^2.6.0 - "@medusajs/notification-local": ^2.6.0 - "@medusajs/notification-sendgrid": ^2.6.0 - "@medusajs/order": ^2.6.0 - "@medusajs/payment": ^2.6.0 - "@medusajs/payment-stripe": ^2.6.0 - "@medusajs/pricing": ^2.6.0 - "@medusajs/product": ^2.6.0 - "@medusajs/promotion": ^2.6.0 - "@medusajs/region": ^2.6.0 - "@medusajs/sales-channel": ^2.6.0 - "@medusajs/stock-location": ^2.6.0 - "@medusajs/store": ^2.6.0 - "@medusajs/tax": ^2.6.0 - "@medusajs/telemetry": ^2.6.0 - "@medusajs/user": ^2.6.0 - "@medusajs/workflow-engine-inmemory": ^2.6.0 - "@medusajs/workflow-engine-redis": ^2.6.0 + "@medusajs/admin-bundler": 2.6.0 + "@medusajs/api-key": 2.6.0 + "@medusajs/auth": 2.6.0 + "@medusajs/auth-emailpass": 2.6.0 + "@medusajs/auth-github": 2.6.0 + "@medusajs/auth-google": 2.6.0 + "@medusajs/cache-inmemory": 2.6.0 + "@medusajs/cache-redis": 2.6.0 + "@medusajs/cart": 2.6.0 + "@medusajs/core-flows": 2.6.0 + "@medusajs/currency": 2.6.0 + "@medusajs/customer": 2.6.0 + "@medusajs/event-bus-local": 2.6.0 + "@medusajs/event-bus-redis": 2.6.0 + "@medusajs/file": 2.6.0 + "@medusajs/file-local": 2.6.0 + "@medusajs/file-s3": 2.6.0 + "@medusajs/framework": 2.6.0 + "@medusajs/fulfillment": 2.6.0 + "@medusajs/fulfillment-manual": 2.6.0 + "@medusajs/index": 2.6.0 + "@medusajs/inventory": 2.6.0 + "@medusajs/link-modules": 2.6.0 + "@medusajs/locking": 2.6.0 + "@medusajs/locking-postgres": 2.6.0 + "@medusajs/locking-redis": 2.6.0 + "@medusajs/notification": 2.6.0 + "@medusajs/notification-local": 2.6.0 + "@medusajs/notification-sendgrid": 2.6.0 + "@medusajs/order": 2.6.0 + "@medusajs/payment": 2.6.0 + "@medusajs/payment-stripe": 2.6.0 + "@medusajs/pricing": 2.6.0 + "@medusajs/product": 2.6.0 + "@medusajs/promotion": 2.6.0 + "@medusajs/region": 2.6.0 + "@medusajs/sales-channel": 2.6.0 + "@medusajs/stock-location": 2.6.0 + "@medusajs/store": 2.6.0 + "@medusajs/tax": 2.6.0 + "@medusajs/telemetry": 2.6.0 + "@medusajs/user": 2.6.0 + "@medusajs/workflow-engine-inmemory": 2.6.0 + "@medusajs/workflow-engine-redis": 2.6.0 "@opentelemetry/api": ^1.9.0 "@opentelemetry/instrumentation": ^0.53.0 "@opentelemetry/instrumentation-pg": ^0.44.0 "@opentelemetry/resources": ^1.26.0 "@opentelemetry/sdk-node": ^0.53.0 "@opentelemetry/sdk-trace-node": ^1.26.0 - "@swc/core": ^1.7.28 - "@swc/helpers": ^0.5.0 + "@swc/core": 1.5.7 + "@swc/helpers": ^0.5.11 "@swc/jest": ^0.2.36 "@types/express": ^4.17.17 "@types/jsonwebtoken": ^8.5.9 @@ -6161,12 +6161,12 @@ __metadata: yalc: 1.0.0-pre.53 zod: 3.22.4 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 "@mikro-orm/core": 6.4.3 "@mikro-orm/knex": 6.4.3 "@mikro-orm/migrations": 6.4.3 "@mikro-orm/postgresql": 6.4.3 - "@swc/core": ^1.7.28 + "@swc/core": 1.5.7 awilix: ^8.0.1 react-dom: ^18.0.0 yalc: 1.0.0-pre.53 @@ -6180,13 +6180,13 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/modules-sdk@^2.6.0, @medusajs/modules-sdk@workspace:^, @medusajs/modules-sdk@workspace:packages/core/modules-sdk": +"@medusajs/modules-sdk@2.6.0, @medusajs/modules-sdk@workspace:^, @medusajs/modules-sdk@workspace:packages/core/modules-sdk": version: 0.0.0-use.local resolution: "@medusajs/modules-sdk@workspace:packages/core/modules-sdk" dependencies: - "@medusajs/orchestration": ^2.6.0 - "@medusajs/types": ^2.6.0 - "@medusajs/utils": ^2.6.0 + "@medusajs/orchestration": 2.6.0 + "@medusajs/types": 2.6.0 + "@medusajs/utils": 2.6.0 "@mikro-orm/core": 6.4.3 "@mikro-orm/knex": 6.4.3 "@mikro-orm/migrations": 6.4.3 @@ -6210,26 +6210,26 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/notification-local@^2.6.0, @medusajs/notification-local@workspace:packages/modules/providers/notification-local": +"@medusajs/notification-local@2.6.0, @medusajs/notification-local@workspace:packages/modules/providers/notification-local": version: 0.0.0-use.local resolution: "@medusajs/notification-local@workspace:packages/modules/providers/notification-local" dependencies: - "@medusajs/framework": ^2.6.0 + "@medusajs/framework": 2.6.0 "@swc/core": ^1.7.28 "@swc/jest": ^0.2.36 jest: ^29.7.0 rimraf: ^5.0.1 typescript: ^5.6.2 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 languageName: unknown linkType: soft -"@medusajs/notification-sendgrid@^2.6.0, @medusajs/notification-sendgrid@workspace:packages/modules/providers/notification-sendgrid": +"@medusajs/notification-sendgrid@2.6.0, @medusajs/notification-sendgrid@workspace:packages/modules/providers/notification-sendgrid": version: 0.0.0-use.local resolution: "@medusajs/notification-sendgrid@workspace:packages/modules/providers/notification-sendgrid" dependencies: - "@medusajs/framework": ^2.6.0 + "@medusajs/framework": 2.6.0 "@sendgrid/mail": ^8.1.3 "@swc/core": ^1.7.28 "@swc/jest": ^0.2.36 @@ -6237,16 +6237,16 @@ __metadata: rimraf: ^5.0.1 typescript: ^5.6.2 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 languageName: unknown linkType: soft -"@medusajs/notification@^2.6.0, @medusajs/notification@workspace:packages/modules/notification": +"@medusajs/notification@2.6.0, @medusajs/notification@workspace:packages/modules/notification": version: 0.0.0-use.local resolution: "@medusajs/notification@workspace:packages/modules/notification" dependencies: - "@medusajs/framework": ^2.6.0 - "@medusajs/test-utils": ^2.6.0 + "@medusajs/framework": 2.6.0 + "@medusajs/test-utils": 2.6.0 "@mikro-orm/cli": 6.4.3 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 @@ -6258,7 +6258,7 @@ __metadata: tsc-alias: ^1.8.6 typescript: ^5.6.2 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 "@mikro-orm/postgresql": 6.4.3 @@ -6275,12 +6275,12 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/orchestration@^2.6.0, @medusajs/orchestration@workspace:packages/core/orchestration": +"@medusajs/orchestration@2.6.0, @medusajs/orchestration@workspace:packages/core/orchestration": version: 0.0.0-use.local resolution: "@medusajs/orchestration@workspace:packages/core/orchestration" dependencies: - "@medusajs/types": ^2.6.0 - "@medusajs/utils": ^2.6.0 + "@medusajs/types": 2.6.0 + "@medusajs/utils": 2.6.0 "@mikro-orm/core": 6.4.3 "@mikro-orm/knex": 6.4.3 "@mikro-orm/migrations": 6.4.3 @@ -6303,12 +6303,12 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/order@^2.6.0, @medusajs/order@workspace:packages/modules/order": +"@medusajs/order@2.6.0, @medusajs/order@workspace:packages/modules/order": version: 0.0.0-use.local resolution: "@medusajs/order@workspace:packages/modules/order" dependencies: - "@medusajs/framework": ^2.6.0 - "@medusajs/test-utils": ^2.6.0 + "@medusajs/framework": 2.6.0 + "@medusajs/test-utils": 2.6.0 "@mikro-orm/cli": 6.4.3 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 @@ -6320,7 +6320,7 @@ __metadata: tsc-alias: ^1.8.6 typescript: ^5.6.2 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 "@mikro-orm/postgresql": 6.4.3 @@ -6328,11 +6328,11 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/payment-stripe@^2.6.0, @medusajs/payment-stripe@workspace:packages/modules/providers/payment-stripe": +"@medusajs/payment-stripe@2.6.0, @medusajs/payment-stripe@workspace:packages/modules/providers/payment-stripe": version: 0.0.0-use.local resolution: "@medusajs/payment-stripe@workspace:packages/modules/providers/payment-stripe" dependencies: - "@medusajs/framework": ^2.6.0 + "@medusajs/framework": 2.6.0 "@swc/core": ^1.7.28 "@swc/jest": ^0.2.36 jest: ^29.7.0 @@ -6340,17 +6340,17 @@ __metadata: stripe: ^15.5.0 typescript: ^5.6.2 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 awilix: ^8.0.1 languageName: unknown linkType: soft -"@medusajs/payment@^2.6.0, @medusajs/payment@workspace:^, @medusajs/payment@workspace:packages/modules/payment": +"@medusajs/payment@2.6.0, @medusajs/payment@workspace:^, @medusajs/payment@workspace:packages/modules/payment": version: 0.0.0-use.local resolution: "@medusajs/payment@workspace:packages/modules/payment" dependencies: - "@medusajs/framework": ^2.6.0 - "@medusajs/test-utils": ^2.6.0 + "@medusajs/framework": 2.6.0 + "@medusajs/test-utils": 2.6.0 "@mikro-orm/cli": 6.4.3 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 @@ -6362,7 +6362,7 @@ __metadata: tsc-alias: ^1.8.6 typescript: ^5.6.2 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 "@mikro-orm/postgresql": 6.4.3 @@ -6370,12 +6370,12 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/pricing@^2.6.0, @medusajs/pricing@workspace:^, @medusajs/pricing@workspace:packages/modules/pricing": +"@medusajs/pricing@2.6.0, @medusajs/pricing@workspace:^, @medusajs/pricing@workspace:packages/modules/pricing": version: 0.0.0-use.local resolution: "@medusajs/pricing@workspace:packages/modules/pricing" dependencies: - "@medusajs/framework": ^2.6.0 - "@medusajs/test-utils": ^2.6.0 + "@medusajs/framework": 2.6.0 + "@medusajs/test-utils": 2.6.0 "@mikro-orm/cli": 6.4.3 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 @@ -6387,7 +6387,7 @@ __metadata: tsc-alias: ^1.8.6 typescript: ^5.6.2 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 "@mikro-orm/postgresql": 6.4.3 @@ -6395,12 +6395,12 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/product@^2.6.0, @medusajs/product@workspace:^, @medusajs/product@workspace:packages/modules/product": +"@medusajs/product@2.6.0, @medusajs/product@workspace:^, @medusajs/product@workspace:packages/modules/product": version: 0.0.0-use.local resolution: "@medusajs/product@workspace:packages/modules/product" dependencies: - "@medusajs/framework": ^2.6.0 - "@medusajs/test-utils": ^2.6.0 + "@medusajs/framework": 2.6.0 + "@medusajs/test-utils": 2.6.0 "@mikro-orm/cli": 6.4.3 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 @@ -6413,7 +6413,7 @@ __metadata: tsc-alias: ^1.8.6 typescript: ^5.6.2 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 "@mikro-orm/postgresql": 6.4.3 @@ -6421,12 +6421,12 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/promotion@^2.6.0, @medusajs/promotion@workspace:^, @medusajs/promotion@workspace:packages/modules/promotion": +"@medusajs/promotion@2.6.0, @medusajs/promotion@workspace:^, @medusajs/promotion@workspace:packages/modules/promotion": version: 0.0.0-use.local resolution: "@medusajs/promotion@workspace:packages/modules/promotion" dependencies: - "@medusajs/framework": ^2.6.0 - "@medusajs/test-utils": ^2.6.0 + "@medusajs/framework": 2.6.0 + "@medusajs/test-utils": 2.6.0 "@mikro-orm/cli": 6.4.3 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 @@ -6438,7 +6438,7 @@ __metadata: tsc-alias: ^1.8.6 typescript: ^5.6.2 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 "@mikro-orm/postgresql": 6.4.3 @@ -6446,12 +6446,12 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/region@^2.6.0, @medusajs/region@workspace:^, @medusajs/region@workspace:packages/modules/region": +"@medusajs/region@2.6.0, @medusajs/region@workspace:^, @medusajs/region@workspace:packages/modules/region": version: 0.0.0-use.local resolution: "@medusajs/region@workspace:packages/modules/region" dependencies: - "@medusajs/framework": ^2.6.0 - "@medusajs/test-utils": ^2.6.0 + "@medusajs/framework": 2.6.0 + "@medusajs/test-utils": 2.6.0 "@mikro-orm/cli": 6.4.3 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 @@ -6463,7 +6463,7 @@ __metadata: tsc-alias: ^1.8.6 typescript: ^5.6.2 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 "@mikro-orm/postgresql": 6.4.3 @@ -6471,12 +6471,12 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/sales-channel@^2.6.0, @medusajs/sales-channel@workspace:packages/modules/sales-channel": +"@medusajs/sales-channel@2.6.0, @medusajs/sales-channel@workspace:packages/modules/sales-channel": version: 0.0.0-use.local resolution: "@medusajs/sales-channel@workspace:packages/modules/sales-channel" dependencies: - "@medusajs/framework": ^2.6.0 - "@medusajs/test-utils": ^2.6.0 + "@medusajs/framework": 2.6.0 + "@medusajs/test-utils": 2.6.0 "@mikro-orm/cli": 6.4.3 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 @@ -6488,7 +6488,7 @@ __metadata: tsc-alias: ^1.8.6 typescript: ^5.6.2 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 "@mikro-orm/postgresql": 6.4.3 @@ -6496,12 +6496,12 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/stock-location@^2.6.0, @medusajs/stock-location@workspace:^, @medusajs/stock-location@workspace:packages/modules/stock-location": +"@medusajs/stock-location@2.6.0, @medusajs/stock-location@workspace:^, @medusajs/stock-location@workspace:packages/modules/stock-location": version: 0.0.0-use.local resolution: "@medusajs/stock-location@workspace:packages/modules/stock-location" dependencies: - "@medusajs/framework": ^2.6.0 - "@medusajs/test-utils": ^2.6.0 + "@medusajs/framework": 2.6.0 + "@medusajs/test-utils": 2.6.0 "@mikro-orm/cli": 6.4.3 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 @@ -6513,7 +6513,7 @@ __metadata: tsc-alias: ^1.8.6 typescript: ^5.6.2 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 "@mikro-orm/postgresql": 6.4.3 @@ -6521,12 +6521,12 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/store@^2.6.0, @medusajs/store@workspace:^, @medusajs/store@workspace:packages/modules/store": +"@medusajs/store@2.6.0, @medusajs/store@workspace:^, @medusajs/store@workspace:packages/modules/store": version: 0.0.0-use.local resolution: "@medusajs/store@workspace:packages/modules/store" dependencies: - "@medusajs/framework": ^2.6.0 - "@medusajs/test-utils": ^2.6.0 + "@medusajs/framework": 2.6.0 + "@medusajs/test-utils": 2.6.0 "@mikro-orm/cli": 6.4.3 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 @@ -6538,7 +6538,7 @@ __metadata: tsc-alias: ^1.8.6 typescript: ^5.6.2 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 "@mikro-orm/postgresql": 6.4.3 @@ -6546,12 +6546,12 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/tax@^2.6.0, @medusajs/tax@workspace:^, @medusajs/tax@workspace:packages/modules/tax": +"@medusajs/tax@2.6.0, @medusajs/tax@workspace:^, @medusajs/tax@workspace:packages/modules/tax": version: 0.0.0-use.local resolution: "@medusajs/tax@workspace:packages/modules/tax" dependencies: - "@medusajs/framework": ^2.6.0 - "@medusajs/test-utils": ^2.6.0 + "@medusajs/framework": 2.6.0 + "@medusajs/test-utils": 2.6.0 "@mikro-orm/cli": 6.4.3 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 @@ -6563,7 +6563,7 @@ __metadata: tsc-alias: ^1.8.6 typescript: ^5.6.2 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 "@mikro-orm/postgresql": 6.4.3 @@ -6571,7 +6571,7 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/telemetry@^2.6.0, @medusajs/telemetry@workspace:packages/medusa-telemetry": +"@medusajs/telemetry@2.6.0, @medusajs/telemetry@workspace:packages/medusa-telemetry": version: 0.0.0-use.local resolution: "@medusajs/telemetry@workspace:packages/medusa-telemetry" dependencies: @@ -6593,11 +6593,11 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/test-utils@^2.6.0, @medusajs/test-utils@workspace:*, @medusajs/test-utils@workspace:packages/medusa-test-utils": +"@medusajs/test-utils@2.6.0, @medusajs/test-utils@workspace:*, @medusajs/test-utils@workspace:packages/medusa-test-utils": version: 0.0.0-use.local resolution: "@medusajs/test-utils@workspace:packages/medusa-test-utils" dependencies: - "@medusajs/framework": ^2.6.0 + "@medusajs/framework": 2.6.0 "@mikro-orm/core": 6.4.3 "@mikro-orm/knex": 6.4.3 "@mikro-orm/migrations": 6.4.3 @@ -6614,8 +6614,8 @@ __metadata: rimraf: ^3.0.2 typescript: ^5.6.2 peerDependencies: - "@medusajs/framework": ^2.4.0 - "@medusajs/medusa": ^2.4.0 + "@medusajs/framework": 2.6.0 + "@medusajs/medusa": 2.6.0 "@mikro-orm/postgresql": 6.4.3 awilix: ^8.0.1 peerDependenciesMeta: @@ -6624,7 +6624,7 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/toolbox@^2.6.0, @medusajs/toolbox@workspace:packages/design-system/toolbox": +"@medusajs/toolbox@2.6.0, @medusajs/toolbox@workspace:packages/design-system/toolbox": version: 0.0.0-use.local resolution: "@medusajs/toolbox@workspace:packages/design-system/toolbox" dependencies: @@ -6650,7 +6650,7 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/types@^2.6.0, @medusajs/types@workspace:^, @medusajs/types@workspace:packages/core/types": +"@medusajs/types@2.6.0, @medusajs/types@workspace:^, @medusajs/types@workspace:packages/core/types": version: 0.0.0-use.local resolution: "@medusajs/types@workspace:packages/core/types" dependencies: @@ -6673,11 +6673,11 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/ui-preset@^2.5.1, @medusajs/ui-preset@^2.6.0, @medusajs/ui-preset@workspace:packages/design-system/ui-preset": +"@medusajs/ui-preset@2.6.0, @medusajs/ui-preset@workspace:packages/design-system/ui-preset": version: 0.0.0-use.local resolution: "@medusajs/ui-preset@workspace:packages/design-system/ui-preset" dependencies: - "@medusajs/toolbox": ^2.6.0 + "@medusajs/toolbox": 2.6.0 "@tailwindcss/forms": ^0.5.3 tailwindcss: ^3.4.1 tailwindcss-animate: ^1.0.6 @@ -6688,13 +6688,13 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/ui@workspace:packages/design-system/ui, @medusajs/ui@~4.0.6": +"@medusajs/ui@4.0.6, @medusajs/ui@workspace:packages/design-system/ui": version: 0.0.0-use.local resolution: "@medusajs/ui@workspace:packages/design-system/ui" dependencies: "@faker-js/faker": ^9.2.0 - "@medusajs/icons": ^2.5.1 - "@medusajs/ui-preset": ^2.5.1 + "@medusajs/icons": 2.6.0 + "@medusajs/ui-preset": 2.6.0 "@storybook/addon-essentials": ^8.3.5 "@storybook/addon-interactions": ^8.3.5 "@storybook/addon-links": ^8.3.5 @@ -6748,12 +6748,12 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/user@^2.6.0, @medusajs/user@workspace:^, @medusajs/user@workspace:packages/modules/user": +"@medusajs/user@2.6.0, @medusajs/user@workspace:^, @medusajs/user@workspace:packages/modules/user": version: 0.0.0-use.local resolution: "@medusajs/user@workspace:packages/modules/user" dependencies: - "@medusajs/framework": ^2.6.0 - "@medusajs/test-utils": ^2.6.0 + "@medusajs/framework": 2.6.0 + "@medusajs/test-utils": 2.6.0 "@mikro-orm/cli": 6.4.3 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 @@ -6766,7 +6766,7 @@ __metadata: tsc-alias: ^1.8.6 typescript: ^5.6.2 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 "@mikro-orm/postgresql": 6.4.3 @@ -6774,7 +6774,7 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/utils@2.6.0, @medusajs/utils@^2.6.0, @medusajs/utils@workspace:^, @medusajs/utils@workspace:packages/core/utils": +"@medusajs/utils@2.6.0, @medusajs/utils@workspace:^, @medusajs/utils@workspace:packages/core/utils": version: 0.0.0-use.local resolution: "@medusajs/utils@workspace:packages/core/utils" dependencies: @@ -6782,7 +6782,7 @@ __metadata: "@graphql-codegen/typescript": ^4.0.9 "@graphql-tools/merge": ^9.0.7 "@graphql-tools/schema": ^10.0.6 - "@medusajs/types": ^2.6.0 + "@medusajs/types": 2.6.0 "@mikro-orm/core": 6.4.3 "@mikro-orm/knex": 6.4.3 "@mikro-orm/migrations": 6.4.3 @@ -6818,12 +6818,12 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/workflow-engine-inmemory@^2.6.0, @medusajs/workflow-engine-inmemory@workspace:*, @medusajs/workflow-engine-inmemory@workspace:packages/modules/workflow-engine-inmemory": +"@medusajs/workflow-engine-inmemory@2.6.0, @medusajs/workflow-engine-inmemory@workspace:*, @medusajs/workflow-engine-inmemory@workspace:packages/modules/workflow-engine-inmemory": version: 0.0.0-use.local resolution: "@medusajs/workflow-engine-inmemory@workspace:packages/modules/workflow-engine-inmemory" dependencies: - "@medusajs/framework": ^2.6.0 - "@medusajs/test-utils": ^2.6.0 + "@medusajs/framework": 2.6.0 + "@medusajs/test-utils": 2.6.0 "@mikro-orm/cli": 6.4.3 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 @@ -6837,7 +6837,7 @@ __metadata: typescript: ^5.6.2 ulid: ^2.3.0 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 "@mikro-orm/postgresql": 6.4.3 @@ -6845,12 +6845,12 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/workflow-engine-redis@^2.6.0, @medusajs/workflow-engine-redis@workspace:packages/modules/workflow-engine-redis": +"@medusajs/workflow-engine-redis@2.6.0, @medusajs/workflow-engine-redis@workspace:packages/modules/workflow-engine-redis": version: 0.0.0-use.local resolution: "@medusajs/workflow-engine-redis@workspace:packages/modules/workflow-engine-redis" dependencies: - "@medusajs/framework": ^2.6.0 - "@medusajs/test-utils": ^2.6.0 + "@medusajs/framework": 2.6.0 + "@medusajs/test-utils": 2.6.0 "@mikro-orm/cli": 6.4.3 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 @@ -6865,7 +6865,7 @@ __metadata: typescript: ^5.6.2 ulid: ^2.3.0 peerDependencies: - "@medusajs/framework": ^2.4.0 + "@medusajs/framework": 2.6.0 "@mikro-orm/core": 6.4.3 "@mikro-orm/migrations": 6.4.3 "@mikro-orm/postgresql": 6.4.3 @@ -6873,14 +6873,14 @@ __metadata: languageName: unknown linkType: soft -"@medusajs/workflows-sdk@^2.6.0, @medusajs/workflows-sdk@workspace:packages/core/workflows-sdk": +"@medusajs/workflows-sdk@2.6.0, @medusajs/workflows-sdk@workspace:packages/core/workflows-sdk": version: 0.0.0-use.local resolution: "@medusajs/workflows-sdk@workspace:packages/core/workflows-sdk" dependencies: - "@medusajs/modules-sdk": ^2.6.0 - "@medusajs/orchestration": ^2.6.0 - "@medusajs/types": ^2.6.0 - "@medusajs/utils": ^2.6.0 + "@medusajs/modules-sdk": 2.6.0 + "@medusajs/orchestration": 2.6.0 + "@medusajs/types": 2.6.0 + "@medusajs/utils": 2.6.0 "@mikro-orm/core": 6.4.3 "@mikro-orm/knex": 6.4.3 "@mikro-orm/migrations": 6.4.3 @@ -13255,6 +13255,13 @@ __metadata: languageName: node linkType: hard +"@swc/core-darwin-arm64@npm:1.5.7": + version: 1.5.7 + resolution: "@swc/core-darwin-arm64@npm:1.5.7" + conditions: os=darwin & cpu=arm64 + languageName: node + linkType: hard + "@swc/core-darwin-arm64@npm:1.7.28": version: 1.7.28 resolution: "@swc/core-darwin-arm64@npm:1.7.28" @@ -13269,6 +13276,13 @@ __metadata: languageName: node linkType: hard +"@swc/core-darwin-x64@npm:1.5.7": + version: 1.5.7 + resolution: "@swc/core-darwin-x64@npm:1.5.7" + conditions: os=darwin & cpu=x64 + languageName: node + linkType: hard + "@swc/core-darwin-x64@npm:1.7.28": version: 1.7.28 resolution: "@swc/core-darwin-x64@npm:1.7.28" @@ -13283,6 +13297,13 @@ __metadata: languageName: node linkType: hard +"@swc/core-linux-arm-gnueabihf@npm:1.5.7": + version: 1.5.7 + resolution: "@swc/core-linux-arm-gnueabihf@npm:1.5.7" + conditions: os=linux & cpu=arm + languageName: node + linkType: hard + "@swc/core-linux-arm-gnueabihf@npm:1.7.28": version: 1.7.28 resolution: "@swc/core-linux-arm-gnueabihf@npm:1.7.28" @@ -13297,6 +13318,13 @@ __metadata: languageName: node linkType: hard +"@swc/core-linux-arm64-gnu@npm:1.5.7": + version: 1.5.7 + resolution: "@swc/core-linux-arm64-gnu@npm:1.5.7" + conditions: os=linux & cpu=arm64 & libc=glibc + languageName: node + linkType: hard + "@swc/core-linux-arm64-gnu@npm:1.7.28": version: 1.7.28 resolution: "@swc/core-linux-arm64-gnu@npm:1.7.28" @@ -13311,6 +13339,13 @@ __metadata: languageName: node linkType: hard +"@swc/core-linux-arm64-musl@npm:1.5.7": + version: 1.5.7 + resolution: "@swc/core-linux-arm64-musl@npm:1.5.7" + conditions: os=linux & cpu=arm64 & libc=musl + languageName: node + linkType: hard + "@swc/core-linux-arm64-musl@npm:1.7.28": version: 1.7.28 resolution: "@swc/core-linux-arm64-musl@npm:1.7.28" @@ -13325,6 +13360,13 @@ __metadata: languageName: node linkType: hard +"@swc/core-linux-x64-gnu@npm:1.5.7": + version: 1.5.7 + resolution: "@swc/core-linux-x64-gnu@npm:1.5.7" + conditions: os=linux & cpu=x64 & libc=glibc + languageName: node + linkType: hard + "@swc/core-linux-x64-gnu@npm:1.7.28": version: 1.7.28 resolution: "@swc/core-linux-x64-gnu@npm:1.7.28" @@ -13339,6 +13381,13 @@ __metadata: languageName: node linkType: hard +"@swc/core-linux-x64-musl@npm:1.5.7": + version: 1.5.7 + resolution: "@swc/core-linux-x64-musl@npm:1.5.7" + conditions: os=linux & cpu=x64 & libc=musl + languageName: node + linkType: hard + "@swc/core-linux-x64-musl@npm:1.7.28": version: 1.7.28 resolution: "@swc/core-linux-x64-musl@npm:1.7.28" @@ -13353,6 +13402,13 @@ __metadata: languageName: node linkType: hard +"@swc/core-win32-arm64-msvc@npm:1.5.7": + version: 1.5.7 + resolution: "@swc/core-win32-arm64-msvc@npm:1.5.7" + conditions: os=win32 & cpu=arm64 + languageName: node + linkType: hard + "@swc/core-win32-arm64-msvc@npm:1.7.28": version: 1.7.28 resolution: "@swc/core-win32-arm64-msvc@npm:1.7.28" @@ -13367,6 +13423,13 @@ __metadata: languageName: node linkType: hard +"@swc/core-win32-ia32-msvc@npm:1.5.7": + version: 1.5.7 + resolution: "@swc/core-win32-ia32-msvc@npm:1.5.7" + conditions: os=win32 & cpu=ia32 + languageName: node + linkType: hard + "@swc/core-win32-ia32-msvc@npm:1.7.28": version: 1.7.28 resolution: "@swc/core-win32-ia32-msvc@npm:1.7.28" @@ -13381,6 +13444,13 @@ __metadata: languageName: node linkType: hard +"@swc/core-win32-x64-msvc@npm:1.5.7": + version: 1.5.7 + resolution: "@swc/core-win32-x64-msvc@npm:1.5.7" + conditions: os=win32 & cpu=x64 + languageName: node + linkType: hard + "@swc/core-win32-x64-msvc@npm:1.7.28": version: 1.7.28 resolution: "@swc/core-win32-x64-msvc@npm:1.7.28" @@ -13388,6 +13458,52 @@ __metadata: languageName: node linkType: hard +"@swc/core@npm:1.5.7": + version: 1.5.7 + resolution: "@swc/core@npm:1.5.7" + dependencies: + "@swc/core-darwin-arm64": 1.5.7 + "@swc/core-darwin-x64": 1.5.7 + "@swc/core-linux-arm-gnueabihf": 1.5.7 + "@swc/core-linux-arm64-gnu": 1.5.7 + "@swc/core-linux-arm64-musl": 1.5.7 + "@swc/core-linux-x64-gnu": 1.5.7 + "@swc/core-linux-x64-musl": 1.5.7 + "@swc/core-win32-arm64-msvc": 1.5.7 + "@swc/core-win32-ia32-msvc": 1.5.7 + "@swc/core-win32-x64-msvc": 1.5.7 + "@swc/counter": ^0.1.2 + "@swc/types": 0.1.7 + peerDependencies: + "@swc/helpers": ^0.5.0 + dependenciesMeta: + "@swc/core-darwin-arm64": + optional: true + "@swc/core-darwin-x64": + optional: true + "@swc/core-linux-arm-gnueabihf": + optional: true + "@swc/core-linux-arm64-gnu": + optional: true + "@swc/core-linux-arm64-musl": + optional: true + "@swc/core-linux-x64-gnu": + optional: true + "@swc/core-linux-x64-musl": + optional: true + "@swc/core-win32-arm64-msvc": + optional: true + "@swc/core-win32-ia32-msvc": + optional: true + "@swc/core-win32-x64-msvc": + optional: true + peerDependenciesMeta: + "@swc/helpers": + optional: true + checksum: 83ab96bee5d448e580d8a6c8c1d1fbfdfaf5561f8904140122e49c428c2336790d31e7bdcdf610ce8f20c7f682785263d2ebab7cb56c2dcb5ea46be54eab2c03 + languageName: node + linkType: hard + "@swc/core@npm:^1.4.8": version: 1.5.3 resolution: "@swc/core@npm:1.5.3" @@ -13496,6 +13612,15 @@ __metadata: languageName: node linkType: hard +"@swc/helpers@npm:^0.5.11": + version: 0.5.15 + resolution: "@swc/helpers@npm:0.5.15" + dependencies: + tslib: ^2.8.0 + checksum: 33002f74f6f885f04c132960835fdfc474186983ea567606db62e86acd0680ca82f34647e8e610f4e1e422d1c16fce729dde22cd3b797ab1fd9061a825dabca4 + languageName: node + linkType: hard + "@swc/jest@npm:^0.2.36": version: 0.2.36 resolution: "@swc/jest@npm:0.2.36" @@ -13509,6 +13634,15 @@ __metadata: languageName: node linkType: hard +"@swc/types@npm:0.1.7": + version: 0.1.7 + resolution: "@swc/types@npm:0.1.7" + dependencies: + "@swc/counter": ^0.1.3 + checksum: da7c542de0a44b85a98139db03920448e86309d28ad9e9335f91b4025e5f32ae4fbbfdd0f287330fb0de737e7c5ec4f64ade0fc5fffea6c2fd9ac681b1e97bea + languageName: node + linkType: hard + "@swc/types@npm:^0.1.12": version: 0.1.12 resolution: "@swc/types@npm:0.1.12" @@ -17656,7 +17790,7 @@ __metadata: version: 0.0.0-use.local resolution: "create-medusa-app@workspace:packages/cli/create-medusa-app" dependencies: - "@medusajs/telemetry": ^2.6.0 + "@medusajs/telemetry": 2.6.0 "@types/chalk": ^2.2.0 "@types/commander": ^2.12.2 "@types/configstore": ^6.0.0 @@ -32259,6 +32393,13 @@ __metadata: languageName: node linkType: hard +"tslib@npm:^2.8.0": + version: 2.8.1 + resolution: "tslib@npm:2.8.1" + checksum: 9c4759110a19c53f992d9aae23aac5ced636e99887b51b9e61def52611732872ff7668757d4e4c61f19691e36f4da981cd9485e869b4a7408d689f6bf1f14e62 + languageName: node + linkType: hard + "tslib@npm:~2.6.0": version: 2.6.3 resolution: "tslib@npm:2.6.3"