asyavee/medusa-store
1
0 Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

chore(docs): merge changes from master (#3780)

Browse Source 
* chore(docs): Generated API Reference (#3761)

Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>

* docs: fix typo (#3771)

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
Co-authored-by: Andre Schweighofer <fidrelity@users.noreply.github.com>
This commit is contained in:
Shahed Nassershahednassergithub-actions[bot]Andre Schweighofer
 authored and GitHub committed 2023-04-10 11:15:54 +03:00
1 parent 5280e1bdad
commit ae017c4657
44 files changed
+211 -286
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api/admin.oas.json
+58 -81
View File
@@ -5791,8 +5791,8 @@
"/admin/inventory-items": { "/admin/inventory-items": {
"get": { "get": {
"operationId": "GetInventoryItems", "operationId": "GetInventoryItems",
"summary": "List inventory items.", "summary": "List Inventory Items",
"description": "Lists inventory items.", "description": "Lists inventory items with the ability to apply filters or search queries on them.",
"x-authenticated": true, "x-authenticated": true,
"parameters": [ "parameters": [
{ {
@@ -5947,12 +5947,12 @@
{ {
"lang": "JavaScript", "lang": "JavaScript",
"label": "JS Client", "label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.inventoryItems.list()\n.then(({ inventory_items }) => {\n console.log(inventory_items.length);\n});\n" "source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.inventoryItems.list()\n.then(({ inventory_items, count, offset, limit }) => {\n console.log(inventory_items.length);\n});\n"
}, },
{ {
"lang": "Shell", "lang": "Shell",
"label": "cURL", "label": "cURL",
"source": "curl --location --request GET 'https://medusa-url.com/admin/inventory-items' \\\n--header 'Authorization: Bearer {api_token}' \\\n--header 'Content-Type: application/json'\n" "source": "curl --location --request GET 'https://medusa-url.com/admin/inventory-items' \\\n--header 'Authorization: Bearer {api_token}'\n"
} }
], ],
"security": [ "security": [
@@ -5999,7 +5999,7 @@
}, },
"post": { "post": {
"operationId": "PostInventoryItems", "operationId": "PostInventoryItems",
"summary": "Create an Inventory Item.", "summary": "Create an Inventory Item",
"description": "Creates an Inventory Item.", "description": "Creates an Inventory Item.",
"x-authenticated": true, "x-authenticated": true,
"parameters": [ "parameters": [
@@ -6037,12 +6037,12 @@
{ {
"lang": "JavaScript", "lang": "JavaScript",
"label": "JS Client", "label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.inventoryItems.create(inventoryItemId, {\n variant_id: 'variant_123',\n sku: \"sku-123\",\n})\n.then(({ inventory_item }) => {\n console.log(inventory_item.id);\n});\n" "source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.inventoryItems.create({\n variant_id: 'variant_123',\n})\n.then(({ inventory_item }) => {\n console.log(inventory_item.id);\n});\n"
}, },
{ {
"lang": "Shell", "lang": "Shell",
"label": "cURL", "label": "cURL",
"source": "curl --location --request POST 'https://medusa-url.com/admin/inventory-items' \\\n--header 'Authorization: Bearer {api_token}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"variant_id\": \"variant_123\",\n \"sku\": \"sku-123\",\n}'\n" "source": "curl --location --request POST 'https://medusa-url.com/admin/inventory-items' \\\n--header 'Authorization: Bearer {api_token}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"variant_id\": \"variant_123\",\n}'\n"
} }
], ],
"security": [ "security": [
@@ -6091,8 +6091,8 @@
"/admin/inventory-items/{id}": { "/admin/inventory-items/{id}": {
"get": { "get": {
"operationId": "GetInventoryItemsInventoryItem", "operationId": "GetInventoryItemsInventoryItem",
"summary": "Retrive an Inventory Item.", "summary": "Get an Inventory Item",
"description": "Retrives an Inventory Item.", "description": "Retrieves an Inventory Item.",
"x-authenticated": true, "x-authenticated": true,
"parameters": [ "parameters": [
{ {
@@ -6134,7 +6134,7 @@
{ {
"lang": "Shell", "lang": "Shell",
"label": "cURL", "label": "cURL",
"source": "curl --location --request GET 'https://medusa-url.com/admin/inventory-items/{id}' \\\n--header 'Authorization: Bearer {api_token}' \\\n--header 'Content-Type: application/json'\n" "source": "curl --location --request GET 'https://medusa-url.com/admin/inventory-items/{id}' \\\n--header 'Authorization: Bearer {api_token}'\n"
} }
], ],
"security": [ "security": [
@@ -6181,7 +6181,7 @@
}, },
"post": { "post": {
"operationId": "PostInventoryItemsInventoryItem", "operationId": "PostInventoryItemsInventoryItem",
"summary": "Update an Inventory Item.", "summary": "Update an Inventory Item",
"description": "Updates an Inventory Item.", "description": "Updates an Inventory Item.",
"x-authenticated": true, "x-authenticated": true,
"parameters": [ "parameters": [
@@ -6340,8 +6340,8 @@
"/admin/inventory-items/{id}/location-levels": { "/admin/inventory-items/{id}/location-levels": {
"get": { "get": {
"operationId": "GetInventoryItemsInventoryItemLocationLevels", "operationId": "GetInventoryItemsInventoryItemLocationLevels",
"summary": "List stock levels of a given location.", "summary": "List Inventory Levels",
"description": "Lists stock levels of a given location.", "description": "Lists inventory levels of an inventory item.",
"x-authenticated": true, "x-authenticated": true,
"parameters": [ "parameters": [
{ {
@@ -6353,24 +6353,6 @@
"type": "string" "type": "string"
} }
}, },
{
"in": "query",
"name": "offset",
"description": "How many stock locations levels to skip in the result.",
"schema": {
"type": "integer",
"default": 0
}
},
{
"in": "query",
"name": "limit",
"description": "Limit the number of stock locations levels returned.",
"schema": {
"type": "integer",
"default": 20
}
},
{ {
"in": "query", "in": "query",
"name": "expand", "name": "expand",
@@ -6401,7 +6383,7 @@
{ {
"lang": "Shell", "lang": "Shell",
"label": "cURL", "label": "cURL",
"source": "curl --location --request GET 'https://medusa-url.com/admin/inventory-items/{id}/location-levels' \\\n--header 'Authorization: Bearer {api_token}' \\\n--header 'Content-Type: application/json'\n" "source": "curl --location --request GET 'https://medusa-url.com/admin/inventory-items/{id}/location-levels' \\\n--header 'Authorization: Bearer {api_token}'\n"
} }
], ],
"security": [ "security": [
@@ -6448,8 +6430,8 @@
}, },
"post": { "post": {
"operationId": "PostInventoryItemsInventoryItemLocationLevels", "operationId": "PostInventoryItemsInventoryItemLocationLevels",
"summary": "Create an Inventory Location Level for a given Inventory Item.", "summary": "Create an Inventory Level",
"description": "Creates an Inventory Location Level for a given Inventory Item.", "description": "Creates an Inventory Level for a given Inventory Item.",
"x-authenticated": true, "x-authenticated": true,
"parameters": [ "parameters": [
{ {
@@ -6495,12 +6477,12 @@
{ {
"lang": "JavaScript", "lang": "JavaScript",
"label": "JS Client", "label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.inventoryItems.createLocationLevel(inventoryItemId, {\n location_id: 'sloc',\n stocked_quantity: 10,\n})\n.then(({ inventory_item }) => {\n console.log(inventory_item.id);\n});\n" "source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.inventoryItems.createLocationLevel(inventoryItemId, {\n location_id: 'sloc_123',\n stocked_quantity: 10,\n})\n.then(({ inventory_item }) => {\n console.log(inventory_item.id);\n});\n"
}, },
{ {
"lang": "Shell", "lang": "Shell",
"label": "cURL", "label": "cURL",
"source": "curl --location --request POST 'https://medusa-url.com/admin/inventory-items/{id}/location-levels' \\\n--header 'Authorization: Bearer {api_token}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"location_id\": \"sloc\",\n \"stocked_quantity\": 10\n}'\n" "source": "curl --location --request POST 'https://medusa-url.com/admin/inventory-items/{id}/location-levels' \\\n--header 'Authorization: Bearer {api_token}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"location_id\": \"sloc_123\",\n \"stocked_quantity\": 10\n}'\n"
} }
], ],
"security": [ "security": [
@@ -6549,8 +6531,8 @@
"/admin/inventory-items/{id}/location-levels/{location_id}": { "/admin/inventory-items/{id}/location-levels/{location_id}": {
"post": { "post": {
"operationId": "PostInventoryItemsInventoryItemLocationLevelsLocationLevel", "operationId": "PostInventoryItemsInventoryItemLocationLevelsLocationLevel",
"summary": "Update an Inventory Location Level for a given Inventory Item.", "summary": "Update an Inventory Level",
"description": "Updates an Inventory Location Level for a given Inventory Item.", "description": "Updates an Inventory Level for a given Inventory Item.",
"x-authenticated": true, "x-authenticated": true,
"parameters": [ "parameters": [
{ {
@@ -6657,7 +6639,7 @@
}, },
"delete": { "delete": {
"operationId": "DeleteInventoryItemsInventoryIteLocationLevelsLocation", "operationId": "DeleteInventoryItemsInventoryIteLocationLevelsLocation",
"summary": "Delete a location level of an Inventory Item.", "summary": "Delete a Location Level",
"description": "Delete a location level of an Inventory Item.", "description": "Delete a location level of an Inventory Item.",
"x-authenticated": true, "x-authenticated": true,
"parameters": [ "parameters": [
@@ -6692,7 +6674,7 @@
{ {
"lang": "Shell", "lang": "Shell",
"label": "cURL", "label": "cURL",
"source": "curl --location --request DELETE 'https://medusa-url.com/admin/inventory-items/{id}/location-levels/{location_id}' \\\n--header 'Authorization: Bearer {api_token}' \\\n--header 'Content-Type: application/json'\n" "source": "curl --location --request DELETE 'https://medusa-url.com/admin/inventory-items/{id}/location-levels/{location_id}' \\\n--header 'Authorization: Bearer {api_token}'\n"
} }
], ],
"security": [ "security": [
@@ -10450,15 +10432,10 @@
} }
}, },
"x-codeSamples": [ "x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.orders.createReservation(order_id, line_item_id, {\n location_id\n})\n.then(({ reservation }) => {\n console.log(reservation.id);\n});\n"
},
{ {
"lang": "Shell", "lang": "Shell",
"label": "cURL", "label": "cURL",
"source": "curl --location --request POST 'https://medusa-url.com/admin/orders/{id}/line-items/{line_item_id}/reservations' \\\n--header 'Authorization: Bearer {api_token}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"location_id\": \"loc_1\"\n}'\n" "source": "curl --location --request POST 'https://medusa-url.com/admin/orders/{id}/line-items/{line_item_id}/reserve' \\\n--header 'Authorization: Bearer {api_token}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"location_id\": \"loc_1\"\n}'\n"
} }
], ],
"security": [ "security": [
@@ -10608,8 +10585,8 @@
"/admin/orders/{id}/reservations": { "/admin/orders/{id}/reservations": {
"get": { "get": {
"operationId": "GetOrdersOrderReservations", "operationId": "GetOrdersOrderReservations",
"summary": "Get reservations for an Order", "summary": "Get reservations of an Order",
"description": "Retrieves reservations for an Order", "description": "Retrieves reservations of an Order",
"x-authenticated": true, "x-authenticated": true,
"parameters": [ "parameters": [
{ {
@@ -10641,11 +10618,6 @@
} }
], ],
"x-codeSamples": [ "x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.orders.retrieveReservations(order_id)\n.then(({ reservations }) => {\n console.log(reservations[0].id);\n});\n"
},
{ {
"lang": "Shell", "lang": "Shell",
"label": "cURL", "label": "cURL",
@@ -13654,7 +13626,7 @@
{ {
"lang": "JavaScript", "lang": "JavaScript",
"label": "JS Client", "label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.productCategories.retrieve(product_category_id)\n.then(({ product_category }) => {\n console.log(product_category.id);\n});\n" "source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.productCategories.retrieve(productCategoryId)\n.then(({ product_category }) => {\n console.log(product_category.id);\n});\n"
}, },
{ {
"lang": "Shell", "lang": "Shell",
@@ -13753,7 +13725,7 @@
{ {
"lang": "JavaScript", "lang": "JavaScript",
"label": "JS Client", "label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.productCategories.update(product_category_id, {\n name: \"Skinny Jeans\"\n})\n.then(({ product_category }) => {\n console.log(product_category.id);\n});\n" "source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.productCategories.update(productCategoryId, {\n name: \"Skinny Jeans\"\n})\n.then(({ product_category }) => {\n console.log(product_category.id);\n});\n"
}, },
{ {
"lang": "Shell", "lang": "Shell",
@@ -13826,7 +13798,7 @@
{ {
"lang": "JavaScript", "lang": "JavaScript",
"label": "JS Client", "label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.productCategories.delete(product_category_id)\n.then(({ id, object, deleted }) => {\n console.log(id);\n});\n" "source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.productCategories.delete(productCategoryId)\n.then(({ id, object, deleted }) => {\n console.log(id);\n});\n"
}, },
{ {
"lang": "Shell", "lang": "Shell",
@@ -13880,7 +13852,7 @@
"/admin/product-categories/{id}/products/batch": { "/admin/product-categories/{id}/products/batch": {
"post": { "post": {
"operationId": "PostProductCategoriesCategoryProductsBatch", "operationId": "PostProductCategoriesCategoryProductsBatch",
"summary": "Add Products to a category", "summary": "Add Products to a Category",
"description": "Assign a batch of products to a product category.", "description": "Assign a batch of products to a product category.",
"x-authenticated": true, "x-authenticated": true,
"parameters": [ "parameters": [
@@ -13927,12 +13899,12 @@
{ {
"lang": "JavaScript", "lang": "JavaScript",
"label": "JS Client", "label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.productCategories.addProducts(product_category_id, {\n product_ids: [\n {\n id: product_id\n }\n ]\n})\n.then(({ product_category }) => {\n console.log(product_category.id);\n});\n" "source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.productCategories.addProducts(productCategoryId, {\n product_ids: [\n {\n id: productId\n }\n ]\n})\n.then(({ product_category }) => {\n console.log(product_category.id);\n});\n"
}, },
{ {
"lang": "Shell", "lang": "Shell",
"label": "cURL", "label": "cURL",
"source": "curl --location \\\n--request POST 'https://medusa-url.com/admin/product-categories/{product_category_id}/products/batch' \\\n--header 'Authorization: Bearer {api_token}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"product_ids\": [\n {\n \"id\": \"{product_id}\"\n }\n ]\n}'\n" "source": "curl --location \\\n--request POST 'https://medusa-url.com/admin/product-categories/{id}/products/batch' \\\n--header 'Authorization: Bearer {api_token}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"product_ids\": [\n {\n \"id\": \"{product_id}\"\n }\n ]\n}'\n"
} }
], ],
"security": [ "security": [
@@ -13979,7 +13951,7 @@
}, },
"delete": { "delete": {
"operationId": "DeleteProductCategoriesCategoryProductsBatch", "operationId": "DeleteProductCategoriesCategoryProductsBatch",
"summary": "Delete Products", "summary": "Remove Products from Category",
"description": "Remove a list of products from a product category.", "description": "Remove a list of products from a product category.",
"x-authenticated": true, "x-authenticated": true,
"parameters": [ "parameters": [
@@ -14026,7 +13998,7 @@
{ {
"lang": "JavaScript", "lang": "JavaScript",
"label": "JS Client", "label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.productCategories.removeProducts(product_category_id, {\n product_ids: [\n {\n id: product_id\n }\n ]\n})\n.then(({ product_category }) => {\n console.log(product_category.id);\n});\n" "source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.productCategories.removeProducts(productCategoryId, {\n product_ids: [\n {\n id: productId\n }\n ]\n})\n.then(({ product_category }) => {\n console.log(product_category.id);\n});\n"
}, },
{ {
"lang": "Shell", "lang": "Shell",
@@ -17808,6 +17780,11 @@
"queryParams": "AdminGetReservationsParams" "queryParams": "AdminGetReservationsParams"
}, },
"x-codeSamples": [ "x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.reservations.list()\n.then(({ reservations, count, limit, offset }) => {\n console.log(reservations.length)\n})\n"
},
{ {
"lang": "Shell", "lang": "Shell",
"label": "cURL", "label": "cURL",
@@ -17858,8 +17835,8 @@
}, },
"post": { "post": {
"operationId": "PostReservations", "operationId": "PostReservations",
"summary": "Creates a Reservation", "summary": "Create a Reservation",
"description": "Creates a Reservation which can be associated with any resource as required.", "description": "Create a Reservation which can be associated with any resource as required.",
"x-authenticated": true, "x-authenticated": true,
"requestBody": { "requestBody": {
"content": { "content": {
@@ -17874,12 +17851,12 @@
{ {
"lang": "JavaScript", "lang": "JavaScript",
"label": "JS Client", "label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.reservations.create({\n})\n.then(({ reservations }) => {\n console.log(reservations.id);\n});\n" "source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.reservations.create({\n line_item_id: 'item_123',\n location_id: 'loc_123',\n inventory_item_id: 'iitem_123',\n quantity: 1\n})\n.then(({ reservation }) => {\n console.log(reservation.id);\n});\n"
}, },
{ {
"lang": "Shell", "lang": "Shell",
"label": "cURL", "label": "cURL",
"source": "curl --location --request POST 'https://medusa-url.com/admin/reservations' \\\n--header 'Authorization: Bearer {api_token}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"resource_id\": \"{resource_id}\",\n \"resource_type\": \"order\",\n \"value\": \"We delivered this order\"\n}'\n" "source": "curl --location --request POST 'https://medusa-url.com/admin/reservations' \\\n--header 'Authorization: Bearer {api_token}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"line_item_id\": \"item_123\",\n \"location_id\": \"loc_123\",\n \"inventory_item_id\": \"iitem_123\",\n \"quantity\": 1\n}'\n"
} }
], ],
"security": [ "security": [
@@ -17929,7 +17906,7 @@
"get": { "get": {
"operationId": "GetReservationsReservation", "operationId": "GetReservationsReservation",
"summary": "Get a Reservation", "summary": "Get a Reservation",
"description": "Retrieves a single reservation using its id", "description": "Retrieves a single reservation using its ID",
"x-authenticated": true, "x-authenticated": true,
"parameters": [ "parameters": [
{ {
@@ -17946,7 +17923,7 @@
{ {
"lang": "JavaScript", "lang": "JavaScript",
"label": "JS Client", "label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.reservations.retrieve(reservation_id)\n.then(({ reservation }) => {\n console.log(reservation.id);\n});\n" "source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.reservations.retrieve(reservationId)\n.then(({ reservation }) => {\n console.log(reservation.id);\n});\n"
}, },
{ {
"lang": "Shell", "lang": "Shell",
@@ -17998,7 +17975,7 @@
}, },
"post": { "post": {
"operationId": "PostReservationsReservation", "operationId": "PostReservationsReservation",
"summary": "Updates a Reservation", "summary": "Update a Reservation",
"description": "Updates a Reservation which can be associated with any resource as required.", "description": "Updates a Reservation which can be associated with any resource as required.",
"x-authenticated": true, "x-authenticated": true,
"parameters": [ "parameters": [
@@ -18025,7 +18002,7 @@
{ {
"lang": "JavaScript", "lang": "JavaScript",
"label": "JS Client", "label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.reservations.update(reservation.id, {\n quantity: 3\n})\n.then(({ reservations }) => {\n console.log(reservations.id);\n});\n" "source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.reservations.update(reservationId, {\n quantity: 3\n})\n.then(({ reservation }) => {\n console.log(reservation.id);\n});\n"
}, },
{ {
"lang": "Shell", "lang": "Shell",
@@ -18098,7 +18075,7 @@
{ {
"lang": "JavaScript", "lang": "JavaScript",
"label": "JS Client", "label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.reservations.delete(reservation.id)\n.then(({ id, object, deleted }) => {\n console.log(id);\n});\n" "source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.reservations.delete(reservationId)\n.then(({ id, object, deleted }) => {\n console.log(id);\n});\n"
}, },
{ {
"lang": "Shell", "lang": "Shell",
@@ -19456,8 +19433,8 @@
"/admin/sales-channels/{id}/stock-locations": { "/admin/sales-channels/{id}/stock-locations": {
"post": { "post": {
"operationId": "PostSalesChannelsSalesChannelStockLocation", "operationId": "PostSalesChannelsSalesChannelStockLocation",
"summary": "Associate a stock location to a Sales Channel", "summary": "Associate a Stock Location",
"description": "Associates a stock location to a Sales Channel.", "description": "Associates a stock location with a Sales Channel.",
"x-authenticated": true, "x-authenticated": true,
"parameters": [ "parameters": [
{ {
@@ -19486,12 +19463,12 @@
{ {
"lang": "JavaScript", "lang": "JavaScript",
"label": "JS Client", "label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.salesChannels.addLocation(sales_channel_id, {\n location_id: 'App'\n})\n.then(({ sales_channel }) => {\n console.log(sales_channel.id);\n});\n" "source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.salesChannels.addLocation(salesChannelId, {\n location_id: 'loc_123'\n})\n.then(({ sales_channel }) => {\n console.log(sales_channel.id);\n});\n"
}, },
{ {
"lang": "Shell", "lang": "Shell",
"label": "cURL", "label": "cURL",
"source": "curl --location --request POST 'https://medusa-url.com/admin/sales-channels/{id}/stock-locations' \\\n--header 'Authorization: Bearer {api_token}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"locaton_id\": \"stock_location_id\"\n}'\n" "source": "curl --location --request POST 'https://medusa-url.com/admin/sales-channels/{id}/stock-locations' \\\n--header 'Authorization: Bearer {api_token}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"locaton_id\": \"loc_123\"\n}'\n"
} }
], ],
"security": [ "security": [
@@ -19538,7 +19515,7 @@
}, },
"delete": { "delete": {
"operationId": "DeleteSalesChannelsSalesChannelStockLocation", "operationId": "DeleteSalesChannelsSalesChannelStockLocation",
"summary": "Remove a stock location from a Sales Channel", "summary": "Remove a Stock Location Association",
"description": "Removes a stock location from a Sales Channel.", "description": "Removes a stock location from a Sales Channel.",
"x-authenticated": true, "x-authenticated": true,
"parameters": [ "parameters": [
@@ -19568,12 +19545,12 @@
{ {
"lang": "JavaScript", "lang": "JavaScript",
"label": "JS Client", "label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.salesChannels.removeLocation(sales_channel_id, {\n location_id: 'App'\n})\n.then(({ sales_channel }) => {\n console.log(sales_channel.id);\n});\n" "source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.salesChannels.removeLocation(salesChannelId, {\n location_id: 'loc_id'\n})\n.then(({ sales_channel }) => {\n console.log(sales_channel.id);\n});\n"
}, },
{ {
"lang": "Shell", "lang": "Shell",
"label": "cURL", "label": "cURL",
"source": "curl --location --request DELETE 'https://medusa-url.com/admin/sales-channels/{id}/stock-locations' \\\n--header 'Authorization: Bearer {api_token}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"locaton_id\": \"stock_location_id\"\n}'\n" "source": "curl --location --request DELETE 'https://medusa-url.com/admin/sales-channels/{id}/stock-locations' \\\n--header 'Authorization: Bearer {api_token}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"locaton_id\": \"loc_id\"\n}'\n"
} }
], ],
"security": [ "security": [
@@ -20628,7 +20605,7 @@
{ {
"lang": "JavaScript", "lang": "JavaScript",
"label": "JS Client", "label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.stockLocations.create({\n name: 'Main Warehouse',\n location_id: 'sloc'\n})\n.then(({ stock_location }) => {\n console.log(stock_location.id);\n});\n" "source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.stockLocations.create({\n name: 'Main Warehouse',\n})\n.then(({ stock_location }) => {\n console.log(stock_location.id);\n});\n"
}, },
{ {
"lang": "Shell", "lang": "Shell",
@@ -20720,7 +20697,7 @@
{ {
"lang": "JavaScript", "lang": "JavaScript",
"label": "JS Client", "label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.stockLocations.retrieve(stock_location_id)\n.then(({ stock_location }) => {\n console.log(stock_location.id);\n});\n" "source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.stockLocations.retrieve(stockLocationId)\n.then(({ stock_location }) => {\n console.log(stock_location.id);\n});\n"
}, },
{ {
"lang": "Shell", "lang": "Shell",
@@ -20800,12 +20777,12 @@
{ {
"lang": "JavaScript", "lang": "JavaScript",
"label": "JS Client", "label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.stockLocations.update(stock_location_id, {\n name: 'App'\n})\n.then(({ stock_location }) => {\n console.log(stock_location.id);\n});\n" "source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.stockLocations.update(stockLocationId, {\n name: 'Main Warehouse'\n})\n.then(({ stock_location }) => {\n console.log(stock_location.id);\n});\n"
}, },
{ {
"lang": "Shell", "lang": "Shell",
"label": "cURL", "label": "cURL",
"source": "curl --location --request POST 'https://medusa-url.com/admin/stock-locations/{id}' \\\n--header 'Authorization: Bearer {api_token}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"name\": \"App\"\n}'\n" "source": "curl --location --request POST 'https://medusa-url.com/admin/stock-locations/{id}' \\\n--header 'Authorization: Bearer {api_token}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"name\": \"Main Warehouse\"\n}'\n"
} }
], ],
"security": [ "security": [
docs/api/admin.oas.yaml
+76 -102
View File
@@ -4574,8 +4574,8 @@ paths:
/admin/inventory-items: /admin/inventory-items:
get: get:
operationId: GetInventoryItems operationId: GetInventoryItems
summary: List inventory items. summary: List Inventory Items
description: Lists inventory items. description: Lists inventory items with the ability to apply filters or search queries on them.
x-authenticated: true x-authenticated: true
parameters: parameters:
- in: query - in: query
@@ -4680,15 +4680,14 @@ paths:
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token // must be previously logged in or use api token
medusa.admin.inventoryItems.list() medusa.admin.inventoryItems.list()
.then(({ inventory_items }) => { .then(({ inventory_items, count, offset, limit }) => {
console.log(inventory_items.length); console.log(inventory_items.length);
}); });
- lang: Shell - lang: Shell
label: cURL label: cURL
source: | source: |
curl --location --request GET 'https://medusa-url.com/admin/inventory-items' \ curl --location --request GET 'https://medusa-url.com/admin/inventory-items' \
--header 'Authorization: Bearer {api_token}' \ --header 'Authorization: Bearer {api_token}'
--header 'Content-Type: application/json'
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -4715,7 +4714,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
post: post:
operationId: PostInventoryItems operationId: PostInventoryItems
summary: Create an Inventory Item. summary: Create an Inventory Item
description: Creates an Inventory Item. description: Creates an Inventory Item.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -4744,9 +4743,8 @@ paths:
import Medusa from "@medusajs/medusa-js" import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token // must be previously logged in or use api token
medusa.admin.inventoryItems.create(inventoryItemId, { medusa.admin.inventoryItems.create({
variant_id: 'variant_123', variant_id: 'variant_123',
sku: "sku-123",
}) })
.then(({ inventory_item }) => { .then(({ inventory_item }) => {
console.log(inventory_item.id); console.log(inventory_item.id);
@@ -4759,7 +4757,6 @@ paths:
--header 'Content-Type: application/json' \ --header 'Content-Type: application/json' \
--data-raw '{ --data-raw '{
"variant_id": "variant_123", "variant_id": "variant_123",
"sku": "sku-123",
}' }'
security: security:
- api_token: [] - api_token: []
@@ -4788,8 +4785,8 @@ paths:
/admin/inventory-items/{id}: /admin/inventory-items/{id}:
get: get:
operationId: GetInventoryItemsInventoryItem operationId: GetInventoryItemsInventoryItem
summary: Retrive an Inventory Item. summary: Get an Inventory Item
description: Retrives an Inventory Item. description: Retrieves an Inventory Item.
x-authenticated: true x-authenticated: true
parameters: parameters:
- in: path - in: path
@@ -4826,8 +4823,7 @@ paths:
label: cURL label: cURL
source: | source: |
curl --location --request GET 'https://medusa-url.com/admin/inventory-items/{id}' \ curl --location --request GET 'https://medusa-url.com/admin/inventory-items/{id}' \
--header 'Authorization: Bearer {api_token}' \ --header 'Authorization: Bearer {api_token}'
--header 'Content-Type: application/json'
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -4854,7 +4850,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
post: post:
operationId: PostInventoryItemsInventoryItem operationId: PostInventoryItemsInventoryItem
summary: Update an Inventory Item. summary: Update an Inventory Item
description: Updates an Inventory Item. description: Updates an Inventory Item.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -4975,8 +4971,8 @@ paths:
/admin/inventory-items/{id}/location-levels: /admin/inventory-items/{id}/location-levels:
get: get:
operationId: GetInventoryItemsInventoryItemLocationLevels operationId: GetInventoryItemsInventoryItemLocationLevels
summary: List stock levels of a given location. summary: List Inventory Levels
description: Lists stock levels of a given location. description: Lists inventory levels of an inventory item.
x-authenticated: true x-authenticated: true
parameters: parameters:
- in: path - in: path
@@ -4985,18 +4981,6 @@ paths:
description: The ID of the Inventory Item. description: The ID of the Inventory Item.
schema: schema:
type: string type: string
- in: query
name: offset
description: How many stock locations levels to skip in the result.
schema:
type: integer
default: 0
- in: query
name: limit
description: Limit the number of stock locations levels returned.
schema:
type: integer
default: 20
- in: query - in: query
name: expand name: expand
description: Comma separated list of relations to include in the results. description: Comma separated list of relations to include in the results.
@@ -5025,8 +5009,7 @@ paths:
label: cURL label: cURL
source: | source: |
curl --location --request GET 'https://medusa-url.com/admin/inventory-items/{id}/location-levels' \ curl --location --request GET 'https://medusa-url.com/admin/inventory-items/{id}/location-levels' \
--header 'Authorization: Bearer {api_token}' \ --header 'Authorization: Bearer {api_token}'
--header 'Content-Type: application/json'
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -5053,8 +5036,8 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
post: post:
operationId: PostInventoryItemsInventoryItemLocationLevels operationId: PostInventoryItemsInventoryItemLocationLevels
summary: Create an Inventory Location Level for a given Inventory Item. summary: Create an Inventory Level
description: Creates an Inventory Location Level for a given Inventory Item. description: Creates an Inventory Level for a given Inventory Item.
x-authenticated: true x-authenticated: true
parameters: parameters:
- in: path - in: path
@@ -5089,7 +5072,7 @@ paths:
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token // must be previously logged in or use api token
medusa.admin.inventoryItems.createLocationLevel(inventoryItemId, { medusa.admin.inventoryItems.createLocationLevel(inventoryItemId, {
location_id: 'sloc', location_id: 'sloc_123',
stocked_quantity: 10, stocked_quantity: 10,
}) })
.then(({ inventory_item }) => { .then(({ inventory_item }) => {
@@ -5102,7 +5085,7 @@ paths:
--header 'Authorization: Bearer {api_token}' \ --header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \ --header 'Content-Type: application/json' \
--data-raw '{ --data-raw '{
"location_id": "sloc", "location_id": "sloc_123",
"stocked_quantity": 10 "stocked_quantity": 10
}' }'
security: security:
@@ -5132,8 +5115,8 @@ paths:
/admin/inventory-items/{id}/location-levels/{location_id}: /admin/inventory-items/{id}/location-levels/{location_id}:
post: post:
operationId: PostInventoryItemsInventoryItemLocationLevelsLocationLevel operationId: PostInventoryItemsInventoryItemLocationLevelsLocationLevel
summary: Update an Inventory Location Level for a given Inventory Item. summary: Update an Inventory Level
description: Updates an Inventory Location Level for a given Inventory Item. description: Updates an Inventory Level for a given Inventory Item.
x-authenticated: true x-authenticated: true
parameters: parameters:
- in: path - in: path
@@ -5214,7 +5197,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
delete: delete:
operationId: DeleteInventoryItemsInventoryIteLocationLevelsLocation operationId: DeleteInventoryItemsInventoryIteLocationLevelsLocation
summary: Delete a location level of an Inventory Item. summary: Delete a Location Level
description: Delete a location level of an Inventory Item. description: Delete a location level of an Inventory Item.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -5247,8 +5230,7 @@ paths:
label: cURL label: cURL
source: | source: |
curl --location --request DELETE 'https://medusa-url.com/admin/inventory-items/{id}/location-levels/{location_id}' \ curl --location --request DELETE 'https://medusa-url.com/admin/inventory-items/{id}/location-levels/{location_id}' \
--header 'Authorization: Bearer {api_token}' \ --header 'Authorization: Bearer {api_token}'
--header 'Content-Type: application/json'
security: security:
- api_token: [] - api_token: []
- cookie_auth: [] - cookie_auth: []
@@ -8055,22 +8037,10 @@ paths:
schema: schema:
$ref: '#/components/schemas/AdminOrdersOrderLineItemReservationReq' $ref: '#/components/schemas/AdminOrdersOrderLineItemReservationReq'
x-codeSamples: 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.admin.orders.createReservation(order_id, line_item_id, {
location_id
})
.then(({ reservation }) => {
console.log(reservation.id);
});
- lang: Shell - lang: Shell
label: cURL label: cURL
source: | source: |
curl --location --request POST 'https://medusa-url.com/admin/orders/{id}/line-items/{line_item_id}/reservations' \ curl --location --request POST 'https://medusa-url.com/admin/orders/{id}/line-items/{line_item_id}/reserve' \
--header 'Authorization: Bearer {api_token}' \ --header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \ --header 'Content-Type: application/json' \
--data-raw '{ --data-raw '{
@@ -8182,8 +8152,8 @@ paths:
/admin/orders/{id}/reservations: /admin/orders/{id}/reservations:
get: get:
operationId: GetOrdersOrderReservations operationId: GetOrdersOrderReservations
summary: Get reservations for an Order summary: Get reservations of an Order
description: Retrieves reservations for an Order description: Retrieves reservations of an Order
x-authenticated: true x-authenticated: true
parameters: parameters:
- in: path - in: path
@@ -8205,16 +8175,6 @@ paths:
type: integer type: integer
default: 20 default: 20
x-codeSamples: 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.admin.orders.retrieveReservations(order_id)
.then(({ reservations }) => {
console.log(reservations[0].id);
});
- lang: Shell - lang: Shell
label: cURL label: cURL
source: | source: |
@@ -10491,7 +10451,7 @@ paths:
import Medusa from "@medusajs/medusa-js" import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token // must be previously logged in or use api token
medusa.admin.productCategories.retrieve(product_category_id) medusa.admin.productCategories.retrieve(productCategoryId)
.then(({ product_category }) => { .then(({ product_category }) => {
console.log(product_category.id); console.log(product_category.id);
}); });
@@ -10561,7 +10521,7 @@ paths:
import Medusa from "@medusajs/medusa-js" import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token // must be previously logged in or use api token
medusa.admin.productCategories.update(product_category_id, { medusa.admin.productCategories.update(productCategoryId, {
name: "Skinny Jeans" name: "Skinny Jeans"
}) })
.then(({ product_category }) => { .then(({ product_category }) => {
@@ -10621,7 +10581,7 @@ paths:
import Medusa from "@medusajs/medusa-js" import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token // must be previously logged in or use api token
medusa.admin.productCategories.delete(product_category_id) medusa.admin.productCategories.delete(productCategoryId)
.then(({ id, object, deleted }) => { .then(({ id, object, deleted }) => {
console.log(id); console.log(id);
}); });
@@ -10657,7 +10617,7 @@ paths:
/admin/product-categories/{id}/products/batch: /admin/product-categories/{id}/products/batch:
post: post:
operationId: PostProductCategoriesCategoryProductsBatch operationId: PostProductCategoriesCategoryProductsBatch
summary: Add Products to a category summary: Add Products to a Category
description: Assign a batch of products to a product category. description: Assign a batch of products to a product category.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -10692,10 +10652,10 @@ paths:
import Medusa from "@medusajs/medusa-js" import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token // must be previously logged in or use api token
medusa.admin.productCategories.addProducts(product_category_id, { medusa.admin.productCategories.addProducts(productCategoryId, {
product_ids: [ product_ids: [
{ {
id: product_id id: productId
} }
] ]
}) })
@@ -10706,7 +10666,7 @@ paths:
label: cURL label: cURL
source: | source: |
curl --location \ curl --location \
--request POST 'https://medusa-url.com/admin/product-categories/{product_category_id}/products/batch' \ --request POST 'https://medusa-url.com/admin/product-categories/{id}/products/batch' \
--header 'Authorization: Bearer {api_token}' \ --header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \ --header 'Content-Type: application/json' \
--data-raw '{ --data-raw '{
@@ -10742,7 +10702,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
delete: delete:
operationId: DeleteProductCategoriesCategoryProductsBatch operationId: DeleteProductCategoriesCategoryProductsBatch
summary: Delete Products summary: Remove Products from Category
description: Remove a list of products from a product category. description: Remove a list of products from a product category.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -10777,10 +10737,10 @@ paths:
import Medusa from "@medusajs/medusa-js" import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token // must be previously logged in or use api token
medusa.admin.productCategories.removeProducts(product_category_id, { medusa.admin.productCategories.removeProducts(productCategoryId, {
product_ids: [ product_ids: [
{ {
id: product_id id: productId
} }
] ]
}) })
@@ -13684,6 +13644,16 @@ paths:
method: list method: list
queryParams: AdminGetReservationsParams queryParams: AdminGetReservationsParams
x-codeSamples: 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.admin.reservations.list()
.then(({ reservations, count, limit, offset }) => {
console.log(reservations.length)
})
- lang: Shell - lang: Shell
label: cURL label: cURL
source: | source: |
@@ -13715,8 +13685,8 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
post: post:
operationId: PostReservations operationId: PostReservations
summary: Creates a Reservation summary: Create a Reservation
description: Creates a Reservation which can be associated with any resource as required. description: Create a Reservation which can be associated with any resource as required.
x-authenticated: true x-authenticated: true
requestBody: requestBody:
content: content:
@@ -13731,9 +13701,13 @@ paths:
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token // must be previously logged in or use api token
medusa.admin.reservations.create({ medusa.admin.reservations.create({
line_item_id: 'item_123',
location_id: 'loc_123',
inventory_item_id: 'iitem_123',
quantity: 1
}) })
.then(({ reservations }) => { .then(({ reservation }) => {
console.log(reservations.id); console.log(reservation.id);
}); });
- lang: Shell - lang: Shell
label: cURL label: cURL
@@ -13742,9 +13716,10 @@ paths:
--header 'Authorization: Bearer {api_token}' \ --header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \ --header 'Content-Type: application/json' \
--data-raw '{ --data-raw '{
"resource_id": "{resource_id}", "line_item_id": "item_123",
"resource_type": "order", "location_id": "loc_123",
"value": "We delivered this order" "inventory_item_id": "iitem_123",
"quantity": 1
}' }'
security: security:
- api_token: [] - api_token: []
@@ -13774,7 +13749,7 @@ paths:
get: get:
operationId: GetReservationsReservation operationId: GetReservationsReservation
summary: Get a Reservation summary: Get a Reservation
description: Retrieves a single reservation using its id description: Retrieves a single reservation using its ID
x-authenticated: true x-authenticated: true
parameters: parameters:
- in: path - in: path
@@ -13790,7 +13765,7 @@ paths:
import Medusa from "@medusajs/medusa-js" import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token // must be previously logged in or use api token
medusa.admin.reservations.retrieve(reservation_id) medusa.admin.reservations.retrieve(reservationId)
.then(({ reservation }) => { .then(({ reservation }) => {
console.log(reservation.id); console.log(reservation.id);
}); });
@@ -13825,7 +13800,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
post: post:
operationId: PostReservationsReservation operationId: PostReservationsReservation
summary: Updates a Reservation summary: Update a Reservation
description: Updates a Reservation which can be associated with any resource as required. description: Updates a Reservation which can be associated with any resource as required.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -13847,11 +13822,11 @@ paths:
import Medusa from "@medusajs/medusa-js" import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token // must be previously logged in or use api token
medusa.admin.reservations.update(reservation.id, { medusa.admin.reservations.update(reservationId, {
quantity: 3 quantity: 3
}) })
.then(({ reservations }) => { .then(({ reservation }) => {
console.log(reservations.id); console.log(reservation.id);
}); });
- lang: Shell - lang: Shell
label: cURL label: cURL
@@ -13907,7 +13882,7 @@ paths:
import Medusa from "@medusajs/medusa-js" import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token // must be previously logged in or use api token
medusa.admin.reservations.delete(reservation.id) medusa.admin.reservations.delete(reservationId)
.then(({ id, object, deleted }) => { .then(({ id, object, deleted }) => {
console.log(id); console.log(id);
}); });
@@ -14958,8 +14933,8 @@ paths:
/admin/sales-channels/{id}/stock-locations: /admin/sales-channels/{id}/stock-locations:
post: post:
operationId: PostSalesChannelsSalesChannelStockLocation operationId: PostSalesChannelsSalesChannelStockLocation
summary: Associate a stock location to a Sales Channel summary: Associate a Stock Location
description: Associates a stock location to a Sales Channel. description: Associates a stock location with a Sales Channel.
x-authenticated: true x-authenticated: true
parameters: parameters:
- in: path - in: path
@@ -14982,8 +14957,8 @@ paths:
import Medusa from "@medusajs/medusa-js" import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token // must be previously logged in or use api token
medusa.admin.salesChannels.addLocation(sales_channel_id, { medusa.admin.salesChannels.addLocation(salesChannelId, {
location_id: 'App' location_id: 'loc_123'
}) })
.then(({ sales_channel }) => { .then(({ sales_channel }) => {
console.log(sales_channel.id); console.log(sales_channel.id);
@@ -14995,7 +14970,7 @@ paths:
--header 'Authorization: Bearer {api_token}' \ --header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \ --header 'Content-Type: application/json' \
--data-raw '{ --data-raw '{
"locaton_id": "stock_location_id" "locaton_id": "loc_123"
}' }'
security: security:
- api_token: [] - api_token: []
@@ -15023,7 +14998,7 @@ paths:
$ref: '#/components/responses/500_error' $ref: '#/components/responses/500_error'
delete: delete:
operationId: DeleteSalesChannelsSalesChannelStockLocation operationId: DeleteSalesChannelsSalesChannelStockLocation
summary: Remove a stock location from a Sales Channel summary: Remove a Stock Location Association
description: Removes a stock location from a Sales Channel. description: Removes a stock location from a Sales Channel.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -15047,8 +15022,8 @@ paths:
import Medusa from "@medusajs/medusa-js" import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token // must be previously logged in or use api token
medusa.admin.salesChannels.removeLocation(sales_channel_id, { medusa.admin.salesChannels.removeLocation(salesChannelId, {
location_id: 'App' location_id: 'loc_id'
}) })
.then(({ sales_channel }) => { .then(({ sales_channel }) => {
console.log(sales_channel.id); console.log(sales_channel.id);
@@ -15060,7 +15035,7 @@ paths:
--header 'Authorization: Bearer {api_token}' \ --header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \ --header 'Content-Type: application/json' \
--data-raw '{ --data-raw '{
"locaton_id": "stock_location_id" "locaton_id": "loc_id"
}' }'
security: security:
- api_token: [] - api_token: []
@@ -15868,7 +15843,6 @@ paths:
// must be previously logged in or use api token // must be previously logged in or use api token
medusa.admin.stockLocations.create({ medusa.admin.stockLocations.create({
name: 'Main Warehouse', name: 'Main Warehouse',
location_id: 'sloc'
}) })
.then(({ stock_location }) => { .then(({ stock_location }) => {
console.log(stock_location.id); console.log(stock_location.id);
@@ -15939,7 +15913,7 @@ paths:
import Medusa from "@medusajs/medusa-js" import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token // must be previously logged in or use api token
medusa.admin.stockLocations.retrieve(stock_location_id) medusa.admin.stockLocations.retrieve(stockLocationId)
.then(({ stock_location }) => { .then(({ stock_location }) => {
console.log(stock_location.id); console.log(stock_location.id);
}); });
@@ -15996,8 +15970,8 @@ paths:
import Medusa from "@medusajs/medusa-js" import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token // must be previously logged in or use api token
medusa.admin.stockLocations.update(stock_location_id, { medusa.admin.stockLocations.update(stockLocationId, {
name: 'App' name: 'Main Warehouse'
}) })
.then(({ stock_location }) => { .then(({ stock_location }) => {
console.log(stock_location.id); console.log(stock_location.id);
@@ -16009,7 +15983,7 @@ paths:
--header 'Authorization: Bearer {api_token}' \ --header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \ --header 'Content-Type: application/json' \
--data-raw '{ --data-raw '{
"name": "App" "name": "Main Warehouse"
}' }'
security: security:
- api_token: [] - api_token: []
docs/api/admin/code_samples/JavaScript/admin_inventory-items/get.js
+1 -1
View File
@@ -2,6 +2,6 @@ import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token // must be previously logged in or use api token
medusa.admin.inventoryItems.list() medusa.admin.inventoryItems.list()
.then(({ inventory_items }) => { .then(({ inventory_items, count, offset, limit }) => {
console.log(inventory_items.length); console.log(inventory_items.length);
}); });
docs/api/admin/code_samples/JavaScript/admin_inventory-items/post.js
+1 -2
View File
@@ -1,9 +1,8 @@
import Medusa from "@medusajs/medusa-js" import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token // must be previously logged in or use api token
medusa.admin.inventoryItems.create(inventoryItemId, { medusa.admin.inventoryItems.create({
variant_id: 'variant_123', variant_id: 'variant_123',
sku: "sku-123",
}) })
.then(({ inventory_item }) => { .then(({ inventory_item }) => {
console.log(inventory_item.id); console.log(inventory_item.id);
docs/api/admin/code_samples/JavaScript/admin_inventory-items_{id}_location-levels/post.js
+1 -1
View File
@@ -2,7 +2,7 @@ import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token // must be previously logged in or use api token
medusa.admin.inventoryItems.createLocationLevel(inventoryItemId, { medusa.admin.inventoryItems.createLocationLevel(inventoryItemId, {
location_id: 'sloc', location_id: 'sloc_123',
stocked_quantity: 10, stocked_quantity: 10,
}) })
.then(({ inventory_item }) => { .then(({ inventory_item }) => {
docs/api/admin/code_samples/JavaScript/admin_orders_{id}_line-items_{line_item_id}_reserve/post.js
-9
View File
@@ -1,9 +0,0 @@
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.createReservation(order_id, line_item_id, {
location_id
})
.then(({ reservation }) => {
console.log(reservation.id);
});
docs/api/admin/code_samples/JavaScript/admin_product-categories_{id}/delete.js
+1 -1
View File
@@ -1,7 +1,7 @@
import Medusa from "@medusajs/medusa-js" import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token // must be previously logged in or use api token
medusa.admin.productCategories.delete(product_category_id) medusa.admin.productCategories.delete(productCategoryId)
.then(({ id, object, deleted }) => { .then(({ id, object, deleted }) => {
console.log(id); console.log(id);
}); });
docs/api/admin/code_samples/JavaScript/admin_product-categories_{id}/get.js
+1 -1
View File
@@ -1,7 +1,7 @@
import Medusa from "@medusajs/medusa-js" import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token // must be previously logged in or use api token
medusa.admin.productCategories.retrieve(product_category_id) medusa.admin.productCategories.retrieve(productCategoryId)
.then(({ product_category }) => { .then(({ product_category }) => {
console.log(product_category.id); console.log(product_category.id);
}); });
docs/api/admin/code_samples/JavaScript/admin_product-categories_{id}/post.js
+1 -1
View File
@@ -1,7 +1,7 @@
import Medusa from "@medusajs/medusa-js" import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token // must be previously logged in or use api token
medusa.admin.productCategories.update(product_category_id, { medusa.admin.productCategories.update(productCategoryId, {
name: "Skinny Jeans" name: "Skinny Jeans"
}) })
.then(({ product_category }) => { .then(({ product_category }) => {
docs/api/admin/code_samples/JavaScript/admin_product-categories_{id}_products_batch/delete.js
+2 -2
View File
@@ -1,10 +1,10 @@
import Medusa from "@medusajs/medusa-js" import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token // must be previously logged in or use api token
medusa.admin.productCategories.removeProducts(product_category_id, { medusa.admin.productCategories.removeProducts(productCategoryId, {
product_ids: [ product_ids: [
{ {
id: product_id id: productId
} }
] ]
}) })
docs/api/admin/code_samples/JavaScript/admin_product-categories_{id}_products_batch/post.js
+2 -2
View File
@@ -1,10 +1,10 @@
import Medusa from "@medusajs/medusa-js" import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token // must be previously logged in or use api token
medusa.admin.productCategories.addProducts(product_category_id, { medusa.admin.productCategories.addProducts(productCategoryId, {
product_ids: [ product_ids: [
{ {
id: product_id id: productId
} }
] ]
}) })
docs/api/admin/code_samples/JavaScript/admin_orders_{id}_reservations/get.js → docs/api/admin/code_samples/JavaScript/admin_reservations/get.js
+4 -4
View File
@@ -1,7 +1,7 @@
import Medusa from "@medusajs/medusa-js" import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token // must be previously logged in or use api token
medusa.admin.orders.retrieveReservations(order_id) medusa.admin.reservations.list()
.then(({ reservations }) => { .then(({ reservations, count, limit, offset }) => {
console.log(reservations[0].id); console.log(reservations.length)
}); })
docs/api/admin/code_samples/JavaScript/admin_reservations/post.js
+6 -2
View File
@@ -2,7 +2,11 @@ import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token // must be previously logged in or use api token
medusa.admin.reservations.create({ medusa.admin.reservations.create({
line_item_id: 'item_123',
location_id: 'loc_123',
inventory_item_id: 'iitem_123',
quantity: 1
}) })
.then(({ reservations }) => { .then(({ reservation }) => {
console.log(reservations.id); console.log(reservation.id);
}); });
docs/api/admin/code_samples/JavaScript/admin_reservations_{id}/delete.js
+1 -1
View File
@@ -1,7 +1,7 @@
import Medusa from "@medusajs/medusa-js" import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token // must be previously logged in or use api token
medusa.admin.reservations.delete(reservation.id) medusa.admin.reservations.delete(reservationId)
.then(({ id, object, deleted }) => { .then(({ id, object, deleted }) => {
console.log(id); console.log(id);
}); });
docs/api/admin/code_samples/JavaScript/admin_reservations_{id}/get.js
+1 -1
View File
@@ -1,7 +1,7 @@
import Medusa from "@medusajs/medusa-js" import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token // must be previously logged in or use api token
medusa.admin.reservations.retrieve(reservation_id) medusa.admin.reservations.retrieve(reservationId)
.then(({ reservation }) => { .then(({ reservation }) => {
console.log(reservation.id); console.log(reservation.id);
}); });
docs/api/admin/code_samples/JavaScript/admin_reservations_{id}/post.js
+3 -3
View File
@@ -1,9 +1,9 @@
import Medusa from "@medusajs/medusa-js" import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token // must be previously logged in or use api token
medusa.admin.reservations.update(reservation.id, { medusa.admin.reservations.update(reservationId, {
quantity: 3 quantity: 3
}) })
.then(({ reservations }) => { .then(({ reservation }) => {
console.log(reservations.id); console.log(reservation.id);
}); });
docs/api/admin/code_samples/JavaScript/admin_sales-channels_{id}_stock-locations/delete.js
+2 -2
View File
@@ -1,8 +1,8 @@
import Medusa from "@medusajs/medusa-js" import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token // must be previously logged in or use api token
medusa.admin.salesChannels.removeLocation(sales_channel_id, { medusa.admin.salesChannels.removeLocation(salesChannelId, {
location_id: 'App' location_id: 'loc_id'
}) })
.then(({ sales_channel }) => { .then(({ sales_channel }) => {
console.log(sales_channel.id); console.log(sales_channel.id);
docs/api/admin/code_samples/JavaScript/admin_sales-channels_{id}_stock-locations/post.js
+2 -2
View File
@@ -1,8 +1,8 @@
import Medusa from "@medusajs/medusa-js" import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token // must be previously logged in or use api token
medusa.admin.salesChannels.addLocation(sales_channel_id, { medusa.admin.salesChannels.addLocation(salesChannelId, {
location_id: 'App' location_id: 'loc_123'
}) })
.then(({ sales_channel }) => { .then(({ sales_channel }) => {
console.log(sales_channel.id); console.log(sales_channel.id);
docs/api/admin/code_samples/JavaScript/admin_stock-locations/post.js
-1
View File
@@ -3,7 +3,6 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token // must be previously logged in or use api token
medusa.admin.stockLocations.create({ medusa.admin.stockLocations.create({
name: 'Main Warehouse', name: 'Main Warehouse',
location_id: 'sloc'
}) })
.then(({ stock_location }) => { .then(({ stock_location }) => {
console.log(stock_location.id); console.log(stock_location.id);
docs/api/admin/code_samples/JavaScript/admin_stock-locations_{id}/get.js
+1 -1
View File
@@ -1,7 +1,7 @@
import Medusa from "@medusajs/medusa-js" import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token // must be previously logged in or use api token
medusa.admin.stockLocations.retrieve(stock_location_id) medusa.admin.stockLocations.retrieve(stockLocationId)
.then(({ stock_location }) => { .then(({ stock_location }) => {
console.log(stock_location.id); console.log(stock_location.id);
}); });
docs/api/admin/code_samples/JavaScript/admin_stock-locations_{id}/post.js
+2 -2
View File
@@ -1,8 +1,8 @@
import Medusa from "@medusajs/medusa-js" import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token // must be previously logged in or use api token
medusa.admin.stockLocations.update(stock_location_id, { medusa.admin.stockLocations.update(stockLocationId, {
name: 'App' name: 'Main Warehouse'
}) })
.then(({ stock_location }) => { .then(({ stock_location }) => {
console.log(stock_location.id); console.log(stock_location.id);
docs/api/admin/code_samples/Shell/admin_inventory-items/get.sh
+1 -2
View File
@@ -1,3 +1,2 @@
curl --location --request GET 'https://medusa-url.com/admin/inventory-items' \ curl --location --request GET 'https://medusa-url.com/admin/inventory-items' \
--header 'Authorization: Bearer {api_token}' \ --header 'Authorization: Bearer {api_token}'
--header 'Content-Type: application/json'
docs/api/admin/code_samples/Shell/admin_inventory-items/post.sh
-1
View File
@@ -3,5 +3,4 @@ curl --location --request POST 'https://medusa-url.com/admin/inventory-items' \
--header 'Content-Type: application/json' \ --header 'Content-Type: application/json' \
--data-raw '{ --data-raw '{
"variant_id": "variant_123", "variant_id": "variant_123",
"sku": "sku-123",
}' }'
docs/api/admin/code_samples/Shell/admin_inventory-items_{id}/get.sh
+1 -2
View File
@@ -1,3 +1,2 @@
curl --location --request GET 'https://medusa-url.com/admin/inventory-items/{id}' \ curl --location --request GET 'https://medusa-url.com/admin/inventory-items/{id}' \
--header 'Authorization: Bearer {api_token}' \ --header 'Authorization: Bearer {api_token}'
--header 'Content-Type: application/json'
docs/api/admin/code_samples/Shell/admin_inventory-items_{id}_location-levels/get.sh
+1 -2
View File
@@ -1,3 +1,2 @@
curl --location --request GET 'https://medusa-url.com/admin/inventory-items/{id}/location-levels' \ curl --location --request GET 'https://medusa-url.com/admin/inventory-items/{id}/location-levels' \
--header 'Authorization: Bearer {api_token}' \ --header 'Authorization: Bearer {api_token}'
--header 'Content-Type: application/json'
docs/api/admin/code_samples/Shell/admin_inventory-items_{id}_location-levels/post.sh
+1 -1
View File
@@ -2,6 +2,6 @@ curl --location --request POST 'https://medusa-url.com/admin/inventory-items/{id
--header 'Authorization: Bearer {api_token}' \ --header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \ --header 'Content-Type: application/json' \
--data-raw '{ --data-raw '{
"location_id": "sloc", "location_id": "sloc_123",
"stocked_quantity": 10 "stocked_quantity": 10
}' }'
docs/api/admin/code_samples/Shell/admin_inventory-items_{id}_location-levels_{location_id}/delete.sh
+1 -2
View File
@@ -1,3 +1,2 @@
curl --location --request DELETE 'https://medusa-url.com/admin/inventory-items/{id}/location-levels/{location_id}' \ curl --location --request DELETE 'https://medusa-url.com/admin/inventory-items/{id}/location-levels/{location_id}' \
--header 'Authorization: Bearer {api_token}' \ --header 'Authorization: Bearer {api_token}'
--header 'Content-Type: application/json'
docs/api/admin/code_samples/Shell/admin_orders_{id}_line-items_{line_item_id}_reserve/post.sh
+1 -1
View File
@@ -1,4 +1,4 @@
curl --location --request POST 'https://medusa-url.com/admin/orders/{id}/line-items/{line_item_id}/reservations' \ curl --location --request POST 'https://medusa-url.com/admin/orders/{id}/line-items/{line_item_id}/reserve' \
--header 'Authorization: Bearer {api_token}' \ --header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \ --header 'Content-Type: application/json' \
--data-raw '{ --data-raw '{
docs/api/admin/code_samples/Shell/admin_product-categories_{id}_products_batch/post.sh
+1 -1
View File
@@ -1,5 +1,5 @@
curl --location \ curl --location \
--request POST 'https://medusa-url.com/admin/product-categories/{product_category_id}/products/batch' \ --request POST 'https://medusa-url.com/admin/product-categories/{id}/products/batch' \
--header 'Authorization: Bearer {api_token}' \ --header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \ --header 'Content-Type: application/json' \
--data-raw '{ --data-raw '{
docs/api/admin/code_samples/Shell/admin_reservations/post.sh
+4 -3
View File
@@ -2,7 +2,8 @@ curl --location --request POST 'https://medusa-url.com/admin/reservations' \
--header 'Authorization: Bearer {api_token}' \ --header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \ --header 'Content-Type: application/json' \
--data-raw '{ --data-raw '{
"resource_id": "{resource_id}", "line_item_id": "item_123",
"resource_type": "order", "location_id": "loc_123",
"value": "We delivered this order" "inventory_item_id": "iitem_123",
"quantity": 1
}' }'
docs/api/admin/code_samples/Shell/admin_sales-channels_{id}_stock-locations/delete.sh
+1 -1
View File
@@ -2,5 +2,5 @@ curl --location --request DELETE 'https://medusa-url.com/admin/sales-channels/{i
--header 'Authorization: Bearer {api_token}' \ --header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \ --header 'Content-Type: application/json' \
--data-raw '{ --data-raw '{
"locaton_id": "stock_location_id" "locaton_id": "loc_id"
}' }'
docs/api/admin/code_samples/Shell/admin_sales-channels_{id}_stock-locations/post.sh
+1 -1
View File
@@ -2,5 +2,5 @@ curl --location --request POST 'https://medusa-url.com/admin/sales-channels/{id}
--header 'Authorization: Bearer {api_token}' \ --header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \ --header 'Content-Type: application/json' \
--data-raw '{ --data-raw '{
"locaton_id": "stock_location_id" "locaton_id": "loc_123"
}' }'
docs/api/admin/code_samples/Shell/admin_stock-locations_{id}/post.sh
+1 -1
View File
@@ -2,5 +2,5 @@ curl --location --request POST 'https://medusa-url.com/admin/stock-locations/{id
--header 'Authorization: Bearer {api_token}' \ --header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \ --header 'Content-Type: application/json' \
--data-raw '{ --data-raw '{
"name": "App" "name": "Main Warehouse"
}' }'
docs/api/admin/paths/admin_inventory-items.yaml
+5 -3
View File
@@ -1,7 +1,9 @@
get: get:
operationId: GetInventoryItems operationId: GetInventoryItems
summary: List inventory items. summary: List Inventory Items
description: Lists inventory items. description: >-
Lists inventory items with the ability to apply filters or search queries on
them.
x-authenticated: true x-authenticated: true
parameters: parameters:
- in: query - in: query
@@ -134,7 +136,7 @@ get:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
post: post:
operationId: PostInventoryItems operationId: PostInventoryItems
summary: Create an Inventory Item. summary: Create an Inventory Item
description: Creates an Inventory Item. description: Creates an Inventory Item.
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/admin_inventory-items_{id}.yaml
+3 -3
View File
@@ -1,7 +1,7 @@
get: get:
operationId: GetInventoryItemsInventoryItem operationId: GetInventoryItemsInventoryItem
summary: Retrive an Inventory Item. summary: Get an Inventory Item
description: Retrives an Inventory Item. description: Retrieves an Inventory Item.
x-authenticated: true x-authenticated: true
parameters: parameters:
- in: path - in: path
@@ -58,7 +58,7 @@ get:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
post: post:
operationId: PostInventoryItemsInventoryItem operationId: PostInventoryItemsInventoryItem
summary: Update an Inventory Item. summary: Update an Inventory Item
description: Updates an Inventory Item. description: Updates an Inventory Item.
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/admin_inventory-items_{id}_location-levels.yaml
+4 -16
View File
@@ -1,7 +1,7 @@
get: get:
operationId: GetInventoryItemsInventoryItemLocationLevels operationId: GetInventoryItemsInventoryItemLocationLevels
summary: List stock levels of a given location. summary: List Inventory Levels
description: Lists stock levels of a given location. description: Lists inventory levels of an inventory item.
x-authenticated: true x-authenticated: true
parameters: parameters:
- in: path - in: path
@@ -10,18 +10,6 @@ get:
description: The ID of the Inventory Item. description: The ID of the Inventory Item.
schema: schema:
type: string type: string
- in: query
name: offset
description: How many stock locations levels to skip in the result.
schema:
type: integer
default: 0
- in: query
name: limit
description: Limit the number of stock locations levels returned.
schema:
type: integer
default: 20
- in: query - in: query
name: expand name: expand
description: Comma separated list of relations to include in the results. description: Comma separated list of relations to include in the results.
@@ -72,8 +60,8 @@ get:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
post: post:
operationId: PostInventoryItemsInventoryItemLocationLevels operationId: PostInventoryItemsInventoryItemLocationLevels
summary: Create an Inventory Location Level for a given Inventory Item. summary: Create an Inventory Level
description: Creates an Inventory Location Level for a given Inventory Item. description: Creates an Inventory Level for a given Inventory Item.
x-authenticated: true x-authenticated: true
parameters: parameters:
- in: path - in: path
docs/api/admin/paths/admin_inventory-items_{id}_location-levels_{location_id}.yaml
+3 -3
View File
@@ -1,7 +1,7 @@
post: post:
operationId: PostInventoryItemsInventoryItemLocationLevelsLocationLevel operationId: PostInventoryItemsInventoryItemLocationLevelsLocationLevel
summary: Update an Inventory Location Level for a given Inventory Item. summary: Update an Inventory Level
description: Updates an Inventory Location Level for a given Inventory Item. description: Updates an Inventory Level for a given Inventory Item.
x-authenticated: true x-authenticated: true
parameters: parameters:
- in: path - in: path
@@ -72,7 +72,7 @@ post:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
delete: delete:
operationId: DeleteInventoryItemsInventoryIteLocationLevelsLocation operationId: DeleteInventoryItemsInventoryIteLocationLevelsLocation
summary: Delete a location level of an Inventory Item. summary: Delete a Location Level
description: Delete a location level of an Inventory Item. description: Delete a location level of an Inventory Item.
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/admin_orders_{id}_line-items_{line_item_id}_reserve.yaml
-5
View File
@@ -24,11 +24,6 @@ post:
schema: schema:
$ref: ../components/schemas/AdminOrdersOrderLineItemReservationReq.yaml $ref: ../components/schemas/AdminOrdersOrderLineItemReservationReq.yaml
x-codeSamples: x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: >-
../code_samples/JavaScript/admin_orders_{id}_line-items_{line_item_id}_reserve/post.js
- lang: Shell - lang: Shell
label: cURL label: cURL
source: source:
docs/api/admin/paths/admin_orders_{id}_reservations.yaml
+2 -6
View File
@@ -1,7 +1,7 @@
get: get:
operationId: GetOrdersOrderReservations operationId: GetOrdersOrderReservations
summary: Get reservations for an Order summary: Get reservations of an Order
description: Retrieves reservations for an Order description: Retrieves reservations of an Order
x-authenticated: true x-authenticated: true
parameters: parameters:
- in: path - in: path
@@ -23,10 +23,6 @@ get:
type: integer type: integer
default: 20 default: 20
x-codeSamples: x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/admin_orders_{id}_reservations/get.js
- lang: Shell - lang: Shell
label: cURL label: cURL
source: source:
docs/api/admin/paths/admin_product-categories_{id}_products_batch.yaml
+2 -2
View File
@@ -1,6 +1,6 @@
post: post:
operationId: PostProductCategoriesCategoryProductsBatch operationId: PostProductCategoriesCategoryProductsBatch
summary: Add Products to a category summary: Add Products to a Category
description: Assign a batch of products to a product category. description: Assign a batch of products to a product category.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -66,7 +66,7 @@ post:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
delete: delete:
operationId: DeleteProductCategoriesCategoryProductsBatch operationId: DeleteProductCategoriesCategoryProductsBatch
summary: Delete Products summary: Remove Products from Category
description: Remove a list of products from a product category. description: Remove a list of products from a product category.
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/admin_reservations.yaml
+6 -2
View File
@@ -81,6 +81,10 @@ get:
method: list method: list
queryParams: AdminGetReservationsParams queryParams: AdminGetReservationsParams
x-codeSamples: x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/admin_reservations/get.js
- lang: Shell - lang: Shell
label: cURL label: cURL
source: source:
@@ -111,8 +115,8 @@ get:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
post: post:
operationId: PostReservations operationId: PostReservations
summary: Creates a Reservation summary: Create a Reservation
description: Creates a Reservation which can be associated with any resource as required. description: Create a Reservation which can be associated with any resource as required.
x-authenticated: true x-authenticated: true
requestBody: requestBody:
content: content:
docs/api/admin/paths/admin_reservations_{id}.yaml
+2 -2
View File
@@ -1,7 +1,7 @@
get: get:
operationId: GetReservationsReservation operationId: GetReservationsReservation
summary: Get a Reservation summary: Get a Reservation
description: Retrieves a single reservation using its id description: Retrieves a single reservation using its ID
x-authenticated: true x-authenticated: true
parameters: parameters:
- in: path - in: path
@@ -45,7 +45,7 @@ get:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
post: post:
operationId: PostReservationsReservation operationId: PostReservationsReservation
summary: Updates a Reservation summary: Update a Reservation
description: Updates a Reservation which can be associated with any resource as required. description: Updates a Reservation which can be associated with any resource as required.
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/api/admin/paths/admin_sales-channels_{id}_stock-locations.yaml
+3 -3
View File
@@ -1,7 +1,7 @@
post: post:
operationId: PostSalesChannelsSalesChannelStockLocation operationId: PostSalesChannelsSalesChannelStockLocation
summary: Associate a stock location to a Sales Channel summary: Associate a Stock Location
description: Associates a stock location to a Sales Channel. description: Associates a stock location with a Sales Channel.
x-authenticated: true x-authenticated: true
parameters: parameters:
- in: path - in: path
@@ -55,7 +55,7 @@ post:
$ref: ../components/responses/500_error.yaml $ref: ../components/responses/500_error.yaml
delete: delete:
operationId: DeleteSalesChannelsSalesChannelStockLocation operationId: DeleteSalesChannelsSalesChannelStockLocation
summary: Remove a stock location from a Sales Channel summary: Remove a Stock Location Association
description: Removes a stock location from a Sales Channel. description: Removes a stock location from a Sales Channel.
x-authenticated: true x-authenticated: true
parameters: parameters:
docs/content/modules/overview.mdx
+1 -1
View File
@@ -103,7 +103,7 @@ Medusa's products configuration allows managing products of different types incl
> >
- Create products with unlimited variants and options. - Create products with unlimited variants and options.
- Organize products into nested categories of different heirarchies. - Organize products into nested categories of different hierarchies.
- Associate products with collections, types, and tags. - Associate products with collections, types, and tags.
- Manage a product’s inventory, pricing, sales channels, and more. - Manage a product’s inventory, pricing, sales channels, and more.
- Import and export products to and from Medusa using CSV files. - Import and export products to and from Medusa using CSV files.