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

chore: generate API reference (#2410)

Browse Source
This commit is contained in:
Shahed Nasser
2022-10-11 10:30:45 +03:00
committed by GitHub
parent 9aeda1b52d
commit 14d4b9d95c
49 changed files with 5045 additions and 1930 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/api/admin/code_samples/JavaScript/order-edits/postundefined Normal file
View File

@@ -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.admin.orderEdit.create({ order_id, internal_note })
.then(({ order_edit }) => {
console.log(order_edit.id)
})

7
docs/api/admin/code_samples/JavaScript/order-edits_{id}/deleteundefined Normal file
View File

@@ -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.admin.orderEdits.delete(edit_id)
.then(({ id, object, deleted }) => {
console.log(id)
})

7
docs/api/admin/code_samples/JavaScript/order-edits_{id}/getundefined Normal file
View File

@@ -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.admin.orderEdit.retrieve(orderEditId)
.then(({ order_edit }) => {
console.log(order_edit.id)
})

8
docs/api/admin/code_samples/JavaScript/order-edits_{id}/postundefined Normal file
View File

@@ -0,0 +1,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
const params = {internal_note: "internal reason XY"}
medusa.admin.orderEdit.update(orderEditId, params)
.then(({ order_edit }) => {
console.log(order_edit.id)
})

7
docs/api/admin/code_samples/JavaScript/order-edits_{id}_cancel/postundefined Normal file
View File

@@ -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.admin.orderEdit.cancel(orderEditId)
.then(({ order_edit }) => {
console.log(order_edit.id)
})

7
docs/api/admin/code_samples/JavaScript/order-edits_{id}_changes_{change_id}/deleteundefined Normal file
View File

@@ -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.admin.orderEdits.deleteItemChange(item_change_id, order_edit_id)
.then(({ id, object, deleted }) => {
console.log(id)
})

7
docs/api/admin/code_samples/JavaScript/order-edits_{id}_confirm/postundefined Normal file
View File

@@ -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.admin.orderEdit.confirm(orderEditId)
.then(({ order_edit }) => {
console.log(order_edit.id)
})

7
docs/api/admin/code_samples/JavaScript/order-edits_{id}_items/postundefined Normal file
View File

@@ -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.admin.orderEdit.addLineItem(order_edit_id, { variant_id, quantity })
.then(({ order_edit }) => {
console.log(order_edit.id)
})

7
docs/api/admin/code_samples/JavaScript/order-edits_{id}_items_{item_id}/deleteundefined Normal file
View File

@@ -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.admin.orderEdits.removeLineItem(order_edit_id, line_item_id)
.then(({ order_edit }) => {
console.log(order_edit.id)
})

7
docs/api/admin/code_samples/JavaScript/order-edits_{id}_items_{item_id}/postundefined Normal file
View File

@@ -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.admin.orderEdits.updateLineItem(order_edit_id, line_item_id)
.then(({ order_edit }) => {
console.log(order_edit.id)
})

7
docs/api/admin/code_samples/JavaScript/order-edits_{id}_request/postundefined Normal file
View File

@@ -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.admin.orderEdits.requestConfirmation(edit_id)
.then({ order_edit }) => {
console.log(order_edit.id)
})

3
docs/api/admin/code_samples/Shell/order-edits/postundefined Normal file
View File

@@ -0,0 +1,3 @@
curl --location --request POST 'https://medusa-url.com/admin/order-edits' \
--header 'Authorization: Bearer {api_token}'
-d '{ "order_id": "my_order_id", "internal_note": "my_optional_note" }'

2
docs/api/admin/code_samples/Shell/order-edits_{id}/deleteundefined Normal file
View File

@@ -0,0 +1,2 @@
curl --location --request DELETE 'https://medusa-url.com/admin/order-edits/{id}' \
--header 'Authorization: Bearer {api_token}'

2
docs/api/admin/code_samples/Shell/order-edits_{id}/getundefined Normal file
View File

@@ -0,0 +1,2 @@
curl --location --request GET 'https://medusa-url.com/admin/order-edits/{id}' \
--header 'Authorization: Bearer {api_token}'

6
docs/api/admin/code_samples/Shell/order-edits_{id}/postundefined Normal file
View File

@@ -0,0 +1,6 @@
curl --location --request POST 'https://medusa-url.com/admin/order-edits/{id}' \
--header 'Authorization: Bearer {api_token}'
--header 'Content-Type: application/json' \
--data-raw '{
"internal_note": "internal reason XY"
}'

2
docs/api/admin/code_samples/Shell/order-edits_{id}_cancel/postundefined Normal file
View File

@@ -0,0 +1,2 @@
curl --location --request POST 'https://medusa-url.com/admin/order-edits/:id/cancel' \
--header 'Authorization: Bearer {api_token}'

2
docs/api/admin/code_samples/Shell/order-edits_{id}_changes_{change_id}/deleteundefined Normal file
View File

@@ -0,0 +1,2 @@
curl --location --request DELETE 'https://medusa-url.com/admin/order-edits/{id}/changes/{change_id}' \
--header 'Authorization: Bearer {api_token}'

2
docs/api/admin/code_samples/Shell/order-edits_{id}_confirm/postundefined Normal file
View File

@@ -0,0 +1,2 @@
curl --location --request POST 'https://medusa-url.com/admin/order-edits/:id/confirm' \
--header 'Authorization: Bearer {api_token}'

3
docs/api/admin/code_samples/Shell/order-edits_{id}_items/postundefined Normal file
View File

@@ -0,0 +1,3 @@
curl --location --request POST 'https://medusa-url.com/admin/order-edits/{id}/items' \
--header 'Authorization: Bearer {api_token}'
-d '{ "variant_id": "some_variant_id", "quantity": 3 }'

2
docs/api/admin/code_samples/Shell/order-edits_{id}_items_{item_id}/deleteundefined Normal file
View File

@@ -0,0 +1,2 @@
curl --location --request DELETE 'https://medusa-url.com/admin/order-edits/{id}/items/{item_id}' \
--header 'Authorization: Bearer {api_token}'

3
docs/api/admin/code_samples/Shell/order-edits_{id}_items_{item_id}/postundefined Normal file
View File

@@ -0,0 +1,3 @@
curl --location --request POST 'https://medusa-url.com/admin/order-edits/{id}/items/{item_id}' \
--header 'Authorization: Bearer {api_token}'
-d '{ "quantity": 5 }'

2
docs/api/admin/code_samples/Shell/order-edits_{id}_request/postundefined Normal file
View File

@@ -0,0 +1,2 @@
curl --location --request POST 'https://medusa-url.com/admin/order-edits/{id}/request' \
--header 'Authorization: Bearer {api_token}'