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

chore(docs): Generated API Reference (#2143)

Browse Source 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2022-09-05 10:23:46 +03:00
committed by GitHub
parent 4961aece1c
commit a1350bfaec
662 changed files with 51365 additions and 29004 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/api/store/code_samples/Shell/auth/deleteundefined Normal file
View File

@@ -0,0 +1,2 @@
curl --location --request DELETE 'https://medusa-url.com/store/auth' \
--header 'Cookie: connect.sid={sid}'

2
docs/api/store/code_samples/Shell/auth/getundefined Normal file
View File

@@ -0,0 +1,2 @@
curl --location --request GET 'https://medusa-url.com/store/auth' \
--header 'Cookie: connect.sid={sid}'

6
docs/api/store/code_samples/Shell/auth/postundefined Normal file
View File

@@ -0,0 +1,6 @@
curl --location --request POST 'https://medusa-url.com/store/auth' \
--header 'Content-Type: application/json' \
--data-raw '{
"email": "user@example.com",
"password": "supersecret"
}'

2
docs/api/store/code_samples/Shell/auth_{email}/getundefined Normal file
View File

@@ -0,0 +1,2 @@
curl --location --request GET 'https://medusa-url.com/store/auth/user@example.com' \
--header 'Cookie: connect.sid={sid}'

1
docs/api/store/code_samples/Shell/carts/postundefined Normal file
View File

@@ -0,0 +1 @@
curl --location --request POST 'https://medusa-url.com/store/carts'

1
docs/api/store/code_samples/Shell/carts_{id}/getundefined Normal file
View File

@@ -0,0 +1 @@
curl --location --request GET 'https://medusa-url.com/store/carts/{id}'

5
docs/api/store/code_samples/Shell/carts_{id}/postundefined Normal file
View File

@@ -0,0 +1,5 @@
curl --location --request POST 'https://medusa-url.com/store/carts/{id}' \
--header 'Content-Type: application/json' \
--data-raw '{
"email": "user@example.com"
}'

1
docs/api/store/code_samples/Shell/carts_{id}_complete/postundefined Normal file
View File

@@ -0,0 +1 @@
curl --location --request POST 'https://medusa-url.com/store/carts/{id}/complete'

1
docs/api/store/code_samples/Shell/carts_{id}_discounts_{code}/deleteundefined Normal file
View File

@@ -0,0 +1 @@
curl --location --request DELETE 'https://medusa-url.com/store/carts/{id}/discounts/{code}'

6
docs/api/store/code_samples/Shell/carts_{id}_line-items/postundefined Normal file
View File

@@ -0,0 +1,6 @@
curl --location --request POST 'https://medusa-url.com/store/carts/{id}/line-items' \
--header 'Content-Type: application/json' \
--data-raw '{
"variant_id": "{variant_id}",
"quantity": 1
}'

1
docs/api/store/code_samples/Shell/carts_{id}_line-items_{line_id}/deleteundefined Normal file
View File

@@ -0,0 +1 @@
curl --location --request DELETE 'https://medusa-url.com/store/carts/{id}/line-items/{line_id}'

5
docs/api/store/code_samples/Shell/carts_{id}_line-items_{line_id}/postundefined Normal file
View File

@@ -0,0 +1,5 @@
curl --location --request POST 'https://medusa-url.com/store/carts/{id}/line-items/{line_id}' \
--header 'Content-Type: application/json' \
--data-raw '{
"quantity": 1
}'

5
docs/api/store/code_samples/Shell/carts_{id}_payment-session/postundefined Normal file
View File

@@ -0,0 +1,5 @@
curl --location --request POST 'https://medusa-url.com/store/carts/{id}/payment-sessions' \
--header 'Content-Type: application/json' \
--data-raw '{
"provider_id": "manual"
}'

1
docs/api/store/code_samples/Shell/carts_{id}_payment-sessions/postundefined Normal file
View File

@@ -0,0 +1 @@
curl --location --request POST 'https://medusa-url.com/store/carts/{id}/payment-sessions'

1
docs/api/store/code_samples/Shell/carts_{id}_payment-sessions_{provider_id}/deleteundefined Normal file
View File

@@ -0,0 +1 @@
curl --location --request DELETE 'https://medusa-url.com/store/carts/{id}/payment-sessions/manual'

5
docs/api/store/code_samples/Shell/carts_{id}_payment-sessions_{provider_id}/postundefined Normal file
View File

@@ -0,0 +1,5 @@
curl --location --request POST 'https://medusa-url.com/store/carts/{id}/payment-sessions/manual' \
--header 'Content-Type: application/json' \
--data-raw '{
"data": {}
}'

1
docs/api/store/code_samples/Shell/carts_{id}_payment-sessions_{provider_id}_refresh/postundefined Normal file
View File

@@ -0,0 +1 @@
curl --location --request POST 'https://medusa-url.com/store/carts/{id}/payment-sessions/manual/refresh'

5
docs/api/store/code_samples/Shell/carts_{id}_shipping-methods/postundefined Normal file
View File

@@ -0,0 +1,5 @@
curl --location --request POST 'https://medusa-url.com/store/carts/{id}/shipping-methods' \
--header 'Content-Type: application/json' \
--data-raw '{
"option_id": "{option_id}",
}'

1
docs/api/store/code_samples/Shell/carts_{id}_taxes/postundefined Normal file
View File

@@ -0,0 +1 @@
curl --location --request POST 'https://medusa-url.com/store/carts/{id}/taxes'

1
docs/api/store/code_samples/Shell/collections/getundefined Normal file
View File

@@ -0,0 +1 @@
curl --location --request GET 'https://medusa-url.com/store/collections'

1
docs/api/store/code_samples/Shell/collections_{id}/getundefined Normal file
View File

@@ -0,0 +1 @@
curl --location --request GET 'https://medusa-url.com/store/collections/{id}'

8
docs/api/store/code_samples/Shell/customers/postundefined Normal file
View File

@@ -0,0 +1,8 @@
curl --location --request POST 'https://medusa-url.com/store/customers' \
--header 'Content-Type: application/json' \
--data-raw '{
"first_name": "Alec",
"last_name": "Reynolds",
"email": "user@example.com",
"password": "supersecret"
}'

2
docs/api/store/code_samples/Shell/customers_me/getundefined Normal file
View File

@@ -0,0 +1,2 @@
curl --location --request GET 'https://medusa-url.com/store/customers/me' \
--header 'Cookie: connect.sid={sid}'

6
docs/api/store/code_samples/Shell/customers_me/postundefined Normal file
View File

@@ -0,0 +1,6 @@
curl --location --request POST 'https://medusa-url.com/store/customers/me' \
--header 'Cookie: connect.sid={sid}' \
--header 'Content-Type: application/json' \
--data-raw '{
"first_name": "Laury"
}'

13
docs/api/store/code_samples/Shell/customers_me_addresses/postundefined Normal file
View File

@@ -0,0 +1,13 @@
curl --location --request POST 'https://medusa-url.com/store/customers/me/addresses' \
--header 'Cookie: connect.sid={sid}' \
--header 'Content-Type: application/json' \
--data-raw '{
"address": {
"first_name": "Celia",
"last_name": "Schumm",
"address_1": "225 Bednar Curve",
"city": "Danielville",
"country_code": "US",
"postal_code": "85137"
}
}'

2
docs/api/store/code_samples/Shell/customers_me_addresses_{address_id}/deleteundefined Normal file
View File

@@ -0,0 +1,2 @@
curl --location --request DELETE 'https://medusa-url.com/store/customers/me/addresses/{address_id}' \
--header 'Cookie: connect.sid={sid}'

6
docs/api/store/code_samples/Shell/customers_me_addresses_{address_id}/postundefined Normal file
View File

@@ -0,0 +1,6 @@
curl --location --request POST 'https://medusa-url.com/store/customers/me/addresses/{address_id}' \
--header 'Cookie: connect.sid={sid}' \
--header 'Content-Type: application/json' \
--data-raw '{
"first_name": "Gina"
}'

2
docs/api/store/code_samples/Shell/customers_me_orders/getundefined Normal file
View File

@@ -0,0 +1,2 @@
curl --location --request GET 'https://medusa-url.com/store/customers/me/orders' \
--header 'Cookie: connect.sid={sid}'

2
docs/api/store/code_samples/Shell/customers_me_payment-methods/getundefined Normal file
View File

@@ -0,0 +1,2 @@
curl --location --request GET 'https://medusa-url.com/store/customers/me/payment-methods' \
--header 'Cookie: connect.sid={sid}'

7
docs/api/store/code_samples/Shell/customers_password-reset/postundefined Normal file
View File

@@ -0,0 +1,7 @@
curl --location --request POST 'https://medusa-url.com/store/customers/password-reset' \
--header 'Content-Type: application/json' \
--data-raw '{
"email": "user@example.com",
"password": "supersecret",
"token": "supersecrettoken"
}'

5
docs/api/store/code_samples/Shell/customers_password-token/postundefined Normal file
View File

@@ -0,0 +1,5 @@
curl --location --request POST 'https://medusa-url.com/store/customers/password-token' \
--header 'Content-Type: application/json' \
--data-raw '{
"email": "user@example.com"
}'

1
docs/api/store/code_samples/Shell/gift-cards_{code}/getundefined Normal file
View File

@@ -0,0 +1 @@
curl --location --request GET 'https://medusa-url.com/store/gift-cards/{code}'

1
docs/api/store/code_samples/Shell/orders/getundefined Normal file
View File

@@ -0,0 +1 @@
curl --location --request GET 'https://medusa-url.com/store/orders?display_id=1&email=user@example.com'

1
docs/api/store/code_samples/Shell/orders_cart_{cart_id}/getundefined Normal file
View File

@@ -0,0 +1 @@
curl --location --request GET 'https://medusa-url.com/store/orders/cart/{id}'

1
docs/api/store/code_samples/Shell/orders_{id}/getundefined Normal file
View File

@@ -0,0 +1 @@
curl --location --request GET 'https://medusa-url.com/store/orders/{id}'

1
docs/api/store/code_samples/Shell/products/getundefined Normal file
View File

@@ -0,0 +1 @@
curl --location --request GET 'https://medusa-url.com/store/products'

1
docs/api/store/code_samples/Shell/products_search/postundefined Normal file
View File

@@ -0,0 +1 @@
curl --location --request POST 'https://medusa-url.com/store/products/search?q=Shirt'

1
docs/api/store/code_samples/Shell/products_{id}/getundefined Normal file
View File

@@ -0,0 +1 @@
curl --location --request GET 'https://medusa-url.com/store/products/{id}'

1
docs/api/store/code_samples/Shell/regions/getundefined Normal file
View File

@@ -0,0 +1 @@
curl --location --request GET 'https://medusa-url.com/store/regions'

1
docs/api/store/code_samples/Shell/regions_{id}/getundefined Normal file
View File

@@ -0,0 +1 @@
curl --location --request GET 'https://medusa-url.com/store/regions/{id}'

1
docs/api/store/code_samples/Shell/return-reasons/getundefined Normal file
View File

@@ -0,0 +1 @@
curl --location --request GET 'https://medusa-url.com/store/return-reasons'

1
docs/api/store/code_samples/Shell/return-reasons_{id}/getundefined Normal file
View File

@@ -0,0 +1 @@
curl --location --request GET 'https://medusa-url.com/store/return-reasons/{id}'

11
docs/api/store/code_samples/Shell/returns/postundefined Normal file
View File

@@ -0,0 +1,11 @@
curl --location --request POST 'https://medusa-url.com/store/returns' \
--header 'Content-Type: application/json' \
--data-raw '{
"order_id": "asfasf",
"items": [
{
"item_id": "assfasf",
"quantity": 1
}
]
}'

1
docs/api/store/code_samples/Shell/shipping-options/getundefined Normal file
View File

@@ -0,0 +1 @@
curl --location --request GET 'https://medusa-url.com/store/shipping-options'

1
docs/api/store/code_samples/Shell/shipping-options_{cart_id}/getundefined Normal file
View File

@@ -0,0 +1 @@
curl --location --request GET 'https://medusa-url.com/store/shipping-options/{cart_id}'

17
docs/api/store/code_samples/Shell/swaps/postundefined Normal file
View File

@@ -0,0 +1,17 @@
curl --location --request POST 'https://medusa-url.com/store/swaps' \
--header 'Content-Type: application/json' \
--data-raw '{
"order_id": "asfasf",
"return_items": [
{
"item_id": "asfas",
"quantity": 1
}
],
"additional_items": [
{
"variant_id": "asfas",
"quantity": 1
}
]
}'

1
docs/api/store/code_samples/Shell/swaps_{cart_id}/getundefined Normal file
View File

@@ -0,0 +1 @@
curl --location --request GET 'https://medusa-url.com/store/swaps/{cart_id}'

1
docs/api/store/code_samples/Shell/variants/getundefined Normal file
View File

@@ -0,0 +1 @@
curl --location --request GET 'https://medusa-url.com/store/variants'

1
docs/api/store/code_samples/Shell/variants_{variant_id}/getundefined Normal file
View File

@@ -0,0 +1 @@
curl --location --request GET 'https://medusa-url.com/store/variants/{id}'