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

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

View File

@@ -0,0 +1,6 @@
curl --location --request POST 'https://medusa-url.com/admin/draft-orders/{id}' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"email": "user@example.com"
}'

View File

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

View File

@@ -0,0 +1,8 @@
curl --location --request POST 'https://medusa-url.com/admin/apps/authorizations' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"application_name": "example",
"state": "ready",
"code": "token"
}'

View File

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

View File

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

View File

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

View File

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

View File

@@ -0,0 +1,7 @@
curl --location --request POST 'https://medusa-url.com/admin/batch-jobs' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {api_token}' \
--data-raw '{
"type": "product-export",
"context": { }
}'

View File

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

View File

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

View File

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

View File

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

View File

@@ -0,0 +1,6 @@
curl --location --request POST 'https://medusa-url.com/admin/collections' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"title": "New Collection"
}'

View File

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

View File

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

View File

@@ -0,0 +1,6 @@
curl --location --request POST 'https://medusa-url.com/admin/collections/{id}' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"title": "New Collection"
}'

View File

@@ -0,0 +1,8 @@
curl --location --request DELETE 'https://medusa-url.com/admin/collections/{id}/products/batch' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"product_ids": [
"prod_01G1G5V2MBA328390B5AXJ610F"
]
}'

View File

@@ -0,0 +1,8 @@
curl --location --request POST 'https://medusa-url.com/admin/collections/{id}/products/batch' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"product_ids": [
"prod_01G1G5V2MBA328390B5AXJ610F"
]
}'

View File

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

View File

@@ -0,0 +1,6 @@
curl --location --request POST 'https://medusa-url.com/admin/customer-groups' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "VIP"
}'

View File

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

View File

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

View File

@@ -0,0 +1,6 @@
curl --location --request POST 'https://medusa-url.com/admin/customer-groups/{id}' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "VIP"
}'

View File

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

View File

@@ -0,0 +1,10 @@
curl --location --request DELETE 'https://medusa-url.com/admin/customer-groups/{id}/customers/batch' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"customer_ids": [
{
"id": "cus_01G2Q4BS9GAHDBMDEN4ZQZCJB2"
}
]
}'

View File

@@ -0,0 +1,10 @@
curl --location --request POST 'https://medusa-url.com/admin/customer-groups/{id}/customers/batch' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"customer_ids": [
{
"id": "cus_01G2Q4BS9GAHDBMDEN4ZQZCJB2"
}
]
}'

View File

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

View File

@@ -0,0 +1,9 @@
curl --location --request POST 'https://medusa-url.com/admin/customers' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"email": "user@example.com",
"first_name": "Caterina",
"last_name": "Yost",
"password": "supersecret"
}'

View File

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

View File

@@ -0,0 +1,6 @@
curl --location --request POST 'https://medusa-url.com/admin/customers/{id}' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"first_name": "Dolly"
}'

View File

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

View File

@@ -0,0 +1,11 @@
curl --location --request POST 'https://medusa-url.com/admin/discounts' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"code": "TEST",
"rule": {
"type": "fixed",
"value": 10,
"allocation": "item"
}
}'

View File

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

View File

@@ -0,0 +1,6 @@
curl --location --request POST 'https://medusa-url.com/admin/discounts/{id}/conditions' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"operator": "in"
}'

View File

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

View File

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

View File

@@ -0,0 +1,8 @@
curl --location --request POST 'https://medusa-url.com/admin/discounts/{id}/conditions/{condition}' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"products": [
"prod_01G1G5V2MBA328390B5AXJ610F"
]
}'

View File

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

View File

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

View File

@@ -0,0 +1,6 @@
curl --location --request POST 'https://medusa-url.com/admin/discounts/{id}' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"code": "TEST"
}'

View File

@@ -0,0 +1,6 @@
curl --location --request POST 'https://medusa-url.com/admin/discounts/{id}/dynamic-codes' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"code": "TEST"
}'

View File

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

View File

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

View File

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

View File

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

View File

@@ -0,0 +1,17 @@
curl --location --request POST 'https://medusa-url.com/admin/draft-orders' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"email": "user@example.com",
"region_id": "{region_id}"
"items": [
{
"quantity": 1
}
],
"shipping_methods": [
{
"option_id": "{option_id}"
}
]
}'

View File

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

View File

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

View File

@@ -0,0 +1,6 @@
curl --location --request POST 'https://medusa-url.com/admin/draft-orders/{id}/line-items' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"quantity": 1
}'

View File

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

View File

@@ -0,0 +1,6 @@
curl --location --request POST 'https://medusa-url.com/admin/draft-orders/{id}/line-items/{line_id}' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"quantity": 1
}'

View File

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

View File

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

View File

@@ -0,0 +1,6 @@
curl --location --request POST 'https://medusa-url.com/admin/gift-cards' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"region_id": "{region_id}"
}'

View File

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

View File

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

View File

@@ -0,0 +1,6 @@
curl --location --request POST 'https://medusa-url.com/admin/gift-cards/{id}' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"region_id": "{region_id}"
}'

View File

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

View File

@@ -0,0 +1,7 @@
curl --location --request POST 'https://medusa-url.com/admin/invites' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"user": "user@example.com",
"role": "admin"
}'

View File

@@ -0,0 +1,11 @@
curl --location --request POST 'https://medusa-url.com/admin/invites/accept' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"token": "{token}",
"user": {
"first_name": "Brigitte",
"last_name": "Collier",
"password": "supersecret"
}
}'

View File

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

View File

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

View File

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

View File

@@ -0,0 +1,8 @@
curl --location --request POST 'https://medusa-url.com/admin/notes' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"resource_id": "{resource_id}",
"resource_type": "order",
"value": "We delivered this order"
}'

View File

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

View File

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

View File

@@ -0,0 +1,6 @@
curl --location --request POST 'https://medusa-url.com/admin/notes/{id}' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"value": "We delivered this order"
}'

View File

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

View File

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

View File

@@ -0,0 +1,12 @@
curl --location --request POST 'https://medusa-url.com/admin/orders/{id}/claims' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"type": "refund",
"claim_items": [
{
"item_id": "asdsd",
"quantity": 1
}
]
}'

View File

@@ -0,0 +1,6 @@
curl --location --request POST 'https://medusa-url.com/admin/orders/{id}/claims/{claim_id}' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"no_notification": true
}'

View File

@@ -0,0 +1,11 @@
curl --location --request POST 'https://medusa-url.com/admin/orders/{id}/swaps' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"return_items": [
{
"item_id": "asfasf",
"quantity": 1
}
]
}'

View File

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

View File

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

View File

@@ -0,0 +1,6 @@
curl --location --request POST 'https://medusa-url.com/admin/orders/adasda' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"email": "user@example.com"
}'

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -0,0 +1,6 @@
curl --location --request POST 'https://medusa-url.com/admin/orders/{id}/claims/{claim_id}/shipments' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"fulfillment_id": "{fulfillment_id}"
}'

View File

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

View File

@@ -0,0 +1,11 @@
curl --location --request POST 'https://medusa-url.com/admin/orders/{id}/fulfillment' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"items": [
{
"item_id": "{item_id}",
"quantity": 1
}
]
}'

View File

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

View File

@@ -0,0 +1,7 @@
curl --location --request POST 'https://medusa-url.com/admin/orders/adasda/refund' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"amount": 1000,
"reason": "Do not like it"
}'

View File

@@ -0,0 +1,11 @@
curl --location --request POST 'https://medusa-url.com/admin/orders/{id}/return' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"items": [
{
"item_id": "{item_id}",
"quantity": 1
}
]
}'

View File

@@ -0,0 +1,6 @@
curl --location --request POST 'https://medusa-url.com/admin/orders/{id}/shipment' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"fulfillment_id": "{fulfillment_id}"
}'

View File

@@ -0,0 +1,7 @@
curl --location --request POST 'https://medusa-url.com/admin/orders/{id}/shipping-methods' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"price": 1000,
"option_id": "{option_id}"
}'

View File

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

View File

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

View File

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

View File

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

View File

@@ -0,0 +1,6 @@
curl --location --request POST 'https://medusa-url.com/admin/orders/{id}/swaps/{swap_id}/shipments' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"fulfillment_id": "{fulfillment_id}"
}'

View File

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

View File

@@ -0,0 +1,15 @@
curl --location --request POST 'https://medusa-url.com/admin/price-lists' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "New Price List",
"description": "A new price list",
"type": "sale",
"prices": [
{
"amount": 1000,
"variant_id": "afafa",
"currency_code": "eur"
}
]
}'

View File

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

View File

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

View File

@@ -0,0 +1,6 @@
curl --location --request POST 'https://medusa-url.com/admin/price-lists/{id}' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "New Price List"
}'

View File

@@ -0,0 +1,8 @@
curl --location --request DELETE 'https://medusa-url.com/admin/price-lists/{id}/prices/batch' \
--header 'Authorization: Bearer {api_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"price_ids": [
"adasfa"
]
}'

Some files were not shown because too many files have changed in this diff Show More