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
2023-08-15 18:07:54 +03:00
1 parent 16249ec280
commit 914d773d3a
@@ -2,244 +2,6 @@ openapi: 3.0.0
 info:
  version: 1.0.0
  title: Medusa Admin API
-  description: |
-    API reference for Medusa's Admin endpoints. All endpoints are prefixed with `/admin`.
-    
-    ## Authentication
-
-    There are two ways to send authenticated requests to the Medusa server: Using a user's API token, or using a Cookie Session ID.
-
-    <!-- ReDoc-Inject: <SecurityDefinitions> -->
-
-    ## Expanding Fields
-
-    In many endpoints you'll find an `expand` query parameter that can be passed to the endpoint. You can use the `expand` query parameter to unpack an entity's relations and return them in the response.
-
-    Please note that the relations you pass to `expand` replace any relations that are expanded by default in the request.
-
-    ### Expanding One Relation
-
-    For example, when you retrieve products, you can retrieve their collection by passing to the `expand` query parameter the value `collection`:
-
-    ```bash
-    curl "http://localhost:9000/admin/products?expand=collection" \
-    -H 'Authorization: Bearer {api_token}'
-    ```
-
-    ### Expanding Multiple Relations
-
-    You can expand more than one relation by separating the relations in the `expand` query parameter with a comma.
-    
-    For example, to retrieve both the variants and the collection of products, pass to the `expand` query parameter the value `variants,collection`:
-
-    ```bash
-    curl "http://localhost:9000/admin/products?expand=variants,collection" \
-    -H 'Authorization: Bearer {api_token}'
-    ```
-
-    ### Prevent Expanding Relations
-
-    Some requests expand relations by default. You can prevent that by passing an empty expand value to retrieve an entity without any extra relations.
-    
-    For example:
-
-    ```bash
-    curl "http://localhost:9000/admin/products?expand" \
-    -H 'Authorization: Bearer {api_token}'
-    ```
-
-    This would retrieve each product with only its properties, without any relations like `collection`.
-
-    ## Selecting Fields
-
-    In many endpoints you'll find a `fields` query parameter that can be passed to the endpoint. You can use the `fields` query parameter to specify which fields in the entity should be returned in the response.
-
-    Please note that if you pass a `fields` query parameter, only the fields you pass in the value along with the `id` of the entity will be returned in the response.
-    
-    Also, the `fields` query parameter does not affect the expanded relations. You'll have to use the `expand` parameter instead.
-
-    ### Selecting One Field
-
-    For example, when you retrieve a list of products, you can retrieve only the titles of the products by passing `title` as a value to the `fields` query parameter:
-    
-    ```bash
-    curl "http://localhost:9000/admin/products?fields=title" \
-    -H 'Authorization: Bearer {api_token}'
-    ```
-
-    As mentioned above, the expanded relations such as `variants` will still be returned as they're not affected by the `fields` parameter.
-    
-    You can ensure that only the `title` field is returned by passing an empty value to the `expand` query parameter. For example:
-    
-    ```bash
-    curl "http://localhost:9000/admin/products?fields=title&expand" \
-    -H 'Authorization: Bearer {api_token}'
-    ```
-
-    ### Selecting Multiple Fields
-
-    You can pass more than one field by seperating the field names in the `fields` query parameter with a comma.
-
-    For example, to select the `title` and `handle` of products:
-
-    ```bash
-    curl "http://localhost:9000/admin/products?fields=title,handle" \
-    -H 'Authorization: Bearer {api_token}'
-    ```
-
-    ### Retrieve Only the ID
-
-    You can pass an empty `fields` query parameter to return only the ID of an entity. For example:
-    
-    ```bash
-    curl "http://localhost:9000/admin/products?fields" \
-    -H 'Authorization: Bearer {api_token}'
-    ```
-
-    You can also pair with an empty `expand` query parameter to ensure that the relations aren't retrieved as well. For example:
-    
-    ```bash
-    curl "http://localhost:9000/admin/products?fields&expand" \
-    -H 'Authorization: Bearer {api_token}'
-    ```
-
-    ## Query Parameter Types
-
-    This section covers how to pass some common data types as query parameters. This is useful if you're sending requests to the API endpoints and not using our JS Client. For example, when using cURL or Postman.
-
-    ### Strings
-
-    You can pass a string value in the form of `<parameter_name>=<value>`.
-
-    For example:
-    
-    ```bash
-    curl "http://localhost:9000/admin/products?title=Shirt" \
-    -H 'Authorization: Bearer {api_token}'
-    ```
-
-    If the string has any characters other than letters and numbers, you must encode them.
-
-    For example, if the string has spaces, you can encode the space with `+` or `%20`:
-
-    ```bash
-    curl "http://localhost:9000/admin/products?title=Blue%20Shirt" \
-    -H 'Authorization: Bearer {api_token}'
-    ```
-
-    You can use tools like [this one](https://www.urlencoder.org/) to learn how a value can be encoded.
-
-    ### Integers
-
-    You can pass an integer value in the form of `<parameter_name>=<value>`.
-
-    For example:
-    
-    ```bash
-    curl "http://localhost:9000/admin/products?offset=1" \
-    -H 'Authorization: Bearer {api_token}'
-    ```
-
-    ### Boolean
-
-    You can pass a boolean value in the form of `<parameter_name>=<value>`.
-
-    For example:
-    
-    ```bash
-    curl "http://localhost:9000/admin/products?is_giftcard=true" \
-    -H 'Authorization: Bearer {api_token}'
-    ```
-
-    ### Date and DateTime
-
-    You can pass a date value in the form `<parameter_name>=<value>`. The date must be in the format `YYYY-MM-DD`.
-
-    For example:
-    
-    ```bash
-    curl -g "http://localhost:9000/admin/products?created_at[lt]=2023-02-17" \
-    -H 'Authorization: Bearer {api_token}'
-    ```
-    
-    You can also pass the time using the format `YYYY-MM-DDTHH:MM:SSZ`. Please note that the `T` and `Z` here are fixed.
-
-    For example:
-    
-    ```bash
-    curl -g "http://localhost:9000/admin/products?created_at[lt]=2023-02-17T07:22:30Z" \
-    -H 'Authorization: Bearer {api_token}'
-    ```
-
-    ### Array
-
-    Each array value must be passed as a separate query parameter in the form `<parameter_name>[]=<value>`. You can also specify the index of each parameter in the brackets `<parameter_name>[0]=<value>`.
-
-    For example:
-    
-    ```bash
-    curl -g "http://localhost:9000/admin/products?sales_channel_id[]=sc_01GPGVB42PZ7N3YQEP2WDM7PC7&sales_channel_id[]=sc_234PGVB42PZ7N3YQEP2WDM7PC7" \
-    -H 'Authorization: Bearer {api_token}'
-    ```
-
-    Note that the `-g` parameter passed to `curl` disables errors being thrown for using the brackets. Read more [here](https://curl.se/docs/manpage.html#-g).
-
-    ### Object
-
-    Object parameters must be passed as separate query parameters in the form `<parameter_name>[<key>]=<value>`.
-
-    For example:
-    
-    ```bash
-    curl -g "http://localhost:9000/admin/products?created_at[lt]=2023-02-17&created_at[gt]=2022-09-17" \
-    -H 'Authorization: Bearer {api_token}'
-    ```
-
-    ## Pagination
-
-    ### Query Parameters
-
-    In listing endpoints, such as list customers or list products, you can control the pagination using the query parameters `limit` and `offset`.
-
-    `limit` is used to specify the maximum number of items that can be return in the response. `offset` is used to specify how many items to skip before returning the resulting entities.
-
-    You can use the `offset` query parameter to change between pages. For example, if the limit is 50, at page 1 the offset should be 0; at page 2 the offset should be 50, and so on.
-
-    For example, to limit the number of products returned in the List Products endpoint:
-    
-    ```bash
-    curl "http://localhost:9000/admin/products?limit=5" \
-    -H 'Authorization: Bearer {api_token}'
-    ```
-
-    ### Response Fields
-
-    In the response of listing endpoints, aside from the entities retrieved, there are three pagination-related fields returned: `count`, `limit`, and `offset`.
-
-    Similar to the query parameters, `limit` is the maximum number of items that can be returned in the response, and `field` is the number of items that were skipped before the entities in the result.
-
-    `count` is the total number of available items of this entity. It can be used to determine how many pages are there.
-    
-    For example, if the `count` is 100 and the `limit` is 50, you can divide the `count` by the `limit` to get the number of pages: `100/50 = 2 pages`.
-
-    ### Sort Order
-
-    The `order` field available on endpoints supporting pagination allows you to sort the retrieved items by an attribute of that item. For example, you can sort products by their `created_at` attribute by setting `order` to `created_at`:
-    
-    ```bash
-    curl "http://localhost:9000/admin/products?order=created_at" \
-    -H 'Authorization: Bearer {api_token}'
-    ```
-
-    By default, the sort direction will be ascending. To change it to descending, pass a dash (`-`) before the attribute name. For example:
-    
-    ```bash
-    curl "http://localhost:9000/admin/products?order=-created_at" \
-    -H 'Authorization: Bearer {api_token}'
-    ```
-    
-    This sorts the products by their `created_at` attribute in the descending order.
-
  license:
    name: MIT
    url: https://github.com/medusajs/medusa/blob/master/LICENSE
@@ -334,6 +96,9 @@ tags:
    externalDocs:
      description: How to edit an order
      url: https://docs.medusajs.com/modules/orders/admin/edit-order
+  - name: Payments
+    description: |
+      A payment can be related to an order, swap, return, or more. It can be captured or refunded.
  - name: Payment Collections
    description: |
      A payment collection is useful for managing additional payments, such as for Order Edits, or installment payments.
@@ -2,224 +2,6 @@ openapi: 3.0.0
 info:
  version: 1.0.0
  title: Medusa Storefront API
-  description: |
-    API reference for Medusa's Storefront endpoints. All endpoints are prefixed with `/store`.
-    
-    ## Authentication
-
-    To send requests as an authenticated customer, you must use the Cookie Session ID.
-
-    <!-- ReDoc-Inject: <SecurityDefinitions> -->
-
-    ## Expanding Fields
-
-    In many endpoints you'll find an `expand` query parameter that can be passed to the endpoint. You can use the `expand` query parameter to unpack an entity's relations and return them in the response.
-
-    Please note that the relations you pass to `expand` replace any relations that are expanded by default in the request.
-
-    ### Expanding One Relation
-
-    For example, when you retrieve a product, you can retrieve its collection by passing to the `expand` query parameter the value `collection`:
-
-    ```bash
-    curl "http://localhost:9000/store/products/prod_01GDJGP2XPQT2N3JHZQFMH5V45?expand=collection"
-    ```
-
-    ### Expanding Multiple Relations
-
-    You can expand more than one relation by separating the relations in the `expand` query parameter with a comma.
-    
-    For example, to retrieve both the variants and the collection of a product, pass to the `expand` query parameter the value `variants,collection`:
-
-    ```bash
-    curl "http://localhost:9000/store/products/prod_01GDJGP2XPQT2N3JHZQFMH5V45?expand=variants,collection"
-    ```
-
-    ### Prevent Expanding Relations
-
-    Some requests expand relations by default. You can prevent that by passing an empty expand value to retrieve an entity without any extra relations.
-    
-    For example:
-
-    ```bash
-    curl "http://localhost:9000/store/products/prod_01GDJGP2XPQT2N3JHZQFMH5V45?expand"
-    ```
-
-    This would retrieve the product with only its properties, without any relations like `collection`.
-
-    ## Selecting Fields
-
-    In many endpoints you'll find a `fields` query parameter that can be passed to the endpoint. You can use the `fields` query parameter to specify which fields in the entity should be returned in the response.
-
-    Please note that if you pass a `fields` query parameter, only the fields you pass in the value along with the `id` of the entity will be returned in the response.
-    
-    Also, the `fields` query parameter does not affect the expanded relations. You'll have to use the `expand` parameter instead.
-
-    ### Selecting One Field
-
-    For example, when you retrieve a list of products, you can retrieve only the titles of the products by passing `title` as a value to the `fields` query parameter:
-    
-    ```bash
-    curl "http://localhost:9000/store/products?fields=title"
-    ```
-
-    As mentioned above, the expanded relations such as `variants` will still be returned as they're not affected by the `fields` parameter.
-    
-    You can ensure that only the `title` field is returned by passing an empty value to the `expand` query parameter. For example:
-    
-    ```bash
-    curl "http://localhost:9000/store/products?fields=title&expand"
-    ```
-
-    ### Selecting Multiple Fields
-
-    You can pass more than one field by seperating the field names in the `fields` query parameter with a comma.
-
-    For example, to select the `title` and `handle` of a product:
-
-    ```bash
-    curl "http://localhost:9000/store/products?fields=title,handle"
-    ```
-
-    ### Retrieve Only the ID
-
-    You can pass an empty `fields` query parameter to return only the ID of an entity. For example:
-    
-    ```bash
-    curl "http://localhost:9000/store/products?fields"
-    ```
-
-    You can also pair with an empty `expand` query parameter to ensure that the relations aren't retrieved as well. For example:
-    
-    ```bash
-    curl "http://localhost:9000/store/products?fields&expand"
-    ```
-
-    ## Query Parameter Types
-
-    This section covers how to pass some common data types as query parameters. This is useful if you're sending requests to the API endpoints and not using our JS Client. For example, when using cURL or Postman.
-
-    ### Strings
-
-    You can pass a string value in the form of `<parameter_name>=<value>`.
-
-    For example:
-    
-    ```bash
-    curl "http://localhost:9000/store/products?title=Shirt"
-    ```
-
-    If the string has any characters other than letters and numbers, you must encode them.
-
-    For example, if the string has spaces, you can encode the space with `+` or `%20`:
-
-    ```bash
-    curl "http://localhost:9000/store/products?title=Blue%20Shirt"
-    ```
-
-    You can use tools like [this one](https://www.urlencoder.org/) to learn how a value can be encoded.
-
-    ### Integers
-
-    You can pass an integer value in the form of `<parameter_name>=<value>`.
-
-    For example:
-    
-    ```bash
-    curl "http://localhost:9000/store/products?offset=1"
-    ```
-
-    ### Boolean
-
-    You can pass a boolean value in the form of `<parameter_name>=<value>`.
-
-    For example:
-    
-    ```bash
-    curl "http://localhost:9000/store/products?is_giftcard=true"
-    ```
-
-    ### Date and DateTime
-
-    You can pass a date value in the form `<parameter_name>=<value>`. The date must be in the format `YYYY-MM-DD`.
-
-    For example:
-    
-    ```bash
-    curl -g "http://localhost:9000/store/products?created_at[lt]=2023-02-17"
-    ```
-    
-    You can also pass the time using the format `YYYY-MM-DDTHH:MM:SSZ`. Please note that the `T` and `Z` here are fixed.
-
-    For example:
-    
-    ```bash
-    curl -g "http://localhost:9000/store/products?created_at[lt]=2023-02-17T07:22:30Z"
-    ```
-
-    ### Array
-
-    Each array value must be passed as a separate query parameter in the form `<parameter_name>[]=<value>`. You can also specify the index of each parameter in the brackets `<parameter_name>[0]=<value>`.
-
-    For example:
-    
-    ```bash
-    curl -g "http://localhost:9000/store/products?sales_channel_id[]=sc_01GPGVB42PZ7N3YQEP2WDM7PC7&sales_channel_id[]=sc_234PGVB42PZ7N3YQEP2WDM7PC7"
-    ```
-
-    Note that the `-g` parameter passed to `curl` disables errors being thrown for using the brackets. Read more [here](https://curl.se/docs/manpage.html#-g).
-
-    ### Object
-
-    Object parameters must be passed as separate query parameters in the form `<parameter_name>[<key>]=<value>`.
-
-    For example:
-    
-    ```bash
-    curl -g "http://localhost:9000/store/products?created_at[lt]=2023-02-17&created_at[gt]=2022-09-17"
-    ```
-
-    ## Pagination
-
-    ### Query Parameters
-
-    In listing endpoints, such as list customers or list products, you can control the pagination using the query parameters `limit` and `offset`.
-
-    `limit` is used to specify the maximum number of items that can be return in the response. `offset` is used to specify how many items to skip before returning the resulting entities.
-
-    You can use the `offset` query parameter to change between pages. For example, if the limit is 50, at page 1 the offset should be 0; at page 2 the offset should be 50, and so on.
-
-    For example, to limit the number of products returned in the List Products endpoint:
-    
-    ```bash
-    curl "http://localhost:9000/store/products?limit=5"
-    ```
-
-    ### Response Fields
-
-    In the response of listing endpoints, aside from the entities retrieved, there are three pagination-related fields returned: `count`, `limit`, and `offset`.
-
-    Similar to the query parameters, `limit` is the maximum number of items that can be returned in the response, and `field` is the number of items that were skipped before the entities in the result.
-
-    `count` is the total number of available items of this entity. It can be used to determine how many pages are there.
-    
-    For example, if the `count` is 100 and the `limit` is 50, you can divide the `count` by the `limit` to get the number of pages: `100/50 = 2 pages`.
-
-    ### Sort Order
-
-    The `order` field available on endpoints supporting pagination allows you to sort the retrieved items by an attribute of that item. For example, you can sort products by their `created_at` attribute by setting `order` to `created_at`:
-    
-    ```bash
-    curl "http://localhost:9000/list/products?order=created_at"
-    ```
-
-    By default, the sort direction will be ascending. To change it to descending, pass a dash (`-`) before the attribute name. For example:
-    
-    ```bash
-    curl "http://localhost:9000/list/products?order=-created_at"
-    ```
-    
-    This sorts the products by their `created_at` attribute in the descending order.
  license:
    name: MIT
    url: https://github.com/medusajs/medusa/blob/master/LICENSE
@@ -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 '{
@@ -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: []
@@ -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: []