api-ref: custom API reference (#4770)
* initialized next.js project * finished markdown sections * added operation schema component * change page metadata * eslint fixes * fixes related to deployment * added response schema * resolve max stack issue * support for different property types * added support for property types * added loading for components * added more loading * type fixes * added oneOf type * removed console * fix replace with push * refactored everything * use static content for description * fixes and improvements * added code examples section * fix path name * optimizations * fixed tag navigation * add support for admin and store references * general enhancements * optimizations and fixes * fixes and enhancements * added search bar * loading enhancements * added loading * added code blocks * added margin top * add empty response text * fixed oneOf parameters * added path and query parameters * general fixes * added base path env variable * small fix for arrays * enhancements * design enhancements * general enhancements * fix isRequired * added enum values * enhancements * general fixes * general fixes * changed oas generation script * additions to the introduction section * added copy button for code + other enhancements * fix response code block * fix metadata * formatted store introduction * move sidebar logic to Tags component * added test env variables * fix code block bug * added loading animation * added expand param + loading * enhance operation loading * made responsive + improvements * added loading provider * fixed loading * adjustments for small devices * added sidebar label for endpoints * added feedback component * fixed analytics * general fixes * listen to scroll for other headings * added sample env file * update api ref files + support new fields * fix for external docs link * added new sections * fix last item in sidebar not showing * move docs content to www/docs * change redirect url * revert change * resolve build errors * configure rewrites * changed to environment variable url * revert changing environment variable name * add environment variable for API path * fix links * fix tailwind settings * remove vercel file * reconfigured api route * move api page under api * fix page metadata * fix external link in navigation bar * update api spec * updated api specs * fixed google lint error * add max-height on request samples * add padding before loading * fix for one of name * fix undefined types * general fixes * remove response schema example * redesigned navigation bar * redesigned sidebar * fixed up paddings * added feedback component + report issue * fixed up typography, padding, and general styling * redesigned code blocks * optimization * added error timeout * fixes * added indexing with algolia + fixes * fix errors with algolia script * redesign operation sections * fix heading scroll * design fixes * fix padding * fix padding + scroll issues * fix scroll issues * improve scroll performance * fixes for safari * optimization and fixes * fixes to docs + details animation * padding fixes for code block * added tab animation * fixed incorrect link * added selection styling * fix lint errors * redesigned details component * added detailed feedback form * api reference fixes * fix tabs * upgrade + fixes * updated documentation links * optimizations to sidebar items * fix spacing in sidebar item * optimizations and fixes * fix endpoint path styling * remove margin * final fixes * change margin on small devices * generated OAS * fixes for mobile * added feedback modal * optimize dark mode button * fixed color mode useeffect * minimize dom size * use new style system * radius and spacing design system * design fixes * fix eslint errors * added meta files * change cron schedule * fix docusaurus configurations * added operating system to feedback data * change content directory name * fixes to contribution guidelines * revert renaming content * added api-reference to documentation workflow * fixes for search * added dark mode + fixes * oas fixes * handle bugs * added code examples for clients * changed tooltip text * change authentication to card * change page title based on selected section * redesigned mobile navbar * fix icon colors * fix key colors * fix medusa-js installation command * change external regex in algolia * change changeset * fix padding on mobile * fix hydration error * update depedencies
This commit is contained in:
@@ -87,10 +87,13 @@ export default () => {
|
||||
* code:
|
||||
* type: string
|
||||
* description: A slug code to indicate the type of the error.
|
||||
* enum: [invalid_state_error, invalid_request_error, api_error, unknown_error]
|
||||
* message:
|
||||
* type: string
|
||||
* description: Description of the error that occurred.
|
||||
* example: "first_name must be a string"
|
||||
* type:
|
||||
* type: string
|
||||
* description: A slug indicating the type of the error.
|
||||
* enum: [QueryRunnerAlreadyReleasedError, TransactionAlreadyStartedError, TransactionNotStartedError, conflict, unauthorized, payment_authorization_error, duplicate_error, not_allowed, invalid_data, not_found, database_error, unexpected_state, invalid_argument, unknown_error]
|
||||
*/
|
||||
|
||||
@@ -20,7 +20,7 @@ import { validator } from "../../../../utils/validator"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/apps/authorizations' \
|
||||
* curl -X POST '{backend_url}/admin/apps/authorizations' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
|
||||
@@ -12,7 +12,7 @@ import { OauthService } from "../../../../services"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl 'https://medusa-url.com/admin/apps' \
|
||||
* curl '{backend_url}/admin/apps' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -37,7 +37,7 @@ import { validator } from "../../../../utils/validator"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/auth' \
|
||||
* curl -X POST '{backend_url}/admin/auth' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
* "email": "user@example.com",
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X DELETE 'https://medusa-url.com/admin/auth' \
|
||||
* curl -X DELETE '{backend_url}/admin/auth' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -23,7 +23,7 @@ import _ from "lodash"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl 'https://medusa-url.com/admin/auth' \
|
||||
* curl '{backend_url}/admin/auth' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -25,7 +25,7 @@ import { EntityManager } from "typeorm"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/batch-jobs/{id}/cancel' \
|
||||
* curl -X POST '{backend_url}/admin/batch-jobs/{id}/cancel' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -25,7 +25,7 @@ import { EntityManager } from "typeorm"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/batch-jobs/{id}/confirm' \
|
||||
* curl -X POST '{backend_url}/admin/batch-jobs/{id}/confirm' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -39,7 +39,7 @@ import { validator } from "../../../../utils/validator"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/batch-jobs' \
|
||||
* curl -X POST '{backend_url}/admin/batch-jobs' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* --data-raw '{
|
||||
|
||||
@@ -22,7 +22,7 @@
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl 'https://medusa-url.com/admin/batch-jobs/{id}' \
|
||||
* curl '{backend_url}/admin/batch-jobs/{id}' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -227,7 +227,7 @@ import { isDefined } from "medusa-core-utils"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl 'https://medusa-url.com/admin/batch-jobs' \
|
||||
* curl '{backend_url}/admin/batch-jobs' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -39,7 +39,7 @@ import { defaultAdminCollectionsRelations } from "./index"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/collections/{id}/products/batch' \
|
||||
* curl -X POST '{backend_url}/admin/collections/{id}/products/batch' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
|
||||
@@ -33,7 +33,7 @@ import { defaultAdminCollectionsRelations } from "."
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/collections' \
|
||||
* curl -X POST '{backend_url}/admin/collections' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
|
||||
@@ -27,7 +27,7 @@ import ProductCollectionService from "../../../../services/product-collection"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X DELETE 'https://medusa-url.com/admin/collections/{id}' \
|
||||
* curl -X DELETE '{backend_url}/admin/collections/{id}' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -27,7 +27,7 @@ import { defaultAdminCollectionsRelations } from "."
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl 'https://medusa-url.com/admin/collections/{id}' \
|
||||
* curl '{backend_url}/admin/collections/{id}' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -101,7 +101,7 @@ import { Type } from "class-transformer"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl 'https://medusa-url.com/admin/collections' \
|
||||
* curl '{backend_url}/admin/collections' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -38,7 +38,7 @@ import ProductCollectionService from "../../../../services/product-collection"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X DELETE 'https://medusa-url.com/admin/collections/{id}/products/batch' \
|
||||
* curl -X DELETE '{backend_url}/admin/collections/{id}/products/batch' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
|
||||
@@ -35,7 +35,7 @@ import { defaultAdminCollectionsRelations } from "."
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/collections/{id}' \
|
||||
* curl -X POST '{backend_url}/admin/collections/{id}' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
|
||||
@@ -40,7 +40,7 @@ import { FeatureFlagDecorators } from "../../../../utils/feature-flag-decorators
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/currencies' \
|
||||
* curl -X POST '{backend_url}/admin/currencies' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* tags:
|
||||
* - Currencies
|
||||
|
||||
@@ -37,7 +37,7 @@ import { EntityManager } from "typeorm"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/currencies/{code}' \
|
||||
* curl -X POST '{backend_url}/admin/currencies/{code}' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
|
||||
@@ -42,7 +42,7 @@ import { validator } from "../../../../utils/validator"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/customer-groups/{id}/customers/batch' \
|
||||
* curl -X POST '{backend_url}/admin/customer-groups/{id}/customers/batch' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
|
||||
@@ -34,7 +34,7 @@ import { validator } from "../../../../utils/validator"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/customer-groups' \
|
||||
* curl -X POST '{backend_url}/admin/customer-groups' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
|
||||
@@ -27,7 +27,7 @@ import { EntityManager } from "typeorm"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X DELETE 'https://medusa-url.com/admin/customer-groups/{id}' \
|
||||
* curl -X DELETE '{backend_url}/admin/customer-groups/{id}' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -42,7 +42,7 @@ import { validator } from "../../../../utils/validator"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X DELETE 'https://medusa-url.com/admin/customer-groups/{id}/customers/batch' \
|
||||
* curl -X DELETE '{backend_url}/admin/customer-groups/{id}/customers/batch' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
|
||||
+1
-1
@@ -33,7 +33,7 @@ import { Type } from "class-transformer"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl 'https://medusa-url.com/admin/customer-groups/{id}/customers' \
|
||||
* curl '{backend_url}/admin/customer-groups/{id}/customers' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -30,7 +30,7 @@ import { FindParams } from "../../../../types/common"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl 'https://medusa-url.com/admin/customer-groups/{id}' \
|
||||
* curl '{backend_url}/admin/customer-groups/{id}' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -117,7 +117,7 @@ import { Type } from "class-transformer"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl 'https://medusa-url.com/admin/customer-groups' \
|
||||
* curl '{backend_url}/admin/customer-groups' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -38,7 +38,7 @@ import { validator } from "../../../../utils/validator"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/customer-groups/{id}' \
|
||||
* curl -X POST '{backend_url}/admin/customer-groups/{id}' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
|
||||
@@ -36,7 +36,7 @@ import { EntityManager } from "typeorm"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/customers' \
|
||||
* curl -X POST '{backend_url}/admin/customers' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
|
||||
@@ -29,7 +29,7 @@ import { validator } from "../../../../utils/validator"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl 'https://medusa-url.com/admin/customers/{id}' \
|
||||
* curl '{backend_url}/admin/customers/{id}' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -41,7 +41,7 @@ import customerController from "../../../../controllers/customers"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl 'https://medusa-url.com/admin/customers' \
|
||||
* curl '{backend_url}/admin/customers' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -48,7 +48,7 @@ import { validator } from "../../../../utils/validator"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/customers/{id}' \
|
||||
* curl -X POST '{backend_url}/admin/customers/{id}' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
@@ -130,7 +130,7 @@ class Group {
|
||||
* properties:
|
||||
* email:
|
||||
* type: string
|
||||
* description: The Customer's email.
|
||||
* description: The Customer's email. You can't update the email of a registered customer.
|
||||
* format: email
|
||||
* first_name:
|
||||
* type: string
|
||||
|
||||
@@ -29,7 +29,7 @@ import { EntityManager } from "typeorm"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/discounts/{id}/regions/{region_id}' \
|
||||
* curl -X POST '{backend_url}/admin/discounts/{id}/regions/{region_id}' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -45,7 +45,7 @@ import { FindParams } from "../../../../types/common"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/discounts/{id}/conditions/{condition_id}/batch' \
|
||||
* curl -X POST '{backend_url}/admin/discounts/{id}/conditions/{condition_id}/batch' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
|
||||
@@ -44,7 +44,7 @@ import { FindParams } from "../../../../types/common"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/discounts/{id}/conditions' \
|
||||
* curl -X POST '{backend_url}/admin/discounts/{id}/conditions' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
|
||||
@@ -67,7 +67,7 @@ import { FindParams } from "../../../../types/common"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/discounts' \
|
||||
* curl -X POST '{backend_url}/admin/discounts' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
|
||||
@@ -43,7 +43,7 @@ import { EntityManager } from "typeorm"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/discounts/{id}/dynamic-codes' \
|
||||
* curl -X POST '{backend_url}/admin/discounts/{id}/dynamic-codes' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
|
||||
@@ -32,7 +32,7 @@ import { FindParams } from "../../../../types/common"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X DELETE 'https://medusa-url.com/admin/discounts/{id}/conditions/{condition_id}' \
|
||||
* curl -X DELETE '{backend_url}/admin/discounts/{id}/conditions/{condition_id}' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -25,7 +25,7 @@ import { EntityManager } from "typeorm"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X DELETE 'https://medusa-url.com/admin/discounts/{id}' \
|
||||
* curl -X DELETE '{backend_url}/admin/discounts/{id}' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -28,7 +28,7 @@ import { EntityManager } from "typeorm"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X DELETE 'https://medusa-url.com/admin/discounts/{id}/dynamic-codes/{code}' \
|
||||
* curl -X DELETE '{backend_url}/admin/discounts/{id}/dynamic-codes/{code}' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
+1
-1
@@ -42,7 +42,7 @@ import { FindParams } from "../../../../types/common"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X DELETE 'https://medusa-url.com/admin/discounts/{id}/conditions/{condition_id}/batch' \
|
||||
* curl -X DELETE '{backend_url}/admin/discounts/{id}/conditions/{condition_id}/batch' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
|
||||
@@ -30,7 +30,7 @@ import { FindParams } from "../../../../types/common"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl 'https://medusa-url.com/admin/discounts/{id}/conditions/{condition_id}' \
|
||||
* curl '{backend_url}/admin/discounts/{id}/conditions/{condition_id}' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -29,7 +29,7 @@ import { FindParams } from "../../../../types/common"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl 'https://medusa-url.com/admin/discounts/code/{code}' \
|
||||
* curl '{backend_url}/admin/discounts/code/{code}' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -29,7 +29,7 @@ import { FindParams } from "../../../../types/common"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl 'https://medusa-url.com/admin/discounts/{id}' \
|
||||
* curl '{backend_url}/admin/discounts/{id}' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -56,7 +56,7 @@ import { optionalBooleanMapper } from "../../../../utils/validators/is-boolean"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl 'https://medusa-url.com/admin/discounts' \
|
||||
* curl '{backend_url}/admin/discounts' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -28,7 +28,7 @@ import { EntityManager } from "typeorm"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X DELETE 'https://medusa-url.com/admin/discounts/{id}/regions/{region_id}' \
|
||||
* curl -X DELETE '{backend_url}/admin/discounts/{id}/regions/{region_id}' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -43,7 +43,7 @@ import { FindParams } from "../../../../types/common"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/discounts/{id}/conditions/{condition}' \
|
||||
* curl -X POST '{backend_url}/admin/discounts/{id}/conditions/{condition}' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
|
||||
@@ -56,7 +56,7 @@ import { FindParams } from "../../../../types/common"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/discounts/{id}' \
|
||||
* curl -X POST '{backend_url}/admin/discounts/{id}' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
|
||||
@@ -67,7 +67,7 @@ import { cleanResponseData } from "../../../../utils/clean-response-data"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/draft-orders' \
|
||||
* curl -X POST '{backend_url}/admin/draft-orders' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
|
||||
@@ -46,7 +46,7 @@ import { cleanResponseData } from "../../../../utils/clean-response-data"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/draft-orders/{id}/line-items' \
|
||||
* curl -X POST '{backend_url}/admin/draft-orders/{id}/line-items' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
|
||||
@@ -25,7 +25,7 @@ import { EntityManager } from "typeorm"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X DELETE 'https://medusa-url.com/admin/draft-orders/{id}' \
|
||||
* curl -X DELETE '{backend_url}/admin/draft-orders/{id}' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -35,7 +35,7 @@ import { cleanResponseData } from "../../../../utils/clean-response-data"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X DELETE 'https://medusa-url.com/admin/draft-orders/{id}/line-items/{line_id}' \
|
||||
* curl -X DELETE '{backend_url}/admin/draft-orders/{id}/line-items/{line_id}' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -33,7 +33,7 @@ import { cleanResponseData } from "../../../../utils/clean-response-data"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl 'https://medusa-url.com/admin/draft-orders/{id}' \
|
||||
* curl '{backend_url}/admin/draft-orders/{id}' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -38,7 +38,7 @@ import { validator } from "../../../../utils/validator"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl 'https://medusa-url.com/admin/draft-orders' \
|
||||
* curl '{backend_url}/admin/draft-orders' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -40,7 +40,7 @@ import { cleanResponseData } from "../../../../utils/clean-response-data"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/draft-orders/{id}/pay' \
|
||||
* curl -X POST '{backend_url}/admin/draft-orders/{id}/pay' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -52,7 +52,7 @@ import { cleanResponseData } from "../../../../utils/clean-response-data"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/draft-orders/{id}' \
|
||||
* curl -X POST '{backend_url}/admin/draft-orders/{id}' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
|
||||
@@ -45,7 +45,7 @@ import { cleanResponseData } from "../../../../utils/clean-response-data"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/draft-orders/{id}/line-items/{line_id}' \
|
||||
* curl -X POST '{backend_url}/admin/draft-orders/{id}/line-items/{line_id}' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
|
||||
@@ -34,7 +34,7 @@ import { EntityManager } from "typeorm"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/gift-cards' \
|
||||
* curl -X POST '{backend_url}/admin/gift-cards' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
|
||||
@@ -24,7 +24,7 @@ import { EntityManager } from "typeorm"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X DELETE 'https://medusa-url.com/admin/gift-cards/{id}' \
|
||||
* curl -X DELETE '{backend_url}/admin/gift-cards/{id}' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -24,7 +24,7 @@ import { defaultAdminGiftCardFields, defaultAdminGiftCardRelations } from "./"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl 'https://medusa-url.com/admin/gift-cards/{id}' \
|
||||
* curl '{backend_url}/admin/gift-cards/{id}' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -33,7 +33,7 @@ import { isDefined } from "medusa-core-utils"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl 'https://medusa-url.com/admin/gift-cards' \
|
||||
* curl '{backend_url}/admin/gift-cards' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -37,7 +37,7 @@ import { validator } from "../../../../utils/validator"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/gift-cards/{id}' \
|
||||
* curl -X POST '{backend_url}/admin/gift-cards/{id}' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
|
||||
@@ -44,7 +44,7 @@ import { validator } from "../../../../utils/validator"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/inventory-items' \
|
||||
* curl -X POST '{backend_url}/admin/inventory-items' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
|
||||
@@ -6,8 +6,8 @@ import { FindParams } from "../../../../types/common"
|
||||
/**
|
||||
* @oas [post] /admin/inventory-items/{id}/location-levels
|
||||
* operationId: "PostInventoryItemsInventoryItemLocationLevels"
|
||||
* summary: "Create an Inventory Level"
|
||||
* description: "Create an Inventory Level for a given Inventory Item."
|
||||
* summary: "Create an Location Level"
|
||||
* description: "Create an Location Level for a given Inventory Item."
|
||||
* x-authenticated: true
|
||||
* parameters:
|
||||
* - (path) id=* {string} The ID of the Inventory Item.
|
||||
@@ -38,7 +38,7 @@ import { FindParams } from "../../../../types/common"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/inventory-items/{id}/location-levels' \
|
||||
* curl -X POST '{backend_url}/admin/inventory-items/{id}/location-levels' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
|
||||
@@ -27,7 +27,7 @@ import { ProductVariantInventoryService } from "../../../../services"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X DELETE 'https://medusa-url.com/admin/inventory-items/{id}' \
|
||||
* curl -X DELETE '{backend_url}/admin/inventory-items/{id}' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -28,7 +28,7 @@ import { EntityManager } from "typeorm"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X DELETE 'https://medusa-url.com/admin/inventory-items/{id}/location-levels/{location_id}' \
|
||||
* curl -X DELETE '{backend_url}/admin/inventory-items/{id}/location-levels/{location_id}' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -30,7 +30,7 @@ import { joinLevels } from "./utils/join-levels"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl 'https://medusa-url.com/admin/inventory-items/{id}' \
|
||||
* curl '{backend_url}/admin/inventory-items/{id}' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -80,7 +80,7 @@ import { Transform } from "class-transformer"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl 'https://medusa-url.com/admin/inventory-items' \
|
||||
* curl '{backend_url}/admin/inventory-items' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -41,7 +41,7 @@ import { IsType } from "../../../../utils/validators/is-type"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl 'https://medusa-url.com/admin/inventory-items/{id}/location-levels' \
|
||||
* curl '{backend_url}/admin/inventory-items/{id}/location-levels' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -39,7 +39,7 @@ import { IInventoryService } from "@medusajs/types"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/inventory-items/{id}' \
|
||||
* curl -X POST '{backend_url}/admin/inventory-items/{id}' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
|
||||
@@ -7,14 +7,14 @@ import { FindParams } from "../../../../types/common"
|
||||
/**
|
||||
* @oas [post] /admin/inventory-items/{id}/location-levels/{location_id}
|
||||
* operationId: "PostInventoryItemsInventoryItemLocationLevelsLocationLevel"
|
||||
* summary: "Update an Inventory Level"
|
||||
* description: "Update an Inventory Level's details for a given Inventory Item."
|
||||
* summary: "Update a Location Level"
|
||||
* description: "Update a Location Level's details for a given Inventory Item."
|
||||
* x-authenticated: true
|
||||
* parameters:
|
||||
* - (path) id=* {string} The ID of the Inventory Item that the location is associated with.
|
||||
* - (path) location_id=* {string} The ID of the Location to update.
|
||||
* - (query) expand {string} Comma-separated relations that should be expanded in the returned inventory level.
|
||||
* - (query) fields {string} Comma-separated fields that should be included in the returned inventory level.
|
||||
* - (query) expand {string} Comma-separated relations that should be expanded in the returned location level.
|
||||
* - (query) fields {string} Comma-separated fields that should be included in the returned location level.
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
@@ -39,7 +39,7 @@ import { FindParams } from "../../../../types/common"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/inventory-items/{id}/location-levels/{location_id}' \
|
||||
* curl -X POST '{backend_url}/admin/inventory-items/{id}/location-levels/{location_id}' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
|
||||
@@ -42,7 +42,7 @@ import { EntityManager } from "typeorm"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/invites/accept' \
|
||||
* curl -X POST '{backend_url}/admin/invites/accept' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
|
||||
@@ -39,7 +39,7 @@ import { EntityManager } from "typeorm"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/invites' \
|
||||
* curl -X POST '{backend_url}/admin/invites' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
|
||||
@@ -25,7 +25,7 @@ import InviteService from "../../../../services/invite"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X DELETE 'https://medusa-url.com/admin/invites/{invite_id}' \
|
||||
* curl -X DELETE '{backend_url}/admin/invites/{invite_id}' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -22,7 +22,7 @@ import InviteService from "../../../../services/invite"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl 'https://medusa-url.com/admin/invites' \
|
||||
* curl '{backend_url}/admin/invites' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -29,7 +29,7 @@ import { EntityManager } from "typeorm"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/invites/{invite_id}/resend' \
|
||||
* curl -X POST '{backend_url}/admin/invites/{invite_id}/resend' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -35,7 +35,7 @@ import { EntityManager } from "typeorm"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/notes' \
|
||||
* curl -X POST '{backend_url}/admin/notes' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
|
||||
@@ -25,7 +25,7 @@ import NoteService from "../../../../services/note"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X DELETE 'https://medusa-url.com/admin/notes/{id}' \
|
||||
* curl -X DELETE '{backend_url}/admin/notes/{id}' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -24,7 +24,7 @@ import NoteService from "../../../../services/note"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl 'https://medusa-url.com/admin/notes/{id}' \
|
||||
* curl '{backend_url}/admin/notes/{id}' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -32,7 +32,7 @@ import { validator } from "../../../../utils/validator"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl 'https://medusa-url.com/admin/notes' \
|
||||
* curl '{backend_url}/admin/notes' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -34,7 +34,7 @@ import { EntityManager } from "typeorm"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/notes/{id}' \
|
||||
* curl -X POST '{backend_url}/admin/notes/{id}' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
|
||||
@@ -44,7 +44,7 @@ import { validator } from "../../../../utils/validator"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl 'https://medusa-url.com/admin/notifications' \
|
||||
* curl '{backend_url}/admin/notifications' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -38,7 +38,7 @@ import { validator } from "../../../../utils/validator"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/notifications/{id}/resend' \
|
||||
* curl -X POST '{backend_url}/admin/notifications/{id}/resend' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -41,7 +41,7 @@ import {
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/order-edits/{id}/items' \
|
||||
* curl -X POST '{backend_url}/admin/order-edits/{id}/items' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{ "variant_id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6", "quantity": 3 }'
|
||||
|
||||
@@ -30,7 +30,7 @@ import {
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/order-edits/{id}/cancel' \
|
||||
* curl -X POST '{backend_url}/admin/order-edits/{id}/cancel' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -30,7 +30,7 @@ import {
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/order-edits/{id}/confirm' \
|
||||
* curl -X POST '{backend_url}/admin/order-edits/{id}/confirm' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -34,7 +34,7 @@ import {
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/order-edits' \
|
||||
* curl -X POST '{backend_url}/admin/order-edits' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{ "order_id": "my_order_id", "internal_note": "my_optional_note" }'
|
||||
|
||||
@@ -32,7 +32,7 @@ import {
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X DELETE 'https://medusa-url.com/admin/order-edits/{id}/items/{item_id}' \
|
||||
* curl -X DELETE '{backend_url}/admin/order-edits/{id}/items/{item_id}' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -26,7 +26,7 @@ import { OrderEditService } from "../../../../services"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X DELETE 'https://medusa-url.com/admin/order-edits/{id}/changes/{change_id}' \
|
||||
* curl -X DELETE '{backend_url}/admin/order-edits/{id}/changes/{change_id}' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -25,7 +25,7 @@ import { OrderEditService } from "../../../../services"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X DELETE 'https://medusa-url.com/admin/order-edits/{id}' \
|
||||
* curl -X DELETE '{backend_url}/admin/order-edits/{id}' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -29,7 +29,7 @@ import { FindParams } from "../../../../types/common"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl 'https://medusa-url.com/admin/order-edits/{id}' \
|
||||
* curl '{backend_url}/admin/order-edits/{id}' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -33,7 +33,7 @@ import { IsOptional, IsString } from "class-validator"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl 'https://medusa-url.com/admin/order-edits' \
|
||||
* curl '{backend_url}/admin/order-edits' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -36,7 +36,7 @@ import {
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/order-edits/{id}/request' \
|
||||
* curl -X POST '{backend_url}/admin/order-edits/{id}/request' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -40,7 +40,7 @@ import {
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/order-edits/{id}/items/{item_id}' \
|
||||
* curl -X POST '{backend_url}/admin/order-edits/{id}/items/{item_id}' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{ "quantity": 5 }'
|
||||
|
||||
@@ -39,7 +39,7 @@ import {
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/order-edits/{id}' \
|
||||
* curl -X POST '{backend_url}/admin/order-edits/{id}' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
|
||||
@@ -46,7 +46,7 @@ import { cleanResponseData } from "../../../../utils/clean-response-data"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/orders/{id}/shipping-methods' \
|
||||
* curl -X POST '{backend_url}/admin/orders/{id}/shipping-methods' \
|
||||
* -H 'Authorization: Bearer {api_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
|
||||
@@ -30,7 +30,7 @@ import { cleanResponseData } from "../../../../utils/clean-response-data"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/orders/{id}/archive' \
|
||||
* curl -X POST '{backend_url}/admin/orders/{id}/archive' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -36,7 +36,7 @@ import { cleanResponseData } from "../../../../utils/clean-response-data"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/orders/{id}/claims/{claim_id}/cancel' \
|
||||
* curl -X POST '{backend_url}/admin/orders/{id}/claims/{claim_id}/cancel' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -38,7 +38,7 @@ import { cleanResponseData } from "../../../../utils/clean-response-data"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/orders/{id}/claims/{claim_id}/fulfillments/{fulfillment_id}/cancel' \
|
||||
* curl -X POST '{backend_url}/admin/orders/{id}/claims/{claim_id}/fulfillments/{fulfillment_id}/cancel' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
@@ -38,7 +38,7 @@ import { cleanResponseData } from "../../../../utils/clean-response-data"
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |
|
||||
* curl -X POST 'https://medusa-url.com/admin/orders/{id}/swaps/{swap_id}/fulfillments/{fulfillment_id}/cancel' \
|
||||
* curl -X POST '{backend_url}/admin/orders/{id}/swaps/{swap_id}/fulfillments/{fulfillment_id}/cancel' \
|
||||
* -H 'Authorization: Bearer {api_token}'
|
||||
* security:
|
||||
* - api_token: []
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user