diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_auth/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_auth/get.js index 961d7e2dc3..44cab70d2e 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_auth/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_auth/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.auth.getSession() .then(({ user }) => { console.log(user.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_auth/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_auth/post.js index a70d7adddf..ce4daa1294 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_auth/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_auth/post.js @@ -6,4 +6,4 @@ medusa.admin.auth.createSession({ }) .then(({ user }) => { console.log(user.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_auth_token/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_auth_token/post.js index ac6963ea40..cf8a5e7c32 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_auth_token/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_auth_token/post.js @@ -6,4 +6,4 @@ medusa.admin.auth.getToken({ }) .then(({ access_token }) => { console.log(access_token); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_batch-jobs/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_batch-jobs/post.js index 83578011ea..a75472d0ab 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_batch-jobs/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_batch-jobs/post.js @@ -7,4 +7,4 @@ medusa.admin.batchJobs.create({ dry_run: false }).then((({ batch_job }) => { console.log(batch_job.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_batch-jobs_{id}/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_batch-jobs_{id}/get.js index d6b6f39a38..4fab0f6dda 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_batch-jobs_{id}/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_batch-jobs_{id}/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.batchJobs.retrieve(batchJobId) .then(({ batch_job }) => { console.log(batch_job.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_batch-jobs_{id}_cancel/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_batch-jobs_{id}_cancel/post.js index 026612e907..639dd18004 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_batch-jobs_{id}_cancel/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_batch-jobs_{id}_cancel/post.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.batchJobs.cancel(batchJobId) .then(({ batch_job }) => { console.log(batch_job.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_batch-jobs_{id}_confirm/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_batch-jobs_{id}_confirm/post.js index 58c5968ad1..153604ef5e 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_batch-jobs_{id}_confirm/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_batch-jobs_{id}_confirm/post.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.batchJobs.confirm(batchJobId) .then(({ batch_job }) => { console.log(batch_job.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_collections/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_collections/get.js index 69ca746169..5bb6f372cd 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_collections/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_collections/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.collections.list() .then(({ collections, limit, offset, count }) => { console.log(collections.length); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_collections/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_collections/post.js index 76f9551100..b1baf8d155 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_collections/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_collections/post.js @@ -6,4 +6,4 @@ medusa.admin.collections.create({ }) .then(({ collection }) => { console.log(collection.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_collections_{id}/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_collections_{id}/delete.js index 0f99261cd8..a3edc10937 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_collections_{id}/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_collections_{id}/delete.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.collections.delete(collectionId) .then(({ id, object, deleted }) => { console.log(id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_collections_{id}/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_collections_{id}/get.js index ad52724dbc..3bebde426e 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_collections_{id}/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_collections_{id}/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.collections.retrieve(collectionId) .then(({ collection }) => { console.log(collection.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_collections_{id}/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_collections_{id}/post.js index d9dd61f35f..926e7ca326 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_collections_{id}/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_collections_{id}/post.js @@ -6,4 +6,4 @@ medusa.admin.collections.update(collectionId, { }) .then(({ collection }) => { console.log(collection.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_currencies/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_currencies/get.js index 73a384b02c..286a6490b9 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_currencies/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_currencies/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.currencies.list() .then(({ currencies, count, offset, limit }) => { console.log(currencies.length); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_currencies_{code}/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_currencies_{code}/post.js index 0cc59f0be3..8bd811990e 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_currencies_{code}/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_currencies_{code}/post.js @@ -6,4 +6,4 @@ medusa.admin.currencies.update(code, { }) .then(({ currency }) => { console.log(currency.code); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customer-groups/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customer-groups/get.js index 1317339480..ae2beec241 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customer-groups/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customer-groups/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.customerGroups.list() .then(({ customer_groups, limit, offset, count }) => { console.log(customer_groups.length); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customer-groups/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customer-groups/post.js index 572f5f2ffe..5fe5f54c5f 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customer-groups/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customer-groups/post.js @@ -6,4 +6,4 @@ medusa.admin.customerGroups.create({ }) .then(({ customer_group }) => { console.log(customer_group.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customer-groups_{id}/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customer-groups_{id}/delete.js index b10f7c1a98..dfb0a6a4b5 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customer-groups_{id}/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customer-groups_{id}/delete.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.customerGroups.delete(customerGroupId) .then(({ id, object, deleted }) => { console.log(id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customer-groups_{id}/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customer-groups_{id}/get.js index 7c52894d54..d175f7a92c 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customer-groups_{id}/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customer-groups_{id}/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.customerGroups.retrieve(customerGroupId) .then(({ customer_group }) => { console.log(customer_group.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customer-groups_{id}/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customer-groups_{id}/post.js index 257830d46b..11d7eeae6b 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customer-groups_{id}/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customer-groups_{id}/post.js @@ -6,4 +6,4 @@ medusa.admin.customerGroups.update(customerGroupId, { }) .then(({ customer_group }) => { console.log(customer_group.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customer-groups_{id}_customers/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customer-groups_{id}_customers/get.js index 580f27ccce..b4fb1b2670 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customer-groups_{id}_customers/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customer-groups_{id}_customers/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.customerGroups.listCustomers(customerGroupId) .then(({ customers }) => { console.log(customers.length); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customer-groups_{id}_customers_batch/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customer-groups_{id}_customers_batch/delete.js index 524376cf93..0528621964 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customer-groups_{id}_customers_batch/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customer-groups_{id}_customers_batch/delete.js @@ -10,4 +10,4 @@ medusa.admin.customerGroups.removeCustomers(customerGroupId, { }) .then(({ customer_group }) => { console.log(customer_group.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customer-groups_{id}_customers_batch/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customer-groups_{id}_customers_batch/post.js index 703b21786e..4c419cafdc 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customer-groups_{id}_customers_batch/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customer-groups_{id}_customers_batch/post.js @@ -10,4 +10,4 @@ medusa.admin.customerGroups.addCustomers(customerGroupId, { }) .then(({ customer_group }) => { console.log(customer_group.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customers/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customers/get.js index 74000c9a3b..c0496e446e 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customers/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customers/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.customers.list() .then(({ customers, limit, offset, count }) => { console.log(customers.length); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customers/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customers/post.js index 90e7bf9641..8c2041aefb 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customers/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customers/post.js @@ -9,4 +9,4 @@ medusa.admin.customers.create({ }) .then(({ customer }) => { console.log(customer.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customers_{id}/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customers_{id}/get.js index 7f459a95d5..276a32d0fe 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customers_{id}/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customers_{id}/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.customers.retrieve(customerId) .then(({ customer }) => { console.log(customer.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customers_{id}/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customers_{id}/post.js index a9d5f0964d..213da32ae6 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customers_{id}/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_customers_{id}/post.js @@ -6,4 +6,4 @@ medusa.admin.customers.update(customerId, { }) .then(({ customer }) => { console.log(customer.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts/get.js index fece22f853..eaeaa3fdec 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.discounts.list() .then(({ discounts, limit, offset, count }) => { console.log(discounts.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts/post.js index a5021231b0..4de95a9b3c 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts/post.js @@ -15,4 +15,4 @@ medusa.admin.discounts.create({ }) .then(({ discount }) => { console.log(discount.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_code_{code}/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_code_{code}/get.js index 823da0f00e..42b3af87b3 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_code_{code}/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_code_{code}/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.discounts.retrieveByCode(code) .then(({ discount }) => { console.log(discount.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{discount_id}_conditions/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{discount_id}_conditions/post.js index 66e5f47c1b..01886c88c1 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{discount_id}_conditions/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{discount_id}_conditions/post.js @@ -3,8 +3,9 @@ import { DiscountConditionOperator } from "@medusajs/medusa" const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) // must be previously logged in or use api token medusa.admin.discounts.createCondition(discountId, { - operator: DiscountConditionOperator.IN + operator: DiscountConditionOperator.IN, + products: [productId] }) .then(({ discount }) => { console.log(discount.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{discount_id}_conditions_{condition_id}/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{discount_id}_conditions_{condition_id}/delete.js index 71e35a0d4e..3da54407d7 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{discount_id}_conditions_{condition_id}/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{discount_id}_conditions_{condition_id}/delete.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.discounts.deleteCondition(discountId, conditionId) .then(({ id, object, deleted }) => { console.log(id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{discount_id}_conditions_{condition_id}/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{discount_id}_conditions_{condition_id}/get.js index 16a9e5697b..23d4dee146 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{discount_id}_conditions_{condition_id}/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{discount_id}_conditions_{condition_id}/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.discounts.getCondition(discountId, conditionId) .then(({ discount_condition }) => { console.log(discount_condition.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{discount_id}_conditions_{condition_id}/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{discount_id}_conditions_{condition_id}/post.js index 437d5e76cb..d59f59db04 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{discount_id}_conditions_{condition_id}/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{discount_id}_conditions_{condition_id}/post.js @@ -8,4 +8,4 @@ medusa.admin.discounts.updateCondition(discountId, conditionId, { }) .then(({ discount }) => { console.log(discount.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{discount_id}_conditions_{condition_id}_batch/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{discount_id}_conditions_{condition_id}_batch/delete.js index 4e8b43f008..8528680079 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{discount_id}_conditions_{condition_id}_batch/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{discount_id}_conditions_{condition_id}_batch/delete.js @@ -6,4 +6,4 @@ medusa.admin.discounts.deleteConditionResourceBatch(discountId, conditionId, { }) .then(({ discount }) => { console.log(discount.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{discount_id}_conditions_{condition_id}_batch/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{discount_id}_conditions_{condition_id}_batch/post.js index a8ae70ae8d..fc8caffa6b 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{discount_id}_conditions_{condition_id}_batch/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{discount_id}_conditions_{condition_id}_batch/post.js @@ -6,4 +6,4 @@ medusa.admin.discounts.addConditionResourceBatch(discountId, conditionId, { }) .then(({ discount }) => { console.log(discount.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{id}/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{id}/delete.js index cfe8b520f4..0b615bf8d6 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{id}/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{id}/delete.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.discounts.delete(discountId) .then(({ id, object, deleted }) => { console.log(id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{id}/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{id}/get.js index 098ff1ed4b..bba22cd8ff 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{id}/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{id}/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.discounts.retrieve(discountId) .then(({ discount }) => { console.log(discount.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{id}/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{id}/post.js index 15cd7af923..e580e90380 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{id}/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{id}/post.js @@ -6,4 +6,4 @@ medusa.admin.discounts.update(discountId, { }) .then(({ discount }) => { console.log(discount.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{id}_dynamic-codes/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{id}_dynamic-codes/post.js index 236bcdba9a..b9a33dc6a5 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{id}_dynamic-codes/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{id}_dynamic-codes/post.js @@ -7,4 +7,4 @@ medusa.admin.discounts.createDynamicCode(discountId, { }) .then(({ discount }) => { console.log(discount.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{id}_dynamic-codes_{code}/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{id}_dynamic-codes_{code}/delete.js index 0443c6185a..344a60ae96 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{id}_dynamic-codes_{code}/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{id}_dynamic-codes_{code}/delete.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.discounts.deleteDynamicCode(discountId, code) .then(({ discount }) => { console.log(discount.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{id}_regions_{region_id}/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{id}_regions_{region_id}/delete.js index bdc32a588e..57ce1befcd 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{id}_regions_{region_id}/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{id}_regions_{region_id}/delete.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.discounts.removeRegion(discountId, regionId) .then(({ discount }) => { console.log(discount.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{id}_regions_{region_id}/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{id}_regions_{region_id}/post.js index 7079d51ac9..439050d200 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{id}_regions_{region_id}/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_discounts_{id}_regions_{region_id}/post.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.discounts.addRegion(discountId, regionId) .then(({ discount }) => { console.log(discount.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders/get.js index 8e3a0cdf7f..02a002151a 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.draftOrders.list() .then(({ draft_orders, limit, offset, count }) => { console.log(draft_orders.length); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders/post.js index 016b974d3f..38e6a1a5ca 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders/post.js @@ -17,4 +17,4 @@ medusa.admin.draftOrders.create({ }) .then(({ draft_order }) => { console.log(draft_order.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders_{id}/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders_{id}/delete.js index b0d0566804..363405573c 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders_{id}/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders_{id}/delete.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.draftOrders.delete(draftOrderId) .then(({ id, object, deleted }) => { console.log(id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders_{id}/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders_{id}/get.js index 089bb0b91c..1636c13fd7 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders_{id}/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders_{id}/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.draftOrders.retrieve(draftOrderId) .then(({ draft_order }) => { console.log(draft_order.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders_{id}/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders_{id}/post.js index d24a678973..a350c78898 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders_{id}/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders_{id}/post.js @@ -6,4 +6,4 @@ medusa.admin.draftOrders.update(draftOrderId, { }) .then(({ draft_order }) => { console.log(draft_order.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders_{id}_line-items/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders_{id}_line-items/post.js index ddb3f2a63c..62e41cc059 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders_{id}_line-items/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders_{id}_line-items/post.js @@ -6,4 +6,4 @@ medusa.admin.draftOrders.addLineItem(draftOrderId, { }) .then(({ draft_order }) => { console.log(draft_order.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders_{id}_line-items_{line_id}/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders_{id}_line-items_{line_id}/delete.js index 0c8c07e725..dd69c9ab74 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders_{id}_line-items_{line_id}/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders_{id}_line-items_{line_id}/delete.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.draftOrders.removeLineItem(draftOrderId, itemId) .then(({ draft_order }) => { console.log(draft_order.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders_{id}_line-items_{line_id}/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders_{id}_line-items_{line_id}/post.js index 4a4cd16b1a..b0f25f157d 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders_{id}_line-items_{line_id}/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders_{id}_line-items_{line_id}/post.js @@ -6,4 +6,4 @@ medusa.admin.draftOrders.updateLineItem(draftOrderId, lineId, { }) .then(({ draft_order }) => { console.log(draft_order.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders_{id}_pay/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders_{id}_pay/post.js index fbeb008678..ce81255c42 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders_{id}_pay/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders_{id}_pay/post.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.draftOrders.markPaid(draftOrderId) .then(({ order }) => { console.log(order.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_gift-cards/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_gift-cards/get.js index 131c7d981e..15f4a4be64 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_gift-cards/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_gift-cards/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.giftCards.list() .then(({ gift_cards, limit, offset, count }) => { console.log(gift_cards.length); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_gift-cards/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_gift-cards/post.js index fa255afb9f..2e6aa01e32 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_gift-cards/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_gift-cards/post.js @@ -6,4 +6,4 @@ medusa.admin.giftCards.create({ }) .then(({ gift_card }) => { console.log(gift_card.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_gift-cards_{id}/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_gift-cards_{id}/delete.js index 2b628081b4..6401273a45 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_gift-cards_{id}/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_gift-cards_{id}/delete.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.giftCards.delete(giftCardId) .then(({ id, object, deleted }) => { console.log(id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_gift-cards_{id}/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_gift-cards_{id}/get.js index 1b65b58c1d..566b7cf5da 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_gift-cards_{id}/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_gift-cards_{id}/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.giftCards.retrieve(giftCardId) .then(({ gift_card }) => { console.log(gift_card.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_gift-cards_{id}/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_gift-cards_{id}/post.js index dbae5ee185..d360c55300 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_gift-cards_{id}/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_gift-cards_{id}/post.js @@ -6,4 +6,4 @@ medusa.admin.giftCards.update(giftCardId, { }) .then(({ gift_card }) => { console.log(gift_card.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_inventory-items/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_inventory-items/get.js index 373f7a8ba5..6ea3b2fdd5 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_inventory-items/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_inventory-items/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.inventoryItems.list() .then(({ inventory_items, count, offset, limit }) => { console.log(inventory_items.length); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_inventory-items/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_inventory-items/post.js index e2abbc4bf7..c87f6789ef 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_inventory-items/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_inventory-items/post.js @@ -6,4 +6,4 @@ medusa.admin.inventoryItems.create({ }) .then(({ inventory_item }) => { console.log(inventory_item.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_inventory-items_{id}/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_inventory-items_{id}/delete.js index ffd9dc0d3a..2d998b01fc 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_inventory-items_{id}/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_inventory-items_{id}/delete.js @@ -2,6 +2,6 @@ import Medusa from "@medusajs/medusa-js" const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) // must be previously logged in or use api token medusa.admin.inventoryItems.delete(inventoryItemId) - .then(({ id, object, deleted }) => { - console.log(id) - }) +.then(({ id, object, deleted }) => { + console.log(id) +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_inventory-items_{id}/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_inventory-items_{id}/get.js index 8bc8511104..65f102df3f 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_inventory-items_{id}/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_inventory-items_{id}/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.inventoryItems.retrieve(inventoryItemId) .then(({ inventory_item }) => { console.log(inventory_item.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_inventory-items_{id}/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_inventory-items_{id}/post.js index 3035162092..91ec13d1f6 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_inventory-items_{id}/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_inventory-items_{id}/post.js @@ -6,4 +6,4 @@ medusa.admin.inventoryItems.update(inventoryItemId, { }) .then(({ inventory_item }) => { console.log(inventory_item.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_inventory-items_{id}_location-levels/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_inventory-items_{id}_location-levels/get.js index 616eaeb60f..01bc8de71f 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_inventory-items_{id}_location-levels/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_inventory-items_{id}_location-levels/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.inventoryItems.listLocationLevels(inventoryItemId) .then(({ inventory_item }) => { console.log(inventory_item.location_levels); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_inventory-items_{id}_location-levels/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_inventory-items_{id}_location-levels/post.js index 3af95d2f1e..01f41a6fff 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_inventory-items_{id}_location-levels/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_inventory-items_{id}_location-levels/post.js @@ -7,4 +7,4 @@ medusa.admin.inventoryItems.createLocationLevel(inventoryItemId, { }) .then(({ inventory_item }) => { console.log(inventory_item.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_inventory-items_{id}_location-levels_{location_id}/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_inventory-items_{id}_location-levels_{location_id}/delete.js index 9cc59e3fb7..7af922f19b 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_inventory-items_{id}_location-levels_{location_id}/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_inventory-items_{id}_location-levels_{location_id}/delete.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.inventoryItems.deleteLocationLevel(inventoryItemId, locationId) .then(({ inventory_item }) => { console.log(inventory_item.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_inventory-items_{id}_location-levels_{location_id}/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_inventory-items_{id}_location-levels_{location_id}/post.js index 42977d427c..6e76ff2ba5 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_inventory-items_{id}_location-levels_{location_id}/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_inventory-items_{id}_location-levels_{location_id}/post.js @@ -6,4 +6,4 @@ medusa.admin.inventoryItems.updateLocationLevel(inventoryItemId, locationId, { }) .then(({ inventory_item }) => { console.log(inventory_item.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_invites/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_invites/get.js index ec3d622aad..abea181cd6 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_invites/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_invites/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.invites.list() .then(({ invites }) => { console.log(invites.length); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_invites/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_invites/post.js index 846edf0e18..460bdaf6f5 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_invites/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_invites/post.js @@ -10,4 +10,4 @@ medusa.admin.invites.create({ }) .catch(() => { // an error occurred -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_invites_accept/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_invites_accept/post.js index b403e85223..58df5efdb1 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_invites_accept/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_invites_accept/post.js @@ -14,4 +14,4 @@ medusa.admin.invites.accept({ }) .catch(() => { // an error occurred -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_invites_{invite_id}/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_invites_{invite_id}/delete.js index 4f542129ab..4b1399f15a 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_invites_{invite_id}/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_invites_{invite_id}/delete.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.invites.delete(inviteId) .then(({ id, object, deleted }) => { console.log(id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_invites_{invite_id}_resend/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_invites_{invite_id}_resend/post.js index c45c6fdb91..a425b24d2d 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_invites_{invite_id}_resend/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_invites_{invite_id}_resend/post.js @@ -7,4 +7,4 @@ medusa.admin.invites.resend(inviteId) }) .catch(() => { // an error occurred -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_notes/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_notes/get.js index f8954d2d46..3b21b2c2de 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_notes/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_notes/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.notes.list() .then(({ notes, limit, offset, count }) => { console.log(notes.length); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_notes/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_notes/post.js index aa71e9d303..0bf37d1fa7 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_notes/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_notes/post.js @@ -8,4 +8,4 @@ medusa.admin.notes.create({ }) .then(({ note }) => { console.log(note.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_notes_{id}/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_notes_{id}/delete.js index 29ae5c215c..8125500adf 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_notes_{id}/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_notes_{id}/delete.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.notes.delete(noteId) .then(({ id, object, deleted }) => { console.log(id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_notes_{id}/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_notes_{id}/get.js index 38333c2acd..8a06e6fcd1 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_notes_{id}/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_notes_{id}/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.notes.retrieve(noteId) .then(({ note }) => { console.log(note.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_notes_{id}/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_notes_{id}/post.js index 02b5278dde..efa6c9615d 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_notes_{id}/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_notes_{id}/post.js @@ -6,4 +6,4 @@ medusa.admin.notes.update(noteId, { }) .then(({ note }) => { console.log(note.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_notifications/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_notifications/get.js index ac8ed302ed..d109e2c8af 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_notifications/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_notifications/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.notifications.list() .then(({ notifications }) => { console.log(notifications.length); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_notifications_{id}_resend/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_notifications_{id}_resend/post.js index b517d33d81..bf5e270b22 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_notifications_{id}_resend/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_notifications_{id}_resend/post.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.notifications.resend(notificationId) .then(({ notification }) => { console.log(notification.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits/get.js index 3f73c739e5..153886a98a 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits/get.js @@ -2,6 +2,6 @@ import Medusa from "@medusajs/medusa-js" const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) // must be previously logged in or use api token medusa.admin.orderEdits.list() - .then(({ order_edits, count, limit, offset }) => { - console.log(order_edits.length) - }) +.then(({ order_edits, count, limit, offset }) => { + console.log(order_edits.length) +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits/post.js index aa94738824..7bc8ff715d 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits/post.js @@ -2,6 +2,6 @@ import Medusa from "@medusajs/medusa-js" const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) // must be previously logged in or use api token medusa.admin.orderEdits.create({ orderId }) - .then(({ order_edit }) => { - console.log(order_edit.id) - }) +.then(({ order_edit }) => { + console.log(order_edit.id) +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}/delete.js index b202ffbe39..75006062e8 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}/delete.js @@ -2,6 +2,6 @@ import Medusa from "@medusajs/medusa-js" const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) // must be previously logged in or use api token medusa.admin.orderEdits.delete(orderEditId) - .then(({ id, object, deleted }) => { - console.log(id) - }) +.then(({ id, object, deleted }) => { + console.log(id) +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}/get.js index 9b7ef7ed33..73ec5a5670 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}/get.js @@ -2,6 +2,6 @@ import Medusa from "@medusajs/medusa-js" const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) // must be previously logged in or use api token medusa.admin.orderEdits.retrieve(orderEditId) - .then(({ order_edit }) => { - console.log(order_edit.id) - }) +.then(({ order_edit }) => { + console.log(order_edit.id) +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}/post.js index c187499c80..b314021235 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}/post.js @@ -4,6 +4,6 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.orderEdits.update(orderEditId, { internal_note: "internal reason XY" }) - .then(({ order_edit }) => { - console.log(order_edit.id) - }) +.then(({ order_edit }) => { + console.log(order_edit.id) +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}_cancel/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}_cancel/post.js index 5d412ff6bb..77fee48db9 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}_cancel/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}_cancel/post.js @@ -2,6 +2,6 @@ import Medusa from "@medusajs/medusa-js" const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) // must be previously logged in or use api token medusa.admin.orderEdits.cancel(orderEditId) - .then(({ order_edit }) => { - console.log(order_edit.id) - }) +.then(({ order_edit }) => { + console.log(order_edit.id) +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}_changes_{change_id}/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}_changes_{change_id}/delete.js index 1e99f36203..323810d25f 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}_changes_{change_id}/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}_changes_{change_id}/delete.js @@ -2,6 +2,6 @@ import Medusa from "@medusajs/medusa-js" const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) // must be previously logged in or use api token medusa.admin.orderEdits.deleteItemChange(orderEdit_id, itemChangeId) - .then(({ id, object, deleted }) => { - console.log(id) - }) +.then(({ id, object, deleted }) => { + console.log(id) +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}_confirm/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}_confirm/post.js index c20d1783ca..a79cbabbba 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}_confirm/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}_confirm/post.js @@ -2,6 +2,6 @@ import Medusa from "@medusajs/medusa-js" const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) // must be previously logged in or use api token medusa.admin.orderEdits.confirm(orderEditId) - .then(({ order_edit }) => { - console.log(order_edit.id) - }) +.then(({ order_edit }) => { + console.log(order_edit.id) +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}_items_{item_id}/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}_items_{item_id}/delete.js index 40c3ebb3d1..46beb557fd 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}_items_{item_id}/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}_items_{item_id}/delete.js @@ -2,6 +2,6 @@ import Medusa from "@medusajs/medusa-js" const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) // must be previously logged in or use api token medusa.admin.orderEdits.removeLineItem(orderEditId, lineItemId) - .then(({ order_edit }) => { - console.log(order_edit.id) - }) +.then(({ order_edit }) => { + console.log(order_edit.id) +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}_items_{item_id}/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}_items_{item_id}/post.js index 725fb29075..00cfbbcd72 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}_items_{item_id}/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}_items_{item_id}/post.js @@ -2,8 +2,8 @@ import Medusa from "@medusajs/medusa-js" const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) // must be previously logged in or use api token medusa.admin.orderEdits.updateLineItem(orderEditId, lineItemId, { - quantity: 5 - }) - .then(({ order_edit }) => { - console.log(order_edit.id) - }) + quantity: 5 +}) +.then(({ order_edit }) => { + console.log(order_edit.id) +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}_request/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}_request/post.js index fb04ce9f44..0f79c1e853 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}_request/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}_request/post.js @@ -2,6 +2,6 @@ import Medusa from "@medusajs/medusa-js" const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) // must be previously logged in or use api token medusa.admin.orderEdits.requestConfirmation(orderEditId) - .then({ order_edit }) => { - console.log(order_edit.id) - }) +.then({ order_edit }) => { + console.log(order_edit.id) +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders/get.js index 18fe99ea17..0b6b5ff508 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.orders.list() .then(({ orders, limit, offset, count }) => { console.log(orders.length); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}/get.js index f9ec05be45..c9b93d4f7b 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.orders.retrieve(orderId) .then(({ order }) => { console.log(order.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}/post.js index e62b225cb3..3fc08c0b20 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}/post.js @@ -6,4 +6,4 @@ medusa.admin.orders.update(orderId, { }) .then(({ order }) => { console.log(order.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_archive/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_archive/post.js index f97eeca032..9bb95dfbf0 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_archive/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_archive/post.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.orders.archive(orderId) .then(({ order }) => { console.log(order.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_cancel/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_cancel/post.js index 2b59256d2f..271e0359eb 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_cancel/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_cancel/post.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.orders.cancel(orderId) .then(({ order }) => { console.log(order.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_capture/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_capture/post.js index 4b40b7191b..0e8c0e9496 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_capture/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_capture/post.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.orders.capturePayment(orderId) .then(({ order }) => { console.log(order.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_claims/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_claims/post.js index a124a24258..e635c46f82 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_claims/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_claims/post.js @@ -12,4 +12,4 @@ medusa.admin.orders.createClaim(orderId, { }) .then(({ order }) => { console.log(order.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_claims_{claim_id}/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_claims_{claim_id}/post.js index 71934dfdac..d3db08333f 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_claims_{claim_id}/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_claims_{claim_id}/post.js @@ -6,4 +6,4 @@ medusa.admin.orders.updateClaim(orderId, claimId, { }) .then(({ order }) => { console.log(order.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_claims_{claim_id}_cancel/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_claims_{claim_id}_cancel/post.js index 3a30076d5d..0039cb0566 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_claims_{claim_id}_cancel/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_claims_{claim_id}_cancel/post.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.orders.cancelClaim(orderId, claimId) .then(({ order }) => { console.log(order.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_claims_{claim_id}_fulfillments/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_claims_{claim_id}_fulfillments/post.js index 2dd691171e..070df1694d 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_claims_{claim_id}_fulfillments/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_claims_{claim_id}_fulfillments/post.js @@ -5,4 +5,4 @@ medusa.admin.orders.fulfillClaim(orderId, claimId, { }) .then(({ order }) => { console.log(order.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel/post.js index 5329b1a2b4..8ecf87f7a7 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel/post.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.orders.cancelClaimFulfillment(orderId, claimId, fulfillmentId) .then(({ order }) => { console.log(order.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_claims_{claim_id}_shipments/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_claims_{claim_id}_shipments/post.js index 2dd9beb63d..c209120759 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_claims_{claim_id}_shipments/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_claims_{claim_id}_shipments/post.js @@ -6,4 +6,4 @@ medusa.admin.orders.createClaimShipment(orderId, claimId, { }) .then(({ order }) => { console.log(order.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_complete/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_complete/post.js index f6331ddaa9..62cf37c16d 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_complete/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_complete/post.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.orders.complete(orderId) .then(({ order }) => { console.log(order.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_fulfillment/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_fulfillment/post.js index 8c6e3e8c7c..8fcc64aeba 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_fulfillment/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_fulfillment/post.js @@ -11,4 +11,4 @@ medusa.admin.orders.createFulfillment(orderId, { }) .then(({ order }) => { console.log(order.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel/post.js index e1bd5b619e..f3bbd29811 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel/post.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.orders.cancelFulfillment(orderId, fulfillmentId) .then(({ order }) => { console.log(order.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_refund/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_refund/post.js index 37dd32dded..5b45bb9542 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_refund/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_refund/post.js @@ -7,4 +7,4 @@ medusa.admin.orders.refundPayment(orderId, { }) .then(({ order }) => { console.log(order.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_return/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_return/post.js index ac431f949b..e5b519bcf6 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_return/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_return/post.js @@ -11,4 +11,4 @@ medusa.admin.orders.requestReturn(orderId, { }) .then(({ order }) => { console.log(order.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_shipment/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_shipment/post.js index 0dbd874fce..620274fb37 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_shipment/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_shipment/post.js @@ -6,4 +6,4 @@ medusa.admin.orders.createShipment(order_id, { }) .then(({ order }) => { console.log(order.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_shipping-methods/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_shipping-methods/post.js index 3f4bd0638e..65dda8bcbd 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_shipping-methods/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_shipping-methods/post.js @@ -7,4 +7,4 @@ medusa.admin.orders.addShippingMethod(orderId, { }) .then(({ order }) => { console.log(order.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_swaps/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_swaps/post.js index 3472f9f4dd..5c28515bba 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_swaps/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_swaps/post.js @@ -11,4 +11,4 @@ medusa.admin.orders.createSwap(orderId, { }) .then(({ order }) => { console.log(order.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_swaps_{swap_id}_cancel/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_swaps_{swap_id}_cancel/post.js index c7210178f1..b20cdb0a41 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_swaps_{swap_id}_cancel/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_swaps_{swap_id}_cancel/post.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.orders.cancelSwap(orderId, swapId) .then(({ order }) => { console.log(order.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_swaps_{swap_id}_fulfillments/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_swaps_{swap_id}_fulfillments/post.js index e367eab89c..318b671886 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_swaps_{swap_id}_fulfillments/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_swaps_{swap_id}_fulfillments/post.js @@ -6,4 +6,4 @@ medusa.admin.orders.fulfillSwap(orderId, swapId, { }) .then(({ order }) => { console.log(order.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel/post.js index 4cbe754ff6..2abfc9954f 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel/post.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.orders.cancelSwapFulfillment(orderId, swapId, fulfillmentId) .then(({ order }) => { console.log(order.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_swaps_{swap_id}_process-payment/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_swaps_{swap_id}_process-payment/post.js index 92b82910c2..fb8e065af4 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_swaps_{swap_id}_process-payment/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_swaps_{swap_id}_process-payment/post.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.orders.processSwapPayment(orderId, swapId) .then(({ order }) => { console.log(order.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_swaps_{swap_id}_shipments/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_swaps_{swap_id}_shipments/post.js index 7cee8d2519..046356d93c 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_swaps_{swap_id}_shipments/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_orders_{id}_swaps_{swap_id}_shipments/post.js @@ -1,9 +1,9 @@ import Medusa from "@medusajs/medusa-js" const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) // must be previously logged in or use api token -medusa.admin.orders.createSwapShipment(order_id, swap_id, { +medusa.admin.orders.createSwapShipment(orderId, swapId, { fulfillment_id }) .then(({ order }) => { console.log(order.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_payment-collections_{id}/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_payment-collections_{id}/delete.js index e581579649..b246e4620e 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_payment-collections_{id}/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_payment-collections_{id}/delete.js @@ -2,6 +2,6 @@ import Medusa from "@medusajs/medusa-js" const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) // must be previously logged in or use api token medusa.admin.paymentCollections.delete(paymentCollectionId) - .then(({ id, object, deleted }) => { - console.log(id) - }) +.then(({ id, object, deleted }) => { + console.log(id) +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_payment-collections_{id}/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_payment-collections_{id}/get.js index 828a767d01..553d64e404 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_payment-collections_{id}/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_payment-collections_{id}/get.js @@ -2,6 +2,6 @@ import Medusa from "@medusajs/medusa-js" const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) // must be previously logged in or use api token medusa.admin.paymentCollections.retrieve(paymentCollectionId) - .then(({ payment_collection }) => { - console.log(payment_collection.id) - }) +.then(({ payment_collection }) => { + console.log(payment_collection.id) +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_payment-collections_{id}/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_payment-collections_{id}/post.js index d7309d8263..3a94713539 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_payment-collections_{id}/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_payment-collections_{id}/post.js @@ -4,6 +4,6 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.paymentCollections.update(paymentCollectionId, { description }) - .then(({ payment_collection }) => { - console.log(payment_collection.id) - }) +.then(({ payment_collection }) => { + console.log(payment_collection.id) +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_payment-collections_{id}_authorize/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_payment-collections_{id}_authorize/post.js index b4a832aa37..282e993124 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_payment-collections_{id}_authorize/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_payment-collections_{id}_authorize/post.js @@ -2,6 +2,6 @@ import Medusa from "@medusajs/medusa-js" const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) // must be previously logged in or use api token medusa.admin.paymentCollections.markAsAuthorized(paymentCollectionId) - .then(({ payment_collection }) => { - console.log(payment_collection.id) - }) +.then(({ payment_collection }) => { + console.log(payment_collection.id) +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_payments_{id}/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_payments_{id}/get.js index 798a30f01f..ada073593a 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_payments_{id}/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_payments_{id}/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.payments.retrieve(paymentId) .then(({ payment }) => { console.log(payment.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_payments_{id}_capture/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_payments_{id}_capture/post.js index 2329cd773e..24db538566 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_payments_{id}_capture/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_payments_{id}_capture/post.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.payments.capturePayment(paymentId) .then(({ payment }) => { console.log(payment.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_payments_{id}_refund/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_payments_{id}_refund/post.js index 3fbf863b8e..c37ed64e57 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_payments_{id}_refund/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_payments_{id}_refund/post.js @@ -8,4 +8,4 @@ medusa.admin.payments.refundPayment(paymentId, { }) .then(({ payment }) => { console.log(payment.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists/get.js index 81a82c6ea5..2f5076c457 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.priceLists.list() .then(({ price_lists, limit, offset, count }) => { console.log(price_lists.length); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists/post.js index fe68beaa24..1d2c9627cb 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists/post.js @@ -16,4 +16,4 @@ medusa.admin.priceLists.create({ }) .then(({ price_list }) => { console.log(price_list.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists_{id}/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists_{id}/delete.js index 4570e41d2d..fd126775e0 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists_{id}/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists_{id}/delete.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.priceLists.delete(priceListId) .then(({ id, object, deleted }) => { console.log(id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists_{id}/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists_{id}/get.js index d80c9d18f6..1ae04780b6 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists_{id}/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists_{id}/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.priceLists.retrieve(priceListId) .then(({ price_list }) => { console.log(price_list.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists_{id}/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists_{id}/post.js index 3fc44ebe9e..fe9fd2b55f 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists_{id}/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists_{id}/post.js @@ -6,4 +6,4 @@ medusa.admin.priceLists.update(priceListId, { }) .then(({ price_list }) => { console.log(price_list.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists_{id}_prices_batch/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists_{id}_prices_batch/delete.js index 1584a969d9..ed925b0331 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists_{id}_prices_batch/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists_{id}_prices_batch/delete.js @@ -8,4 +8,4 @@ medusa.admin.priceLists.deletePrices(priceListId, { }) .then(({ ids, object, deleted }) => { console.log(ids.length); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists_{id}_prices_batch/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists_{id}_prices_batch/post.js index e4905c86ac..273cc9d276 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists_{id}_prices_batch/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists_{id}_prices_batch/post.js @@ -12,4 +12,4 @@ medusa.admin.priceLists.addPrices(priceListId, { }) .then(({ price_list }) => { console.log(price_list.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists_{id}_products/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists_{id}_products/get.js index 7b5a1183e5..afd30dceff 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists_{id}_products/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists_{id}_products/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.priceLists.listProducts(priceListId) .then(({ products, limit, offset, count }) => { console.log(products.length); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists_{id}_products_prices_batch/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists_{id}_products_prices_batch/delete.js index 869d581a12..129218f080 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists_{id}_products_prices_batch/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists_{id}_products_prices_batch/delete.js @@ -9,4 +9,4 @@ medusa.admin.priceLists.deleteProductsPrices(priceListId, { }) .then(({ ids, object, deleted }) => { console.log(ids.length); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists_{id}_products_{product_id}_prices/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists_{id}_products_{product_id}_prices/delete.js index 0362af01c5..f93fea4a41 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists_{id}_products_{product_id}_prices/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists_{id}_products_{product_id}_prices/delete.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.priceLists.deleteProductPrices(priceListId, productId) .then(({ ids, object, deleted }) => { console.log(ids.length); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists_{id}_variants_{variant_id}_prices/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists_{id}_variants_{variant_id}_prices/delete.js index b8732da339..ce22d96528 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists_{id}_variants_{variant_id}_prices/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_price-lists_{id}_variants_{variant_id}_prices/delete.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.priceLists.deleteVariantPrices(priceListId, variantId) .then(({ ids, object, deleted }) => { console.log(ids); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_product-categories/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_product-categories/get.js index 8df496de40..be3b48c395 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_product-categories/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_product-categories/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.productCategories.list() .then(({ product_categories, limit, offset, count }) => { console.log(product_categories.length); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_product-categories/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_product-categories/post.js index ecda755d7f..3a64df6ac0 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_product-categories/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_product-categories/post.js @@ -6,4 +6,4 @@ medusa.admin.productCategories.create({ }) .then(({ product_category }) => { console.log(product_category.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_product-categories_{id}/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_product-categories_{id}/delete.js index 0282324e2a..d8f4d2e89d 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_product-categories_{id}/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_product-categories_{id}/delete.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.productCategories.delete(productCategoryId) .then(({ id, object, deleted }) => { console.log(id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_product-categories_{id}/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_product-categories_{id}/get.js index 85b6eef992..4281b7e540 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_product-categories_{id}/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_product-categories_{id}/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.productCategories.retrieve(productCategoryId) .then(({ product_category }) => { console.log(product_category.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_product-categories_{id}/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_product-categories_{id}/post.js index 96498da4ad..bcb24b74dc 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_product-categories_{id}/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_product-categories_{id}/post.js @@ -6,4 +6,4 @@ medusa.admin.productCategories.update(productCategoryId, { }) .then(({ product_category }) => { console.log(product_category.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_product-categories_{id}_products_batch/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_product-categories_{id}_products_batch/delete.js index bd80d72094..c1c49aeb37 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_product-categories_{id}_products_batch/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_product-categories_{id}_products_batch/delete.js @@ -10,4 +10,4 @@ medusa.admin.productCategories.removeProducts(productCategoryId, { }) .then(({ product_category }) => { console.log(product_category.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_product-categories_{id}_products_batch/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_product-categories_{id}_products_batch/post.js index bb1b11aeb5..b303c6ed02 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_product-categories_{id}_products_batch/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_product-categories_{id}_products_batch/post.js @@ -10,4 +10,4 @@ medusa.admin.productCategories.addProducts(productCategoryId, { }) .then(({ product_category }) => { console.log(product_category.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_product-tags/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_product-tags/get.js index 65f9fe32d7..b13d6f05d9 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_product-tags/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_product-tags/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.productTags.list() .then(({ product_tags }) => { console.log(product_tags.length); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_product-types/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_product-types/get.js index d379aa453c..98b2c0860a 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_product-types/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_product-types/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.productTypes.list() .then(({ product_types }) => { console.log(product_types.length); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products/get.js index 019d803217..14c8e5e192 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.products.list() .then(({ products, limit, offset, count }) => { console.log(products.length); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products/post.js index 648c90f2bb..a9e7150511 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products/post.js @@ -8,4 +8,4 @@ medusa.admin.products.create({ }) .then(({ product }) => { console.log(product.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_tag-usage/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_tag-usage/get.js index 17969a2bac..e6e17cfb0c 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_tag-usage/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_tag-usage/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.products.listTags() .then(({ tags }) => { console.log(tags.length); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_types/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_types/get.js index a04b425c8a..348c33460f 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_types/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_types/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.products.listTypes() .then(({ types }) => { console.log(types.length); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}/delete.js index cfb5326ac4..0a69bca706 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}/delete.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.products.delete(productId) .then(({ id, object, deleted }) => { console.log(id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}/get.js index 9fc7a2510f..ab69a73129 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.products.retrieve(productId) .then(({ product }) => { console.log(product.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}/post.js index c730be10ca..515832dfa2 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}/post.js @@ -6,4 +6,4 @@ medusa.admin.products.update(productId, { }) .then(({ product }) => { console.log(product.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_metadata/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_metadata/post.js index fffafe946e..2fc17c15ea 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_metadata/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_metadata/post.js @@ -7,4 +7,4 @@ medusa.admin.products.setMetadata(productId, { }) .then(({ product }) => { console.log(product.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_options/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_options/post.js index f07b707d5b..3dd1b432bd 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_options/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_options/post.js @@ -6,4 +6,4 @@ medusa.admin.products.addOption(productId, { }) .then(({ product }) => { console.log(product.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_options_{option_id}/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_options_{option_id}/delete.js index 0814e498c6..311597bac8 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_options_{option_id}/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_options_{option_id}/delete.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.products.deleteOption(productId, optionId) .then(({ option_id, object, deleted, product }) => { console.log(product.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_options_{option_id}/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_options_{option_id}/post.js index 954401f08d..c8236c1c6e 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_options_{option_id}/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_options_{option_id}/post.js @@ -6,4 +6,4 @@ medusa.admin.products.updateOption(productId, optionId, { }) .then(({ product }) => { console.log(product.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_variants_{variant_id}/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_variants_{variant_id}/delete.js index ec99bbc7d0..21f3b3e58d 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_variants_{variant_id}/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_variants_{variant_id}/delete.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.products.deleteVariant(productId, variantId) .then(({ variant_id, object, deleted, product }) => { console.log(product.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_variants_{variant_id}/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_variants_{variant_id}/post.js index 5043e8ffaa..a406cc6ba4 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_variants_{variant_id}/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_variants_{variant_id}/post.js @@ -19,4 +19,4 @@ medusa.admin.products.updateVariant(productId, variantId, { }) .then(({ product }) => { console.log(product.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_publishable-api-keys/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_publishable-api-keys/get.js index 0aed124df5..7027ee3c61 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_publishable-api-keys/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_publishable-api-keys/get.js @@ -2,6 +2,6 @@ import Medusa from "@medusajs/medusa-js" const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) // must be previously logged in or use api token medusa.admin.publishableApiKeys.list() - .then(({ publishable_api_keys, count, limit, offset }) => { - console.log(publishable_api_keys) - }) +.then(({ publishable_api_keys, count, limit, offset }) => { + console.log(publishable_api_keys) +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_publishable-api-keys_{id}_revoke/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_publishable-api-keys_{id}_revoke/post.js index 3705a7e41d..c48cc0f180 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_publishable-api-keys_{id}_revoke/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_publishable-api-keys_{id}_revoke/post.js @@ -2,6 +2,6 @@ import Medusa from "@medusajs/medusa-js" const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) // must be previously logged in or use api token medusa.admin.publishableApiKeys.revoke(publishableApiKeyId) - .then(({ publishable_api_key }) => { - console.log(publishable_api_key.id) - }) +.then(({ publishable_api_key }) => { + console.log(publishable_api_key.id) +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_publishable-api-keys_{id}_sales-channels/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_publishable-api-keys_{id}_sales-channels/get.js index df67996f8d..b14d54188b 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_publishable-api-keys_{id}_sales-channels/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_publishable-api-keys_{id}_sales-channels/get.js @@ -2,6 +2,6 @@ import Medusa from "@medusajs/medusa-js" const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) // must be previously logged in or use api token medusa.admin.publishableApiKeys.listSalesChannels() - .then(({ sales_channels }) => { - console.log(sales_channels.length) - }) +.then(({ sales_channels }) => { + console.log(sales_channels.length) +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_publishable-api-keys_{id}_sales-channels_batch/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_publishable-api-keys_{id}_sales-channels_batch/delete.js index 7d0dbee55c..aeb244376d 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_publishable-api-keys_{id}_sales-channels_batch/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_publishable-api-keys_{id}_sales-channels_batch/delete.js @@ -10,4 +10,4 @@ medusa.admin.publishableApiKeys.deleteSalesChannelsBatch(publishableApiKeyId, { }) .then(({ publishable_api_key }) => { console.log(publishable_api_key.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_publishable-api-keys_{id}_sales-channels_batch/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_publishable-api-keys_{id}_sales-channels_batch/post.js index 94e1d0cfad..fd38b7f096 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_publishable-api-keys_{id}_sales-channels_batch/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_publishable-api-keys_{id}_sales-channels_batch/post.js @@ -10,4 +10,4 @@ medusa.admin.publishableApiKeys.addSalesChannelsBatch(publishableApiKeyId, { }) .then(({ publishable_api_key }) => { console.log(publishable_api_key.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions/get.js index ba2d7532ee..647c347340 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.regions.list() .then(({ regions, limit, offset, count }) => { console.log(regions.length); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions/post.js index 361f3f7cfe..43eff6dbcf 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions/post.js @@ -17,4 +17,4 @@ medusa.admin.regions.create({ }) .then(({ region }) => { console.log(region.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}/delete.js index e3cc3dbb0c..87149267ba 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}/delete.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.regions.delete(regionId) .then(({ id, object, deleted }) => { console.log(id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}/get.js index 92a96f0b49..0697eddf84 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.regions.retrieve(regionId) .then(({ region }) => { console.log(region.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}/post.js index 4315dc3b49..a96f349303 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}/post.js @@ -6,4 +6,4 @@ medusa.admin.regions.update(regionId, { }) .then(({ region }) => { console.log(region.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}_countries/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}_countries/post.js index 1e38a75e3c..b2c31cceee 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}_countries/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}_countries/post.js @@ -6,4 +6,4 @@ medusa.admin.regions.addCountry(regionId, { }) .then(({ region }) => { console.log(region.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}_countries_{country_code}/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}_countries_{country_code}/delete.js index 0c5244602a..7398b8ba11 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}_countries_{country_code}/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}_countries_{country_code}/delete.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.regions.deleteCountry(regionId, "dk") .then(({ region }) => { console.log(region.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}_fulfillment-options/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}_fulfillment-options/get.js index 93e49b798a..69c6e82bcd 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}_fulfillment-options/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}_fulfillment-options/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.regions.retrieveFulfillmentOptions(regionId) .then(({ fulfillment_options }) => { console.log(fulfillment_options.length); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}_fulfillment-providers/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}_fulfillment-providers/post.js index 6b82817f8b..350822c70b 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}_fulfillment-providers/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}_fulfillment-providers/post.js @@ -6,4 +6,4 @@ medusa.admin.regions.addFulfillmentProvider(regionId, { }) .then(({ region }) => { console.log(region.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}_fulfillment-providers_{provider_id}/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}_fulfillment-providers_{provider_id}/delete.js index 3e8ed63fcb..4fe91d2993 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}_fulfillment-providers_{provider_id}/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}_fulfillment-providers_{provider_id}/delete.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.regions.deleteFulfillmentProvider(regionId, "manual") .then(({ region }) => { console.log(region.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}_payment-providers/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}_payment-providers/post.js index 875db17be0..be40f8498c 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}_payment-providers/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}_payment-providers/post.js @@ -6,4 +6,4 @@ medusa.admin.regions.addPaymentProvider(regionId, { }) .then(({ region }) => { console.log(region.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}_payment-providers_{provider_id}/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}_payment-providers_{provider_id}/delete.js index e5d6380cce..4591a1b351 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}_payment-providers_{provider_id}/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_regions_{id}_payment-providers_{provider_id}/delete.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.regions.deletePaymentProvider(regionId, "manual") .then(({ region }) => { console.log(region.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_reservations/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_reservations/post.js index ca31036994..55fdf093cb 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_reservations/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_reservations/post.js @@ -9,4 +9,4 @@ medusa.admin.reservations.create({ }) .then(({ reservation }) => { console.log(reservation.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_reservations_{id}/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_reservations_{id}/delete.js index fe4e71e55d..0cffb9d607 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_reservations_{id}/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_reservations_{id}/delete.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.reservations.delete(reservationId) .then(({ id, object, deleted }) => { console.log(id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_reservations_{id}/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_reservations_{id}/get.js index 9030b12152..480aa766ec 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_reservations_{id}/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_reservations_{id}/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.reservations.retrieve(reservationId) .then(({ reservation }) => { console.log(reservation.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_reservations_{id}/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_reservations_{id}/post.js index 804742a276..b0edd1d39b 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_reservations_{id}/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_reservations_{id}/post.js @@ -6,4 +6,4 @@ medusa.admin.reservations.update(reservationId, { }) .then(({ reservation }) => { console.log(reservation.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_return-reasons/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_return-reasons/get.js index ebcc0e0029..2ef93fb1ba 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_return-reasons/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_return-reasons/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.returnReasons.list() .then(({ return_reasons }) => { console.log(return_reasons.length); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_return-reasons/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_return-reasons/post.js index 42f3c4ca35..8f6ba5a2ad 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_return-reasons/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_return-reasons/post.js @@ -7,4 +7,4 @@ medusa.admin.returnReasons.create({ }) .then(({ return_reason }) => { console.log(return_reason.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_return-reasons_{id}/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_return-reasons_{id}/delete.js index 62e63a2573..d69c087f34 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_return-reasons_{id}/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_return-reasons_{id}/delete.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.returnReasons.delete(returnReasonId) .then(({ id, object, deleted }) => { console.log(id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_return-reasons_{id}/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_return-reasons_{id}/get.js index b2ee78d7d0..094096b898 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_return-reasons_{id}/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_return-reasons_{id}/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.returnReasons.retrieve(returnReasonId) .then(({ return_reason }) => { console.log(return_reason.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_return-reasons_{id}/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_return-reasons_{id}/post.js index 987e8cfb2e..78756c3989 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_return-reasons_{id}/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_return-reasons_{id}/post.js @@ -6,4 +6,4 @@ medusa.admin.returnReasons.update(returnReasonId, { }) .then(({ return_reason }) => { console.log(return_reason.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_returns/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_returns/get.js index 956b17b8f7..d07e97b191 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_returns/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_returns/get.js @@ -3,5 +3,5 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) // must be previously logged in or use api token medusa.admin.returns.list() .then(({ returns, limit, offset, count }) => { - console.log(returns.length); -}); + console.log(returns.length) +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_returns_{id}_cancel/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_returns_{id}_cancel/post.js index a692e34c71..9c8e7ca903 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_returns_{id}_cancel/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_returns_{id}_cancel/post.js @@ -3,5 +3,5 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) // must be previously logged in or use api token medusa.admin.returns.cancel(returnId) .then(({ order }) => { - console.log(order.id); -}); + console.log(order.id) +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_returns_{id}_receive/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_returns_{id}_receive/post.js index aeff7eb923..7c1e52791e 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_returns_{id}_receive/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_returns_{id}_receive/post.js @@ -11,4 +11,4 @@ medusa.admin.returns.receive(returnId, { }) .then((data) => { console.log(data.return.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_sales-channels/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_sales-channels/get.js index e2ff907f23..fca9318064 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_sales-channels/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_sales-channels/get.js @@ -3,5 +3,5 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) // must be previously logged in or use api token medusa.admin.salesChannels.list() .then(({ sales_channels, limit, offset, count }) => { - console.log(sales_channels.length); -}); + console.log(sales_channels.length) +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_sales-channels/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_sales-channels/post.js index 7f955e298b..343af3b461 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_sales-channels/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_sales-channels/post.js @@ -7,4 +7,4 @@ medusa.admin.salesChannels.create({ }) .then(({ sales_channel }) => { console.log(sales_channel.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_sales-channels_{id}/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_sales-channels_{id}/delete.js index 33335bcafa..d877774830 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_sales-channels_{id}/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_sales-channels_{id}/delete.js @@ -3,5 +3,5 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) // must be previously logged in or use api token medusa.admin.salesChannels.delete(salesChannelId) .then(({ id, object, deleted }) => { - console.log(id); -}); + console.log(id) +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_sales-channels_{id}/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_sales-channels_{id}/get.js index 0e25e9344f..e32d8f0592 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_sales-channels_{id}/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_sales-channels_{id}/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.salesChannels.retrieve(salesChannelId) .then(({ sales_channel }) => { console.log(sales_channel.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_sales-channels_{id}/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_sales-channels_{id}/post.js index 30e43a4ebf..4f511af44f 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_sales-channels_{id}/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_sales-channels_{id}/post.js @@ -6,4 +6,4 @@ medusa.admin.salesChannels.update(salesChannelId, { }) .then(({ sales_channel }) => { console.log(sales_channel.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_sales-channels_{id}_products_batch/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_sales-channels_{id}_products_batch/delete.js index bc5d1a35db..b64765defb 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_sales-channels_{id}_products_batch/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_sales-channels_{id}_products_batch/delete.js @@ -9,5 +9,5 @@ medusa.admin.salesChannels.removeProducts(salesChannelId, { ] }) .then(({ sales_channel }) => { - console.log(sales_channel.id); -}); + console.log(sales_channel.id) +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_sales-channels_{id}_products_batch/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_sales-channels_{id}_products_batch/post.js index 6e9f86ee21..2385e9fb6f 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_sales-channels_{id}_products_batch/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_sales-channels_{id}_products_batch/post.js @@ -10,4 +10,4 @@ medusa.admin.salesChannels.addProducts(salesChannelId, { }) .then(({ sales_channel }) => { console.log(sales_channel.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_sales-channels_{id}_stock-locations/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_sales-channels_{id}_stock-locations/delete.js index 3d965e58e0..0a8e044188 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_sales-channels_{id}_stock-locations/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_sales-channels_{id}_stock-locations/delete.js @@ -6,4 +6,4 @@ medusa.admin.salesChannels.removeLocation(salesChannelId, { }) .then(({ sales_channel }) => { console.log(sales_channel.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_sales-channels_{id}_stock-locations/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_sales-channels_{id}_stock-locations/post.js index ad1afff74a..ea7f2cce0b 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_sales-channels_{id}_stock-locations/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_sales-channels_{id}_stock-locations/post.js @@ -6,4 +6,4 @@ medusa.admin.salesChannels.addLocation(salesChannelId, { }) .then(({ sales_channel }) => { console.log(sales_channel.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-options/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-options/get.js index 2318c1afd4..a67bf2c443 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-options/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-options/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.shippingOptions.list() .then(({ shipping_options, count }) => { console.log(shipping_options.length); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-options/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-options/post.js index aeacf0245e..1b9373e143 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-options/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-options/post.js @@ -11,4 +11,4 @@ medusa.admin.shippingOptions.create({ }) .then(({ shipping_option }) => { console.log(shipping_option.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-options_{id}/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-options_{id}/delete.js index 22085391dd..86ff851dfc 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-options_{id}/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-options_{id}/delete.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.shippingOptions.delete(optionId) .then(({ id, object, deleted }) => { console.log(id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-options_{id}/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-options_{id}/get.js index 6a304dbc03..3f0ad845ac 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-options_{id}/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-options_{id}/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.shippingOptions.retrieve(optionId) .then(({ shipping_option }) => { console.log(shipping_option.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-options_{id}/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-options_{id}/post.js index f3d2f8285e..ef30c1219f 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-options_{id}/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-options_{id}/post.js @@ -13,4 +13,4 @@ medusa.admin.shippingOptions.update(optionId, { }) .then(({ shipping_option }) => { console.log(shipping_option.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-profiles/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-profiles/get.js index 39c4e65180..c15f3bd0ba 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-profiles/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-profiles/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.shippingProfiles.list() .then(({ shipping_profiles }) => { console.log(shipping_profiles.length); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-profiles/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-profiles/post.js index 5d82ba2477..9cd8bb9c05 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-profiles/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-profiles/post.js @@ -6,4 +6,4 @@ medusa.admin.shippingProfiles.create({ }) .then(({ shipping_profile }) => { console.log(shipping_profile.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-profiles_{id}/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-profiles_{id}/delete.js index a1862657a7..814f719edd 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-profiles_{id}/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-profiles_{id}/delete.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.shippingProfiles.delete(profileId) .then(({ id, object, deleted }) => { console.log(id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-profiles_{id}/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-profiles_{id}/get.js index 86ffde5d0e..bcde558645 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-profiles_{id}/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-profiles_{id}/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.shippingProfiles.retrieve(profileId) .then(({ shipping_profile }) => { console.log(shipping_profile.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-profiles_{id}/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-profiles_{id}/post.js index 03c6b3fc05..fcaac5eda2 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-profiles_{id}/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_shipping-profiles_{id}/post.js @@ -6,4 +6,4 @@ medusa.admin.shippingProfiles.update(shippingProfileId, { }) .then(({ shipping_profile }) => { console.log(shipping_profile.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_stock-locations/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_stock-locations/get.js index b0af38afae..de8a49d085 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_stock-locations/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_stock-locations/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.stockLocations.list() .then(({ stock_locations, limit, offset, count }) => { console.log(stock_locations.length); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_stock-locations/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_stock-locations/post.js index 2c6b725808..43add759fc 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_stock-locations/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_stock-locations/post.js @@ -6,4 +6,4 @@ medusa.admin.stockLocations.create({ }) .then(({ stock_location }) => { console.log(stock_location.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_stock-locations_{id}/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_stock-locations_{id}/get.js index a0656b1086..c69524cdfb 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_stock-locations_{id}/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_stock-locations_{id}/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.stockLocations.retrieve(stockLocationId) .then(({ stock_location }) => { console.log(stock_location.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_stock-locations_{id}/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_stock-locations_{id}/post.js index f3ad1429e3..d03f2a3ff0 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_stock-locations_{id}/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_stock-locations_{id}/post.js @@ -6,4 +6,4 @@ medusa.admin.stockLocations.update(stockLocationId, { }) .then(({ stock_location }) => { console.log(stock_location.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_store/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_store/get.js index 98075c1e6a..e9ff095154 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_store/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_store/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.store.retrieve() .then(({ store }) => { console.log(store.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_store/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_store/post.js index f259cd2f01..12fb37943a 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_store/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_store/post.js @@ -6,4 +6,4 @@ medusa.admin.store.update({ }) .then(({ store }) => { console.log(store.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_store_currencies_{code}/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_store_currencies_{code}/delete.js index 5f3514aba8..bfdbcf73be 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_store_currencies_{code}/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_store_currencies_{code}/delete.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.store.deleteCurrency("eur") .then(({ store }) => { console.log(store.currencies); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_store_currencies_{code}/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_store_currencies_{code}/post.js index 99d96959c3..53a55fdded 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_store_currencies_{code}/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_store_currencies_{code}/post.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.store.addCurrency("eur") .then(({ store }) => { console.log(store.currencies); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_store_payment-providers/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_store_payment-providers/get.js index faa67b4447..499ae8c6ff 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_store_payment-providers/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_store_payment-providers/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.store.listPaymentProviders() .then(({ payment_providers }) => { console.log(payment_providers.length); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_store_tax-providers/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_store_tax-providers/get.js index 2fc472fe98..c0e5b424e0 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_store_tax-providers/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_store_tax-providers/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.store.listTaxProviders() .then(({ tax_providers }) => { console.log(tax_providers.length); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_swaps/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_swaps/get.js index 2f68e11799..7cfa03d604 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_swaps/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_swaps/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.swaps.list() .then(({ swaps }) => { console.log(swaps.length); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_swaps_{id}/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_swaps_{id}/get.js index b7cb2a9632..754f2aa341 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_swaps_{id}/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_swaps_{id}/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.swaps.retrieve(swapId) .then(({ swap }) => { console.log(swap.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates/get.js index d80de4ad90..824b60b633 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.taxRates.list() .then(({ tax_rates, limit, offset, count }) => { console.log(tax_rates.length); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates/post.js index 6a448583b5..a5ab240912 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates/post.js @@ -8,4 +8,4 @@ medusa.admin.taxRates.create({ }) .then(({ tax_rate }) => { console.log(tax_rate.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates_{id}/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates_{id}/delete.js index f2cca5e1ec..fd84111a14 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates_{id}/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates_{id}/delete.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.taxRates.delete(taxRateId) .then(({ id, object, deleted }) => { console.log(id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates_{id}/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates_{id}/get.js index 17b7808207..92aa4a8d67 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates_{id}/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates_{id}/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.taxRates.retrieve(taxRateId) .then(({ tax_rate }) => { console.log(tax_rate.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates_{id}/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates_{id}/post.js index 95c2798abe..e32c49bfa4 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates_{id}/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates_{id}/post.js @@ -6,4 +6,4 @@ medusa.admin.taxRates.update(taxRateId, { }) .then(({ tax_rate }) => { console.log(tax_rate.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates_{id}_product-types_batch/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates_{id}_product-types_batch/delete.js index 9914f85587..25277943a3 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates_{id}_product-types_batch/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates_{id}_product-types_batch/delete.js @@ -8,4 +8,4 @@ medusa.admin.taxRates.removeProductTypes(taxRateId, { }) .then(({ tax_rate }) => { console.log(tax_rate.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates_{id}_product-types_batch/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates_{id}_product-types_batch/post.js index c25965b9cb..5b5ce3f6ac 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates_{id}_product-types_batch/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates_{id}_product-types_batch/post.js @@ -8,4 +8,4 @@ medusa.admin.taxRates.addProductTypes(taxRateId, { }) .then(({ tax_rate }) => { console.log(tax_rate.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates_{id}_products_batch/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates_{id}_products_batch/delete.js index cb642c610b..aa3fa0db50 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates_{id}_products_batch/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates_{id}_products_batch/delete.js @@ -8,4 +8,4 @@ medusa.admin.taxRates.removeProducts(taxRateId, { }) .then(({ tax_rate }) => { console.log(tax_rate.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates_{id}_products_batch/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates_{id}_products_batch/post.js index 50cceed4e2..74830ca7ef 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates_{id}_products_batch/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates_{id}_products_batch/post.js @@ -8,4 +8,4 @@ medusa.admin.taxRates.addProducts(taxRateId, { }) .then(({ tax_rate }) => { console.log(tax_rate.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates_{id}_shipping-options_batch/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates_{id}_shipping-options_batch/delete.js index 0b427612f7..0295bc2ccf 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates_{id}_shipping-options_batch/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates_{id}_shipping-options_batch/delete.js @@ -8,4 +8,4 @@ medusa.admin.taxRates.removeShippingOptions(taxRateId, { }) .then(({ tax_rate }) => { console.log(tax_rate.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates_{id}_shipping-options_batch/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates_{id}_shipping-options_batch/post.js index 0a2fd121c6..f24e59c767 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates_{id}_shipping-options_batch/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_tax-rates_{id}_shipping-options_batch/post.js @@ -8,4 +8,4 @@ medusa.admin.taxRates.addShippingOptions(taxRateId, { }) .then(({ tax_rate }) => { console.log(tax_rate.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_uploads/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_uploads/delete.js index 1b560d5144..4edd8431db 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_uploads/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_uploads/delete.js @@ -6,4 +6,4 @@ medusa.admin.uploads.delete({ }) .then(({ id, object, deleted }) => { console.log(id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_uploads/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_uploads/post.js index 67a54930b0..4d73e5cb5a 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_uploads/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_uploads/post.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.uploads.create(file) .then(({ uploads }) => { console.log(uploads.length); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_uploads_download-url/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_uploads_download-url/post.js index b84c168eff..ccbc1154fa 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_uploads_download-url/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_uploads_download-url/post.js @@ -6,4 +6,4 @@ medusa.admin.uploads.getPresignedDownloadUrl({ }) .then(({ download_url }) => { console.log(download_url); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_uploads_protected/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_uploads_protected/post.js index ddd65037e5..a35f958acf 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_uploads_protected/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_uploads_protected/post.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.uploads.createProtected(file) .then(({ uploads }) => { console.log(uploads.length); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_users/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_users/get.js index 38d9ada2ab..d703d64f1b 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_users/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_users/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.users.list() .then(({ users }) => { console.log(users.length); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_users/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_users/post.js index 94f4bfbe42..70aa036912 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_users/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_users/post.js @@ -7,4 +7,4 @@ medusa.admin.users.create({ }) .then(({ user }) => { console.log(user.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_users_password-token/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_users_password-token/post.js index dd09a098af..eb62808f65 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_users_password-token/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_users_password-token/post.js @@ -9,4 +9,4 @@ medusa.admin.users.sendResetPasswordToken({ }) .catch(() => { // error occurred -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_users_reset-password/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_users_reset-password/post.js index 56ca075c54..3d6c146ba4 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_users_reset-password/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_users_reset-password/post.js @@ -7,4 +7,4 @@ medusa.admin.users.resetPassword({ }) .then(({ user }) => { console.log(user.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_users_{id}/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_users_{id}/delete.js index 5d90c96bfd..8f6e0e4665 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_users_{id}/delete.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_users_{id}/delete.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.users.delete(userId) .then(({ id, object, deleted }) => { console.log(id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_users_{id}/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_users_{id}/get.js index 0f80f02119..1c9acc76b6 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_users_{id}/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_users_{id}/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.users.retrieve(userId) .then(({ user }) => { console.log(user.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_users_{id}/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_users_{id}/post.js index 89c77cca1c..bd461cb961 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_users_{id}/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_users_{id}/post.js @@ -6,4 +6,4 @@ medusa.admin.users.update(userId, { }) .then(({ user }) => { console.log(user.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_variants/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_variants/get.js index efcf6f97d0..8ee716d2ea 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_variants/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_variants/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.variants.list() .then(({ variants, limit, offset, count }) => { console.log(variants.length); -}); +}) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_variants_{id}/get.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_variants_{id}/get.js index b1a38a0e59..34b5cb84db 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_variants_{id}/get.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_variants_{id}/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.admin.variants.retrieve(variantId) .then(({ variant }) => { console.log(variant.id); -}); +}) diff --git a/www/apps/api-reference/specs/admin/components/schemas/AddressPayload.yaml b/www/apps/api-reference/specs/admin/components/schemas/AddressPayload.yaml index 89fa9ff576..826bf11526 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AddressPayload.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AddressPayload.yaml @@ -15,6 +15,7 @@ properties: example: 16128234334802 company: type: string + description: Company address_1: description: Address line 1 type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminAuthRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminAuthRes.yaml index f5834ed1e0..a5f5bcc495 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminAuthRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminAuthRes.yaml @@ -1,4 +1,5 @@ type: object +description: The user's details. required: - user properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminBatchJobRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminBatchJobRes.yaml index eed89446c7..38e6af340d 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminBatchJobRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminBatchJobRes.yaml @@ -1,4 +1,5 @@ type: object +description: The batch job's details. required: - batch_job properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminBearerAuthRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminBearerAuthRes.yaml index 096d46cc6b..cef364431b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminBearerAuthRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminBearerAuthRes.yaml @@ -1,4 +1,5 @@ type: object +description: The access token of the user, if they're authenticated successfully. properties: access_token: description: Access token that can be used to send authenticated requests. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCollectionsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCollectionsRes.yaml index acb25a9335..c68818ac13 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCollectionsRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCollectionsRes.yaml @@ -1,4 +1,5 @@ type: object +description: The collection's details. x-expanded-relations: field: collection relations: @@ -7,5 +8,5 @@ required: - collection properties: collection: - type: Product Collection details. + description: Product Collection details. $ref: ./ProductCollection.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCurrenciesListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCurrenciesListRes.yaml index b912955581..baf22c8547 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCurrenciesListRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCurrenciesListRes.yaml @@ -1,4 +1,5 @@ type: object +description: List of currencies with pagination fields. required: - currencies - count diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCurrenciesRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCurrenciesRes.yaml index 25c62e87f6..6d75dfa3ac 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCurrenciesRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCurrenciesRes.yaml @@ -1,4 +1,5 @@ type: object +description: A currency's details. required: - currency properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerGroupsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerGroupsRes.yaml index dc4382b13c..738a35695c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerGroupsRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerGroupsRes.yaml @@ -1,4 +1,5 @@ type: object +description: The customer group's details. required: - customer_group properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomersListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomersListRes.yaml index 7d345090bf..bd60809bb7 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomersListRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomersListRes.yaml @@ -1,3 +1,4 @@ +description: The list of customers with pagination fields. type: object required: - customers diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomersRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomersRes.yaml index c44155d3fd..47890d9d0b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomersRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomersRes.yaml @@ -1,4 +1,5 @@ type: object +description: The customer's details. x-expanded-relations: field: customer relations: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteDiscountsDiscountConditionsConditionBatchReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteDiscountsDiscountConditionsConditionBatchReq.yaml index 8cbf27f590..8e3b48b994 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteDiscountsDiscountConditionsConditionBatchReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteDiscountsDiscountConditionsConditionBatchReq.yaml @@ -1,4 +1,5 @@ type: object +description: The resources to remove. required: - resources properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteProductsFromCollectionRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteProductsFromCollectionRes.yaml index 363119f0d4..d387516c83 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteProductsFromCollectionRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteProductsFromCollectionRes.yaml @@ -1,4 +1,5 @@ type: object +description: Deletion operation details required: - id - object diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteTaxRatesTaxRateProductTypesReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteTaxRatesTaxRateProductTypesReq.yaml index fc4d2ffb89..0323995581 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteTaxRatesTaxRateProductTypesReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteTaxRatesTaxRateProductTypesReq.yaml @@ -1,4 +1,5 @@ type: object +description: Product types to remove from the tax rates. required: - product_types properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDiscountsListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDiscountsListRes.yaml index b0e26427a7..5f027be6e1 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminDiscountsListRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminDiscountsListRes.yaml @@ -1,4 +1,5 @@ type: object +description: The list of discounts with pagination fields. x-expanded-relations: field: discounts relations: @@ -14,6 +15,7 @@ required: properties: discounts: type: array + description: The list of discounts. items: $ref: ./Discount.yaml count: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDiscountsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDiscountsRes.yaml index 7a7a49f4e1..55c5640e03 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminDiscountsRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminDiscountsRes.yaml @@ -1,4 +1,5 @@ type: object +description: The discount's details. x-expanded-relations: field: discount relations: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrdersListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrdersListRes.yaml index 4bf28364f3..539b3e9204 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrdersListRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrdersListRes.yaml @@ -1,3 +1,4 @@ +description: The list of draft orders with pagination fields. type: object x-expanded-relations: field: draft_orders diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrdersRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrdersRes.yaml index 19365b254d..20ae557261 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrdersRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrdersRes.yaml @@ -1,4 +1,5 @@ type: object +description: The list of draft orders. x-expanded-relations: field: draft_order relations: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminExtendedStoresRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminExtendedStoresRes.yaml index a0eddd2063..b48265c097 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminExtendedStoresRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminExtendedStoresRes.yaml @@ -1,4 +1,5 @@ type: object +description: The store's details with additional details like payment and tax providers. x-expanded-relations: field: store relations: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminGetRegionsRegionFulfillmentOptionsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminGetRegionsRegionFulfillmentOptionsRes.yaml index c62c12a07c..122df7072d 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminGetRegionsRegionFulfillmentOptionsRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminGetRegionsRegionFulfillmentOptionsRes.yaml @@ -1,4 +1,5 @@ type: object +description: The list of fulfillment options in a region. required: - fulfillment_options properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminGetVariantsVariantInventoryRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminGetVariantsVariantInventoryRes.yaml index 1c72e73f56..fa021b68fd 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminGetVariantsVariantInventoryRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminGetVariantsVariantInventoryRes.yaml @@ -1,6 +1,7 @@ type: object +description: The variant's inventory details. properties: variant: type: object - description: The product variant's. + description: The product variant's inventory details. $ref: ./VariantInventory.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminGiftCardsListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminGiftCardsListRes.yaml index ed0e6d8125..4554a7f3f7 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminGiftCardsListRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminGiftCardsListRes.yaml @@ -1,4 +1,5 @@ type: object +description: The list of gift cards with pagination fields. x-expanded-relations: field: gift_cards relations: @@ -15,6 +16,7 @@ required: properties: gift_cards: type: array + description: The list of gift cards. items: $ref: ./GiftCard.yaml count: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminGiftCardsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminGiftCardsRes.yaml index 4911078159..6660bb4615 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminGiftCardsRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminGiftCardsRes.yaml @@ -1,4 +1,5 @@ type: object +description: The gift card's details. x-expanded-relations: field: gift_card relations: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItemsLocationLevelsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItemsLocationLevelsRes.yaml index f275fb9d97..2eae35229b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItemsLocationLevelsRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItemsLocationLevelsRes.yaml @@ -1,15 +1,18 @@ type: object +description: Details of inventory items and their associated location levels. required: - inventory_item properties: inventory_item: type: object + description: An inventory item's ID and associated location levels. required: - id - location_levels properties: id: description: The id of the location + type: string location_levels: description: List of stock levels at a given location type: array diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItemsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItemsRes.yaml index c876c27e0d..5970f5ad2f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItemsRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItemsRes.yaml @@ -1,4 +1,5 @@ type: object +description: The inventory item's details. required: - inventory_item properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminListInvitesRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminListInvitesRes.yaml index f9f4b9fca1..24604800af 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminListInvitesRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminListInvitesRes.yaml @@ -1,3 +1,4 @@ +description: The list of invites. type: object required: - invites diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminNotesListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminNotesListRes.yaml index cf9e5ff664..a65b53deaf 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminNotesListRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminNotesListRes.yaml @@ -1,4 +1,5 @@ type: object +description: The list of notes with pagination fields. required: - notes - count diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminNotesRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminNotesRes.yaml index acd2598e9b..cb19ac88c4 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminNotesRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminNotesRes.yaml @@ -1,4 +1,5 @@ type: object +description: The note's details. required: - note properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminNotificationsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminNotificationsRes.yaml index 8ecc76a011..72d8cd2f2a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminNotificationsRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminNotificationsRes.yaml @@ -1,4 +1,5 @@ type: object +description: The notification's details. x-expanded-relations: field: notification relations: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderEditItemChangeDeleteRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderEditItemChangeDeleteRes.yaml index b1d52f5627..3004c5cfd9 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderEditItemChangeDeleteRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderEditItemChangeDeleteRes.yaml @@ -1,4 +1,5 @@ type: object +description: The details of deleting order edit item changes. required: - id - object diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderEditsListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderEditsListRes.yaml index c308a79b1f..a49569c577 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderEditsListRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderEditsListRes.yaml @@ -1,4 +1,5 @@ type: object +description: The list of order edits with pagination fields. x-expanded-relations: field: order_edits relations: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderEditsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderEditsRes.yaml index b1a5813f06..77f7749b24 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderEditsRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderEditsRes.yaml @@ -1,4 +1,5 @@ type: object +description: The order edit details. x-expanded-relations: field: order_edit relations: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrdersListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrdersListRes.yaml index ff363d4520..05b64d5f94 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrdersListRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrdersListRes.yaml @@ -1,4 +1,5 @@ type: object +description: The list of orders with pagination fields. x-expanded-relations: field: orders relations: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrdersRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrdersRes.yaml index def46daae7..15f2179e17 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrdersRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrdersRes.yaml @@ -1,4 +1,5 @@ type: object +description: The order's details. x-expanded-relations: field: order relations: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollectionDeleteRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollectionDeleteRes.yaml index 46401f7f36..a2a7150b53 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollectionDeleteRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollectionDeleteRes.yaml @@ -1,4 +1,5 @@ type: object +description: The details of deleting a payment collection. required: - id - object diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentProvidersList.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentProvidersList.yaml index 5f706026af..d0548fb65d 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentProvidersList.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentProvidersList.yaml @@ -1,4 +1,5 @@ type: object +description: The list of payment providers in a store. required: - payment_providers properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentRes.yaml index 4e812a9072..7d52b01d9a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentRes.yaml @@ -1,4 +1,5 @@ type: object +description: The payment's details. required: - payment properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDiscountsDiscountConditionsConditionBatchReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostDiscountsDiscountConditionsConditionBatchReq.yaml index c19f356129..b79fdcaf52 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDiscountsDiscountConditionsConditionBatchReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostDiscountsDiscountConditionsConditionBatchReq.yaml @@ -11,5 +11,5 @@ properties: - id properties: id: - description: The id of the item + description: The ID of the item type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDraftOrdersDraftOrderRegisterPaymentRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostDraftOrdersDraftOrderRegisterPaymentRes.yaml index 39f759fc27..949163a867 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDraftOrdersDraftOrderRegisterPaymentRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostDraftOrdersDraftOrderRegisterPaymentRes.yaml @@ -1,4 +1,5 @@ type: object +description: The order's details. required: - order properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsInventoryItemReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsInventoryItemReq.yaml index 4971d79503..5d28182435 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsInventoryItemReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsInventoryItemReq.yaml @@ -1,4 +1,5 @@ type: object +description: The attributes to update in an inventory item. properties: hs_code: description: >- @@ -42,6 +43,15 @@ properties: The length of the Inventory Item. May be used in shipping rate calculations. type: number + title: + description: The inventory item's title. + type: string + description: + description: The inventory item's description. + type: string + thumbnail: + description: The inventory item's thumbnail. + type: string requires_shipping: description: Whether the item requires shipping. type: boolean diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsReq.yaml index f1b14b3f54..ca1e586a24 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsReq.yaml @@ -72,6 +72,15 @@ properties: used by Fulfillment Providers to pass customs information to shipping carriers. type: string + title: + description: The inventory item's title. + type: string + description: + description: The inventory item's description. + type: string + thumbnail: + description: The inventory item's thumbnail. + type: string metadata: description: An optional set of key-value pairs with additional information. type: object diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostInvitesInviteAcceptReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostInvitesInviteAcceptReq.yaml index 5fcb0d30c5..3e12386930 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostInvitesInviteAcceptReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostInvitesInviteAcceptReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the invite to be accepted. required: - token - user diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderClaimsClaimFulfillmentsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderClaimsClaimFulfillmentsReq.yaml index 44986a8f4d..e19eb4e160 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderClaimsClaimFulfillmentsReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderClaimsClaimFulfillmentsReq.yaml @@ -12,3 +12,6 @@ properties: If set to `true`, no notification will be sent to the customer related to this Claim. type: boolean + location_id: + description: The ID of the fulfillment's location. + type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderClaimsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderClaimsReq.yaml index e46b5b55a4..ff71675024 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderClaimsReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderClaimsReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the claim to be created. required: - type - claim_items @@ -111,6 +112,9 @@ properties: no_notification: description: If set to true no notification will be send related to this Claim. type: boolean + return_location_id: + description: The ID of the location used for the associated return. + type: string metadata: description: An optional set of key-value pairs to hold additional information. type: object diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderFulfillmentsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderFulfillmentsReq.yaml index 58c6dbcd49..1eb020638b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderFulfillmentsReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderFulfillmentsReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the fulfillment to be created. required: - items properties: @@ -17,6 +18,9 @@ properties: quantity: description: The quantity of the Line Item to fulfill. type: integer + location_id: + type: string + description: The ID of the location where the items will be fulfilled from. no_notification: description: >- If set to `true`, no notification will be sent to the customer related to diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderReq.yaml index 8b1f00f5e1..ce759df2f7 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderReq.yaml @@ -1,7 +1,7 @@ type: object properties: email: - description: the email associated with the order + description: The email associated with the order type: string billing_address: description: The order's billing address diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderReturnsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderReturnsReq.yaml index d485a2c1a3..d7b166d0bb 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderReturnsReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderReturnsReq.yaml @@ -50,3 +50,6 @@ properties: refund: description: The amount to refund. type: integer + location_id: + description: The ID of the location used for the return. + type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderShippingMethodsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderShippingMethodsReq.yaml index 800529076e..ec49d666e9 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderShippingMethodsReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderShippingMethodsReq.yaml @@ -1,4 +1,5 @@ type: object +description: The shipping method's details. required: - price - option_id @@ -9,7 +10,7 @@ properties: option_id: type: string description: The ID of the Shipping Option to create the Shipping Method from. - date: + data: type: object description: >- The data required for the Shipping Option to create a Shipping Method. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderSwapsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderSwapsReq.yaml index 72ead89d62..093972e864 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderSwapsReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderSwapsReq.yaml @@ -50,6 +50,9 @@ properties: quantity: description: The quantity of the Product Variant. type: integer + sales_channel_id: + type: string + description: The ID of the sales channel associated with the swap. custom_shipping_options: description: >- An array of custom shipping options to potentially create a Shipping @@ -72,6 +75,9 @@ properties: If set to `true`, no notification will be sent to the customer related to this Swap. type: boolean + return_location_id: + type: string + description: The ID of the location used for the associated return. allow_backorder: description: If set to `true`, swaps can be completed with items out of stock type: boolean diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderSwapsSwapFulfillmentsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderSwapsSwapFulfillmentsReq.yaml index 5ace30af64..8bea2ccb6a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderSwapsSwapFulfillmentsReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderSwapsSwapFulfillmentsReq.yaml @@ -12,3 +12,6 @@ properties: If set to `true`, no notification will be sent to the customer related to this swap. type: boolean + location_id: + description: The ID of the fulfillment's location. + type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsProductReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsProductReq.yaml index 931a9dd137..f2b81a1546 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsProductReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsProductReq.yaml @@ -246,6 +246,9 @@ properties: width: description: The width of the Product. type: number + hs_code: + description: The Harmonized System code of the product variant. + type: string origin_country: description: The country of origin of the Product. type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReservationsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReservationsReq.yaml index 14bbbad8b6..863f0a8ed9 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReservationsReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReservationsReq.yaml @@ -16,6 +16,9 @@ properties: quantity: description: The quantity to reserve. type: number + description: + description: The reservation's description. + type: string metadata: description: An optional set of key-value pairs with additional information. type: object diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReservationsReservationReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReservationsReservationReq.yaml index 56c51300bf..e77598239c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReservationsReservationReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReservationsReservationReq.yaml @@ -6,6 +6,9 @@ properties: quantity: description: The quantity to reserve. type: number + description: + description: The reservation's description. + type: string metadata: description: An optional set of key-value pairs with additional information. type: object diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReturnReceiveReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReturnReceiveReq.yaml index c04d99907c..2147216e85 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReturnReceiveReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReturnReceiveReq.yaml @@ -20,3 +20,6 @@ properties: refund: description: The amount to refund. type: number + location_id: + description: The ID of the location to return items from. + type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostShippingProfilesReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostShippingProfilesReq.yaml index 88cbc518be..cedb4ee33d 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostShippingProfilesReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostShippingProfilesReq.yaml @@ -13,3 +13,10 @@ properties: - default - gift_card - custom + metadata: + description: An optional set of key-value pairs with additional information. + type: object + externalDocs: + description: Learn about the metadata attribute, and how to delete and update it. + url: >- + https://docs.medusajs.com/development/entities/overview#metadata-attribute diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostStockLocationsLocationReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostStockLocationsLocationReq.yaml index 9762d74719..186ace8985 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostStockLocationsLocationReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostStockLocationsLocationReq.yaml @@ -16,4 +16,5 @@ properties: url: >- https://docs.medusajs.com/development/entities/overview#metadata-attribute address: + description: The data of an associated address to create or update. $ref: ./StockLocationAddressInput.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostStockLocationsReqAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostStockLocationsReqAddress.yaml index e5de8e0677..7d83e82f88 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostStockLocationsReqAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostStockLocationsReqAddress.yaml @@ -19,7 +19,7 @@ properties: description: Stock location address' city example: Mexico city country_code: - description: The 2 character ISO code for the country. + description: The two character ISO code for the country. type: string externalDocs: url: >- diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesTaxRateProductTypesReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesTaxRateProductTypesReq.yaml index 74ee9a8d35..3d53e43351 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesTaxRateProductTypesReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesTaxRateProductTypesReq.yaml @@ -1,4 +1,5 @@ type: object +description: The product types to add to the tax rate. required: - product_types properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListDeleteBatchRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListDeleteBatchRes.yaml index 9886cd7408..92ba375b0b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListDeleteBatchRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListDeleteBatchRes.yaml @@ -1,4 +1,5 @@ type: object +description: The details of deleting a price list. required: - ids - object @@ -6,9 +7,10 @@ required: properties: ids: type: array + description: The IDs of the deleted prices. items: type: string - description: The IDs of the deleted prices. + description: The ID of a deleted price. object: type: string description: >- diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListRes.yaml index 6ea0db5299..723aadc472 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListRes.yaml @@ -1,4 +1,5 @@ type: object +description: The price list's details. x-expanded-relations: field: price_list relations: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListsListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListsListRes.yaml index ee8358997f..6a00753e4f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListsListRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListsListRes.yaml @@ -1,4 +1,5 @@ type: object +description: The list of price lists with pagination fields. required: - price_lists - count diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListsProductsListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListsProductsListRes.yaml index 2ef7a8aa35..d782773dff 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListsProductsListRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListsProductsListRes.yaml @@ -1,4 +1,5 @@ type: object +description: The list of products with pagination fields. x-expanded-relations: field: products relations: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoriesCategoryRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoriesCategoryRes.yaml index bc22b78246..65073b08a6 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoriesCategoryRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoriesCategoryRes.yaml @@ -1,4 +1,5 @@ type: object +description: The product category's details. x-expanded-relations: field: product_category relations: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoriesListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoriesListRes.yaml index 5c00fdc6d4..ae632ec86c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoriesListRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoriesListRes.yaml @@ -1,4 +1,5 @@ type: object +description: The list of product categories with pagination fields. x-expanded-relations: field: product_categories relations: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTagsListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTagsListRes.yaml index 199eb7e7a2..2663c80b5a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTagsListRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTagsListRes.yaml @@ -1,4 +1,5 @@ type: object +description: The list of product tags with pagination fields. required: - product_tags - count diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypesListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypesListRes.yaml index 643254d68d..7a6196cb3b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypesListRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypesListRes.yaml @@ -1,4 +1,5 @@ type: object +description: The list of product types with pagination fields. required: - product_types - count diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductsDeleteOptionRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductsDeleteOptionRes.yaml index d3811c810e..5ead8a8fea 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductsDeleteOptionRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductsDeleteOptionRes.yaml @@ -1,4 +1,5 @@ type: object +description: The details of deleting a product's option. x-expanded-relations: field: product relations: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductsDeleteRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductsDeleteRes.yaml index 709cb3aef3..4fc6532608 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductsDeleteRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductsDeleteRes.yaml @@ -1,4 +1,5 @@ type: object +description: The details of deleting a product. required: - id - object diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductsDeleteVariantRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductsDeleteVariantRes.yaml index 4b2277cce2..46d801216c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductsDeleteVariantRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductsDeleteVariantRes.yaml @@ -1,4 +1,5 @@ type: object +description: The details of deleting a product's variant. x-expanded-relations: field: product relations: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductsListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductsListRes.yaml index f812bb637f..e841feb40a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductsListRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductsListRes.yaml @@ -1,4 +1,5 @@ type: object +description: The list of products with pagination fields. x-expanded-relations: field: products relations: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductsListTagsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductsListTagsRes.yaml index cbf191a7a7..b568306f84 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductsListTagsRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductsListTagsRes.yaml @@ -1,4 +1,5 @@ type: object +description: The usage details of product tags. required: - tags properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductsRes.yaml index 93d2af1704..247e9e3725 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductsRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductsRes.yaml @@ -1,4 +1,5 @@ type: object +description: The product's details. x-expanded-relations: field: product relations: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPublishableApiKeysListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPublishableApiKeysListRes.yaml index 5afc36dcf9..9d70064441 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPublishableApiKeysListRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPublishableApiKeysListRes.yaml @@ -1,4 +1,5 @@ type: object +description: The list of publishable API keys with pagination fields. required: - publishable_api_keys - count diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPublishableApiKeysListSalesChannelsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPublishableApiKeysListSalesChannelsRes.yaml index 416fd103b8..1cfe709ec1 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPublishableApiKeysListSalesChannelsRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPublishableApiKeysListSalesChannelsRes.yaml @@ -1,4 +1,5 @@ type: object +description: The list of sales channel. required: - sales_channels properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPublishableApiKeysRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPublishableApiKeysRes.yaml index eb0d3fefbc..e34ea5f2fe 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPublishableApiKeysRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPublishableApiKeysRes.yaml @@ -1,4 +1,5 @@ type: object +description: The publishable API key's details. required: - publishable_api_key properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminRefundRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminRefundRes.yaml index 20dd7559fe..df50b7eba4 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminRefundRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminRefundRes.yaml @@ -1,7 +1,8 @@ type: object +description: The refund's details. required: - refund properties: refund: - description: Refund details + description: Refund details. $ref: ./Refund.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminRegionsListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminRegionsListRes.yaml index 4af8c05732..23f457049d 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminRegionsListRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminRegionsListRes.yaml @@ -1,4 +1,5 @@ type: object +description: The list of regions with pagination fields. x-expanded-relations: field: regions relations: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminRegionsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminRegionsRes.yaml index b2f409ff6b..6a710c9b74 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminRegionsRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminRegionsRes.yaml @@ -1,4 +1,5 @@ type: object +description: The region's details. x-expanded-relations: field: region relations: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReservationsListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReservationsListRes.yaml index 1518e2bee4..8a9afebfba 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminReservationsListRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminReservationsListRes.yaml @@ -1,4 +1,5 @@ type: object +description: The list of reservations with pagination fields. required: - reservations - count diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReservationsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReservationsRes.yaml index ab8cf9ab40..ab3cc2c88a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminReservationsRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminReservationsRes.yaml @@ -1,4 +1,5 @@ type: object +description: The reservation's details. required: - reservation properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonsListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonsListRes.yaml index 0f212752fc..79ddc132d1 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonsListRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonsListRes.yaml @@ -1,4 +1,5 @@ type: object +description: The list of return reasons. x-expanded-relations: field: return_reasons relations: @@ -9,5 +10,6 @@ required: properties: return_reasons: type: array + description: The list of return reasons. items: $ref: ./ReturnReason.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonsRes.yaml index f5a1907b17..73c0b9a260 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonsRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonsRes.yaml @@ -1,4 +1,5 @@ type: object +description: The return reason's details. x-expanded-relations: field: return_reason relations: @@ -8,4 +9,5 @@ required: - return_reason properties: return_reason: + description: The return reason's details. $ref: ./ReturnReason.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnsCancelRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnsCancelRes.yaml index 771effd6e6..5a9946f7a4 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnsCancelRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnsCancelRes.yaml @@ -1,4 +1,5 @@ type: object +description: The associated order's details. x-expanded-relations: field: order relations: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnsListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnsListRes.yaml index 350a3250c7..e40254eb57 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnsListRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnsListRes.yaml @@ -1,4 +1,5 @@ type: object +description: The list of returns with pagination fields. x-expanded-relation: field: returns relations: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnsRes.yaml index a7d799fb76..07642af666 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnsRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnsRes.yaml @@ -1,4 +1,5 @@ type: object +description: The return's details. x-expanded-relation: field: return relations: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelsListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelsListRes.yaml index 5e64079787..2bc137e1c7 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelsListRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelsListRes.yaml @@ -1,4 +1,5 @@ type: object +description: The list of sales channels with pagination fields. required: - sales_channels - count diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelsRes.yaml index 6ceb950176..0fb4eee0f8 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelsRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelsRes.yaml @@ -1,4 +1,5 @@ type: object +description: The sales channel's details. required: - sales_channel properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionsListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionsListRes.yaml index 3847d8b0c7..db1ab6f304 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionsListRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionsListRes.yaml @@ -1,4 +1,5 @@ type: object +description: The list of shipping options with pagination fields. x-expanded-relations: field: shipping_options relations: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionsRes.yaml index 460a1483a5..005b91abb2 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionsRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionsRes.yaml @@ -1,4 +1,5 @@ type: object +description: The shipping option's details. x-expanded-relations: field: shipping_option relations: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfilesListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfilesListRes.yaml index 6b4d186f8c..6026c70ce3 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfilesListRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfilesListRes.yaml @@ -1,4 +1,5 @@ type: object +description: The list of shipping profiles. required: - shipping_profiles properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfilesRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfilesRes.yaml index b3a3413b62..78ef8ae7d8 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfilesRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfilesRes.yaml @@ -1,4 +1,5 @@ type: object +description: The shipping profile's details. x-expanded-relations: field: shipping_profile relations: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationsListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationsListRes.yaml index 6d29c11c9d..a44c47a8ba 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationsListRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationsListRes.yaml @@ -1,4 +1,5 @@ type: object +description: The list of stock locations with pagination fields. required: - stock_locations - count diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationsRes.yaml index 4c4ec94220..2720159825 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationsRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationsRes.yaml @@ -1,4 +1,5 @@ type: object +description: The stock location's details. required: - stock_location properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminStoresRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminStoresRes.yaml index bf36cffbb8..ca9362c05e 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminStoresRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminStoresRes.yaml @@ -1,4 +1,5 @@ type: object +description: The store's details. required: - store properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminSwapsListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminSwapsListRes.yaml index 300860d604..36cc47821b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminSwapsListRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminSwapsListRes.yaml @@ -1,4 +1,5 @@ type: object +description: The list of swaps with pagination fields. required: - swaps - count diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminSwapsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminSwapsRes.yaml index 485be172fd..d0afd6fcc5 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminSwapsRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminSwapsRes.yaml @@ -1,4 +1,5 @@ type: object +description: The swap's details. x-expanded-relations: field: swap relations: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxProvidersList.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxProvidersList.yaml index 6167447314..ffd5d3e4a5 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxProvidersList.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxProvidersList.yaml @@ -1,4 +1,5 @@ type: object +description: The list of tax providers in a store. required: - tax_providers properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRatesListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRatesListRes.yaml index a88ab78284..576c38f3b4 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRatesListRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRatesListRes.yaml @@ -1,4 +1,5 @@ type: object +description: The list of tax rates with pagination fields. required: - tax_rates - count diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRatesRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRatesRes.yaml index 36b8301eee..3d45207088 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRatesRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRatesRes.yaml @@ -1,4 +1,5 @@ type: object +description: The tax rate's details. required: - tax_rate properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUploadsDownloadUrlRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUploadsDownloadUrlRes.yaml index 52469d3c61..d3cfb785dc 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUploadsDownloadUrlRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUploadsDownloadUrlRes.yaml @@ -1,4 +1,5 @@ type: object +description: The download URL details. required: - download_url properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUploadsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUploadsRes.yaml index 447c898afe..556b721195 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUploadsRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUploadsRes.yaml @@ -1,4 +1,5 @@ type: object +description: The list of uploaded files. required: - uploads properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUserRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUserRes.yaml index f5834ed1e0..a5f5bcc495 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUserRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUserRes.yaml @@ -1,4 +1,5 @@ type: object +description: The user's details. required: - user properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUsersListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUsersListRes.yaml index 104f5d2365..205583a405 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUsersListRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUsersListRes.yaml @@ -1,4 +1,5 @@ type: object +description: The list of users. required: - users properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminVariantsListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminVariantsListRes.yaml index ed865661f7..e07d1e752d 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminVariantsListRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminVariantsListRes.yaml @@ -1,4 +1,5 @@ type: object +description: The list of variants with pagination fields. x-expanded-relations: field: variants relations: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminVariantsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminVariantsRes.yaml index 9d7334c0b1..ce92e0c8c0 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminVariantsRes.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminVariantsRes.yaml @@ -1,4 +1,5 @@ type: object +description: The product variant's details. x-expanded-relations: field: variant relations: diff --git a/www/apps/api-reference/specs/admin/components/schemas/ExtendedStoreDTO.yaml b/www/apps/api-reference/specs/admin/components/schemas/ExtendedStoreDTO.yaml index af6132c641..fe169bafc5 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/ExtendedStoreDTO.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/ExtendedStoreDTO.yaml @@ -8,10 +8,14 @@ allOf: - modules properties: payment_providers: + description: The store's payment providers. $ref: ./PaymentProvider.yaml fulfillment_providers: + description: The store's fulfillment providers. $ref: ./FulfillmentProvider.yaml feature_flags: + description: The feature flags enabled in the store's backend. $ref: ./FeatureFlagsResponse.yaml modules: + description: The modules installed in the store's backend. $ref: ./ModulesResponse.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/InventoryItemDTO.yaml b/www/apps/api-reference/specs/admin/components/schemas/InventoryItemDTO.yaml index 9fccc01512..641ec3a26f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/InventoryItemDTO.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/InventoryItemDTO.yaml @@ -2,6 +2,10 @@ type: object required: - sku properties: + id: + description: The inventory item's ID. + type: string + example: iitem_12334 sku: description: The Stock Keeping Unit (SKU) code of the Inventory Item. type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/PaymentCollection.yaml b/www/apps/api-reference/specs/admin/components/schemas/PaymentCollection.yaml index c41fe34593..4c8342dae9 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/PaymentCollection.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/PaymentCollection.yaml @@ -59,7 +59,7 @@ properties: $ref: ./Region.yaml currency_code: description: >- - The 3 character ISO code for the currency this payment collection is + The three character ISO code for the currency this payment collection is associated with. type: string example: usd diff --git a/www/apps/api-reference/specs/admin/components/schemas/PricedProduct.yaml b/www/apps/api-reference/specs/admin/components/schemas/PricedProduct.yaml index 6054bb7d16..aa57632b38 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/PricedProduct.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/PricedProduct.yaml @@ -5,6 +5,7 @@ allOf: - type: object properties: variants: + description: The product variants and their prices. type: array items: $ref: ./PricedVariant.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/ProductCategory.yaml b/www/apps/api-reference/specs/admin/components/schemas/ProductCategory.yaml index b4acd30f4e..e49782d700 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/ProductCategory.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/ProductCategory.yaml @@ -25,6 +25,10 @@ properties: description: The product category's name type: string example: Regular Fit + description: + description: The product category's description. + type: string + default: '' handle: description: >- A unique string that identifies the Product Category - can for example be diff --git a/www/apps/api-reference/specs/admin/components/schemas/Region.yaml b/www/apps/api-reference/specs/admin/components/schemas/Region.yaml index 2e19d39db4..b9f3b0c9e3 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/Region.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/Region.yaml @@ -30,7 +30,7 @@ properties: type: string example: EU currency_code: - description: The 3 character currency code used in the region. + description: The three character currency code used in the region. type: string example: usd externalDocs: diff --git a/www/apps/api-reference/specs/admin/components/schemas/StockLocationExpandedDTO.yaml b/www/apps/api-reference/specs/admin/components/schemas/StockLocationExpandedDTO.yaml index e2d6b28a56..993fad1ca8 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StockLocationExpandedDTO.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StockLocationExpandedDTO.yaml @@ -3,4 +3,5 @@ allOf: - type: object properties: sales_channels: + description: The associated sales channels. $ref: ./SalesChannel.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/Store.yaml b/www/apps/api-reference/specs/admin/components/schemas/Store.yaml index 3a79d6301a..e1331293bc 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/Store.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/Store.yaml @@ -24,8 +24,9 @@ properties: description: The name of the Store - this may be displayed to the Customer. type: string example: Medusa Store + default: Medusa Store default_currency_code: - description: The 3 character currency code that is the default of the store. + description: The three character currency code that is the default of the store. type: string example: usd externalDocs: @@ -34,6 +35,7 @@ properties: default_currency: description: The details of the store's default currency. x-expandable: default_currency + default: usd nullable: true $ref: ./Currency.yaml currencies: diff --git a/www/apps/api-reference/specs/admin/components/schemas/VariantInventory.yaml b/www/apps/api-reference/specs/admin/components/schemas/VariantInventory.yaml index 8b8ee0e232..816d5fcbfb 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/VariantInventory.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/VariantInventory.yaml @@ -12,9 +12,7 @@ properties: $ref: ./ResponseInventoryItem.yaml sales_channel_availability: type: array - description: >- - An array of details about the variant's inventory availability in sales - channels. + description: Details about the variant's inventory availability in sales channels. items: type: object required: diff --git a/www/apps/api-reference/specs/admin/openapi.full.yaml b/www/apps/api-reference/specs/admin/openapi.full.yaml index b5faf7f6cc..223581fb2c 100644 --- a/www/apps/api-reference/specs/admin/openapi.full.yaml +++ b/www/apps/api-reference/specs/admin/openapi.full.yaml @@ -31,7 +31,7 @@ tags: asynchronusly. For example, the Import Product feature is implemented using batch jobs. - Batch Job API Routes allows admins to manage the batch jobs and their + Batch Job API Routes allow admins to manage the batch jobs and their state. externalDocs: description: How to import products @@ -289,7 +289,7 @@ tags: They are created by the admin and they're not associated with a fulfillment provider. externalDocs: - description: Shipping Option architecture + description: Shipping Profile architecture url: >- https://docs.medusajs.com/modules/carts-and-checkout/shipping#shipping-profile - name: Stock Locations @@ -462,7 +462,7 @@ paths: .then(({ user }) => { console.log(user.id); - }); + }) - lang: Shell label: cURL source: | @@ -526,7 +526,7 @@ paths: .then(({ user }) => { console.log(user.id); - }); + }) - lang: Shell label: cURL source: | @@ -637,7 +637,7 @@ paths: .then(({ access_token }) => { console.log(access_token); - }); + }) - lang: Shell label: cURL source: | @@ -985,7 +985,7 @@ paths: dry_run: false }).then((({ batch_job }) => { console.log(batch_job.id); - }); + }) - lang: Shell label: cURL source: | @@ -1051,7 +1051,7 @@ paths: .then(({ batch_job }) => { console.log(batch_job.id); - }); + }) - lang: Shell label: cURL source: | @@ -1114,7 +1114,7 @@ paths: .then(({ batch_job }) => { console.log(batch_job.id); - }); + }) - lang: Shell label: cURL source: | @@ -1178,7 +1178,7 @@ paths: .then(({ batch_job }) => { console.log(batch_job.id); - }); + }) - lang: Shell label: cURL source: | @@ -1335,7 +1335,7 @@ paths: .then(({ collections, limit, offset, count }) => { console.log(collections.length); - }); + }) - lang: Shell label: cURL source: | @@ -1395,7 +1395,7 @@ paths: .then(({ collection }) => { console.log(collection.id); - }); + }) - lang: Shell label: cURL source: | @@ -1462,7 +1462,7 @@ paths: .then(({ collection }) => { console.log(collection.id); - }); + }) - lang: Shell label: cURL source: | @@ -1529,7 +1529,7 @@ paths: .then(({ collection }) => { console.log(collection.id); - }); + }) - lang: Shell label: cURL source: | @@ -1593,7 +1593,7 @@ paths: .then(({ id, object, deleted }) => { console.log(id); - }); + }) - lang: Shell label: cURL source: | @@ -1838,7 +1838,7 @@ paths: .then(({ currencies, count, offset, limit }) => { console.log(currencies.length); - }); + }) - lang: Shell label: cURL source: | @@ -1894,7 +1894,7 @@ paths: .then(({ currency }) => { console.log(currency.code); - }); + }) - lang: Shell label: cURL source: | @@ -2063,7 +2063,7 @@ paths: .then(({ customer_groups, limit, offset, count }) => { console.log(customer_groups.length); - }); + }) - lang: Shell label: cURL source: | @@ -2097,7 +2097,7 @@ paths: post: operationId: PostCustomerGroups summary: Create a Customer Group - description: Creates a Customer Group. + description: Create a Customer Group. x-authenticated: true requestBody: content: @@ -2123,7 +2123,7 @@ paths: .then(({ customer_group }) => { console.log(customer_group.id); - }); + }) - lang: Shell label: cURL source: | @@ -2205,7 +2205,7 @@ paths: .then(({ customer_group }) => { console.log(customer_group.id); - }); + }) - lang: Shell label: cURL source: | @@ -2272,7 +2272,7 @@ paths: .then(({ customer_group }) => { console.log(customer_group.id); - }); + }) - lang: Shell label: cURL source: | @@ -2338,7 +2338,7 @@ paths: .then(({ id, object, deleted }) => { console.log(id); - }); + }) - lang: Shell label: cURL source: | @@ -2426,7 +2426,7 @@ paths: .then(({ customers }) => { console.log(customers.length); - }); + }) - lang: Shell label: cURL source: | @@ -2499,7 +2499,7 @@ paths: .then(({ customer_group }) => { console.log(customer_group.id); - }); + }) - lang: Shell label: cURL source: > @@ -2586,7 +2586,7 @@ paths: .then(({ customer_group }) => { console.log(customer_group.id); - }); + }) - lang: Shell label: cURL source: > @@ -2689,7 +2689,7 @@ paths: .then(({ customers, limit, offset, count }) => { console.log(customers.length); - }); + }) - lang: Shell label: cURL source: | @@ -2723,7 +2723,7 @@ paths: post: operationId: PostCustomers summary: Create a Customer - description: Allow admins to create a customer. + description: Create a customer as an admin. x-authenticated: true requestBody: content: @@ -2752,7 +2752,7 @@ paths: .then(({ customer }) => { console.log(customer.id); - }); + }) - lang: Shell label: cURL source: | @@ -2834,7 +2834,7 @@ paths: .then(({ customer }) => { console.log(customer.id); - }); + }) - lang: Shell label: cURL source: | @@ -2915,7 +2915,7 @@ paths: .then(({ customer }) => { console.log(customer.id); - }); + }) - lang: Shell label: cURL source: | @@ -3030,7 +3030,7 @@ paths: .then(({ discounts, limit, offset, count }) => { console.log(discounts.id); - }); + }) - lang: Shell label: cURL source: | @@ -3118,7 +3118,7 @@ paths: .then(({ discount }) => { console.log(discount.id); - }); + }) - lang: Shell label: cURL source: | @@ -3204,7 +3204,7 @@ paths: .then(({ discount }) => { console.log(discount.id); - }); + }) - lang: Shell label: cURL source: | @@ -3289,12 +3289,13 @@ paths: // must be previously logged in or use api token medusa.admin.discounts.createCondition(discountId, { - operator: DiscountConditionOperator.IN + operator: DiscountConditionOperator.IN, + products: [productId] }) .then(({ discount }) => { console.log(discount.id); - }); + }) - lang: Shell label: cURL source: | @@ -3380,7 +3381,7 @@ paths: .then(({ discount_condition }) => { console.log(discount_condition.id); - }); + }) - lang: Shell label: cURL source: > @@ -3478,7 +3479,7 @@ paths: .then(({ discount }) => { console.log(discount.id); - }); + }) - lang: Shell label: cURL source: > @@ -3523,7 +3524,7 @@ paths: operationId: DeleteDiscountsDiscountConditionsCondition summary: Delete a Condition description: >- - Deletes a Discount Condition. This does not delete resources associated + Delete a Discount Condition. This does not delete resources associated to the discount condition. x-authenticated: true parameters: @@ -3571,7 +3572,7 @@ paths: .then(({ id, object, deleted }) => { console.log(id); - }); + }) - lang: Shell label: cURL source: > @@ -3668,7 +3669,7 @@ paths: .then(({ discount }) => { console.log(discount.id); - }); + }) - lang: Shell label: cURL source: > @@ -3714,7 +3715,7 @@ paths: description: >- Remove a batch of resources from a discount condition. This will only remove the association between the resource and the discount condition, - but not the resource itself. + not the resource itself. x-authenticated: true parameters: - in: path @@ -3769,7 +3770,7 @@ paths: .then(({ discount }) => { console.log(discount.id); - }); + }) - lang: Shell label: cURL source: > @@ -3813,7 +3814,7 @@ paths: get: operationId: GetDiscountsDiscount summary: Get a Discount - description: Retrieves a Discount + description: Retrieve a Discount. x-authenticated: true parameters: - in: path @@ -3854,7 +3855,7 @@ paths: .then(({ discount }) => { console.log(discount.id); - }); + }) - lang: Shell label: cURL source: | @@ -3938,7 +3939,7 @@ paths: .then(({ discount }) => { console.log(discount.id); - }); + }) - lang: Shell label: cURL source: | @@ -4004,7 +4005,7 @@ paths: .then(({ id, object, deleted }) => { console.log(id); - }); + }) - lang: Shell label: cURL source: | @@ -4076,7 +4077,7 @@ paths: .then(({ discount }) => { console.log(discount.id); - }); + }) - lang: Shell label: cURL source: | @@ -4147,7 +4148,7 @@ paths: .then(({ discount }) => { console.log(discount.id); - }); + }) - lang: Shell label: cURL source: > @@ -4216,7 +4217,7 @@ paths: .then(({ discount }) => { console.log(discount.id); - }); + }) - lang: Shell label: cURL source: > @@ -4287,7 +4288,7 @@ paths: .then(({ discount }) => { console.log(discount.id); - }); + }) - lang: Shell label: cURL source: > @@ -4366,7 +4367,7 @@ paths: .then(({ draft_orders, limit, offset, count }) => { console.log(draft_orders.length); - }); + }) - lang: Shell label: cURL source: | @@ -4439,7 +4440,7 @@ paths: .then(({ draft_order }) => { console.log(draft_order.id); - }); + }) - lang: Shell label: cURL source: | @@ -4515,7 +4516,7 @@ paths: .then(({ draft_order }) => { console.log(draft_order.id); - }); + }) - lang: Shell label: cURL source: | @@ -4582,7 +4583,7 @@ paths: .then(({ draft_order }) => { console.log(draft_order.id); - }); + }) - lang: Shell label: cURL source: | @@ -4620,7 +4621,7 @@ paths: delete: operationId: DeleteDraftOrdersDraftOrder summary: Delete a Draft Order - description: Delete a Draft Order + description: Delete a Draft Order. x-authenticated: true parameters: - in: path @@ -4646,7 +4647,7 @@ paths: .then(({ id, object, deleted }) => { console.log(id); - }); + }) - lang: Shell label: cURL source: | @@ -4714,7 +4715,7 @@ paths: .then(({ draft_order }) => { console.log(draft_order.id); - }); + }) - lang: Shell label: cURL source: | @@ -4753,7 +4754,7 @@ paths: post: operationId: PostDraftOrdersDraftOrderLineItemsItem summary: Update a Line Item - description: Update a Line Item in a Draft Order + description: Update a Line Item in a Draft Order. x-authenticated: true parameters: - in: path @@ -4793,7 +4794,7 @@ paths: .then(({ draft_order }) => { console.log(draft_order.id); - }); + }) - lang: Shell label: cURL source: > @@ -4835,7 +4836,7 @@ paths: delete: operationId: DeleteDraftOrdersDraftOrderLineItemsItem summary: Delete a Line Item - description: Deletes a Line Item from a Draft Order. + description: Delete a Line Item from a Draft Order. x-authenticated: true parameters: - in: path @@ -4867,7 +4868,7 @@ paths: .then(({ draft_order }) => { console.log(draft_order.id); - }); + }) - lang: Shell label: cURL source: > @@ -4935,7 +4936,7 @@ paths: .then(({ order }) => { console.log(order.id); - }); + }) - lang: Shell label: cURL source: | @@ -5011,7 +5012,7 @@ paths: .then(({ gift_cards, limit, offset, count }) => { console.log(gift_cards.length); - }); + }) - lang: Shell label: cURL source: | @@ -5073,7 +5074,7 @@ paths: .then(({ gift_card }) => { console.log(gift_card.id); - }); + }) - lang: Shell label: cURL source: | @@ -5138,7 +5139,7 @@ paths: .then(({ gift_card }) => { console.log(gift_card.id); - }); + }) - lang: Shell label: cURL source: | @@ -5205,7 +5206,7 @@ paths: .then(({ gift_card }) => { console.log(gift_card.id); - }); + }) - lang: Shell label: cURL source: | @@ -5269,7 +5270,7 @@ paths: .then(({ id, object, deleted }) => { console.log(id); - }); + }) - lang: Shell label: cURL source: | @@ -5433,7 +5434,7 @@ paths: .then(({ inventory_items, count, offset, limit }) => { console.log(inventory_items.length); - }); + }) - lang: Shell label: cURL source: | @@ -5510,7 +5511,7 @@ paths: .then(({ inventory_item }) => { console.log(inventory_item.id); - }); + }) - lang: Shell label: cURL source: | @@ -5590,7 +5591,7 @@ paths: .then(({ inventory_item }) => { console.log(inventory_item.id); - }); + }) - lang: Shell label: cURL source: | @@ -5672,7 +5673,7 @@ paths: .then(({ inventory_item }) => { console.log(inventory_item.id); - }); + }) - lang: Shell label: cURL source: | @@ -5735,9 +5736,10 @@ paths: // must be previously logged in or use api token medusa.admin.inventoryItems.delete(inventoryItemId) - .then(({ id, object, deleted }) => { - console.log(id) - }) + + .then(({ id, object, deleted }) => { + console.log(id) + }) - lang: Shell label: cURL source: | @@ -5764,8 +5766,7 @@ paths: summary: List Inventory Level description: >- Retrieve a list of inventory levels of an inventory item. The inventory - levels can be filtered by fields such as `location_id`. The inventory - levels can also be paginated. + levels can be filtered by fields such as `location_id`. x-authenticated: true parameters: - in: path @@ -5815,7 +5816,7 @@ paths: .then(({ inventory_item }) => { console.log(inventory_item.location_levels); - }); + }) - lang: Shell label: cURL source: | @@ -5848,8 +5849,8 @@ paths: $ref: '#/components/responses/500_error' post: operationId: PostInventoryItemsInventoryItemLocationLevels - summary: Create an Location Level - description: Create an Location Level for a given Inventory Item. + summary: Create a Location Level + description: Create a Location Level for a given Inventory Item. x-authenticated: true parameters: - in: path @@ -5899,7 +5900,7 @@ paths: .then(({ inventory_item }) => { console.log(inventory_item.id); - }); + }) - lang: Shell label: cURL source: > @@ -5999,7 +6000,7 @@ paths: .then(({ inventory_item }) => { console.log(inventory_item.id); - }); + }) - lang: Shell label: cURL source: > @@ -6075,7 +6076,7 @@ paths: .then(({ inventory_item }) => { console.log(inventory_item.id); - }); + }) - lang: Shell label: cURL source: > @@ -6132,7 +6133,7 @@ paths: .then(({ invites }) => { console.log(invites.length); - }); + }) - lang: Shell label: cURL source: | @@ -6202,7 +6203,7 @@ paths: .catch(() => { // an error occurred - }); + }) - lang: Shell label: cURL source: | @@ -6276,7 +6277,7 @@ paths: .catch(() => { // an error occurred - }); + }) - lang: Shell label: cURL source: | @@ -6342,7 +6343,7 @@ paths: .then(({ id, object, deleted }) => { console.log(id); - }); + }) - lang: Shell label: cURL source: | @@ -6412,7 +6413,7 @@ paths: .catch(() => { // an error occurred - }); + }) - lang: Shell label: cURL source: | @@ -6483,7 +6484,7 @@ paths: .then(({ notes, limit, offset, count }) => { console.log(notes.length); - }); + }) - lang: Shell label: cURL source: | @@ -6545,7 +6546,7 @@ paths: .then(({ note }) => { console.log(note.id); - }); + }) - lang: Shell label: cURL source: | @@ -6612,7 +6613,7 @@ paths: .then(({ note }) => { console.log(note.id); - }); + }) - lang: Shell label: cURL source: | @@ -6647,7 +6648,7 @@ paths: operationId: PostNotesNote summary: Update a Note x-authenticated: true - description: Update a Note's details.' + description: Update a Note's details. parameters: - in: path name: id @@ -6679,7 +6680,7 @@ paths: .then(({ note }) => { console.log(note.id); - }); + }) - lang: Shell label: cURL source: | @@ -6743,7 +6744,7 @@ paths: .then(({ id, object, deleted }) => { console.log(id); - }); + }) - lang: Shell label: cURL source: | @@ -6862,7 +6863,7 @@ paths: .then(({ notifications }) => { console.log(notifications.length); - }); + }) - lang: Shell label: cURL source: | @@ -6930,7 +6931,7 @@ paths: .then(({ notification }) => { console.log(notification.id); - }); + }) - lang: Shell label: cURL source: | @@ -7021,9 +7022,10 @@ paths: // must be previously logged in or use api token medusa.admin.orderEdits.list() - .then(({ order_edits, count, limit, offset }) => { - console.log(order_edits.length) - }) + + .then(({ order_edits, count, limit, offset }) => { + console.log(order_edits.length) + }) - lang: Shell label: cURL source: | @@ -7078,9 +7080,10 @@ paths: // must be previously logged in or use api token medusa.admin.orderEdits.create({ orderId }) - .then(({ order_edit }) => { - console.log(order_edit.id) - }) + + .then(({ order_edit }) => { + console.log(order_edit.id) + }) - lang: Shell label: cURL source: > @@ -7159,9 +7162,10 @@ paths: // must be previously logged in or use api token medusa.admin.orderEdits.retrieve(orderEditId) - .then(({ order_edit }) => { - console.log(order_edit.id) - }) + + .then(({ order_edit }) => { + console.log(order_edit.id) + }) - lang: Shell label: cURL source: | @@ -7195,7 +7199,7 @@ paths: post: operationId: PostOrderEditsOrderEdit summary: Update an Order Edit - description: Updates an Order Edit's details. + description: Update an Order Edit's details. x-authenticated: true parameters: - in: path @@ -7225,9 +7229,10 @@ paths: medusa.admin.orderEdits.update(orderEditId, { internal_note: "internal reason XY" }) - .then(({ order_edit }) => { - console.log(order_edit.id) - }) + + .then(({ order_edit }) => { + console.log(order_edit.id) + }) - lang: Shell label: cURL source: | @@ -7290,9 +7295,10 @@ paths: // must be previously logged in or use api token medusa.admin.orderEdits.delete(orderEditId) - .then(({ id, object, deleted }) => { - console.log(id) - }) + + .then(({ id, object, deleted }) => { + console.log(id) + }) - lang: Shell label: cURL source: | @@ -7317,7 +7323,7 @@ paths: post: operationId: PostOrderEditsOrderEditCancel summary: Cancel an Order Edit - description: Cancel an OrderEdit. + description: Cancel an Order Edit. x-authenticated: true parameters: - in: path @@ -7340,9 +7346,10 @@ paths: // must be previously logged in or use api token medusa.admin.orderEdits.cancel(orderEditId) - .then(({ order_edit }) => { - console.log(order_edit.id) - }) + + .then(({ order_edit }) => { + console.log(order_edit.id) + }) - lang: Shell label: cURL source: | @@ -7404,9 +7411,10 @@ paths: // must be previously logged in or use api token medusa.admin.orderEdits.deleteItemChange(orderEdit_id, itemChangeId) - .then(({ id, object, deleted }) => { - console.log(id) - }) + + .then(({ id, object, deleted }) => { + console.log(id) + }) - lang: Shell label: cURL source: > @@ -7458,9 +7466,10 @@ paths: // must be previously logged in or use api token medusa.admin.orderEdits.confirm(orderEditId) - .then(({ order_edit }) => { - console.log(order_edit.id) - }) + + .then(({ order_edit }) => { + console.log(order_edit.id) + }) - lang: Shell label: cURL source: | @@ -7607,11 +7616,12 @@ paths: // must be previously logged in or use api token medusa.admin.orderEdits.updateLineItem(orderEditId, lineItemId, { - quantity: 5 - }) - .then(({ order_edit }) => { - console.log(order_edit.id) - }) + quantity: 5 + }) + + .then(({ order_edit }) => { + console.log(order_edit.id) + }) - lang: Shell label: cURL source: > @@ -7683,9 +7693,10 @@ paths: // must be previously logged in or use api token medusa.admin.orderEdits.removeLineItem(orderEditId, lineItemId) - .then(({ order_edit }) => { - console.log(order_edit.id) - }) + + .then(({ order_edit }) => { + console.log(order_edit.id) + }) - lang: Shell label: cURL source: > @@ -7748,9 +7759,10 @@ paths: // must be previously logged in or use api token medusa.admin.orderEdits.requestConfirmation(orderEditId) - .then({ order_edit }) => { - console.log(order_edit.id) - }) + + .then({ order_edit }) => { + console.log(order_edit.id) + }) - lang: Shell label: cURL source: | @@ -8017,7 +8029,7 @@ paths: .then(({ orders, limit, offset, count }) => { console.log(orders.length); - }); + }) - lang: Shell label: cURL source: | @@ -8093,7 +8105,7 @@ paths: .then(({ order }) => { console.log(order.id); - }); + }) - lang: Shell label: cURL source: | @@ -8175,7 +8187,7 @@ paths: .then(({ order }) => { console.log(order.id); - }); + }) - lang: Shell label: cURL source: | @@ -8255,7 +8267,7 @@ paths: .then(({ order }) => { console.log(order.id); - }); + }) - lang: Shell label: cURL source: | @@ -8334,7 +8346,7 @@ paths: .then(({ order }) => { console.log(order.id); - }); + }) - lang: Shell label: cURL source: | @@ -8412,7 +8424,7 @@ paths: .then(({ order }) => { console.log(order.id); - }); + }) - lang: Shell label: cURL source: | @@ -8507,7 +8519,7 @@ paths: .then(({ order }) => { console.log(order.id); - }); + }) - lang: Shell label: cURL source: | @@ -8606,7 +8618,7 @@ paths: .then(({ order }) => { console.log(order.id); - }); + }) - lang: Shell label: cURL source: | @@ -8698,7 +8710,7 @@ paths: .then(({ order }) => { console.log(order.id); - }); + }) - lang: Shell label: cURL source: > @@ -8735,7 +8747,11 @@ paths: post: operationId: PostOrdersOrderClaimsClaimFulfillments summary: Create a Claim Fulfillment - description: Create a Fulfillment for a Claim. + description: >- + Create a Fulfillment for a Claim, and change its fulfillment status to + `partially_fulfilled` or `fulfilled` depending on whether all the items + were fulfilled. It may also change the status to `requires_action` if + any actions are required. x-authenticated: true externalDocs: description: Fulfill a claim @@ -8793,7 +8809,7 @@ paths: .then(({ order }) => { console.log(order.id); - }); + }) - lang: Shell label: cURL source: > @@ -8830,7 +8846,9 @@ paths: post: operationId: PostOrdersClaimFulfillmentsCancel summary: Cancel Claim's Fulfillment - description: Cancel a claim's fulfillment and change its status. + description: >- + Cancel a claim's fulfillment and change its fulfillment status to + `canceled`. x-authenticated: true parameters: - in: path @@ -8884,7 +8902,7 @@ paths: .then(({ order }) => { console.log(order.id); - }); + }) - lang: Shell label: cURL source: > @@ -8923,9 +8941,10 @@ paths: operationId: PostOrdersOrderClaimsClaimShipments summary: Ship a Claim's Fulfillment description: >- - Mark a claim's fulfillment as shipped. This changes the claim's - fulfillment status to either `shipped` or `partially_shipped`, depending - on whether all the items were shipped. + Create a shipment for the claim and mark its fulfillment as shipped. + This changes the claim's fulfillment status to either + `partially_shipped` or `shipped`, depending on whether all the items + were shipped. x-authenticated: true externalDocs: description: Fulfill a claim @@ -8982,7 +9001,7 @@ paths: .then(({ order }) => { console.log(order.id); - }); + }) - lang: Shell label: cURL source: > @@ -9068,7 +9087,7 @@ paths: .then(({ order }) => { console.log(order.id); - }); + }) - lang: Shell label: cURL source: | @@ -9103,7 +9122,10 @@ paths: post: operationId: PostOrdersOrderFulfillments summary: Create a Fulfillment - description: Create a Fulfillment of an Order using the fulfillment provider. + description: >- + Create a Fulfillment of an Order using the fulfillment provider, and + change the order's fulfillment status to either `partially_fulfilled` or + `fulfilled`, depending on whether all the items were fulfilled. x-authenticated: true externalDocs: description: Fulfillments of orders @@ -9159,7 +9181,7 @@ paths: .then(({ order }) => { console.log(order.id); - }); + }) - lang: Shell label: cURL source: | @@ -9203,7 +9225,9 @@ paths: post: operationId: PostOrdersOrderFulfillmentsCancel summary: Cancel a Fulfilmment - description: Cancel an order's fulfillment and change its status. + description: >- + Cancel an order's fulfillment and change its fulfillment status to + `canceled`. x-authenticated: true parameters: - in: path @@ -9250,7 +9274,7 @@ paths: .then(({ order }) => { console.log(order.id); - }); + }) - lang: Shell label: cURL source: > @@ -9405,7 +9429,7 @@ paths: .then(({ order }) => { console.log(order.id); - }); + }) - lang: Shell label: cURL source: | @@ -9559,7 +9583,7 @@ paths: .then(({ order }) => { console.log(order.id); - }); + }) - lang: Shell label: cURL source: | @@ -9604,9 +9628,9 @@ paths: operationId: PostOrdersOrderShipment summary: Ship a Fulfillment description: >- - Mark a fulfillment as shipped. This changes the order's fulfillment - status to either `shipped` or `partially_shipped`, depending on whether - all the items were shipped. + Create a shipment and mark a fulfillment as shipped. This changes the + order's fulfillment status to either `partially_shipped` or `shipped`, + depending on whether all the items were shipped. x-authenticated: true externalDocs: description: Fulfillments of orders @@ -9657,7 +9681,7 @@ paths: .then(({ order }) => { console.log(order.id); - }); + }) - lang: Shell label: cURL source: | @@ -9697,7 +9721,7 @@ paths: operationId: PostOrdersOrderShippingMethods summary: Add a Shipping Method description: >- - Adds a Shipping Method to an Order. If another Shipping Method exists + Add a Shipping Method to an Order. If another Shipping Method exists with the same Shipping Profile, the previous Shipping Method will be replaced. parameters: @@ -9748,7 +9772,7 @@ paths: .then(({ order }) => { console.log(order.id); - }); + }) - lang: Shell label: cURL source: | @@ -9846,7 +9870,7 @@ paths: .then(({ order }) => { console.log(order.id); - }); + }) - lang: Shell label: cURL source: | @@ -9940,7 +9964,7 @@ paths: .then(({ order }) => { console.log(order.id); - }); + }) - lang: Shell label: cURL source: > @@ -9977,7 +10001,10 @@ paths: post: operationId: PostOrdersOrderSwapsSwapFulfillments summary: Create a Swap Fulfillment - description: Create a Fulfillment for a Swap. + description: >- + Create a Fulfillment for a Swap and change its fulfillment status to + `fulfilled`. If it requires any additional actions, its fulfillment + status may change to `requires_action`. x-authenticated: true externalDocs: description: Handling a swap's fulfillment @@ -10037,7 +10064,7 @@ paths: .then(({ order }) => { console.log(order.id); - }); + }) - lang: Shell label: cURL source: > @@ -10074,7 +10101,9 @@ paths: post: operationId: PostOrdersSwapFulfillmentsCancel summary: Cancel Swap's Fulfilmment - description: Cancel a swap's fulfillment and change its status. + description: >- + Cancel a swap's fulfillment and change its fulfillment status to + `canceled`. x-authenticated: true parameters: - in: path @@ -10128,7 +10157,7 @@ paths: .then(({ order }) => { console.log(order.id); - }); + }) - lang: Shell label: cURL source: > @@ -10220,7 +10249,7 @@ paths: .then(({ order }) => { console.log(order.id); - }); + }) - lang: Shell label: cURL source: > @@ -10258,9 +10287,9 @@ paths: operationId: PostOrdersOrderSwapsSwapShipments summary: Ship a Swap's Fulfillment description: >- - RMark a swap's fulfillment as shipped. This changes the swap's - fulfillment status to either `shipped` or `partially_shipped`, depending - on whether all the items were shipped. + Create a shipment for a swap and mark its fulfillment as shipped. This + changes the swap's fulfillment status to either `partially_shipped` or + `shipped`, depending on whether all the items were shipped. x-authenticated: true externalDocs: description: Handling swap fulfillments @@ -10312,13 +10341,13 @@ paths: // must be previously logged in or use api token - medusa.admin.orders.createSwapShipment(order_id, swap_id, { + medusa.admin.orders.createSwapShipment(orderId, swapId, { fulfillment_id }) .then(({ order }) => { console.log(order.id); - }); + }) - lang: Shell label: cURL source: > @@ -10399,9 +10428,10 @@ paths: // must be previously logged in or use api token medusa.admin.paymentCollections.retrieve(paymentCollectionId) - .then(({ payment_collection }) => { - console.log(payment_collection.id) - }) + + .then(({ payment_collection }) => { + console.log(payment_collection.id) + }) - lang: Shell label: cURL source: | @@ -10465,9 +10495,10 @@ paths: medusa.admin.paymentCollections.update(paymentCollectionId, { description }) - .then(({ payment_collection }) => { - console.log(payment_collection.id) - }) + + .then(({ payment_collection }) => { + console.log(payment_collection.id) + }) - lang: Shell label: cURL source: | @@ -10530,9 +10561,10 @@ paths: // must be previously logged in or use api token medusa.admin.paymentCollections.delete(paymentCollectionId) - .then(({ id, object, deleted }) => { - console.log(id) - }) + + .then(({ id, object, deleted }) => { + console.log(id) + }) - lang: Shell label: cURL source: | @@ -10584,9 +10616,10 @@ paths: // must be previously logged in or use api token medusa.admin.paymentCollections.markAsAuthorized(paymentCollectionId) - .then(({ payment_collection }) => { - console.log(payment_collection.id) - }) + + .then(({ payment_collection }) => { + console.log(payment_collection.id) + }) - lang: Shell label: cURL source: > @@ -10650,7 +10683,7 @@ paths: .then(({ payment }) => { console.log(payment.id); - }); + }) - lang: Shell label: cURL source: | @@ -10711,7 +10744,7 @@ paths: .then(({ payment }) => { console.log(payment.id); - }); + }) - lang: Shell label: cURL source: | @@ -10781,7 +10814,7 @@ paths: .then(({ payment }) => { console.log(payment.id); - }); + }) - lang: Shell label: cURL source: | @@ -10993,7 +11026,7 @@ paths: .then(({ price_lists, limit, offset, count }) => { console.log(price_lists.length); - }); + }) - lang: Shell label: cURL source: | @@ -11064,7 +11097,7 @@ paths: .then(({ price_list }) => { console.log(price_list.id); - }); + }) - lang: Shell label: cURL source: | @@ -11138,7 +11171,7 @@ paths: .then(({ price_list }) => { console.log(price_list.id); - }); + }) - lang: Shell label: cURL source: | @@ -11205,7 +11238,7 @@ paths: .then(({ price_list }) => { console.log(price_list.id); - }); + }) - lang: Shell label: cURL source: | @@ -11269,7 +11302,7 @@ paths: .then(({ id, object, deleted }) => { console.log(id); - }); + }) - lang: Shell label: cURL source: | @@ -11304,7 +11337,7 @@ paths: post: operationId: PostPriceListsPriceListPricesBatch summary: Add or Update Prices - description: Add or update a list of prices in a Price List + description: Add or update a list of prices in a Price List. x-authenticated: true parameters: - in: path @@ -11343,7 +11376,7 @@ paths: .then(({ price_list }) => { console.log(price_list.id); - }); + }) - lang: Shell label: cURL source: | @@ -11422,7 +11455,7 @@ paths: .then(({ ids, object, deleted }) => { console.log(ids.length); - }); + }) - lang: Shell label: cURL source: | @@ -11664,7 +11697,7 @@ paths: .then(({ products, limit, offset, count }) => { console.log(products.length); - }); + }) - lang: Shell label: cURL source: | @@ -11730,7 +11763,7 @@ paths: .then(({ ids, object, deleted }) => { console.log(ids.length); - }); + }) - lang: Shell label: cURL source: > @@ -11808,7 +11841,7 @@ paths: .then(({ ids, object, deleted }) => { console.log(ids.length); - }); + }) - lang: Shell label: cURL source: > @@ -11846,7 +11879,7 @@ paths: delete: operationId: DeletePriceListsPriceListVariantsVariantPrices summary: Delete a Variant's Prices - description: Delete all the prices related to a specific variant in a price list + description: Delete all the prices related to a specific variant in a price list. x-authenticated: true parameters: - in: path @@ -11878,7 +11911,7 @@ paths: .then(({ ids, object, deleted }) => { console.log(ids); - }); + }) - lang: Shell label: cURL source: > @@ -12001,7 +12034,7 @@ paths: .then(({ product_categories, limit, offset, count }) => { console.log(product_categories.length); - }); + }) - lang: Shell label: cURL source: | @@ -12078,7 +12111,7 @@ paths: .then(({ product_category }) => { console.log(product_category.id); - }); + }) - lang: Shell label: cURL source: | @@ -12159,7 +12192,7 @@ paths: .then(({ product_category }) => { console.log(product_category.id); - }); + }) - lang: Shell label: cURL source: | @@ -12242,7 +12275,7 @@ paths: .then(({ product_category }) => { console.log(product_category.id); - }); + }) - lang: Shell label: cURL source: | @@ -12307,7 +12340,7 @@ paths: .then(({ id, object, deleted }) => { console.log(id); - }); + }) - lang: Shell label: cURL source: | @@ -12396,7 +12429,7 @@ paths: .then(({ product_category }) => { console.log(product_category.id); - }); + }) - lang: Shell label: cURL source: > @@ -12496,7 +12529,7 @@ paths: .then(({ product_category }) => { console.log(product_category.id); - }); + }) - lang: Shell label: cURL source: > @@ -12658,7 +12691,7 @@ paths: .then(({ product_tags }) => { console.log(product_tags.length); - }); + }) - lang: Shell label: cURL source: | @@ -12810,7 +12843,7 @@ paths: .then(({ product_types }) => { console.log(product_types.length); - }); + }) - lang: Shell label: cURL source: | @@ -13103,7 +13136,7 @@ paths: .then(({ products, limit, offset, count }) => { console.log(products.length); - }); + }) - lang: Shell label: cURL source: | @@ -13167,7 +13200,7 @@ paths: .then(({ product }) => { console.log(product.id); - }); + }) - lang: Shell label: cURL source: | @@ -13227,7 +13260,7 @@ paths: .then(({ tags }) => { console.log(tags.length); - }); + }) - lang: Shell label: cURL source: | @@ -13282,7 +13315,7 @@ paths: .then(({ types }) => { console.log(types.length); - }); + }) - lang: Shell label: cURL source: | @@ -13343,7 +13376,7 @@ paths: .then(({ product }) => { console.log(product.id); - }); + }) - lang: Shell label: cURL source: | @@ -13410,7 +13443,7 @@ paths: .then(({ product }) => { console.log(product.id); - }); + }) - lang: Shell label: cURL source: | @@ -13474,7 +13507,7 @@ paths: .then(({ id, object, deleted }) => { console.log(id); - }); + }) - lang: Shell label: cURL source: | @@ -13549,7 +13582,7 @@ paths: .then(({ product }) => { console.log(product.id); - }); + }) - lang: Shell label: cURL source: | @@ -13622,7 +13655,7 @@ paths: .then(({ product }) => { console.log(product.id); - }); + }) - lang: Shell label: cURL source: | @@ -13700,7 +13733,7 @@ paths: .then(({ product }) => { console.log(product.id); - }); + }) - lang: Shell label: cURL source: > @@ -13776,7 +13809,7 @@ paths: .then(({ option_id, object, deleted, product }) => { console.log(product.id); - }); + }) - lang: Shell label: cURL source: > @@ -14045,7 +14078,7 @@ paths: .then(({ product }) => { console.log(product.id); - }); + }) - lang: Shell label: cURL source: > @@ -14125,7 +14158,7 @@ paths: .then(({ variant_id, object, deleted, product }) => { console.log(product.id); - }); + }) - lang: Shell label: cURL source: > @@ -14216,9 +14249,10 @@ paths: // must be previously logged in or use api token medusa.admin.publishableApiKeys.list() - .then(({ publishable_api_keys, count, limit, offset }) => { - console.log(publishable_api_keys) - }) + + .then(({ publishable_api_keys, count, limit, offset }) => { + console.log(publishable_api_keys) + }) - lang: Shell label: cURL source: | @@ -14252,7 +14286,7 @@ paths: post: operationId: PostPublishableApiKeys summary: Create Publishable API Key - description: Creates a Publishable API Key. + description: Create a Publishable API Key. requestBody: content: application/json: @@ -14527,9 +14561,10 @@ paths: // must be previously logged in or use api token medusa.admin.publishableApiKeys.revoke(publishableApiKeyId) - .then(({ publishable_api_key }) => { - console.log(publishable_api_key.id) - }) + + .then(({ publishable_api_key }) => { + console.log(publishable_api_key.id) + }) - lang: Shell label: cURL source: > @@ -14597,9 +14632,10 @@ paths: // must be previously logged in or use api token medusa.admin.publishableApiKeys.listSalesChannels() - .then(({ sales_channels }) => { - console.log(sales_channels.length) - }) + + .then(({ sales_channels }) => { + console.log(sales_channels.length) + }) - lang: Shell label: cURL source: > @@ -14637,7 +14673,7 @@ paths: post: operationId: PostPublishableApiKeySalesChannelsChannelsBatch summary: Add Sales Channels - description: Assign a list of sales channels to a publishable API key. + description: Add a list of sales channels to a publishable API key. x-authenticated: true parameters: - in: path @@ -14676,7 +14712,7 @@ paths: .then(({ publishable_api_key }) => { console.log(publishable_api_key.id); - }); + }) - lang: Shell label: cURL source: > @@ -14764,7 +14800,7 @@ paths: .then(({ publishable_api_key }) => { console.log(publishable_api_key.id); - }); + }) - lang: Shell label: cURL source: > @@ -14813,7 +14849,7 @@ paths: summary: List Regions description: >- Retrieve a list of Regions. The regions can be filtered by fields such - as `created_at`. The regions can also be paginated + as `created_at`. The regions can also be paginated. x-authenticated: true parameters: - in: query @@ -14917,7 +14953,7 @@ paths: .then(({ regions, limit, offset, count }) => { console.log(regions.length); - }); + }) - lang: Shell label: cURL source: | @@ -14988,7 +15024,7 @@ paths: .then(({ region }) => { console.log(region.id); - }); + }) - lang: Shell label: cURL source: | @@ -15064,7 +15100,7 @@ paths: .then(({ region }) => { console.log(region.id); - }); + }) - lang: Shell label: cURL source: | @@ -15131,7 +15167,7 @@ paths: .then(({ region }) => { console.log(region.id); - }); + }) - lang: Shell label: cURL source: | @@ -15197,7 +15233,7 @@ paths: .then(({ id, object, deleted }) => { console.log(id); - }); + }) - lang: Shell label: cURL source: | @@ -15232,7 +15268,7 @@ paths: post: operationId: PostRegionsRegionCountries summary: Add Country - description: Add a Country to the list of Countries in a Region + description: Add a Country to the list of Countries in a Region. x-authenticated: true parameters: - in: path @@ -15265,7 +15301,7 @@ paths: .then(({ region }) => { console.log(region.id); - }); + }) - lang: Shell label: cURL source: | @@ -15342,7 +15378,7 @@ paths: .then(({ region }) => { console.log(region.id); - }); + }) - lang: Shell label: cURL source: > @@ -15405,7 +15441,7 @@ paths: .then(({ fulfillment_options }) => { console.log(fulfillment_options.length); - }); + }) - lang: Shell label: cURL source: | @@ -15477,7 +15513,7 @@ paths: .then(({ region }) => { console.log(region.id); - }); + }) - lang: Shell label: cURL source: > @@ -15554,7 +15590,7 @@ paths: .then(({ region }) => { console.log(region.id); - }); + }) - lang: Shell label: cURL source: > @@ -15625,7 +15661,7 @@ paths: .then(({ region }) => { console.log(region.id); - }); + }) - lang: Shell label: cURL source: | @@ -15698,7 +15734,7 @@ paths: .then(({ region }) => { console.log(region.id); - }); + }) - lang: Shell label: cURL source: > @@ -15943,7 +15979,7 @@ paths: .then(({ reservation }) => { console.log(reservation.id); - }); + }) - lang: Shell label: cURL source: | @@ -15985,7 +16021,7 @@ paths: get: operationId: GetReservationsReservation summary: Get a Reservation - description: Retrieve a reservation's details.' + description: Retrieve a reservation's details. x-authenticated: true parameters: - in: path @@ -16009,7 +16045,7 @@ paths: .then(({ reservation }) => { console.log(reservation.id); - }); + }) - lang: Shell label: cURL source: | @@ -16043,7 +16079,7 @@ paths: post: operationId: PostReservationsReservation summary: Update a Reservation - description: Update a Reservation's details.' + description: Update a Reservation's details. x-authenticated: true parameters: - in: path @@ -16074,7 +16110,7 @@ paths: .then(({ reservation }) => { console.log(reservation.id); - }); + }) - lang: Shell label: cURL source: | @@ -16140,7 +16176,7 @@ paths: .then(({ id, object, deleted }) => { console.log(id); - }); + }) - lang: Shell label: cURL source: | @@ -16194,7 +16230,7 @@ paths: .then(({ return_reasons }) => { console.log(return_reasons.length); - }); + }) - lang: Shell label: cURL source: | @@ -16255,7 +16291,7 @@ paths: .then(({ return_reason }) => { console.log(return_reason.id); - }); + }) - lang: Shell label: cURL source: | @@ -16321,7 +16357,7 @@ paths: .then(({ return_reason }) => { console.log(return_reason.id); - }); + }) - lang: Shell label: cURL source: | @@ -16388,7 +16424,7 @@ paths: .then(({ return_reason }) => { console.log(return_reason.id); - }); + }) - lang: Shell label: cURL source: | @@ -16452,7 +16488,7 @@ paths: .then(({ id, object, deleted }) => { console.log(id); - }); + }) - lang: Shell label: cURL source: | @@ -16518,8 +16554,8 @@ paths: medusa.admin.returns.list() .then(({ returns, limit, offset, count }) => { - console.log(returns.length); - }); + console.log(returns.length) + }) - lang: Shell label: cURL source: | @@ -16580,8 +16616,8 @@ paths: medusa.admin.returns.cancel(returnId) .then(({ order }) => { - console.log(order.id); - }); + console.log(order.id) + }) - lang: Shell label: cURL source: | @@ -16655,7 +16691,7 @@ paths: .then((data) => { console.log(data.return.id); - }); + }) - lang: Shell label: cURL source: | @@ -16841,8 +16877,8 @@ paths: medusa.admin.salesChannels.list() .then(({ sales_channels, limit, offset, count }) => { - console.log(sales_channels.length); - }); + console.log(sales_channels.length) + }) - lang: Shell label: cURL source: | @@ -16903,7 +16939,7 @@ paths: .then(({ sales_channel }) => { console.log(sales_channel.id); - }); + }) - lang: Shell label: cURL source: | @@ -16968,7 +17004,7 @@ paths: .then(({ sales_channel }) => { console.log(sales_channel.id); - }); + }) - lang: Shell label: cURL source: | @@ -17035,7 +17071,7 @@ paths: .then(({ sales_channel }) => { console.log(sales_channel.id); - }); + }) - lang: Shell label: cURL source: | @@ -17100,8 +17136,8 @@ paths: medusa.admin.salesChannels.delete(salesChannelId) .then(({ id, object, deleted }) => { - console.log(id); - }); + console.log(id) + }) - lang: Shell label: cURL source: | @@ -17174,7 +17210,7 @@ paths: .then(({ sales_channel }) => { console.log(sales_channel.id); - }); + }) - lang: Shell label: cURL source: > @@ -17260,8 +17296,8 @@ paths: }) .then(({ sales_channel }) => { - console.log(sales_channel.id); - }); + console.log(sales_channel.id) + }) - lang: Shell label: cURL source: > @@ -17342,7 +17378,7 @@ paths: .then(({ sales_channel }) => { console.log(sales_channel.id); - }); + }) - lang: Shell label: cURL source: > @@ -17421,7 +17457,7 @@ paths: .then(({ sales_channel }) => { console.log(sales_channel.id); - }); + }) - lang: Shell label: cURL source: > @@ -17502,7 +17538,7 @@ paths: .then(({ shipping_options, count }) => { console.log(shipping_options.length); - }); + }) - lang: Shell label: cURL source: | @@ -17567,7 +17603,7 @@ paths: .then(({ shipping_option }) => { console.log(shipping_option.id); - }); + }) - lang: Shell label: cURL source: | @@ -17636,7 +17672,7 @@ paths: .then(({ shipping_option }) => { console.log(shipping_option.id); - }); + }) - lang: Shell label: cURL source: | @@ -17710,7 +17746,7 @@ paths: .then(({ shipping_option }) => { console.log(shipping_option.id); - }); + }) - lang: Shell label: cURL source: | @@ -17781,7 +17817,7 @@ paths: .then(({ id, object, deleted }) => { console.log(id); - }); + }) - lang: Shell label: cURL source: | @@ -17835,7 +17871,7 @@ paths: .then(({ shipping_profiles }) => { console.log(shipping_profiles.length); - }); + }) - lang: Shell label: cURL source: | @@ -17895,7 +17931,7 @@ paths: .then(({ shipping_profile }) => { console.log(shipping_profile.id); - }); + }) - lang: Shell label: cURL source: | @@ -17960,7 +17996,7 @@ paths: .then(({ shipping_profile }) => { console.log(shipping_profile.id); - }); + }) - lang: Shell label: cURL source: | @@ -18026,7 +18062,7 @@ paths: .then(({ shipping_profile }) => { console.log(shipping_profile.id); - }); + }) - lang: Shell label: cURL source: | @@ -18092,7 +18128,7 @@ paths: .then(({ id, object, deleted }) => { console.log(id); - }); + }) - lang: Shell label: cURL source: | @@ -18262,7 +18298,7 @@ paths: .then(({ stock_locations, limit, offset, count }) => { console.log(stock_locations.length); - }); + }) - lang: Shell label: cURL source: | @@ -18337,7 +18373,7 @@ paths: .then(({ stock_location }) => { console.log(stock_location.id); - }); + }) - lang: Shell label: cURL source: | @@ -18417,7 +18453,7 @@ paths: .then(({ stock_location }) => { console.log(stock_location.id); - }); + }) - lang: Shell label: cURL source: | @@ -18486,7 +18522,7 @@ paths: .then(({ stock_location }) => { console.log(stock_location.id); - }); + }) - lang: Shell label: cURL source: | @@ -18592,7 +18628,7 @@ paths: .then(({ store }) => { console.log(store.id); - }); + }) - lang: Shell label: cURL source: | @@ -18652,7 +18688,7 @@ paths: .then(({ store }) => { console.log(store.id); - }); + }) - lang: Shell label: cURL source: | @@ -18724,7 +18760,7 @@ paths: .then(({ store }) => { console.log(store.currencies); - }); + }) - lang: Shell label: cURL source: > @@ -18792,7 +18828,7 @@ paths: .then(({ store }) => { console.log(store.currencies); - }); + }) - lang: Shell label: cURL source: > @@ -18848,7 +18884,7 @@ paths: .then(({ payment_providers }) => { console.log(payment_providers.length); - }); + }) - lang: Shell label: cURL source: | @@ -18902,7 +18938,7 @@ paths: .then(({ tax_providers }) => { console.log(tax_providers.length); - }); + }) - lang: Shell label: cURL source: | @@ -18970,7 +19006,7 @@ paths: .then(({ swaps }) => { console.log(swaps.length); - }); + }) - lang: Shell label: cURL source: | @@ -19031,7 +19067,7 @@ paths: .then(({ swap }) => { console.log(swap.id); - }); + }) - lang: Shell label: cURL source: | @@ -19166,7 +19202,7 @@ paths: .then(({ tax_rates, limit, offset, count }) => { console.log(tax_rates.length); - }); + }) - lang: Shell label: cURL source: | @@ -19252,7 +19288,7 @@ paths: .then(({ tax_rate }) => { console.log(tax_rate.id); - }); + }) - lang: Shell label: cURL source: | @@ -19342,7 +19378,7 @@ paths: .then(({ tax_rate }) => { console.log(tax_rate.id); - }); + }) - lang: Shell label: cURL source: | @@ -19432,7 +19468,7 @@ paths: .then(({ tax_rate }) => { console.log(tax_rate.id); - }); + }) - lang: Shell label: cURL source: | @@ -19498,7 +19534,7 @@ paths: .then(({ id, object, deleted }) => { console.log(id); - }); + }) - lang: Shell label: cURL source: | @@ -19533,7 +19569,7 @@ paths: post: operationId: PostTaxRatesTaxRateProductTypes summary: Add to Product Types - description: Associates a Tax Rate with a list of Product Types + description: Add Product Types to a Tax Rate. parameters: - in: path name: id @@ -19591,7 +19627,7 @@ paths: .then(({ tax_rate }) => { console.log(tax_rate.id); - }); + }) - lang: Shell label: cURL source: > @@ -19696,7 +19732,7 @@ paths: .then(({ tax_rate }) => { console.log(tax_rate.id); - }); + }) - lang: Shell label: cURL source: > @@ -19741,7 +19777,7 @@ paths: post: operationId: PostTaxRatesTaxRateProducts summary: Add to Products - description: Associates a Tax Rate with a list of Products. + description: Add products to a tax rate. parameters: - in: path name: id @@ -19799,7 +19835,7 @@ paths: .then(({ tax_rate }) => { console.log(tax_rate.id); - }); + }) - lang: Shell label: cURL source: | @@ -19899,7 +19935,7 @@ paths: .then(({ tax_rate }) => { console.log(tax_rate.id); - }); + }) - lang: Shell label: cURL source: | @@ -19940,7 +19976,7 @@ paths: post: operationId: PostTaxRatesTaxRateShippingOptions summary: Add to Shipping Options - description: Associates a Tax Rate with a list of Shipping Options. + description: Add Shipping Options to a Tax Rate. parameters: - in: path name: id @@ -19998,7 +20034,7 @@ paths: .then(({ tax_rate }) => { console.log(tax_rate.id); - }); + }) - lang: Shell label: cURL source: > @@ -20104,7 +20140,7 @@ paths: .then(({ tax_rate }) => { console.log(tax_rate.id); - }); + }) - lang: Shell label: cURL source: > @@ -20177,7 +20213,7 @@ paths: .then(({ uploads }) => { console.log(uploads.length); - }); + }) - lang: Shell label: cURL source: | @@ -20240,7 +20276,7 @@ paths: .then(({ id, object, deleted }) => { console.log(id); - }); + }) - lang: Shell label: cURL source: | @@ -20306,7 +20342,7 @@ paths: .then(({ download_url }) => { console.log(download_url); - }); + }) - lang: Shell label: cURL source: | @@ -20373,7 +20409,7 @@ paths: .then(({ uploads }) => { console.log(uploads.length); - }); + }) - lang: Shell label: cURL source: | @@ -20430,7 +20466,7 @@ paths: .then(({ users }) => { console.log(users.length); - }); + }) - lang: Shell label: cURL source: | @@ -20494,7 +20530,7 @@ paths: .then(({ user }) => { console.log(user.id); - }); + }) - lang: Shell label: cURL source: | @@ -20534,7 +20570,15 @@ paths: post: operationId: PostUsersUserPasswordToken summary: Request Password Reset - description: Generate a password token for an admin user with a given email. + description: >- + Generate a password token for an admin user with a given email. This + also triggers the `user.password_reset` event. So, if you have a + Notification Service installed that can handle this event, a + notification, such as an email, will be sent to the user. The token is + triggered as part of the `user.password_reset` event's payload. That + token must be used later to reset the password using the [Reset + Password](https://docs.medusajs.com/api/admin#users_postusersuserpassword) + API Route. externalDocs: description: How to reset a user's password url: >- @@ -20567,7 +20611,7 @@ paths: .catch(() => { // error occurred - }); + }) - lang: Shell label: cURL source: | @@ -20635,7 +20679,7 @@ paths: .then(({ user }) => { console.log(user.id); - }); + }) - lang: Shell label: cURL source: | @@ -20701,7 +20745,7 @@ paths: .then(({ user }) => { console.log(user.id); - }); + }) - lang: Shell label: cURL source: | @@ -20768,7 +20812,7 @@ paths: .then(({ user }) => { console.log(user.id); - }); + }) - lang: Shell label: cURL source: | @@ -20834,7 +20878,7 @@ paths: .then(({ id, object, deleted }) => { console.log(id); - }); + }) - lang: Shell label: cURL source: | @@ -21015,7 +21059,7 @@ paths: .then(({ variants, limit, offset, count }) => { console.log(variants.length); - }); + }) - lang: Shell label: cURL source: | @@ -21091,7 +21135,7 @@ paths: .then(({ variant }) => { console.log(variant.id); - }); + }) - lang: Shell label: cURL source: | @@ -21530,6 +21574,7 @@ components: example: 16128234334802 company: type: string + description: Company address_1: description: Address line 1 type: string @@ -21583,6 +21628,7 @@ components: $ref: '#/components/schemas/OAuth' AdminAuthRes: type: object + description: The user's details. required: - user properties: @@ -21613,6 +21659,7 @@ components: description: The number of items per page AdminBatchJobRes: type: object + description: The batch job's details. required: - batch_job properties: @@ -21621,6 +21668,7 @@ components: $ref: '#/components/schemas/BatchJob' AdminBearerAuthRes: type: object + description: The access token of the user, if they're authenticated successfully. properties: access_token: description: Access token that can be used to send authenticated requests. @@ -21669,6 +21717,7 @@ components: description: The number of items per page AdminCollectionsRes: type: object + description: The collection's details. x-expanded-relations: field: collection relations: @@ -21677,7 +21726,7 @@ components: - collection properties: collection: - type: Product Collection details. + description: Product Collection details. $ref: '#/components/schemas/ProductCollection' AdminCreateUserRequest: type: object @@ -21710,6 +21759,7 @@ components: format: password AdminCurrenciesListRes: type: object + description: List of currencies with pagination fields. required: - currencies - count @@ -21732,6 +21782,7 @@ components: description: The number of items per page AdminCurrenciesRes: type: object + description: A currency's details. required: - currency properties: @@ -21782,6 +21833,7 @@ components: description: The number of items per page AdminCustomerGroupsRes: type: object + description: The customer group's details. required: - customer_group properties: @@ -21789,6 +21841,7 @@ components: description: Customer group details. $ref: '#/components/schemas/CustomerGroup' AdminCustomersListRes: + description: The list of customers with pagination fields. type: object required: - customers @@ -21812,6 +21865,7 @@ components: description: The number of items per page AdminCustomersRes: type: object + description: The customer's details. x-expanded-relations: field: customer relations: @@ -21841,6 +21895,7 @@ components: type: string AdminDeleteDiscountsDiscountConditionsConditionBatchReq: type: object + description: The resources to remove. required: - resources properties: @@ -21900,6 +21955,7 @@ components: type: string AdminDeleteProductsFromCollectionRes: type: object + description: Deletion operation details required: - id - object @@ -21978,6 +22034,7 @@ components: default: true AdminDeleteTaxRatesTaxRateProductTypesReq: type: object + description: Product types to remove from the tax rates. required: - product_types properties: @@ -22112,6 +22169,7 @@ components: default: true AdminDiscountsListRes: type: object + description: The list of discounts with pagination fields. x-expanded-relations: field: discounts relations: @@ -22127,6 +22185,7 @@ components: properties: discounts: type: array + description: The list of discounts. items: $ref: '#/components/schemas/Discount' count: @@ -22140,6 +22199,7 @@ components: description: The number of items per page AdminDiscountsRes: type: object + description: The discount's details. x-expanded-relations: field: discount relations: @@ -22175,6 +22235,7 @@ components: description: Whether the draft order was deleted successfully. default: true AdminDraftOrdersListRes: + description: The list of draft orders with pagination fields. type: object x-expanded-relations: field: draft_orders @@ -22205,6 +22266,7 @@ components: description: The number of items per page AdminDraftOrdersRes: type: object + description: The list of draft orders. x-expanded-relations: field: draft_order relations: @@ -22272,6 +22334,9 @@ components: $ref: '#/components/schemas/DraftOrder' AdminExtendedStoresRes: type: object + description: >- + The store's details with additional details like payment and tax + providers. x-expanded-relations: field: store relations: @@ -22285,6 +22350,7 @@ components: $ref: '#/components/schemas/ExtendedStoreDTO' AdminGetRegionsRegionFulfillmentOptionsRes: type: object + description: The list of fulfillment options in a region. required: - fulfillment_options properties: @@ -22311,10 +22377,11 @@ components: is_return: true AdminGetVariantsVariantInventoryRes: type: object + description: The variant's inventory details. properties: variant: type: object - description: The product variant's. + description: The product variant's inventory details. $ref: '#/components/schemas/VariantInventory' AdminGiftCardsDeleteRes: type: object @@ -22336,6 +22403,7 @@ components: default: true AdminGiftCardsListRes: type: object + description: The list of gift cards with pagination fields. x-expanded-relations: field: gift_cards relations: @@ -22352,6 +22420,7 @@ components: properties: gift_cards: type: array + description: The list of gift cards. items: $ref: '#/components/schemas/GiftCard' count: @@ -22365,6 +22434,7 @@ components: description: The number of items per page AdminGiftCardsRes: type: object + description: The gift card's details. x-expanded-relations: field: gift_card relations: @@ -22447,17 +22517,20 @@ components: description: The number of items per page AdminInventoryItemsLocationLevelsRes: type: object + description: Details of inventory items and their associated location levels. required: - inventory_item properties: inventory_item: type: object + description: An inventory item's ID and associated location levels. required: - id - location_levels properties: id: description: The id of the location + type: string location_levels: description: List of stock levels at a given location type: array @@ -22465,6 +22538,7 @@ components: $ref: '#/components/schemas/InventoryLevelDTO' AdminInventoryItemsRes: type: object + description: The inventory item's details. required: - inventory_item properties: @@ -22490,6 +22564,7 @@ components: description: Whether or not the invite was deleted. default: true AdminListInvitesRes: + description: The list of invites. type: object required: - invites @@ -22519,6 +22594,7 @@ components: default: true AdminNotesListRes: type: object + description: The list of notes with pagination fields. required: - notes - count @@ -22541,6 +22617,7 @@ components: description: The number of items per page AdminNotesRes: type: object + description: The note's details. required: - note properties: @@ -22574,6 +22651,7 @@ components: description: The number of notifications per page AdminNotificationsRes: type: object + description: The notification's details. x-expanded-relations: field: notification relations: @@ -22604,6 +22682,7 @@ components: default: true AdminOrderEditItemChangeDeleteRes: type: object + description: The details of deleting order edit item changes. required: - id - object @@ -22622,6 +22701,7 @@ components: default: true AdminOrderEditsListRes: type: object + description: The list of order edits with pagination fields. x-expanded-relations: field: order_edits relations: @@ -22679,6 +22759,7 @@ components: description: The number of items per page AdminOrderEditsRes: type: object + description: The order edit details. x-expanded-relations: field: order_edit relations: @@ -22722,6 +22803,7 @@ components: $ref: '#/components/schemas/OrderEdit' AdminOrdersListRes: type: object + description: The list of orders with pagination fields. x-expanded-relations: field: orders relations: @@ -22859,6 +22941,7 @@ components: type: number AdminOrdersRes: type: object + description: The order's details. x-expanded-relations: field: order relations: @@ -22971,6 +23054,7 @@ components: $ref: '#/components/schemas/Order' AdminPaymentCollectionDeleteRes: type: object + description: The details of deleting a payment collection. required: - id - object @@ -23006,6 +23090,7 @@ components: $ref: '#/components/schemas/PaymentCollection' AdminPaymentProvidersList: type: object + description: The list of payment providers in a store. required: - payment_providers properties: @@ -23016,6 +23101,7 @@ components: $ref: '#/components/schemas/PaymentProvider' AdminPaymentRes: type: object + description: The payment's details. required: - payment properties: @@ -23354,7 +23440,7 @@ components: - id properties: id: - description: The id of the item + description: The ID of the item type: string AdminPostDiscountsDiscountDynamicCodesReq: type: object @@ -23714,6 +23800,7 @@ components: https://docs.medusajs.com/development/entities/overview#metadata-attribute AdminPostDraftOrdersDraftOrderRegisterPaymentRes: type: object + description: The order's details. required: - order properties: @@ -23947,6 +24034,7 @@ components: https://docs.medusajs.com/development/entities/overview#metadata-attribute AdminPostInventoryItemsInventoryItemReq: type: object + description: The attributes to update in an inventory item. properties: hs_code: description: >- @@ -23992,6 +24080,15 @@ components: The length of the Inventory Item. May be used in shipping rate calculations. type: number + title: + description: The inventory item's title. + type: string + description: + description: The inventory item's description. + type: string + thumbnail: + description: The inventory item's thumbnail. + type: string requires_shipping: description: Whether the item requires shipping. type: boolean @@ -24102,6 +24199,15 @@ components: be used by Fulfillment Providers to pass customs information to shipping carriers. type: string + title: + description: The inventory item's title. + type: string + description: + description: The inventory item's description. + type: string + thumbnail: + description: The inventory item's thumbnail. + type: string metadata: description: An optional set of key-value pairs with additional information. type: object @@ -24113,6 +24219,7 @@ components: https://docs.medusajs.com/development/entities/overview#metadata-attribute AdminPostInvitesInviteAcceptReq: type: object + description: The details of the invite to be accepted. required: - token - user @@ -24261,6 +24368,9 @@ components: If set to `true`, no notification will be sent to the customer related to this Claim. type: boolean + location_id: + description: The ID of the fulfillment's location. + type: string AdminPostOrdersOrderClaimsClaimReq: type: object properties: @@ -24376,6 +24486,7 @@ components: type: string AdminPostOrdersOrderClaimsReq: type: object + description: The details of the claim to be created. required: - type - claim_items @@ -24492,6 +24603,9 @@ components: no_notification: description: If set to true no notification will be send related to this Claim. type: boolean + return_location_id: + description: The ID of the location used for the associated return. + type: string metadata: description: An optional set of key-value pairs to hold additional information. type: object @@ -24503,6 +24617,7 @@ components: https://docs.medusajs.com/development/entities/overview#metadata-attribute AdminPostOrdersOrderFulfillmentsReq: type: object + description: The details of the fulfillment to be created. required: - items properties: @@ -24521,6 +24636,9 @@ components: quantity: description: The quantity of the Line Item to fulfill. type: integer + location_id: + type: string + description: The ID of the location where the items will be fulfilled from. no_notification: description: >- If set to `true`, no notification will be sent to the customer @@ -24561,7 +24679,7 @@ components: type: object properties: email: - description: the email associated with the order + description: The email associated with the order type: string billing_address: description: The order's billing address @@ -24676,6 +24794,9 @@ components: refund: description: The amount to refund. type: integer + location_id: + description: The ID of the location used for the return. + type: string AdminPostOrdersOrderShipmentReq: type: object required: @@ -24696,6 +24817,7 @@ components: type: boolean AdminPostOrdersOrderShippingMethodsReq: type: object + description: The shipping method's details. required: - price - option_id @@ -24708,7 +24830,7 @@ components: option_id: type: string description: The ID of the Shipping Option to create the Shipping Method from. - date: + data: type: object description: >- The data required for the Shipping Option to create a Shipping @@ -24768,6 +24890,9 @@ components: quantity: description: The quantity of the Product Variant. type: integer + sales_channel_id: + type: string + description: The ID of the sales channel associated with the swap. custom_shipping_options: description: >- An array of custom shipping options to potentially create a Shipping @@ -24790,6 +24915,9 @@ components: If set to `true`, no notification will be sent to the customer related to this Swap. type: boolean + return_location_id: + type: string + description: The ID of the location used for the associated return. allow_backorder: description: If set to `true`, swaps can be completed with items out of stock type: boolean @@ -24811,6 +24939,9 @@ components: If set to `true`, no notification will be sent to the customer related to this swap. type: boolean + location_id: + description: The ID of the fulfillment's location. + type: string AdminPostOrdersOrderSwapsSwapShipmentsReq: type: object required: @@ -25413,6 +25544,9 @@ components: width: description: The width of the Product. type: number + hs_code: + description: The Harmonized System code of the product variant. + type: string origin_country: description: The country of origin of the Product. type: string @@ -26167,6 +26301,9 @@ components: quantity: description: The quantity to reserve. type: number + description: + description: The reservation's description. + type: string metadata: description: An optional set of key-value pairs with additional information. type: object @@ -26185,6 +26322,9 @@ components: quantity: description: The quantity to reserve. type: number + description: + description: The reservation's description. + type: string metadata: description: An optional set of key-value pairs with additional information. type: object @@ -26265,6 +26405,9 @@ components: refund: description: The amount to refund. type: number + location_id: + description: The ID of the location to return items from. + type: string AdminPostSalesChannelsChannelProductsBatchReq: type: object required: @@ -26502,6 +26645,15 @@ components: - default - gift_card - custom + metadata: + description: An optional set of key-value pairs with additional information. + type: object + externalDocs: + description: >- + Learn about the metadata attribute, and how to delete and update + it. + url: >- + https://docs.medusajs.com/development/entities/overview#metadata-attribute AdminPostStockLocationsLocationReq: type: object properties: @@ -26523,6 +26675,7 @@ components: url: >- https://docs.medusajs.com/development/entities/overview#metadata-attribute address: + description: The data of an associated address to create or update. $ref: '#/components/schemas/StockLocationAddressInput' AdminPostStockLocationsReq: type: object @@ -26575,7 +26728,7 @@ components: description: Stock location address' city example: Mexico city country_code: - description: The 2 character ISO code for the country. + description: The two character ISO code for the country. type: string externalDocs: url: >- @@ -26678,6 +26831,7 @@ components: type: string AdminPostTaxRatesTaxRateProductTypesReq: type: object + description: The product types to add to the tax rate. required: - product_types properties: @@ -26749,6 +26903,7 @@ components: type: string AdminPriceListDeleteBatchRes: type: object + description: The details of deleting a price list. required: - ids - object @@ -26756,9 +26911,10 @@ components: properties: ids: type: array + description: The IDs of the deleted prices. items: type: string - description: The IDs of the deleted prices. + description: The ID of a deleted price. object: type: string description: >- @@ -26833,6 +26989,7 @@ components: default: true AdminPriceListRes: type: object + description: The price list's details. x-expanded-relations: field: price_list relations: @@ -26846,6 +27003,7 @@ components: $ref: '#/components/schemas/PriceList' AdminPriceListsListRes: type: object + description: The list of price lists with pagination fields. required: - price_lists - count @@ -26868,6 +27026,7 @@ components: description: The number of items per page AdminPriceListsProductsListRes: type: object + description: The list of products with pagination fields. x-expanded-relations: field: products relations: @@ -26919,6 +27078,7 @@ components: default: true AdminProductCategoriesCategoryRes: type: object + description: The product category's details. x-expanded-relations: field: product_category relations: @@ -26932,6 +27092,7 @@ components: $ref: '#/components/schemas/ProductCategory' AdminProductCategoriesListRes: type: object + description: The list of product categories with pagination fields. x-expanded-relations: field: product_categories relations: @@ -26961,6 +27122,7 @@ components: description: The number of items per page AdminProductTagsListRes: type: object + description: The list of product tags with pagination fields. required: - product_tags - count @@ -26983,6 +27145,7 @@ components: description: The number of items per page AdminProductTypesListRes: type: object + description: The list of product types with pagination fields. required: - product_types - count @@ -27007,6 +27170,7 @@ components: description: The number of items per page AdminProductsDeleteOptionRes: type: object + description: The details of deleting a product's option. x-expanded-relations: field: product relations: @@ -27040,6 +27204,7 @@ components: $ref: '#/components/schemas/PricedProduct' AdminProductsDeleteRes: type: object + description: The details of deleting a product. required: - id - object @@ -27058,6 +27223,7 @@ components: default: true AdminProductsDeleteVariantRes: type: object + description: The details of deleting a product's variant. x-expanded-relations: field: product relations: @@ -27091,6 +27257,7 @@ components: $ref: '#/components/schemas/PricedProduct' AdminProductsListRes: type: object + description: The list of products with pagination fields. x-expanded-relations: field: products relations: @@ -27126,6 +27293,7 @@ components: description: The number of items per page AdminProductsListTagsRes: type: object + description: The usage details of product tags. required: - tags properties: @@ -27184,6 +27352,7 @@ components: description: The number of items per page AdminProductsRes: type: object + description: The product's details. x-expanded-relations: field: product relations: @@ -27221,6 +27390,7 @@ components: default: true AdminPublishableApiKeysListRes: type: object + description: The list of publishable API keys with pagination fields. required: - publishable_api_keys - count @@ -27245,6 +27415,7 @@ components: description: The number of items per page AdminPublishableApiKeysListSalesChannelsRes: type: object + description: The list of sales channel. required: - sales_channels properties: @@ -27255,6 +27426,7 @@ components: $ref: '#/components/schemas/SalesChannel' AdminPublishableApiKeysRes: type: object + description: The publishable API key's details. required: - publishable_api_key properties: @@ -27263,11 +27435,12 @@ components: $ref: '#/components/schemas/PublishableApiKey' AdminRefundRes: type: object + description: The refund's details. required: - refund properties: refund: - description: Refund details + description: Refund details. $ref: '#/components/schemas/Refund' AdminRegionsDeleteRes: type: object @@ -27289,6 +27462,7 @@ components: default: true AdminRegionsListRes: type: object + description: The list of regions with pagination fields. x-expanded-relations: field: regions relations: @@ -27320,6 +27494,7 @@ components: description: The number of items per page AdminRegionsRes: type: object + description: The region's details. x-expanded-relations: field: region relations: @@ -27355,6 +27530,7 @@ components: default: true AdminReservationsListRes: type: object + description: The list of reservations with pagination fields. required: - reservations - count @@ -27377,6 +27553,7 @@ components: description: The number of items per page AdminReservationsRes: type: object + description: The reservation's details. required: - reservation properties: @@ -27431,6 +27608,7 @@ components: default: true AdminReturnReasonsListRes: type: object + description: The list of return reasons. x-expanded-relations: field: return_reasons relations: @@ -27441,10 +27619,12 @@ components: properties: return_reasons: type: array + description: The list of return reasons. items: $ref: '#/components/schemas/ReturnReason' AdminReturnReasonsRes: type: object + description: The return reason's details. x-expanded-relations: field: return_reason relations: @@ -27454,9 +27634,11 @@ components: - return_reason properties: return_reason: + description: The return reason's details. $ref: '#/components/schemas/ReturnReason' AdminReturnsCancelRes: type: object + description: The associated order's details. x-expanded-relations: field: order relations: @@ -27513,6 +27695,7 @@ components: $ref: '#/components/schemas/Order' AdminReturnsListRes: type: object + description: The list of returns with pagination fields. x-expanded-relation: field: returns relations: @@ -27540,6 +27723,7 @@ components: description: The number of items per page AdminReturnsRes: type: object + description: The return's details. x-expanded-relation: field: return relations: @@ -27588,6 +27772,7 @@ components: default: true AdminSalesChannelsListRes: type: object + description: The list of sales channels with pagination fields. required: - sales_channels - count @@ -27610,6 +27795,7 @@ components: description: The number of items per page AdminSalesChannelsRes: type: object + description: The sales channel's details. required: - sales_channel properties: @@ -27636,6 +27822,7 @@ components: default: true AdminShippingOptionsListRes: type: object + description: The list of shipping options with pagination fields. x-expanded-relations: field: shipping_options relations: @@ -27669,6 +27856,7 @@ components: description: The number of items per page AdminShippingOptionsRes: type: object + description: The shipping option's details. x-expanded-relations: field: shipping_option relations: @@ -27686,6 +27874,7 @@ components: $ref: '#/components/schemas/ShippingOption' AdminShippingProfilesListRes: type: object + description: The list of shipping profiles. required: - shipping_profiles properties: @@ -27696,6 +27885,7 @@ components: $ref: '#/components/schemas/ShippingProfile' AdminShippingProfilesRes: type: object + description: The shipping profile's details. x-expanded-relations: field: shipping_profile relations: @@ -27727,6 +27917,7 @@ components: default: true AdminStockLocationsListRes: type: object + description: The list of stock locations with pagination fields. required: - stock_locations - count @@ -27750,6 +27941,7 @@ components: description: The number of items per page AdminStockLocationsRes: type: object + description: The stock location's details. required: - stock_location properties: @@ -27758,6 +27950,7 @@ components: $ref: '#/components/schemas/StockLocationExpandedDTO' AdminStoresRes: type: object + description: The store's details. required: - store properties: @@ -27766,6 +27959,7 @@ components: $ref: '#/components/schemas/Store' AdminSwapsListRes: type: object + description: The list of swaps with pagination fields. required: - swaps - count @@ -27788,6 +27982,7 @@ components: description: The number of items per page AdminSwapsRes: type: object + description: The swap's details. x-expanded-relations: field: swap relations: @@ -27814,6 +28009,7 @@ components: $ref: '#/components/schemas/Swap' AdminTaxProvidersList: type: object + description: The list of tax providers in a store. required: - tax_providers properties: @@ -27842,6 +28038,7 @@ components: default: true AdminTaxRatesListRes: type: object + description: The list of tax rates with pagination fields. required: - tax_rates - count @@ -27864,6 +28061,7 @@ components: description: The number of items per page AdminTaxRatesRes: type: object + description: The tax rate's details. required: - tax_rate properties: @@ -27917,6 +28115,7 @@ components: https://docs.medusajs.com/development/entities/overview#metadata-attribute AdminUploadsDownloadUrlRes: type: object + description: The download URL details. required: - download_url properties: @@ -27925,6 +28124,7 @@ components: type: string AdminUploadsRes: type: object + description: The list of uploaded files. required: - uploads properties: @@ -27948,6 +28148,7 @@ components: type: string AdminUserRes: type: object + description: The user's details. required: - user properties: @@ -27956,6 +28157,7 @@ components: $ref: '#/components/schemas/User' AdminUsersListRes: type: object + description: The list of users. required: - users properties: @@ -27966,6 +28168,7 @@ components: $ref: '#/components/schemas/User' AdminVariantsListRes: type: object + description: The list of variants with pagination fields. x-expanded-relations: field: variants relations: @@ -27998,6 +28201,7 @@ components: description: The number of items per page AdminVariantsRes: type: object + description: The product variant's details. x-expanded-relations: field: variant relations: @@ -29902,12 +30106,16 @@ components: - modules properties: payment_providers: + description: The store's payment providers. $ref: '#/components/schemas/PaymentProvider' fulfillment_providers: + description: The store's fulfillment providers. $ref: '#/components/schemas/FulfillmentProvider' feature_flags: + description: The feature flags enabled in the store's backend. $ref: '#/components/schemas/FeatureFlagsResponse' modules: + description: The modules installed in the store's backend. $ref: '#/components/schemas/ModulesResponse' FeatureFlagsResponse: type: array @@ -30410,6 +30618,10 @@ components: required: - sku properties: + id: + description: The inventory item's ID. + type: string + example: iitem_12334 sku: description: The Stock Keeping Unit (SKU) code of the Inventory Item. type: string @@ -32128,8 +32340,8 @@ components: $ref: '#/components/schemas/Region' currency_code: description: >- - The 3 character ISO code for the currency this payment collection is - associated with. + The three character ISO code for the currency this payment + collection is associated with. type: string example: usd externalDocs: @@ -32412,6 +32624,7 @@ components: - type: object properties: variants: + description: The product variants and their prices. type: array items: $ref: '#/components/schemas/PricedVariant' @@ -32775,6 +32988,10 @@ components: description: The product category's name type: string example: Regular Fit + description: + description: The product category's description. + type: string + default: '' handle: description: >- A unique string that identifies the Product Category - can for @@ -33689,7 +33906,7 @@ components: type: string example: EU currency_code: - description: The 3 character currency code used in the region. + description: The three character currency code used in the region. type: string example: usd externalDocs: @@ -34938,6 +35155,7 @@ components: - type: object properties: sales_channels: + description: The associated sales channels. $ref: '#/components/schemas/SalesChannel' Store: title: Store @@ -34967,8 +35185,9 @@ components: description: The name of the Store - this may be displayed to the Customer. type: string example: Medusa Store + default: Medusa Store default_currency_code: - description: The 3 character currency code that is the default of the store. + description: The three character currency code that is the default of the store. type: string example: usd externalDocs: @@ -34977,6 +35196,7 @@ components: default_currency: description: The details of the store's default currency. x-expandable: default_currency + default: usd nullable: true $ref: '#/components/schemas/Currency' currencies: @@ -35583,8 +35803,8 @@ components: sales_channel_availability: type: array description: >- - An array of details about the variant's inventory availability in - sales channels. + Details about the variant's inventory availability in sales + channels. items: type: object required: diff --git a/www/apps/api-reference/specs/admin/openapi.yaml b/www/apps/api-reference/specs/admin/openapi.yaml index bc9deb20d2..626235e729 100644 --- a/www/apps/api-reference/specs/admin/openapi.yaml +++ b/www/apps/api-reference/specs/admin/openapi.yaml @@ -31,7 +31,7 @@ tags: asynchronusly. For example, the Import Product feature is implemented using batch jobs. - Batch Job API Routes allows admins to manage the batch jobs and their + Batch Job API Routes allow admins to manage the batch jobs and their state. externalDocs: description: How to import products @@ -289,7 +289,7 @@ tags: They are created by the admin and they're not associated with a fulfillment provider. externalDocs: - description: Shipping Option architecture + description: Shipping Profile architecture url: >- https://docs.medusajs.com/modules/carts-and-checkout/shipping#shipping-profile - name: Stock Locations diff --git a/www/apps/api-reference/specs/admin/paths/admin_customer-groups.yaml b/www/apps/api-reference/specs/admin/paths/admin_customer-groups.yaml index 2982ba399d..724adab038 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customer-groups.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customer-groups.yaml @@ -165,7 +165,7 @@ get: post: operationId: PostCustomerGroups summary: Create a Customer Group - description: Creates a Customer Group. + description: Create a Customer Group. x-authenticated: true requestBody: content: diff --git a/www/apps/api-reference/specs/admin/paths/admin_customers.yaml b/www/apps/api-reference/specs/admin/paths/admin_customers.yaml index 5d929d95db..c5ec96ce6a 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers.yaml @@ -79,7 +79,7 @@ get: post: operationId: PostCustomers summary: Create a Customer - description: Allow admins to create a customer. + description: Create a customer as an admin. x-authenticated: true requestBody: content: diff --git a/www/apps/api-reference/specs/admin/paths/admin_discounts_{discount_id}_conditions_{condition_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_discounts_{discount_id}_conditions_{condition_id}.yaml index 7395338bb6..91fd9659be 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_discounts_{discount_id}_conditions_{condition_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_discounts_{discount_id}_conditions_{condition_id}.yaml @@ -153,7 +153,7 @@ delete: operationId: DeleteDiscountsDiscountConditionsCondition summary: Delete a Condition description: >- - Deletes a Discount Condition. This does not delete resources associated to + Delete a Discount Condition. This does not delete resources associated to the discount condition. x-authenticated: true parameters: diff --git a/www/apps/api-reference/specs/admin/paths/admin_discounts_{discount_id}_conditions_{condition_id}_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_discounts_{discount_id}_conditions_{condition_id}_batch.yaml index 305432b068..256b97e5c2 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_discounts_{discount_id}_conditions_{condition_id}_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_discounts_{discount_id}_conditions_{condition_id}_batch.yaml @@ -82,7 +82,7 @@ delete: summary: Remove Batch Resources description: >- Remove a batch of resources from a discount condition. This will only remove - the association between the resource and the discount condition, but not the + the association between the resource and the discount condition, not the resource itself. x-authenticated: true parameters: diff --git a/www/apps/api-reference/specs/admin/paths/admin_discounts_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_discounts_{id}.yaml index f60d249ef7..173c0a61a6 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_discounts_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_discounts_{id}.yaml @@ -1,7 +1,7 @@ get: operationId: GetDiscountsDiscount summary: Get a Discount - description: Retrieves a Discount + description: Retrieve a Discount. x-authenticated: true parameters: - in: path diff --git a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}.yaml index b4f9b21b89..b4e1aee1b7 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}.yaml @@ -102,7 +102,7 @@ post: delete: operationId: DeleteDraftOrdersDraftOrder summary: Delete a Draft Order - description: Delete a Draft Order + description: Delete a Draft Order. x-authenticated: true parameters: - in: path diff --git a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_line-items_{line_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_line-items_{line_id}.yaml index fd882c83bf..dfe87b82e4 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_line-items_{line_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_line-items_{line_id}.yaml @@ -1,7 +1,7 @@ post: operationId: PostDraftOrdersDraftOrderLineItemsItem summary: Update a Line Item - description: Update a Line Item in a Draft Order + description: Update a Line Item in a Draft Order. x-authenticated: true parameters: - in: path @@ -63,7 +63,7 @@ post: delete: operationId: DeleteDraftOrdersDraftOrderLineItemsItem summary: Delete a Line Item - description: Deletes a Line Item from a Draft Order. + description: Delete a Line Item from a Draft Order. x-authenticated: true parameters: - in: path diff --git a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml index 76f369899c..688cad9b67 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml @@ -3,8 +3,7 @@ get: summary: List Inventory Level description: >- Retrieve a list of inventory levels of an inventory item. The inventory - levels can be filtered by fields such as `location_id`. The inventory levels - can also be paginated. + levels can be filtered by fields such as `location_id`. x-authenticated: true parameters: - in: path @@ -77,8 +76,8 @@ get: $ref: ../components/responses/500_error.yaml post: operationId: PostInventoryItemsInventoryItemLocationLevels - summary: Create an Location Level - description: Create an Location Level for a given Inventory Item. + summary: Create a Location Level + description: Create a Location Level for a given Inventory Item. x-authenticated: true parameters: - in: path diff --git a/www/apps/api-reference/specs/admin/paths/admin_notes_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_notes_{id}.yaml index ca47f4c1b2..8c769e2ab1 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_notes_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_notes_{id}.yaml @@ -50,7 +50,7 @@ post: operationId: PostNotesNote summary: Update a Note x-authenticated: true - description: Update a Note's details.' + description: Update a Note's details. parameters: - in: path name: id diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}.yaml index 6e381063cf..d7f7aa2a6c 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}.yaml @@ -64,7 +64,7 @@ get: post: operationId: PostOrderEditsOrderEdit summary: Update an Order Edit - description: Updates an Order Edit's details. + description: Update an Order Edit's details. x-authenticated: true parameters: - in: path diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_cancel.yaml index 9908edc300..d42fd817b8 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_cancel.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_cancel.yaml @@ -1,7 +1,7 @@ post: operationId: PostOrderEditsOrderEditCancel summary: Cancel an Order Edit - description: Cancel an OrderEdit. + description: Cancel an Order Edit. x-authenticated: true parameters: - in: path diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_claims_{claim_id}_fulfillments.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_claims_{claim_id}_fulfillments.yaml index fa53d242f0..aca31dbcfc 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_claims_{claim_id}_fulfillments.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_claims_{claim_id}_fulfillments.yaml @@ -1,7 +1,11 @@ post: operationId: PostOrdersOrderClaimsClaimFulfillments summary: Create a Claim Fulfillment - description: Create a Fulfillment for a Claim. + description: >- + Create a Fulfillment for a Claim, and change its fulfillment status to + `partially_fulfilled` or `fulfilled` depending on whether all the items were + fulfilled. It may also change the status to `requires_action` if any actions + are required. x-authenticated: true externalDocs: description: Fulfill a claim diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel.yaml index a7c6deac1e..211fd8723f 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel.yaml @@ -1,7 +1,9 @@ post: operationId: PostOrdersClaimFulfillmentsCancel summary: Cancel Claim's Fulfillment - description: Cancel a claim's fulfillment and change its status. + description: >- + Cancel a claim's fulfillment and change its fulfillment status to + `canceled`. x-authenticated: true parameters: - in: path diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_claims_{claim_id}_shipments.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_claims_{claim_id}_shipments.yaml index 682e8f004b..bcf12abcfe 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_claims_{claim_id}_shipments.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_claims_{claim_id}_shipments.yaml @@ -2,9 +2,9 @@ post: operationId: PostOrdersOrderClaimsClaimShipments summary: Ship a Claim's Fulfillment description: >- - Mark a claim's fulfillment as shipped. This changes the claim's fulfillment - status to either `shipped` or `partially_shipped`, depending on whether all - the items were shipped. + Create a shipment for the claim and mark its fulfillment as shipped. This + changes the claim's fulfillment status to either `partially_shipped` or + `shipped`, depending on whether all the items were shipped. x-authenticated: true externalDocs: description: Fulfill a claim diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillment.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillment.yaml index c47e90219c..780fe5c489 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillment.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillment.yaml @@ -1,7 +1,10 @@ post: operationId: PostOrdersOrderFulfillments summary: Create a Fulfillment - description: Create a Fulfillment of an Order using the fulfillment provider. + description: >- + Create a Fulfillment of an Order using the fulfillment provider, and change + the order's fulfillment status to either `partially_fulfilled` or + `fulfilled`, depending on whether all the items were fulfilled. x-authenticated: true externalDocs: description: Fulfillments of orders diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml index 74f0e20f75..f7cdd71af4 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml @@ -1,7 +1,9 @@ post: operationId: PostOrdersOrderFulfillmentsCancel summary: Cancel a Fulfilmment - description: Cancel an order's fulfillment and change its status. + description: >- + Cancel an order's fulfillment and change its fulfillment status to + `canceled`. x-authenticated: true parameters: - in: path diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_shipment.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_shipment.yaml index 0df2907f73..1643e0de78 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_shipment.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_shipment.yaml @@ -2,9 +2,9 @@ post: operationId: PostOrdersOrderShipment summary: Ship a Fulfillment description: >- - Mark a fulfillment as shipped. This changes the order's fulfillment status - to either `shipped` or `partially_shipped`, depending on whether all the - items were shipped. + Create a shipment and mark a fulfillment as shipped. This changes the + order's fulfillment status to either `partially_shipped` or `shipped`, + depending on whether all the items were shipped. x-authenticated: true externalDocs: description: Fulfillments of orders diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_shipping-methods.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_shipping-methods.yaml index 7c6d1013c7..2cc7add549 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_shipping-methods.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_shipping-methods.yaml @@ -2,7 +2,7 @@ post: operationId: PostOrdersOrderShippingMethods summary: Add a Shipping Method description: >- - Adds a Shipping Method to an Order. If another Shipping Method exists with + Add a Shipping Method to an Order. If another Shipping Method exists with the same Shipping Profile, the previous Shipping Method will be replaced. parameters: - in: path diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_swaps_{swap_id}_fulfillments.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_swaps_{swap_id}_fulfillments.yaml index 26e0620662..7744bb6576 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_swaps_{swap_id}_fulfillments.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_swaps_{swap_id}_fulfillments.yaml @@ -1,7 +1,10 @@ post: operationId: PostOrdersOrderSwapsSwapFulfillments summary: Create a Swap Fulfillment - description: Create a Fulfillment for a Swap. + description: >- + Create a Fulfillment for a Swap and change its fulfillment status to + `fulfilled`. If it requires any additional actions, its fulfillment status + may change to `requires_action`. x-authenticated: true externalDocs: description: Handling a swap's fulfillment diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel.yaml index 85827c0604..86fb0d493b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel.yaml @@ -1,7 +1,7 @@ post: operationId: PostOrdersSwapFulfillmentsCancel summary: Cancel Swap's Fulfilmment - description: Cancel a swap's fulfillment and change its status. + description: Cancel a swap's fulfillment and change its fulfillment status to `canceled`. x-authenticated: true parameters: - in: path diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_swaps_{swap_id}_shipments.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_swaps_{swap_id}_shipments.yaml index 7049d3c282..a4e97a836e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_swaps_{swap_id}_shipments.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_swaps_{swap_id}_shipments.yaml @@ -2,9 +2,9 @@ post: operationId: PostOrdersOrderSwapsSwapShipments summary: Ship a Swap's Fulfillment description: >- - RMark a swap's fulfillment as shipped. This changes the swap's fulfillment - status to either `shipped` or `partially_shipped`, depending on whether all - the items were shipped. + Create a shipment for a swap and mark its fulfillment as shipped. This + changes the swap's fulfillment status to either `partially_shipped` or + `shipped`, depending on whether all the items were shipped. x-authenticated: true externalDocs: description: Handling swap fulfillments diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_prices_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_prices_batch.yaml index 9b8bf480ae..eafa65d63f 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_prices_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_prices_batch.yaml @@ -1,7 +1,7 @@ post: operationId: PostPriceListsPriceListPricesBatch summary: Add or Update Prices - description: Add or update a list of prices in a Price List + description: Add or update a list of prices in a Price List. x-authenticated: true parameters: - in: path diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_variants_{variant_id}_prices.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_variants_{variant_id}_prices.yaml index 70a1f461b4..cd4a364cc9 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_variants_{variant_id}_prices.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_variants_{variant_id}_prices.yaml @@ -1,7 +1,7 @@ delete: operationId: DeletePriceListsPriceListVariantsVariantPrices summary: Delete a Variant's Prices - description: Delete all the prices related to a specific variant in a price list + description: Delete all the prices related to a specific variant in a price list. x-authenticated: true parameters: - in: path diff --git a/www/apps/api-reference/specs/admin/paths/admin_publishable-api-keys.yaml b/www/apps/api-reference/specs/admin/paths/admin_publishable-api-keys.yaml index c1e0b0be90..34ec723386 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_publishable-api-keys.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_publishable-api-keys.yaml @@ -80,7 +80,7 @@ get: post: operationId: PostPublishableApiKeys summary: Create Publishable API Key - description: Creates a Publishable API Key. + description: Create a Publishable API Key. requestBody: content: application/json: diff --git a/www/apps/api-reference/specs/admin/paths/admin_publishable-api-keys_{id}_sales-channels_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_publishable-api-keys_{id}_sales-channels_batch.yaml index 3249e9595e..c909368259 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_publishable-api-keys_{id}_sales-channels_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_publishable-api-keys_{id}_sales-channels_batch.yaml @@ -1,7 +1,7 @@ post: operationId: PostPublishableApiKeySalesChannelsChannelsBatch summary: Add Sales Channels - description: Assign a list of sales channels to a publishable API key. + description: Add a list of sales channels to a publishable API key. x-authenticated: true parameters: - in: path diff --git a/www/apps/api-reference/specs/admin/paths/admin_regions.yaml b/www/apps/api-reference/specs/admin/paths/admin_regions.yaml index baafe6b2be..fbbe631664 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_regions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_regions.yaml @@ -3,7 +3,7 @@ get: summary: List Regions description: >- Retrieve a list of Regions. The regions can be filtered by fields such as - `created_at`. The regions can also be paginated + `created_at`. The regions can also be paginated. x-authenticated: true parameters: - in: query diff --git a/www/apps/api-reference/specs/admin/paths/admin_regions_{id}_countries.yaml b/www/apps/api-reference/specs/admin/paths/admin_regions_{id}_countries.yaml index ca15c4b9bb..94441efa6a 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_regions_{id}_countries.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_regions_{id}_countries.yaml @@ -1,7 +1,7 @@ post: operationId: PostRegionsRegionCountries summary: Add Country - description: Add a Country to the list of Countries in a Region + description: Add a Country to the list of Countries in a Region. x-authenticated: true parameters: - in: path diff --git a/www/apps/api-reference/specs/admin/paths/admin_reservations_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_reservations_{id}.yaml index b6311e1b20..29c6ea2f43 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_reservations_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_reservations_{id}.yaml @@ -1,7 +1,7 @@ get: operationId: GetReservationsReservation summary: Get a Reservation - description: Retrieve a reservation's details.' + description: Retrieve a reservation's details. x-authenticated: true parameters: - in: path @@ -47,7 +47,7 @@ get: post: operationId: PostReservationsReservation summary: Update a Reservation - description: Update a Reservation's details.' + description: Update a Reservation's details. x-authenticated: true parameters: - in: path diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_product-types_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_product-types_batch.yaml index 512607f594..ceb2f01cf0 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_product-types_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_product-types_batch.yaml @@ -1,7 +1,7 @@ post: operationId: PostTaxRatesTaxRateProductTypes summary: Add to Product Types - description: Associates a Tax Rate with a list of Product Types + description: Add Product Types to a Tax Rate. parameters: - in: path name: id diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_products_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_products_batch.yaml index 9139d2bd59..ae9e5af20e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_products_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_products_batch.yaml @@ -1,7 +1,7 @@ post: operationId: PostTaxRatesTaxRateProducts summary: Add to Products - description: Associates a Tax Rate with a list of Products. + description: Add products to a tax rate. parameters: - in: path name: id diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_shipping-options_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_shipping-options_batch.yaml index dd01164001..bc72d985e4 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_shipping-options_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_shipping-options_batch.yaml @@ -1,7 +1,7 @@ post: operationId: PostTaxRatesTaxRateShippingOptions summary: Add to Shipping Options - description: Associates a Tax Rate with a list of Shipping Options. + description: Add Shipping Options to a Tax Rate. parameters: - in: path name: id diff --git a/www/apps/api-reference/specs/admin/paths/admin_users_password-token.yaml b/www/apps/api-reference/specs/admin/paths/admin_users_password-token.yaml index fae5a7fa3b..e52047fd49 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_users_password-token.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_users_password-token.yaml @@ -1,7 +1,15 @@ post: operationId: PostUsersUserPasswordToken summary: Request Password Reset - description: Generate a password token for an admin user with a given email. + description: >- + Generate a password token for an admin user with a given email. This also + triggers the `user.password_reset` event. So, if you have a Notification + Service installed that can handle this event, a notification, such as an + email, will be sent to the user. The token is triggered as part of the + `user.password_reset` event's payload. That token must be used later to + reset the password using the [Reset + Password](https://docs.medusajs.com/api/admin#users_postusersuserpassword) + API Route. externalDocs: description: How to reset a user's password url: >- diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_auth/delete.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_auth/delete.js new file mode 100644 index 0000000000..57c19c98ad --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_auth/delete.js @@ -0,0 +1,6 @@ +import Medusa from "@medusajs/medusa-js" +const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) +medusa.auth.deleteSession() +.then(() => { + // customer logged out successfully +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_auth/get.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_auth/get.js index 0c21313927..6af347259c 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_auth/get.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_auth/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.auth.getSession() .then(({ customer }) => { console.log(customer.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_auth/post.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_auth/post.js index 2ca0af88ac..0e7c68a624 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_auth/post.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_auth/post.js @@ -6,4 +6,4 @@ medusa.auth.authenticate({ }) .then(({ customer }) => { console.log(customer.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_auth_token/post.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_auth_token/post.js index 67972b7404..20dc73ca00 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_auth_token/post.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_auth_token/post.js @@ -6,4 +6,4 @@ medusa.auth.getToken({ }) .then(({ access_token }) => { console.log(access_token); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts/post.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts/post.js index 2c436be865..9024defc29 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts/post.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts/post.js @@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.carts.create() .then(({ cart }) => { console.log(cart.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}/get.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}/get.js index 139cbed7f7..69ada822d3 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}/get.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}/get.js @@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.carts.retrieve(cartId) .then(({ cart }) => { console.log(cart.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}/post.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}/post.js index 9884d7fa2c..ec553a1c5c 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}/post.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}/post.js @@ -5,4 +5,4 @@ medusa.carts.update(cartId, { }) .then(({ cart }) => { console.log(cart.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_complete/post.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_complete/post.js index 5b48e36b7e..c146a2a6c1 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_complete/post.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_complete/post.js @@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.carts.complete(cartId) .then(({ cart }) => { console.log(cart.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_discounts_{code}/delete.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_discounts_{code}/delete.js index f007cd25ee..aa52289e46 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_discounts_{code}/delete.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_discounts_{code}/delete.js @@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.carts.deleteDiscount(cartId, code) .then(({ cart }) => { console.log(cart.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_line-items/post.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_line-items/post.js index 094d7dbd04..cd32dd64ad 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_line-items/post.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_line-items/post.js @@ -6,4 +6,4 @@ medusa.carts.lineItems.create(cart_id, { }) .then(({ cart }) => { console.log(cart.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_line-items_{line_id}/delete.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_line-items_{line_id}/delete.js index 4facbcb7e4..574a156c07 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_line-items_{line_id}/delete.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_line-items_{line_id}/delete.js @@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.carts.lineItems.delete(cartId, lineId) .then(({ cart }) => { console.log(cart.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_line-items_{line_id}/post.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_line-items_{line_id}/post.js index ea73b56540..4a48648faf 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_line-items_{line_id}/post.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_line-items_{line_id}/post.js @@ -5,4 +5,4 @@ medusa.carts.lineItems.update(cartId, lineId, { }) .then(({ cart }) => { console.log(cart.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_payment-session/post.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_payment-session/post.js index 51080a095f..092175fa75 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_payment-session/post.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_payment-session/post.js @@ -5,4 +5,4 @@ medusa.carts.setPaymentSession(cartId, { }) .then(({ cart }) => { console.log(cart.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_payment-sessions/post.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_payment-sessions/post.js index 1fd399dc05..04f47612d5 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_payment-sessions/post.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_payment-sessions/post.js @@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.carts.createPaymentSessions(cartId) .then(({ cart }) => { console.log(cart.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_payment-sessions_{provider_id}/delete.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_payment-sessions_{provider_id}/delete.js index 3051206af2..d943b70afe 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_payment-sessions_{provider_id}/delete.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_payment-sessions_{provider_id}/delete.js @@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.carts.deletePaymentSession(cartId, "manual") .then(({ cart }) => { console.log(cart.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_payment-sessions_{provider_id}/post.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_payment-sessions_{provider_id}/post.js index 71ad429b17..47742d12c2 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_payment-sessions_{provider_id}/post.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_payment-sessions_{provider_id}/post.js @@ -7,4 +7,4 @@ medusa.carts.updatePaymentSession(cartId, "manual", { }) .then(({ cart }) => { console.log(cart.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_payment-sessions_{provider_id}_refresh/post.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_payment-sessions_{provider_id}_refresh/post.js index 7724a62f85..a6e94cbd04 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_payment-sessions_{provider_id}_refresh/post.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_payment-sessions_{provider_id}_refresh/post.js @@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.carts.refreshPaymentSession(cartId, "manual") .then(({ cart }) => { console.log(cart.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_shipping-methods/post.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_shipping-methods/post.js index f79b14bf7a..97ea371adf 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_shipping-methods/post.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_carts_{id}_shipping-methods/post.js @@ -5,4 +5,4 @@ medusa.carts.addShippingMethod(cartId, { }) .then(({ cart }) => { console.log(cart.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_collections/get.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_collections/get.js index 9b59fa07a1..bac19e5f96 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_collections/get.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_collections/get.js @@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.collections.list() .then(({ collections, limit, offset, count }) => { console.log(collections.length); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_collections_{id}/get.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_collections_{id}/get.js index 3eacf7cb2f..da1058fcc8 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_collections_{id}/get.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_collections_{id}/get.js @@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.collections.retrieve(collectionId) .then(({ collection }) => { console.log(collection.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers/post.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers/post.js index 36ac0280c8..e3a8ed6cfb 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers/post.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers/post.js @@ -8,4 +8,4 @@ medusa.customers.create({ }) .then(({ customer }) => { console.log(customer.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_me/get.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_me/get.js index eddbee9d38..0074f411fd 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_me/get.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_me/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.customers.retrieve() .then(({ customer }) => { console.log(customer.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_me/post.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_me/post.js index 5008f75361..e37d3a0676 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_me/post.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_me/post.js @@ -6,4 +6,4 @@ medusa.customers.update({ }) .then(({ customer }) => { console.log(customer.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_me_addresses/post.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_me_addresses/post.js index 5663839ac2..8530ec651e 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_me_addresses/post.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_me_addresses/post.js @@ -16,4 +16,4 @@ medusa.customers.addresses.addAddress({ }) .then(({ customer }) => { console.log(customer.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_me_addresses_{address_id}/delete.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_me_addresses_{address_id}/delete.js index 733b07ba54..1b24012605 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_me_addresses_{address_id}/delete.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_me_addresses_{address_id}/delete.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.customers.addresses.deleteAddress(addressId) .then(({ customer }) => { console.log(customer.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_me_addresses_{address_id}/post.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_me_addresses_{address_id}/post.js index 838712aee1..265f70ba62 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_me_addresses_{address_id}/post.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_me_addresses_{address_id}/post.js @@ -6,4 +6,4 @@ medusa.customers.addresses.updateAddress(addressId, { }) .then(({ customer }) => { console.log(customer.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_me_orders/get.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_me_orders/get.js index 1261f01cd2..9fc4bda68d 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_me_orders/get.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_me_orders/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.customers.listOrders() .then(({ orders, limit, offset, count }) => { console.log(orders); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_me_payment-methods/get.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_me_payment-methods/get.js index aab15b677f..f8a9fab751 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_me_payment-methods/get.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_me_payment-methods/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.customers.paymentMethods.list() .then(({ payment_methods }) => { console.log(payment_methods.length); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_password-reset/post.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_password-reset/post.js index 62118381a1..2a09881c00 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_password-reset/post.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_customers_password-reset/post.js @@ -7,4 +7,4 @@ medusa.customers.resetPassword({ }) .then(({ customer }) => { console.log(customer.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_gift-cards_{code}/get.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_gift-cards_{code}/get.js index 32ce72e3e2..699716e7f2 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_gift-cards_{code}/get.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_gift-cards_{code}/get.js @@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.giftCards.retrieve(code) .then(({ gift_card }) => { console.log(gift_card.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_order-edits_{id}/get.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_order-edits_{id}/get.js index c87462c010..3000f48539 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_order-edits_{id}/get.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_order-edits_{id}/get.js @@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.orderEdits.retrieve(orderEditId) .then(({ order_edit }) => { console.log(order_edit.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_order-edits_{id}_complete/post.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_order-edits_{id}_complete/post.js index e675dc9bf0..ffe9b8856a 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_order-edits_{id}_complete/post.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_order-edits_{id}_complete/post.js @@ -1,6 +1,6 @@ import Medusa from "@medusajs/medusa-js" const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.orderEdits.complete(orderEditId) - .then(({ order_edit }) => { - console.log(order_edit.id) - }) +.then(({ order_edit }) => { + console.log(order_edit.id) +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_order-edits_{id}_decline/post.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_order-edits_{id}_decline/post.js index 982a69fa63..0da8cade93 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_order-edits_{id}_decline/post.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_order-edits_{id}_decline/post.js @@ -1,6 +1,6 @@ import Medusa from "@medusajs/medusa-js" const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.orderEdits.decline(orderEditId) - .then(({ order_edit }) => { - console.log(order_edit.id); - }) +.then(({ order_edit }) => { + console.log(order_edit.id); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_orders/get.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_orders/get.js index 752d402f6a..21e2d24916 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_orders/get.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_orders/get.js @@ -6,4 +6,4 @@ medusa.orders.lookupOrder({ }) .then(({ order }) => { console.log(order.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_orders_batch_customer_token/post.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_orders_batch_customer_token/post.js index 3e6f7f187a..961a68b881 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_orders_batch_customer_token/post.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_orders_batch_customer_token/post.js @@ -9,4 +9,4 @@ medusa.orders.requestCustomerOrders({ }) .catch(() => { // an error occurred -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_orders_cart_{cart_id}/get.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_orders_cart_{cart_id}/get.js index 2b3a951751..52f1632cee 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_orders_cart_{cart_id}/get.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_orders_cart_{cart_id}/get.js @@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.orders.retrieveByCartId(cartId) .then(({ order }) => { console.log(order.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_orders_customer_confirm/post.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_orders_customer_confirm/post.js index 10c39a00a1..b8d4a495fd 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_orders_customer_confirm/post.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_orders_customer_confirm/post.js @@ -9,4 +9,4 @@ medusa.orders.confirmRequest( }) .catch(() => { // an error occurred -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_orders_{id}/get.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_orders_{id}/get.js index 9d6d19410a..d71044e4bd 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_orders_{id}/get.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_orders_{id}/get.js @@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.orders.retrieve(orderId) .then(({ order }) => { console.log(order.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_payment-collections_{id}/get.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_payment-collections_{id}/get.js index 8a6b688942..d0ea61ee9a 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_payment-collections_{id}/get.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_payment-collections_{id}/get.js @@ -2,6 +2,6 @@ import Medusa from "@medusajs/medusa-js" const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) // must be previously logged in or use api token medusa.paymentCollections.retrieve(paymentCollectionId) - .then(({ payment_collection }) => { - console.log(payment_collection.id) - }) +.then(({ payment_collection }) => { + console.log(payment_collection.id) +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_payment-collections_{id}_sessions/post.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_payment-collections_{id}_sessions/post.js index 1c3b157a61..af30eb8c00 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_payment-collections_{id}_sessions/post.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_payment-collections_{id}_sessions/post.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.paymentCollections.managePaymentSession(payment_id, { provider_id: "stripe" }) .then(({ payment_collection }) => { console.log(payment_collection.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_payment-collections_{id}_sessions_batch/post.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_payment-collections_{id}_sessions_batch/post.js index 4a653c973e..47433b822e 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_payment-collections_{id}_sessions_batch/post.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_payment-collections_{id}_sessions_batch/post.js @@ -19,7 +19,7 @@ medusa.paymentCollections.managePaymentSessionsBatch(paymentId, { }) .then(({ payment_collection }) => { console.log(payment_collection.id); -}); +}) // Example 2: Updating one session and removing the other medusa.paymentCollections.managePaymentSessionsBatch(paymentId, { @@ -33,4 +33,4 @@ medusa.paymentCollections.managePaymentSessionsBatch(paymentId, { }) .then(({ payment_collection }) => { console.log(payment_collection.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_payment-collections_{id}_sessions_batch_authorize/post.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_payment-collections_{id}_sessions_batch_authorize/post.js index 3de81243e0..75c2b76bd4 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_payment-collections_{id}_sessions_batch_authorize/post.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_payment-collections_{id}_sessions_batch_authorize/post.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.paymentCollections.authorize(paymentId) .then(({ payment_collection }) => { console.log(payment_collection.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_payment-collections_{id}_sessions_{session_id}/post.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_payment-collections_{id}_sessions_{session_id}/post.js index 88bffc5121..ac448401c8 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_payment-collections_{id}_sessions_{session_id}/post.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_payment-collections_{id}_sessions_{session_id}/post.js @@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.paymentCollections.refreshPaymentSession(paymentCollectionId, sessionId) .then(({ payment_session }) => { console.log(payment_session.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_payment-collections_{id}_sessions_{session_id}_authorize/post.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_payment-collections_{id}_sessions_{session_id}_authorize/post.js index 64de9d34fb..0f8f404651 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_payment-collections_{id}_sessions_{session_id}_authorize/post.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_payment-collections_{id}_sessions_{session_id}_authorize/post.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.paymentCollections.authorize(paymentId, sessionId) .then(({ payment_collection }) => { console.log(payment_collection.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_product-categories/get.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_product-categories/get.js index 1640c466e4..209e588278 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_product-categories/get.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_product-categories/get.js @@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.productCategories.list() .then(({ product_categories, limit, offset, count }) => { console.log(product_categories.length); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_product-categories_{id}/get.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_product-categories_{id}/get.js index c2ed536dfe..f9f29cb332 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_product-categories_{id}/get.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_product-categories_{id}/get.js @@ -2,6 +2,6 @@ import Medusa from "@medusajs/medusa-js" const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) // must be previously logged in or use api token medusa.productCategories.retrieve(productCategoryId) - .then(({ product_category }) => { - console.log(product_category.id); - }); +.then(({ product_category }) => { + console.log(product_category.id); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_product-tags/get.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_product-tags/get.js index 4cb9290fe8..1eb88b7e7b 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_product-tags/get.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_product-tags/get.js @@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.productTags.list() .then(({ product_tags }) => { console.log(product_tags.length); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_product-types/get.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_product-types/get.js index 448cefcb2a..c743a2291c 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_product-types/get.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_product-types/get.js @@ -4,4 +4,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.productTypes.list() .then(({ product_types }) => { console.log(product_types.length); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_products/get.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_products/get.js index 8b497d740a..596abe3f0e 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_products/get.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_products/get.js @@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.products.list() .then(({ products, limit, offset, count }) => { console.log(products.length); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_products_search/post.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_products_search/post.js index 4b261f2535..bfdccf1e16 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_products_search/post.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_products_search/post.js @@ -5,4 +5,4 @@ medusa.products.search({ }) .then(({ hits }) => { console.log(hits.length); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_products_{id}/get.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_products_{id}/get.js index bf85f9521c..54c51f2c72 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_products_{id}/get.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_products_{id}/get.js @@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.products.retrieve(productId) .then(({ product }) => { console.log(product.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_regions/get.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_regions/get.js index 80c115fa9f..7880325269 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_regions/get.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_regions/get.js @@ -1,6 +1,6 @@ import Medusa from "@medusajs/medusa-js" const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.regions.list() -.then(({ regions }) => { +.then(({ regions, count, limit, offset }) => { console.log(regions.length); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_regions_{id}/get.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_regions_{id}/get.js index 699aa67088..534cf52c6b 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_regions_{id}/get.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_regions_{id}/get.js @@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.regions.retrieve(regionId) .then(({ region }) => { console.log(region.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_return-reasons/get.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_return-reasons/get.js index 35c674e9a7..28796b8688 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_return-reasons/get.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_return-reasons/get.js @@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.returnReasons.list() .then(({ return_reasons }) => { console.log(return_reasons.length); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_return-reasons_{id}/get.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_return-reasons_{id}/get.js index 123e755c02..2cfe70cf1b 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_return-reasons_{id}/get.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_return-reasons_{id}/get.js @@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.returnReasons.retrieve(reasonId) .then(({ return_reason }) => { console.log(return_reason.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_returns/post.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_returns/post.js index 3f88229f0d..d74df1284b 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_returns/post.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_returns/post.js @@ -11,4 +11,4 @@ medusa.returns.create({ }) .then((data) => { console.log(data.return.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_shipping-options/get.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_shipping-options/get.js index d2230ea4fc..58d3105cf8 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_shipping-options/get.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_shipping-options/get.js @@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.shippingOptions.list() .then(({ shipping_options }) => { console.log(shipping_options.length); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_shipping-options_{cart_id}/get.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_shipping-options_{cart_id}/get.js index dbb08d94ef..9fa3a08540 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_shipping-options_{cart_id}/get.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_shipping-options_{cart_id}/get.js @@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.shippingOptions.listCartOptions(cartId) .then(({ shipping_options }) => { console.log(shipping_options.length); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_swaps/post.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_swaps/post.js index 8bb8aacc34..422457df9f 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_swaps/post.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_swaps/post.js @@ -17,4 +17,4 @@ medusa.swaps.create({ }) .then(({ swap }) => { console.log(swap.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_swaps_{cart_id}/get.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_swaps_{cart_id}/get.js index e0eec5b76c..6f1dd1d3a5 100644 --- a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_swaps_{cart_id}/get.js +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_swaps_{cart_id}/get.js @@ -3,4 +3,4 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) medusa.swaps.retrieveByCartId(cartId) .then(({ swap }) => { console.log(swap.id); -}); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_variants/get.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_variants/get.js new file mode 100644 index 0000000000..3eff911a1a --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_variants/get.js @@ -0,0 +1,7 @@ +import Medusa from "@medusajs/medusa-js" +const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) +// must be previously logged in or use api token +medusa.product.variants.list() +.then(({ variants }) => { + console.log(variants.length); +}) diff --git a/www/apps/api-reference/specs/store/code_samples/JavaScript/store_variants_{id}/get.js b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_variants_{id}/get.js new file mode 100644 index 0000000000..22555a6a1e --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/JavaScript/store_variants_{id}/get.js @@ -0,0 +1,7 @@ +import Medusa from "@medusajs/medusa-js" +const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) +// must be previously logged in or use api token +medusa.product.variants.retrieve(productVariantId) +.then(({ variant }) => { + console.log(variant.id); +}) diff --git a/www/apps/api-reference/specs/store/components/schemas/AddressPayload.yaml b/www/apps/api-reference/specs/store/components/schemas/AddressPayload.yaml index 89fa9ff576..826bf11526 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AddressPayload.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AddressPayload.yaml @@ -15,6 +15,7 @@ properties: example: 16128234334802 company: type: string + description: Company address_1: description: Address line 1 type: string diff --git a/www/apps/api-reference/specs/store/components/schemas/ExtendedStoreDTO.yaml b/www/apps/api-reference/specs/store/components/schemas/ExtendedStoreDTO.yaml index af6132c641..fe169bafc5 100644 --- a/www/apps/api-reference/specs/store/components/schemas/ExtendedStoreDTO.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/ExtendedStoreDTO.yaml @@ -8,10 +8,14 @@ allOf: - modules properties: payment_providers: + description: The store's payment providers. $ref: ./PaymentProvider.yaml fulfillment_providers: + description: The store's fulfillment providers. $ref: ./FulfillmentProvider.yaml feature_flags: + description: The feature flags enabled in the store's backend. $ref: ./FeatureFlagsResponse.yaml modules: + description: The modules installed in the store's backend. $ref: ./ModulesResponse.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/InventoryItemDTO.yaml b/www/apps/api-reference/specs/store/components/schemas/InventoryItemDTO.yaml index 9fccc01512..641ec3a26f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/InventoryItemDTO.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/InventoryItemDTO.yaml @@ -2,6 +2,10 @@ type: object required: - sku properties: + id: + description: The inventory item's ID. + type: string + example: iitem_12334 sku: description: The Stock Keeping Unit (SKU) code of the Inventory Item. type: string diff --git a/www/apps/api-reference/specs/store/components/schemas/PaymentCollection.yaml b/www/apps/api-reference/specs/store/components/schemas/PaymentCollection.yaml index c41fe34593..4c8342dae9 100644 --- a/www/apps/api-reference/specs/store/components/schemas/PaymentCollection.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/PaymentCollection.yaml @@ -59,7 +59,7 @@ properties: $ref: ./Region.yaml currency_code: description: >- - The 3 character ISO code for the currency this payment collection is + The three character ISO code for the currency this payment collection is associated with. type: string example: usd diff --git a/www/apps/api-reference/specs/store/components/schemas/PricedProduct.yaml b/www/apps/api-reference/specs/store/components/schemas/PricedProduct.yaml index 6054bb7d16..aa57632b38 100644 --- a/www/apps/api-reference/specs/store/components/schemas/PricedProduct.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/PricedProduct.yaml @@ -5,6 +5,7 @@ allOf: - type: object properties: variants: + description: The product variants and their prices. type: array items: $ref: ./PricedVariant.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/ProductCategory.yaml b/www/apps/api-reference/specs/store/components/schemas/ProductCategory.yaml index b4acd30f4e..e49782d700 100644 --- a/www/apps/api-reference/specs/store/components/schemas/ProductCategory.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/ProductCategory.yaml @@ -25,6 +25,10 @@ properties: description: The product category's name type: string example: Regular Fit + description: + description: The product category's description. + type: string + default: '' handle: description: >- A unique string that identifies the Product Category - can for example be diff --git a/www/apps/api-reference/specs/store/components/schemas/Region.yaml b/www/apps/api-reference/specs/store/components/schemas/Region.yaml index 2e19d39db4..b9f3b0c9e3 100644 --- a/www/apps/api-reference/specs/store/components/schemas/Region.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/Region.yaml @@ -30,7 +30,7 @@ properties: type: string example: EU currency_code: - description: The 3 character currency code used in the region. + description: The three character currency code used in the region. type: string example: usd externalDocs: diff --git a/www/apps/api-reference/specs/store/components/schemas/StockLocationExpandedDTO.yaml b/www/apps/api-reference/specs/store/components/schemas/StockLocationExpandedDTO.yaml index e2d6b28a56..993fad1ca8 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StockLocationExpandedDTO.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StockLocationExpandedDTO.yaml @@ -3,4 +3,5 @@ allOf: - type: object properties: sales_channels: + description: The associated sales channels. $ref: ./SalesChannel.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/Store.yaml b/www/apps/api-reference/specs/store/components/schemas/Store.yaml index 3a79d6301a..e1331293bc 100644 --- a/www/apps/api-reference/specs/store/components/schemas/Store.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/Store.yaml @@ -24,8 +24,9 @@ properties: description: The name of the Store - this may be displayed to the Customer. type: string example: Medusa Store + default: Medusa Store default_currency_code: - description: The 3 character currency code that is the default of the store. + description: The three character currency code that is the default of the store. type: string example: usd externalDocs: @@ -34,6 +35,7 @@ properties: default_currency: description: The details of the store's default currency. x-expandable: default_currency + default: usd nullable: true $ref: ./Currency.yaml currencies: diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreAuthRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreAuthRes.yaml index 2d0677080d..a07910fbbc 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreAuthRes.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreAuthRes.yaml @@ -1,4 +1,5 @@ type: object +description: The customer's details. x-expanded-relations: field: customer relations: diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreBearerAuthRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreBearerAuthRes.yaml index 096d46cc6b..f234f6150f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreBearerAuthRes.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreBearerAuthRes.yaml @@ -1,4 +1,5 @@ type: object +description: The access token details. properties: access_token: description: Access token that can be used to send authenticated requests. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCartsRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCartsRes.yaml index b3f5bd7488..e81dfd2e6e 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCartsRes.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCartsRes.yaml @@ -1,4 +1,5 @@ type: object +description: The cart's details. x-expanded-relations: field: cart relations: diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCollectionsListRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCollectionsListRes.yaml index 73b8557c45..6368865422 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCollectionsListRes.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCollectionsListRes.yaml @@ -1,4 +1,5 @@ type: object +description: The list of product collections with pagination fields. required: - collections - count diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCollectionsRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCollectionsRes.yaml index f5e0d5b0f2..484b75525d 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCollectionsRes.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCollectionsRes.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the product collection. required: - collection properties: diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCompleteCartRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCompleteCartRes.yaml index 0624fa5271..6071a8d0e0 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCompleteCartRes.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCompleteCartRes.yaml @@ -1,4 +1,8 @@ type: object +description: >- + If the cart is completed successfully, this will have the created order or the + swap's details, based on the cart's type. Otherwise, it'll be the cart's + details. required: - type - data diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCustomersListOrdersRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCustomersListOrdersRes.yaml index 24a102a92c..3bc36a35c4 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCustomersListOrdersRes.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCustomersListOrdersRes.yaml @@ -1,4 +1,5 @@ type: object +description: The list of the customer's orders with pagination fields. x-expanded-relations: field: orders relations: diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCustomersListPaymentMethodsRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCustomersListPaymentMethodsRes.yaml index 6a25bc8a68..18dde4fd55 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCustomersListPaymentMethodsRes.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCustomersListPaymentMethodsRes.yaml @@ -1,10 +1,11 @@ type: object +description: The payment method's details. required: - payment_methods properties: payment_methods: type: array - description: An array of saved payment method details. + description: The details of the saved payment methods. items: type: object required: diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCustomersRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCustomersRes.yaml index a98b41e268..8c488986d3 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCustomersRes.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCustomersRes.yaml @@ -1,4 +1,5 @@ type: object +description: The customer's details. x-expanded-relations: field: customer relations: diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreGetAuthEmailRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreGetAuthEmailRes.yaml index 6e24297835..5284fceda8 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreGetAuthEmailRes.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreGetAuthEmailRes.yaml @@ -1,4 +1,5 @@ type: object +description: Details on whether the email exists. required: - exists properties: diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreGetProductCategoriesCategoryRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreGetProductCategoriesCategoryRes.yaml index bc22b78246..65073b08a6 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreGetProductCategoriesCategoryRes.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreGetProductCategoriesCategoryRes.yaml @@ -1,4 +1,5 @@ type: object +description: The product category's details. x-expanded-relations: field: product_category relations: diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreGetProductCategoriesRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreGetProductCategoriesRes.yaml index 55c49a2d38..d48f936a44 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreGetProductCategoriesRes.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreGetProductCategoriesRes.yaml @@ -1,4 +1,5 @@ type: object +description: The list of product categories with pagination fields. x-expanded-relations: field: product_categories relations: diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreGiftCardsRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreGiftCardsRes.yaml index b089e39740..e6b9ca7155 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreGiftCardsRes.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreGiftCardsRes.yaml @@ -1,3 +1,4 @@ +description: The gift card's details. type: object required: - gift_card diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreOrderEditsRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreOrderEditsRes.yaml index 2ce8949be8..f979dc1cc6 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreOrderEditsRes.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreOrderEditsRes.yaml @@ -1,4 +1,5 @@ type: object +description: The order edit's details. x-expanded-relations: field: order_edit relations: diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreOrdersRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreOrdersRes.yaml index 37131a3f45..df86572f62 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreOrdersRes.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreOrdersRes.yaml @@ -1,4 +1,5 @@ type: object +description: The order's details. required: - order x-expanded-relations: diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollectionsRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollectionsRes.yaml index 892745b97b..d8184c614c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollectionsRes.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollectionsRes.yaml @@ -1,4 +1,5 @@ type: object +description: The payment collection's details. x-expanded-relations: field: payment_collection relations: diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostCartReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostCartReq.yaml index ed170c0acd..d362a3c156 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StorePostCartReq.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StorePostCartReq.yaml @@ -1,4 +1,5 @@ type: object +description: The details of the cart to be created. properties: region_id: type: string @@ -25,7 +26,7 @@ properties: country_code: type: string description: >- - The 2 character ISO country code to create the Cart in. Setting this + The two character ISO country code to create the Cart in. Setting this parameter will set the country code of the shipping address. externalDocs: url: >- diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostPaymentCollectionsBatchSessionsReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostPaymentCollectionsBatchSessionsReq.yaml index 358ccf173a..9a83dc0106 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StorePostPaymentCollectionsBatchSessionsReq.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StorePostPaymentCollectionsBatchSessionsReq.yaml @@ -4,8 +4,8 @@ required: properties: sessions: description: >- - An array of payment sessions related to the Payment Collection. Existing - sessions that are not added in this array will be deleted. + Payment sessions related to the Payment Collection. Existing sessions that + are not added in this array will be deleted. type: array items: type: object diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostSearchRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostSearchRes.yaml index 3c87ebc5ec..f689e858cd 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StorePostSearchRes.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StorePostSearchRes.yaml @@ -1,3 +1,4 @@ +description: The list of search results. allOf: - type: object required: diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProductTagsListRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProductTagsListRes.yaml index e25f98e822..1c6c262968 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreProductTagsListRes.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreProductTagsListRes.yaml @@ -1,4 +1,5 @@ type: object +description: The list of product tags with pagination fields. required: - product_tags - count diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProductsListRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProductsListRes.yaml index 6b7b2e1de6..8acc42fbd4 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreProductsListRes.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreProductsListRes.yaml @@ -1,4 +1,5 @@ type: object +description: The list of products with pagination fields. x-expanded-relations: field: products relations: diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreRegionsListRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreRegionsListRes.yaml index b08a1baa11..8c19a9ffc8 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreRegionsListRes.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreRegionsListRes.yaml @@ -1,4 +1,5 @@ type: object +description: The list of regions with pagination fields. x-expanded-relations: field: regions relations: diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreRegionsRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreRegionsRes.yaml index e905119273..5d89f837ee 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreRegionsRes.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreRegionsRes.yaml @@ -1,4 +1,5 @@ type: object +description: The region's details. x-expanded-relations: field: region relations: diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreReturnReasonsListRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreReturnReasonsListRes.yaml index 49723b49f7..a40b7de4ef 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreReturnReasonsListRes.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreReturnReasonsListRes.yaml @@ -1,4 +1,5 @@ type: object +description: The list of return reasons. x-expanded-relations: field: return_reasons relations: diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreReturnReasonsRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreReturnReasonsRes.yaml index 3612cfb1d7..74ce5c5d7d 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreReturnReasonsRes.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreReturnReasonsRes.yaml @@ -1,4 +1,5 @@ type: object +description: The return reason's details. x-expanded-relations: field: return_reason relations: diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreReturnsRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreReturnsRes.yaml index 80898a7a94..831aa95d7c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreReturnsRes.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreReturnsRes.yaml @@ -1,4 +1,5 @@ type: object +description: The return's details. x-expanded-relations: field: return relations: diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreShippingOptionsListRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreShippingOptionsListRes.yaml index 3c89434c3a..3e9f8e6139 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreShippingOptionsListRes.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreShippingOptionsListRes.yaml @@ -1,4 +1,5 @@ type: object +description: The list of shipping options. x-expanded-relations: field: shipping_options relations: diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreSwapsRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreSwapsRes.yaml index c5f516da65..2557a02fb8 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreSwapsRes.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreSwapsRes.yaml @@ -1,4 +1,5 @@ type: object +description: The swap's details. x-expanded-relations: field: swap relations: diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreVariantsListRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreVariantsListRes.yaml index 8dfeaf532f..92c48a7d66 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreVariantsListRes.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreVariantsListRes.yaml @@ -1,4 +1,5 @@ type: object +description: The list of product variants. x-expanded-relations: field: variants relations: diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreVariantsRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreVariantsRes.yaml index a786096a7d..0263244edd 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreVariantsRes.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreVariantsRes.yaml @@ -1,4 +1,5 @@ type: object +description: The product variant's details. x-expanded-relations: field: variant relations: diff --git a/www/apps/api-reference/specs/store/openapi.full.yaml b/www/apps/api-reference/specs/store/openapi.full.yaml index ea4a923270..2af55f852c 100644 --- a/www/apps/api-reference/specs/store/openapi.full.yaml +++ b/www/apps/api-reference/specs/store/openapi.full.yaml @@ -8,11 +8,11 @@ info: tags: - name: Auth description: > - Authentication API Routes allow customers to manage their session, such as - login or log out. + Authentication API Routes allow you to manage a customer's session, such + as login or log out. - When a customer is logged in, the cookie header is set indicating the - customer's login session. + You can send authenticated requests for a customer either using the Cookie + header or using the JWT Token. externalDocs: description: How to implement customer profiles in your storefront url: >- @@ -176,7 +176,7 @@ paths: .then(({ customer }) => { console.log(customer.id); - }); + }) - lang: Shell label: cURL source: | @@ -237,7 +237,7 @@ paths: .then(({ customer }) => { console.log(customer.id); - }); + }) - lang: Shell label: cURL source: | @@ -276,6 +276,19 @@ paths: x-codegen: method: deleteSession x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + medusa.auth.deleteSession() + + .then(() => { + // customer logged out successfully + }) - lang: Shell label: cURL source: | @@ -332,7 +345,7 @@ paths: .then(({ access_token }) => { console.log(access_token); - }); + }) - lang: Shell label: cURL source: | @@ -424,8 +437,8 @@ paths: customer changes their region. - If a customer is logged in, the cart's customer ID and email will - automatically be set. + If a customer is logged in, make sure to pass its ID or email within the + cart's details so that the cart is attached to the customer. requestBody: content: application/json: @@ -446,7 +459,7 @@ paths: .then(({ cart }) => { console.log(cart.id); - }); + }) - lang: Shell label: cURL source: | @@ -497,7 +510,7 @@ paths: .then(({ cart }) => { console.log(cart.id); - }); + }) - lang: Shell label: cURL source: | @@ -557,7 +570,7 @@ paths: .then(({ cart }) => { console.log(cart.id); - }); + }) - lang: Shell label: cURL source: | @@ -590,9 +603,8 @@ paths: summary: Complete a Cart operationId: PostCartsCartComplete description: > - Complete a cart and place an order or create a swap, based on what the - cart is created for. This includes attempting to authorize the cart's - payment. + Complete a cart and place an order or create a swap, based on the cart's + type. This includes attempting to authorize the cart's payment. If authorizing the payment requires more action, the cart will not be completed and the order will not be placed or the swap will not be @@ -633,7 +645,7 @@ paths: .then(({ cart }) => { console.log(cart.id); - }); + }) - lang: Shell label: cURL source: | @@ -669,8 +681,9 @@ paths: summary: Remove Discount description: >- Remove a Discount from a Cart. This only removes the application of the - discount, and not completely delete it. The totals will be re-calculated - and the payment sessions will be refreshed after the removal. + discount, and not completely deletes it. The totals will be + re-calculated and the payment sessions will be refreshed after the + removal. parameters: - in: path name: id @@ -699,7 +712,7 @@ paths: .then(({ cart }) => { console.log(cart.id); - }); + }) - lang: Shell label: cURL source: | @@ -760,7 +773,7 @@ paths: .then(({ cart }) => { console.log(cart.id); - }); + }) - lang: Shell label: cURL source: | @@ -829,7 +842,7 @@ paths: .then(({ cart }) => { console.log(cart.id); - }); + }) - lang: Shell label: cURL source: | @@ -891,7 +904,7 @@ paths: .then(({ cart }) => { console.log(cart.id); - }); + }) - lang: Shell label: cURL source: | @@ -952,7 +965,7 @@ paths: .then(({ cart }) => { console.log(cart.id); - }); + }) - lang: Shell label: cURL source: | @@ -986,7 +999,7 @@ paths: summary: Create Payment Sessions description: >- Create Payment Sessions for each of the available Payment Providers in - the Cart's Region. If there only one payment session is created, it will + the Cart's Region. If there's only one payment session created, it will be selected by default. The creation of the payment session uses the payment provider and may require sending requests to third-party services. @@ -1012,7 +1025,7 @@ paths: .then(({ cart }) => { console.log(cart.id); - }); + }) - lang: Shell label: cURL source: | @@ -1081,7 +1094,7 @@ paths: .then(({ cart }) => { console.log(cart.id); - }); + }) - lang: Shell label: cURL source: > @@ -1148,7 +1161,7 @@ paths: .then(({ cart }) => { console.log(cart.id); - }); + }) - lang: Shell label: cURL source: > @@ -1210,7 +1223,7 @@ paths: .then(({ cart }) => { console.log(cart.id); - }); + }) - lang: Shell label: cURL source: > @@ -1271,7 +1284,7 @@ paths: .then(({ cart }) => { console.log(cart.id); - }); + }) - lang: Shell label: cURL source: | @@ -1436,7 +1449,7 @@ paths: .then(({ collections, limit, offset, count }) => { console.log(collections.length); - }); + }) - lang: Shell label: cURL source: | @@ -1487,7 +1500,7 @@ paths: .then(({ collection }) => { console.log(collection.id); - }); + }) - lang: Shell label: cURL source: | @@ -1546,7 +1559,7 @@ paths: .then(({ customer }) => { console.log(customer.id); - }); + }) - lang: Shell label: cURL source: | @@ -1620,7 +1633,7 @@ paths: .then(({ customer }) => { console.log(customer.id); - }); + }) - lang: Shell label: cURL source: | @@ -1679,7 +1692,7 @@ paths: .then(({ customer }) => { console.log(customer.id); - }); + }) - lang: Shell label: cURL source: | @@ -1753,7 +1766,7 @@ paths: .then(({ customer }) => { console.log(customer.id); - }); + }) - lang: Shell label: cURL source: | @@ -1832,7 +1845,7 @@ paths: .then(({ customer }) => { console.log(customer.id); - }); + }) - lang: Shell label: cURL source: > @@ -1899,7 +1912,7 @@ paths: .then(({ customer }) => { console.log(customer.id); - }); + }) - lang: Shell label: cURL source: > @@ -2150,7 +2163,7 @@ paths: .then(({ orders, limit, offset, count }) => { console.log(orders); - }); + }) - lang: Shell label: cURL source: | @@ -2209,7 +2222,7 @@ paths: .then(({ payment_methods }) => { console.log(payment_methods.length); - }); + }) - lang: Shell label: cURL source: | @@ -2275,7 +2288,7 @@ paths: .then(({ customer }) => { console.log(customer.id); - }); + }) - lang: Shell label: cURL source: | @@ -2400,7 +2413,7 @@ paths: .then(({ gift_card }) => { console.log(gift_card.id); - }); + }) - lang: Shell label: cURL source: | @@ -2451,7 +2464,7 @@ paths: .then(({ order_edit }) => { console.log(order_edit.id); - }); + }) - lang: Shell label: cURL source: | @@ -2507,9 +2520,10 @@ paths: 3 }) medusa.orderEdits.complete(orderEditId) - .then(({ order_edit }) => { - console.log(order_edit.id) - }) + + .then(({ order_edit }) => { + console.log(order_edit.id) + }) - lang: Shell label: cURL source: | @@ -2562,9 +2576,10 @@ paths: 3 }) medusa.orderEdits.decline(orderEditId) - .then(({ order_edit }) => { - console.log(order_edit.id); - }) + + .then(({ order_edit }) => { + console.log(order_edit.id); + }) - lang: Shell label: cURL source: | @@ -2653,7 +2668,7 @@ paths: .then(({ order }) => { console.log(order.id); - }); + }) - lang: Shell label: cURL source: > @@ -2723,7 +2738,7 @@ paths: .catch(() => { // an error occurred - }); + }) - lang: Shell label: cURL source: | @@ -2782,7 +2797,7 @@ paths: .then(({ order }) => { console.log(order.id); - }); + }) - lang: Shell label: cURL source: | @@ -2845,7 +2860,7 @@ paths: .catch(() => { // an error occurred - }); + }) - lang: Shell label: cURL source: | @@ -2916,7 +2931,7 @@ paths: .then(({ order }) => { console.log(order.id); - }); + }) - lang: Shell label: cURL source: | @@ -2982,9 +2997,10 @@ paths: // must be previously logged in or use api token medusa.paymentCollections.retrieve(paymentCollectionId) - .then(({ payment_collection }) => { - console.log(payment_collection.id) - }) + + .then(({ payment_collection }) => { + console.log(payment_collection.id) + }) - lang: Shell label: cURL source: | @@ -3049,7 +3065,7 @@ paths: .then(({ payment_collection }) => { console.log(payment_collection.id); - }); + }) - lang: Shell label: cURL source: > @@ -3098,7 +3114,7 @@ paths: - in: path name: id required: true - description: The ID of the Payment Collections. + description: The ID of the Payment Collection. schema: type: string requestBody: @@ -3140,7 +3156,7 @@ paths: .then(({ payment_collection }) => { console.log(payment_collection.id); - }); + }) // Example 2: Updating one session and removing the other @@ -3157,7 +3173,7 @@ paths: .then(({ payment_collection }) => { console.log(payment_collection.id); - }); + }) - lang: Shell label: cURL source: > @@ -3238,7 +3254,7 @@ paths: .then(({ payment_collection }) => { console.log(payment_collection.id); - }); + }) - lang: Shell label: cURL source: > @@ -3305,7 +3321,7 @@ paths: .then(({ payment_session }) => { console.log(payment_session.id); - }); + }) - lang: Shell label: cURL source: > @@ -3343,7 +3359,7 @@ paths: - in: path name: id required: true - description: The ID of the Payment Collections. + description: The ID of the Payment Collection. schema: type: string - in: path @@ -3369,7 +3385,7 @@ paths: .then(({ payment_collection }) => { console.log(payment_collection.id); - }); + }) - lang: Shell label: cURL source: > @@ -3480,7 +3496,7 @@ paths: .then(({ product_categories, limit, offset, count }) => { console.log(product_categories.length); - }); + }) - lang: Shell label: cURL source: | @@ -3553,9 +3569,10 @@ paths: // must be previously logged in or use api token medusa.productCategories.retrieve(productCategoryId) - .then(({ product_category }) => { - console.log(product_category.id); - }); + + .then(({ product_category }) => { + console.log(product_category.id); + }) - lang: Shell label: cURL source: | @@ -3703,7 +3720,7 @@ paths: .then(({ product_tags }) => { console.log(product_tags.length); - }); + }) - lang: Shell label: cURL source: | @@ -3850,7 +3867,7 @@ paths: .then(({ product_types }) => { console.log(product_types.length); - }); + }) - lang: Shell label: cURL source: | @@ -4130,7 +4147,7 @@ paths: .then(({ products, limit, offset, count }) => { console.log(products.length); - }); + }) - lang: Shell label: cURL source: | @@ -4184,7 +4201,7 @@ paths: .then(({ hits }) => { console.log(hits.length); - }); + }) - lang: Shell label: cURL source: | @@ -4303,7 +4320,7 @@ paths: .then(({ product }) => { console.log(product.id); - }); + }) - lang: Shell label: cURL source: | @@ -4410,9 +4427,9 @@ paths: medusa.regions.list() - .then(({ regions }) => { + .then(({ regions, count, limit, offset }) => { console.log(regions.length); - }); + }) - lang: Shell label: cURL source: | @@ -4463,7 +4480,7 @@ paths: .then(({ region }) => { console.log(region.id); - }); + }) - lang: Shell label: cURL source: | @@ -4509,7 +4526,7 @@ paths: .then(({ return_reasons }) => { console.log(return_reasons.length); - }); + }) - lang: Shell label: cURL source: | @@ -4560,7 +4577,7 @@ paths: .then(({ return_reason }) => { console.log(return_reason.id); - }); + }) - lang: Shell label: cURL source: | @@ -4622,7 +4639,7 @@ paths: .then((data) => { console.log(data.return.id); - }); + }) - lang: Shell label: cURL source: | @@ -4700,7 +4717,7 @@ paths: .then(({ shipping_options }) => { console.log(shipping_options.length); - }); + }) - lang: Shell label: cURL source: | @@ -4755,7 +4772,7 @@ paths: .then(({ shipping_options }) => { console.log(shipping_options.length); - }); + }) - lang: Shell label: cURL source: | @@ -4837,7 +4854,7 @@ paths: .then(({ swap }) => { console.log(swap.id); - }); + }) - lang: Shell label: cURL source: | @@ -4904,7 +4921,7 @@ paths: .then(({ swap }) => { console.log(swap.id); - }); + }) - lang: Shell label: cURL source: | @@ -5080,6 +5097,21 @@ paths: method: list queryParams: StoreGetVariantsParams x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.product.variants.list() + + .then(({ variants }) => { + console.log(variants.length); + }) - lang: Shell label: cURL source: | @@ -5168,6 +5200,21 @@ paths: method: retrieve queryParams: StoreGetVariantsVariantParams x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.product.variants.retrieve(productVariantId) + + .then(({ variant }) => { + console.log(variant.id); + }) - lang: Shell label: cURL source: | @@ -5594,6 +5641,7 @@ components: example: 16128234334802 company: type: string + description: Company address_1: description: Address line 1 type: string @@ -7482,12 +7530,16 @@ components: - modules properties: payment_providers: + description: The store's payment providers. $ref: '#/components/schemas/PaymentProvider' fulfillment_providers: + description: The store's fulfillment providers. $ref: '#/components/schemas/FulfillmentProvider' feature_flags: + description: The feature flags enabled in the store's backend. $ref: '#/components/schemas/FeatureFlagsResponse' modules: + description: The modules installed in the store's backend. $ref: '#/components/schemas/ModulesResponse' FeatureFlagsResponse: type: array @@ -7990,6 +8042,10 @@ components: required: - sku properties: + id: + description: The inventory item's ID. + type: string + example: iitem_12334 sku: description: The Stock Keeping Unit (SKU) code of the Inventory Item. type: string @@ -9708,8 +9764,8 @@ components: $ref: '#/components/schemas/Region' currency_code: description: >- - The 3 character ISO code for the currency this payment collection is - associated with. + The three character ISO code for the currency this payment + collection is associated with. type: string example: usd externalDocs: @@ -9992,6 +10048,7 @@ components: - type: object properties: variants: + description: The product variants and their prices. type: array items: $ref: '#/components/schemas/PricedVariant' @@ -10355,6 +10412,10 @@ components: description: The product category's name type: string example: Regular Fit + description: + description: The product category's description. + type: string + default: '' handle: description: >- A unique string that identifies the Product Category - can for @@ -11269,7 +11330,7 @@ components: type: string example: EU currency_code: - description: The 3 character currency code used in the region. + description: The three character currency code used in the region. type: string example: usd externalDocs: @@ -12500,6 +12561,7 @@ components: - type: object properties: sales_channels: + description: The associated sales channels. $ref: '#/components/schemas/SalesChannel' Store: title: Store @@ -12529,8 +12591,9 @@ components: description: The name of the Store - this may be displayed to the Customer. type: string example: Medusa Store + default: Medusa Store default_currency_code: - description: The 3 character currency code that is the default of the store. + description: The three character currency code that is the default of the store. type: string example: usd externalDocs: @@ -12539,6 +12602,7 @@ components: default_currency: description: The details of the store's default currency. x-expandable: default_currency + default: usd nullable: true $ref: '#/components/schemas/Currency' currencies: @@ -12603,6 +12667,7 @@ components: https://docs.medusajs.com/development/entities/overview#metadata-attribute StoreAuthRes: type: object + description: The customer's details. x-expanded-relations: field: customer relations: @@ -12617,6 +12682,7 @@ components: $ref: '#/components/schemas/Customer' StoreBearerAuthRes: type: object + description: The access token details. properties: access_token: description: Access token that can be used to send authenticated requests. @@ -12638,6 +12704,7 @@ components: $ref: '#/components/schemas/PricedShippingOption' StoreCartsRes: type: object + description: The cart's details. x-expanded-relations: field: cart relations: @@ -12702,6 +12769,7 @@ components: $ref: '#/components/schemas/Cart' StoreCollectionsListRes: type: object + description: The list of product collections with pagination fields. required: - collections - count @@ -12726,6 +12794,7 @@ components: description: The number of items per page StoreCollectionsRes: type: object + description: The details of the product collection. required: - collection properties: @@ -12734,6 +12803,10 @@ components: $ref: '#/components/schemas/ProductCollection' StoreCompleteCartRes: type: object + description: >- + If the cart is completed successfully, this will have the created order + or the swap's details, based on the cart's type. Otherwise, it'll be the + cart's details. required: - type - data @@ -12776,6 +12849,7 @@ components: - $ref: '#/components/schemas/Swap' StoreCustomersListOrdersRes: type: object + description: The list of the customer's orders with pagination fields. x-expanded-relations: field: orders relations: @@ -12880,12 +12954,13 @@ components: type: integer StoreCustomersListPaymentMethodsRes: type: object + description: The payment method's details. required: - payment_methods properties: payment_methods: type: array - description: An array of saved payment method details. + description: The details of the saved payment methods. items: type: object required: @@ -12904,6 +12979,7 @@ components: type: object StoreCustomersRes: type: object + description: The customer's details. x-expanded-relations: field: customer relations: @@ -12925,6 +13001,7 @@ components: $ref: '#/components/schemas/Customer' StoreGetAuthEmailRes: type: object + description: Details on whether the email exists. required: - exists properties: @@ -12933,6 +13010,7 @@ components: type: boolean StoreGetProductCategoriesCategoryRes: type: object + description: The product category's details. x-expanded-relations: field: product_category relations: @@ -12946,6 +13024,7 @@ components: $ref: '#/components/schemas/ProductCategory' StoreGetProductCategoriesRes: type: object + description: The list of product categories with pagination fields. x-expanded-relations: field: product_categories relations: @@ -12974,6 +13053,7 @@ components: type: integer description: The number of items per page StoreGiftCardsRes: + description: The gift card's details. type: object required: - gift_card @@ -12983,6 +13063,7 @@ components: $ref: '#/components/schemas/GiftCard' StoreOrderEditsRes: type: object + description: The order edit's details. x-expanded-relations: field: order_edit relations: @@ -13026,6 +13107,7 @@ components: $ref: '#/components/schemas/OrderEdit' StoreOrdersRes: type: object + description: The order's details. required: - order x-expanded-relations: @@ -13123,6 +13205,7 @@ components: description: The ID of the Payment Provider. StorePaymentCollectionsRes: type: object + description: The payment collection's details. x-expanded-relations: field: payment_collection relations: @@ -13159,6 +13242,7 @@ components: description: The Customer's password. StorePostCartReq: type: object + description: The details of the cart to be created. properties: region_id: type: string @@ -13186,8 +13270,8 @@ components: country_code: type: string description: >- - The 2 character ISO country code to create the Cart in. Setting this - parameter will set the country code of the shipping address. + The two character ISO country code to create the Cart in. Setting + this parameter will set the country code of the shipping address. externalDocs: url: >- https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements @@ -13506,8 +13590,8 @@ components: properties: sessions: description: >- - An array of payment sessions related to the Payment Collection. - Existing sessions that are not added in this array will be deleted. + Payment sessions related to the Payment Collection. Existing + sessions that are not added in this array will be deleted. type: array items: type: object @@ -13586,6 +13670,7 @@ components: filter: description: Pass filters based on the search service. StorePostSearchRes: + description: The list of search results. allOf: - type: object required: @@ -13650,6 +13735,7 @@ components: type: integer StoreProductTagsListRes: type: object + description: The list of product tags with pagination fields. required: - product_tags - count @@ -13696,6 +13782,7 @@ components: description: The number of items per page StoreProductsListRes: type: object + description: The list of products with pagination fields. x-expanded-relations: field: products relations: @@ -13754,6 +13841,7 @@ components: $ref: '#/components/schemas/PricedProduct' StoreRegionsListRes: type: object + description: The list of regions with pagination fields. x-expanded-relations: field: regions relations: @@ -13782,6 +13870,7 @@ components: description: The number of items per page StoreRegionsRes: type: object + description: The region's details. x-expanded-relations: field: region relations: @@ -13799,6 +13888,7 @@ components: $ref: '#/components/schemas/Region' StoreReturnReasonsListRes: type: object + description: The list of return reasons. x-expanded-relations: field: return_reasons relations: @@ -13814,6 +13904,7 @@ components: $ref: '#/components/schemas/ReturnReason' StoreReturnReasonsRes: type: object + description: The return reason's details. x-expanded-relations: field: return_reason relations: @@ -13827,6 +13918,7 @@ components: $ref: '#/components/schemas/ReturnReason' StoreReturnsRes: type: object + description: The return's details. x-expanded-relations: field: return relations: @@ -13842,6 +13934,7 @@ components: $ref: '#/components/schemas/Return' StoreShippingOptionsListRes: type: object + description: The list of shipping options. x-expanded-relations: field: shipping_options relations: @@ -13856,6 +13949,7 @@ components: $ref: '#/components/schemas/PricedShippingOption' StoreSwapsRes: type: object + description: The swap's details. x-expanded-relations: field: swap relations: @@ -13879,6 +13973,7 @@ components: $ref: '#/components/schemas/Swap' StoreVariantsListRes: type: object + description: The list of product variants. x-expanded-relations: field: variants relations: @@ -13897,6 +13992,7 @@ components: $ref: '#/components/schemas/PricedVariant' StoreVariantsRes: type: object + description: The product variant's details. x-expanded-relations: field: variant relations: diff --git a/www/apps/api-reference/specs/store/openapi.yaml b/www/apps/api-reference/specs/store/openapi.yaml index 4698b5580c..0701018e89 100644 --- a/www/apps/api-reference/specs/store/openapi.yaml +++ b/www/apps/api-reference/specs/store/openapi.yaml @@ -8,11 +8,11 @@ info: tags: - name: Auth description: > - Authentication API Routes allow customers to manage their session, such as - login or log out. + Authentication API Routes allow you to manage a customer's session, such + as login or log out. - When a customer is logged in, the cookie header is set indicating the - customer's login session. + You can send authenticated requests for a customer either using the Cookie + header or using the JWT Token. externalDocs: description: How to implement customer profiles in your storefront url: >- diff --git a/www/apps/api-reference/specs/store/paths/store_auth.yaml b/www/apps/api-reference/specs/store/paths/store_auth.yaml index 631a18ae51..5f230011df 100644 --- a/www/apps/api-reference/specs/store/paths/store_auth.yaml +++ b/www/apps/api-reference/specs/store/paths/store_auth.yaml @@ -91,6 +91,10 @@ delete: x-codegen: method: deleteSession x-codeSamples: + - lang: JavaScript + label: JS Client + source: + $ref: ../code_samples/JavaScript/store_auth/delete.js - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_carts.yaml b/www/apps/api-reference/specs/store/paths/store_carts.yaml index b72b588bcd..cf9b4035e0 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts.yaml @@ -10,8 +10,8 @@ post: changes their region. - If a customer is logged in, the cart's customer ID and email will - automatically be set. + If a customer is logged in, make sure to pass its ID or email within the + cart's details so that the cart is attached to the customer. requestBody: content: application/json: diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_complete.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_complete.yaml index 3e3555cbc6..e4bdb138a2 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_complete.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_complete.yaml @@ -2,8 +2,8 @@ post: summary: Complete a Cart operationId: PostCartsCartComplete description: > - Complete a cart and place an order or create a swap, based on what the cart - is created for. This includes attempting to authorize the cart's payment. + Complete a cart and place an order or create a swap, based on the cart's + type. This includes attempting to authorize the cart's payment. If authorizing the payment requires more action, the cart will not be completed and the order will not be placed or the swap will not be created. diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_discounts_{code}.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_discounts_{code}.yaml index 877b3f01c4..e89f14a946 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_discounts_{code}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_discounts_{code}.yaml @@ -3,8 +3,8 @@ delete: summary: Remove Discount description: >- Remove a Discount from a Cart. This only removes the application of the - discount, and not completely delete it. The totals will be re-calculated and - the payment sessions will be refreshed after the removal. + discount, and not completely deletes it. The totals will be re-calculated + and the payment sessions will be refreshed after the removal. parameters: - in: path name: id diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-sessions.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-sessions.yaml index e51878c2fc..242657d9d1 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-sessions.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-sessions.yaml @@ -3,7 +3,7 @@ post: summary: Create Payment Sessions description: >- Create Payment Sessions for each of the available Payment Providers in the - Cart's Region. If there only one payment session is created, it will be + Cart's Region. If there's only one payment session created, it will be selected by default. The creation of the payment session uses the payment provider and may require sending requests to third-party services. parameters: diff --git a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_batch.yaml b/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_batch.yaml index 4077008697..dc53193384 100644 --- a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_batch.yaml +++ b/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_batch.yaml @@ -10,7 +10,7 @@ post: - in: path name: id required: true - description: The ID of the Payment Collections. + description: The ID of the Payment Collection. schema: type: string requestBody: diff --git a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_{session_id}_authorize.yaml b/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_{session_id}_authorize.yaml index 5d9b5a837c..6319d711e0 100644 --- a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_{session_id}_authorize.yaml +++ b/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_{session_id}_authorize.yaml @@ -7,7 +7,7 @@ post: - in: path name: id required: true - description: The ID of the Payment Collections. + description: The ID of the Payment Collection. schema: type: string - in: path diff --git a/www/apps/api-reference/specs/store/paths/store_variants.yaml b/www/apps/api-reference/specs/store/paths/store_variants.yaml index f4a5a30887..472bc9eb9c 100644 --- a/www/apps/api-reference/specs/store/paths/store_variants.yaml +++ b/www/apps/api-reference/specs/store/paths/store_variants.yaml @@ -147,6 +147,10 @@ get: method: list queryParams: StoreGetVariantsParams x-codeSamples: + - lang: JavaScript + label: JS Client + source: + $ref: ../code_samples/JavaScript/store_variants/get.js - lang: Shell label: cURL source: diff --git a/www/apps/api-reference/specs/store/paths/store_variants_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_variants_{id}.yaml index 78ae0da5c7..d46d5ef79b 100644 --- a/www/apps/api-reference/specs/store/paths/store_variants_{id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_variants_{id}.yaml @@ -62,6 +62,10 @@ get: method: retrieve queryParams: StoreGetVariantsVariantParams x-codeSamples: + - lang: JavaScript + label: JS Client + source: + $ref: ../code_samples/JavaScript/store_variants_{id}/get.js - lang: Shell label: cURL source: